Class PXEDisklayoutsResource

PXE Disklayouts management resource

Hierarchy

BaseResource
- PXEDisklayoutsResource

Index

Constructors

constructor

new PXEDisklayoutsResource(client: TenantosClient): PXEDisklayoutsResource
Parameters
- client: TenantosClient
Returns PXEDisklayoutsResource
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;
        disklayout?: string;
        dont_offer_if_has_tag?: string[];
        dont_offer_if_user_has_role?: string[];
        hw_raid_handling?: string;
        isDisabled?: boolean;
        min_disks?: number;
        name: string;
        offer_if_has_tag?: string[];
        offer_if_user_has_role?: string[];
        tags: string[];
    },
): Promise<PXEDisklayout>
Parameters
- data: {
      allow_for_dedicated?: boolean;
      allow_for_vps?: boolean;
      disklayout?: string;
      dont_offer_if_has_tag?: string[];
      dont_offer_if_user_has_role?: string[];
      hw_raid_handling?: string;
      isDisabled?: boolean;
      min_disks?: number;
      name: string;
      offer_if_has_tag?: string[];
      offer_if_user_has_role?: string[];
      tags: string[];
  }
  - Optionalallow_for_dedicated?: boolean
    Example
    false
  - Optionalallow_for_vps?: boolean
    Example
    true
  - Optionaldisklayout?: string
    Description
    The kickstart or preseed configuration.
    
    Example
    autopart --type=lvm
  - Optionaldont_offer_if_has_tag?: string[]
    Example
    [ "odit" ]
  - Optionaldont_offer_if_user_has_role?: string[]
    Example
    [ null ]
  - Optionalhw_raid_handling?: string
    Description
    Must be one of always_offer, only_offer_if_hw_raid, or dont_offer_if_hw_raid.
    
    Example
    dont_offer_if_hw_raid
  - OptionalisDisabled?: boolean
    Example
    true
  - Optionalmin_disks?: number
    Description
    The profile will only be offered if the server has the specificated minimum amount of disks. Leave empty to always offer.
    
    Example
    3
  - name: string
    Example
    accusamus
  - Optionaloffer_if_has_tag?: string[]
    Example
    [ "rerum" ]
  - Optionaloffer_if_user_has_role?: string[]
    Example
    [ null ]
  - tags: string[]
    Description
    Must have at least 1 item. The disk layout is linked to the operating systems via tags.
    
    Example
    [ "kickstart" ]
Returns Promise<PXEDisklayout>
- Defined in resources.ts:362

delete

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

duplicate

duplicate(pxeDisklayoutId: number): Promise<PXEDisklayout>
Parameters
- pxeDisklayoutId: number
Returns Promise<PXEDisklayout>
- Defined in resources.ts:401

get

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

list

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

`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<CreatePXEDisklayoutRequest>,
): Promise<PXEDisklayout>
Parameters
- id: number
- data: Partial<CreatePXEDisklayoutRequest>
Returns Promise<PXEDisklayout>
- Defined in resources.ts:376

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PXEDisklayoutsResource

Properties

Protected Readonlyclient

Methods

create

Parameters

Optionalallow_for_dedicated?: boolean

Example

Optionalallow_for_vps?: boolean

Example

Optionaldisklayout?: string

Description

Example

Optionaldont_offer_if_has_tag?: string[]

Example

Optionaldont_offer_if_user_has_role?: string[]

Example

Optionalhw_raid_handling?: string

Description

Example

OptionalisDisabled?: boolean

Example

Optionalmin_disks?: number

Description

Example

name: string

Example

Optionaloffer_if_has_tag?: string[]

Example

Optionaloffer_if_user_has_role?: string[]

Example

tags: string[]

Description

Example

Returns Promise<PXEDisklayout>

delete

Parameters

Returns Promise<void>

duplicate

Parameters

Returns Promise<PXEDisklayout>

get

Parameters

Returns Promise<PXEDisklayout>

list

Returns Promise<PXEDisklayout[]>

Protectedrequest

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

update

Parameters

Returns Promise<PXEDisklayout>

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`disklayout?: string

`Optional`dont_offer_if_has_tag?: string[]

`Optional`dont_offer_if_user_has_role?: string[]

`Optional`hw_raid_handling?: string

`Optional`isDisabled?: boolean

`Optional`min_disks?: number

`Optional`offer_if_has_tag?: string[]

`Optional`offer_if_user_has_role?: string[]

`Protected`request

`Protected`validateId

`Protected`validateRequiredString