Class Allocation

Implements

AllocationAttributes

Index

Constructors

Properties

id ip ip_alias? is_default notes? parentServer port

Methods

setNotes setPrimary unassign

Constructors

constructor

new Allocation(userClient, allocationProps, parentServer): Allocation
Parameters
- userClient: UserClient
- allocationProps: RawAllocation
- parentServer: Server
Returns Allocation
- Defined in src/UserClient/Allocation.ts:15

Properties

`Readonly`id

id: number

`Readonly`ip

ip: string

`Optional` `Readonly`ip_alias

ip_alias?: string

is_default

is_default: boolean

`Optional`notes

notes?: null | string

`Readonly`parentServer

parentServer: Server

`Readonly`port

port: number

Methods

setNotes

setNotes(notes): Promise<void>
Set the notes of this allocation
Parameters
- notes: string
Returns Promise<void>
- Defined in src/UserClient/Allocation.ts:29

setPrimary

setPrimary(): Promise<void>
Set the notes of this allocation

Returns Promise<void>
- Defined in src/UserClient/Allocation.ts:39

unassign

unassign(): Promise<void>
Remove this allocation from this Server
To be able to unassign this allocation this CAN NOT be the primary allocation!

Returns Promise<void>
- Defined in src/UserClient/Allocation.ts:49