Class PXEProfilesResource

PXE Profiles management resource

Hierarchy

BaseResource
- PXEProfilesResource

Index

Constructors

constructor

new PXEProfilesResource(client: TenantosClient): PXEProfilesResource
Parameters
- client: TenantosClient
Returns PXEProfilesResource
Inherited from BaseResource.constructor
- Defined in resources.ts:85

Properties

`Protected` `Readonly`client

client: TenantosClient

Methods

clearCache

clearCache(pxeProfileId: number): Promise<void>
Parameters
- pxeProfileId: number
Returns Promise<void>
- Defined in resources.ts:198

create

create(
    data: {
        additionalDriversUrl?: string;
        allow_for_dedicated?: boolean;
        allow_for_vps?: boolean;
        allow_set_hostname?: boolean;
        allow_ssh_keys?: boolean;
        autoInstallTemplate?: string;
        cacheDirectory: string;
        configure_all_ipvfour_ask_user?: boolean;
        configure_all_ipvfour_enforce?: boolean;
        configure_all_ipvsix_ask_user?: boolean;
        configure_all_ipvsix_enforce?: boolean;
        configure_ipvfour_even_if_outside_of_gateway?: boolean;
        customFirstBoot?: string;
        customPostScript?: string;
        default_disklayout_template?: number;
        default_run_scripts?: string[];
        default_run_scripts_hide_others?: boolean;
        defaultDiskLayout?: string;
        dont_offer_if_has_tag?: string[];
        dont_offer_if_user_has_role?: string[];
        enforced_default_disklayout_template?: boolean;
        enforced_default_run_scripts?: boolean;
        fallback_to_default_disklayout_if_unset?: boolean;
        httpdirectory?: string;
        ipxe_bios_file?: string;
        ipxe_efi_file?: string;
        isDisabled?: boolean;
        keep_dhcp_minutes?: number;
        language?: string;
        licensekey?: string;
        mark_installation_completed_event?: string;
        mirrorUrl?: string;
        networkConfigMode?: string;
        offer_if_has_tag?: string[];
        offer_if_user_has_role?: string[];
        osName: string;
        packages?: string;
        pxe_enable_comboot?: boolean;
        pxe_file_caching_policy?: string;
        pxeConfig: string;
        pxeType: string;
        set_root_password?: boolean;
        tags: string[];
        timezone?: string;
        updateServerHardwareInventory?: boolean;
        version?: string;
        windows_activation_key?: string;
        windows_bypass_system_requirements_check?: boolean;
        windows_key_location_specialize?: boolean;
        windows_key_location_userdata?: boolean;
        windows_skip_oobe?: boolean;
        windows_use_empty_activation_key?: boolean;
    },
): Promise<PXEProfile>
Parameters
- data: {
      additionalDriversUrl?: string;
      allow_for_dedicated?: boolean;
      allow_for_vps?: boolean;
      allow_set_hostname?: boolean;
      allow_ssh_keys?: boolean;
      autoInstallTemplate?: string;
      cacheDirectory: string;
      configure_all_ipvfour_ask_user?: boolean;
      configure_all_ipvfour_enforce?: boolean;
      configure_all_ipvsix_ask_user?: boolean;
      configure_all_ipvsix_enforce?: boolean;
      configure_ipvfour_even_if_outside_of_gateway?: boolean;
      customFirstBoot?: string;
      customPostScript?: string;
      default_disklayout_template?: number;
      default_run_scripts?: string[];
      default_run_scripts_hide_others?: boolean;
      defaultDiskLayout?: string;
      dont_offer_if_has_tag?: string[];
      dont_offer_if_user_has_role?: string[];
      enforced_default_disklayout_template?: boolean;
      enforced_default_run_scripts?: boolean;
      fallback_to_default_disklayout_if_unset?: boolean;
      httpdirectory?: string;
      ipxe_bios_file?: string;
      ipxe_efi_file?: string;
      isDisabled?: boolean;
      keep_dhcp_minutes?: number;
      language?: string;
      licensekey?: string;
      mark_installation_completed_event?: string;
      mirrorUrl?: string;
      networkConfigMode?: string;
      offer_if_has_tag?: string[];
      offer_if_user_has_role?: string[];
      osName: string;
      packages?: string;
      pxe_enable_comboot?: boolean;
      pxe_file_caching_policy?: string;
      pxeConfig: string;
      pxeType: string;
      set_root_password?: boolean;
      tags: string[];
      timezone?: string;
      updateServerHardwareInventory?: boolean;
      version?: string;
      windows_activation_key?: string;
      windows_bypass_system_requirements_check?: boolean;
      windows_key_location_specialize?: boolean;
      windows_key_location_userdata?: boolean;
      windows_skip_oobe?: boolean;
      windows_use_empty_activation_key?: boolean;
  }
  - OptionaladditionalDriversUrl?: string
    Description
    Must be a valid URL.
    
    Example
    https://domain.com/drivers
  - Optionalallow_for_dedicated?: boolean
    Example
    false
  - Optionalallow_for_vps?: boolean
    Example
    true
  - Optionalallow_set_hostname?: boolean
    Example
    true
  - Optionalallow_ssh_keys?: boolean
    Example
    true
  - OptionalautoInstallTemplate?: string
    Description
    The answer file for the OS installer.
    
    Example
    network --bootproto=static
  - cacheDirectory: string
    Description
    The OS files will be stored in this directory.
    
    Example
    centos8
  - Optionalconfigure_all_ipvfour_ask_user?: boolean
    Example
    false
  - Optionalconfigure_all_ipvfour_enforce?: boolean
    Example
    true
  - Optionalconfigure_all_ipvsix_ask_user?: boolean
    Example
    true
  - Optionalconfigure_all_ipvsix_enforce?: boolean
    Example
    false
  - Optionalconfigure_ipvfour_even_if_outside_of_gateway?: boolean
    Example
    true
  - OptionalcustomFirstBoot?: string
    Description
    Script will be executed on first operating system boot.
    
    Example
    touch /root/123
  - OptionalcustomPostScript?: string
    Description
    Script will be executed on after the installation has been completed, but within the installer environment.
    
    Example
    touch /root/123
  - Optionaldefault_disklayout_template?: number
    Example
    4
  - Optionaldefault_run_scripts?: string[]
    Example
    [ "nulla" ]
  - Optionaldefault_run_scripts_hide_others?: boolean
    Example
    false
  - OptionaldefaultDiskLayout?: string
    Description
    optional The disk layout configuration.
    
    Example
    autopart --type=lvm
  - Optionaldont_offer_if_has_tag?: string[]
    Example
    [ "ex" ]
  - Optionaldont_offer_if_user_has_role?: string[]
    Example
    [ null ]
  - Optionalenforced_default_disklayout_template?: boolean
    Example
    false
  - Optionalenforced_default_run_scripts?: boolean
    Example
    true
  - Optionalfallback_to_default_disklayout_if_unset?: boolean
    Example
    false
  - Optionalhttpdirectory?: string
    Example
    vel
  - Optionalipxe_bios_file?: string
    Example
    facere
  - Optionalipxe_efi_file?: string
    Example
    atque
  - OptionalisDisabled?: boolean
    Example
    true
  - Optionalkeep_dhcp_minutes?: number
    Description
    Must be at least 1. Must not be greater than 6000.
    
    Example
    4340
  - Optionallanguage?: string
    Example
    sequi
  - Optionallicensekey?: string
    Example
    voluptatem
  - Optionalmark_installation_completed_event?: string
    Description
    Must be one of afterBaseInstall, firstBootBeforeScriptExecution, firstBootAfterScriptExecution, or onFirstPxeFileAccess.
    
    Example
    firstBootAfterScriptExecution
  - OptionalmirrorUrl?: string
    Description
    The URL to the OS mirror.
    
    Example
    http://mirror.fra10.de.leaseweb.net/centos/8-stream/BaseOS/x86_64/os
  - OptionalnetworkConfigMode?: string
    Description
    Must be a valid network mode.
    
    Example
    default
  - Optionaloffer_if_has_tag?: string[]
    Example
    [ "aut" ]
  - Optionaloffer_if_user_has_role?: string[]
    Example
    [ null ]
  - osName: string
    Example
    nobis
  - Optionalpackages?: string
    Description
    A list of packages which should be installed.
    
    Example
    kexec-tools
  - Optionalpxe_enable_comboot?: boolean
    Example
    true
  - Optionalpxe_file_caching_policy?: string
    Description
    Must be one of smartCaching, dailyCleanup, clearBeforeInstallation, or keepAsLongAsPossible.
    
    Example
    keepAsLongAsPossible
  - pxeConfig: string
    Description
    The iPXE boot configuration.
    
    Example
    #!ipxe
  - pxeType: string
    Description
    Must be one of preseed,kickstart,autoinstall,windows,grml,vmware.
    
    Example
    kickstart
  - Optionalset_root_password?: boolean
    Example
    true
  - tags: string[]
    Example
    [ "kickstart " ]
  - Optionaltimezone?: string
    Example
    sed
  - OptionalupdateServerHardwareInventory?: boolean
    Example
    false
  - Optionalversion?: string
    Description
    The version of the operating system. Only required for Ubuntu / Windows.
    
    Example
    voluptate
  - Optionalwindows_activation_key?: string
    Example
    ipsam
  - Optionalwindows_bypass_system_requirements_check?: boolean
    Example
    true
  - Optionalwindows_key_location_specialize?: boolean
    Example
    false
  - Optionalwindows_key_location_userdata?: boolean
    Example
    false
  - Optionalwindows_skip_oobe?: boolean
    Example
    true
  - Optionalwindows_use_empty_activation_key?: boolean
    Example
    false
