Class PXEScriptsResource

PXE Scripts management resource

Hierarchy

BaseResource
- PXEScriptsResource

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: TenantosClient

Methods

create

create(
    data: {
        allow_for_dedicated?: boolean;
        allow_for_vps?: boolean;
        dont_offer_if_has_tag?: string[];
        dont_offer_if_user_has_role?: string[];
        isDisabled?: boolean;
        name: string;
        offer_if_has_tag?: string[];
        offer_if_user_has_role?: string[];
        script: string;
        tags: string[];
    },
): Promise<PXEScript>
Parameters
- data: {
      allow_for_dedicated?: boolean;
      allow_for_vps?: boolean;
      dont_offer_if_has_tag?: string[];
      dont_offer_if_user_has_role?: string[];
      isDisabled?: boolean;
      name: string;
      offer_if_has_tag?: string[];
      offer_if_user_has_role?: string[];
      script: string;
      tags: string[];
  }
  - Optionalallow_for_dedicated?: boolean
    Example
    false
  - Optionalallow_for_vps?: boolean
    Example
    false
  - Optionaldont_offer_if_has_tag?: string[]
    Example
    [ "sit" ]
  - Optionaldont_offer_if_user_has_role?: string[]
    Example
    [ null ]
  - OptionalisDisabled?: boolean
    Example
    true
  - name: string
    Example
    quo
  - Optionaloffer_if_has_tag?: string[]
    Example
    [ "adipisci" ]
  - Optionaloffer_if_user_has_role?: string[]
    Example
    [ null ]
  - script: string
    Description
    Script will be executed on after the installation has been completed.
    
    Example
    touch /root/123
  - tags: string[]
    Description
    The script is linked to the operating systems via tags.
    
    Example
    [ "kickstart" ]
Returns Promise<PXEScript>
- Defined in resources.ts:279

delete

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

duplicate

duplicate(pxeScriptId: number): Promise<PXEScript>
Parameters
- pxeScriptId: number
Returns Promise<PXEScript>
- Defined in resources.ts:318

get

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

list

list(): Promise<PXEScript[]>
Returns Promise<PXEScript[]>
- Defined in resources.ts:255

`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

update

update(id: number, data: Partial<CreatePXEScriptRequest>): Promise<PXEScript>
Parameters
- id: number
- data: Partial<CreatePXEScriptRequest>
Returns Promise<PXEScript>
- Defined in resources.ts:293

`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 PXEScriptsResource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PXEScriptsResource

Properties

Protected Readonlyclient

Methods

create

Parameters

Optionalallow_for_dedicated?: boolean

Example

Optionalallow_for_vps?: boolean

Example

Optionaldont_offer_if_has_tag?: string[]

Example

Optionaldont_offer_if_user_has_role?: string[]

Example

OptionalisDisabled?: boolean

Example

name: string

Example

Optionaloffer_if_has_tag?: string[]

Example

Optionaloffer_if_user_has_role?: string[]

Example

script: string

Description

Example

tags: string[]

Description

Example

Returns Promise<PXEScript>

delete

Parameters

Returns Promise<void>

duplicate

Parameters

Returns Promise<PXEScript>

get

Parameters

Returns Promise<PXEScript>

list

Returns Promise<PXEScript[]>

Protectedrequest

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

update

Parameters

Returns Promise<PXEScript>

ProtectedvalidateId

Parameters

Returns void

ProtectedvalidateRequiredString

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`client

`Optional`allow_for_dedicated?: boolean

`Optional`allow_for_vps?: boolean

`Optional`dont_offer_if_has_tag?: string[]

`Optional`dont_offer_if_user_has_role?: string[]

`Optional`isDisabled?: boolean

`Optional`offer_if_has_tag?: string[]

`Optional`offer_if_user_has_role?: string[]

`Protected`request

`Protected`validateId

`Protected`validateRequiredString