Returns Promise<PXEProfile>
- Defined in resources.ts:144

delete

delete(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in resources.ts:174

duplicate

duplicate(pxeProfileId: number): Promise<PXEProfile>
Parameters
- pxeProfileId: number
Returns Promise<PXEProfile>
- Defined in resources.ts:183

get

get(id: number): Promise<PXEProfile>
Parameters
- id: number
Returns Promise<PXEProfile>
- Defined in resources.ts:129

getProfilesByTags

getProfilesByTags(tags: string[]): Promise<PXEProfile[]>
Parameters
- tags: string[]
Returns Promise<PXEProfile[]>
- Defined in resources.ts:225

getTags

getTags(): Promise<string[]>
Returns Promise<string[]>
- Defined in resources.ts:216

list

list(options?: ListOptions<PXEProfileFilters>): Promise<PXEProfile[]>
Parameters
- options: ListOptions<PXEProfileFilters> = {}
Returns Promise<PXEProfile[]>
- Defined in resources.ts:117

`Protected`request

request<T>(config: RequestConfig): Promise<ApiResponse<T>>
Make a request to the API with automatic error handling
Type Parameters
- T
Parameters
- config: RequestConfig
Returns Promise<ApiResponse<T>>
Inherited from BaseResource.request
- Defined in resources.ts:90

restore

restore(pxeProfileId: number): Promise<void>
Parameters
- pxeProfileId: number
Returns Promise<void>
- Defined in resources.ts:207

update

update(id: number, data: Partial<CreatePXEProfileRequest>): Promise<PXEProfile>
Parameters
- id: number
- data: Partial<CreatePXEProfileRequest>
Returns Promise<PXEProfile>
- Defined in resources.ts:158

`Protected`validateId

validateId(id: number, resourceName?: string): void
Validate that an ID is a positive integer
Parameters
- id: number
- resourceName: string = 'Resource'
Returns void
Inherited from BaseResource.validateId
- Defined in resources.ts:97

`Protected`validateRequiredString

validateRequiredString(value: string, fieldName: string): void
Validate required string field
Parameters
- value: string
- fieldName: string
Returns void
Inherited from BaseResource.validateRequiredString
- Defined in resources.ts:106

Class PXEProfilesResource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PXEProfilesResource

Properties

Protected Readonlyclient

Methods

clearCache

Parameters

Returns Promise<void>

create

Parameters

OptionaladditionalDriversUrl?: string

Description

Example

Optionalallow_for_dedicated?: boolean

Example

Optionalallow_for_vps?: boolean

Example

Optionalallow_set_hostname?: boolean

Example

Optionalallow_ssh_keys?: boolean

Example

OptionalautoInstallTemplate?: string

Description

Example

cacheDirectory: string

Description

Example

Optionalconfigure_all_ipvfour_ask_user?: boolean

Example

Optionalconfigure_all_ipvfour_enforce?: boolean

Example

Optionalconfigure_all_ipvsix_ask_user?: boolean

Example

Optionalconfigure_all_ipvsix_enforce?: boolean

Example

Optionalconfigure_ipvfour_even_if_outside_of_gateway?: boolean

Example

OptionalcustomFirstBoot?: string

Description

Example

OptionalcustomPostScript?: string

Description

Example

Optionaldefault_disklayout_template?: number

Example

Optionaldefault_run_scripts?: string[]

Example

Optionaldefault_run_scripts_hide_others?: boolean

Example

OptionaldefaultDiskLayout?: string

Description

Example

Optionaldont_offer_if_has_tag?: string[]

Example

Optionaldont_offer_if_user_has_role?: string[]

Example

Optionalenforced_default_disklayout_template?: boolean

Example

Optionalenforced_default_run_scripts?: boolean

Example

Optionalfallback_to_default_disklayout_if_unset?: boolean

Example

Optionalhttpdirectory?: string

Example

Optionalipxe_bios_file?: string

Example

Optionalipxe_efi_file?: string

Example

OptionalisDisabled?: boolean

Example

Optionalkeep_dhcp_minutes?: number

Description

`Protected` `Readonly`client

`Optional`additionalDriversUrl?: string

`Optional`allow_for_dedicated?: boolean

`Optional`allow_for_vps?: boolean

`Optional`allow_set_hostname?: boolean

`Optional`allow_ssh_keys?: boolean

`Optional`autoInstallTemplate?: string

`Optional`configure_all_ipvfour_ask_user?: boolean

`Optional`configure_all_ipvfour_enforce?: boolean

`Optional`configure_all_ipvsix_ask_user?: boolean

`Optional`configure_all_ipvsix_enforce?: boolean

`Optional`configure_ipvfour_even_if_outside_of_gateway?: boolean

`Optional`customFirstBoot?: string

`Optional`customPostScript?: string

`Optional`default_disklayout_template?: number

`Optional`default_run_scripts?: string[]

`Optional`default_run_scripts_hide_others?: boolean

`Optional`defaultDiskLayout?: string

`Optional`dont_offer_if_has_tag?: string[]

`Optional`dont_offer_if_user_has_role?: string[]

`Optional`enforced_default_disklayout_template?: boolean

`Optional`enforced_default_run_scripts?: boolean

`Optional`fallback_to_default_disklayout_if_unset?: boolean

`Optional`httpdirectory?: string

`Optional`ipxe_bios_file?: string

`Optional`ipxe_efi_file?: string

`Optional`isDisabled?: boolean

`Optional`keep_dhcp_minutes?: number

`Optional`language?: string

`Optional`licensekey?: string

`Optional`mark_installation_completed_event?: string

`Optional`mirrorUrl?: string

`Optional`networkConfigMode?: string

`Optional`offer_if_has_tag?: string[]

`Optional`offer_if_user_has_role?: string[]

`Optional`packages?: string

`Optional`pxe_enable_comboot?: boolean

`Optional`pxe_file_caching_policy?: string

`Optional`set_root_password?: boolean

`Optional`timezone?: string

`Optional`updateServerHardwareInventory?: boolean

`Optional`version?: string

`Optional`windows_activation_key?: string

`Optional`windows_bypass_system_requirements_check?: boolean

`Optional`windows_key_location_specialize?: boolean

`Optional`windows_key_location_userdata?: boolean

`Optional`windows_skip_oobe?: boolean

`Optional`windows_use_empty_activation_key?: boolean