Class PanelServer

Implements

ServerAttributes

Constructors

constructor

new PanelServer(applicationClient, serverProperties): PanelServer
Parameters
- applicationClient: ApplicationClient
- serverProperties: RawServer
Returns PanelServer
- Defined in src/ApplicationClient/PanelServer.ts:85

Properties

allocation

allocation: number

`Optional` `Readonly`allocations

allocations?: NodeAllocation[]

`Optional` `Readonly`associatedEgg

associatedEgg?: Egg

`Optional` `Readonly`associatedNest

associatedNest?: Nest

`Optional` `Readonly`associatedNode

associatedNode?: PanelNode

container

container: {
    environment: {
        [key: string]:
            | string
            | number
            | boolean
            | null;
    };
    image: string;
    installed: 0 | 1;
    startup_command: string;
}

`Readonly`created_at

created_at: Date

`Optional` `Readonly`databases

databases?: ServerDatabase[]

description

description: string

egg

egg: number

`Optional`eggData

eggData?: RawPanelEgg

`Optional`external_id

external_id?: null | string

feature_limits

feature_limits: {
    allocations: number;
    backups: number;
    databases: number;
}

`Readonly`id

id: number

identifier

identifier: string

limits

limits: {
    cpu: number;
    disk: number;
    io: number;
    memory: number;
    oom_disabled: boolean;
    swap: number;
    threads: null | string;
}

`Optional` `Readonly`location

location?: PanelLocation

name

name: string

nest

nest: number

node

node: number

suspended

suspended: boolean

updated_at

updated_at: Date

user

user: number

`Readonly`uuid

uuid: string

`Optional` `Readonly`variables

variables?: ServerVariable[]

Methods

addAllocation

addAllocation(allocation): Promise<void>
Add a allocation to this server
Parameters
- allocation: number | NodeAllocation
  The allocation id or the NodeAllocation object
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:333

addEnvironmentVariable

addEnvironmentVariable(key, value): Promise<void>
Add environment vars with which the server will start
Parameters
- key: string
- value: string
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:438

createDatabase

createDatabase(databaseCreateProperties): Promise<void>
Create a database for this server
Parameters
- databaseCreateProperties: DatabaseBuilder
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:512

delete

delete(force?): Promise<void>
Delete this server
Parameters
- force: boolean = false
  Should the server be force-deleted
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:486

getDatabase

getDatabase(databaseId): Promise<ServerDatabase>
Get a database for this server
Parameters
- databaseId: number
Returns Promise<ServerDatabase>
- Defined in src/ApplicationClient/PanelServer.ts:504

getDatabases

getDatabases(): Promise<ServerDatabase[]>
Get the databases for this server

Returns Promise<ServerDatabase[]>
- Defined in src/ApplicationClient/PanelServer.ts:495

reinstall

reinstall(): Promise<void>
Reinstall this server

Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:477

removeAllocation

removeAllocation(allocation): Promise<void>
Remove a allocation from this server
Parameters
- allocation: number | NodeAllocation
  The allocation id or the NodeAllocation object
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:344

setAllocationLimit

setAllocationLimit(limit): Promise<void>
Set the new allocation limit
Parameters
- limit: number
  How many allocations can be created for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:322

setBackupLimit

setBackupLimit(limit): Promise<void>
Set the new backup limit
Parameters
- limit: number
  How many backups can be created for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:311

setCpuLimit

setCpuLimit(limit): Promise<void>
Set the maximum cpu usage for this server
Set this to 0 for no cpu limit
If you have 4 cores and want to allow to use all of them you'll need to use 400
Example: 4 * 100 = 400 | Cores * 100 = Max for this node
Parameters
- limit: number
  The new cpu limit in %
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:217

setCpuPinning

setCpuPinning(pinning): Promise<void>
Set which cores can be used by a server
Example: 0; 1-3; 4,5,6;
Parameters
- pinning: string | (string | number)[]
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:229

setCustomDockerImage

setCustomDockerImage(image): Promise<void>
Set the custom docker image for this server
Parameters
- image: string
  The new image for this container
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:449

setDatabaseLimit

setDatabaseLimit(limit): Promise<void>
Set the new database limit
Parameters
- limit: number
  How many databases can be created for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:300

setDescription

setDescription(description): Promise<void>
Set the description for this server
Parameters
- description: string
  The new description for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:177

setDiskLimit

setDiskLimit(limit): Promise<void>
Set the new disk limit
Parameters
- limit: number
  The new disk limit in MiB
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:262

setDockerImage

setDockerImage(image): Promise<void>
Set the docker image for this server
Parameters
- image: string
  The new image for this container
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:416

setEnvironment

setEnvironment(environment): Promise<void>
Set the environment vars with which the server will start
Parameters
- environment: {
  [environment: string]: string;
  }
  Overwrites all current variables
  - [environment: string]: string
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:427

setExternalId

setExternalId(externalId): Promise<void>
Set the external id for this server
Parameters
- externalId: string
  The new external id for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:155

setIoLimit

setIoLimit(limit): Promise<void>
[ADVANCED]
Set the io limit for this server
Documentation: https://docs.docker.com/engine/reference/run/#block-io-bandwidth-blkio-constraint
Parameters
- limit: number
  The new io limit, number between 10 and 1000
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:275

setMemoryLimit

setMemoryLimit(limit): Promise<void>
Set the new memory limit
Parameters
- limit: number
  The new memory limit in MiB
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:240

setName

setName(name): Promise<void>
Set the name for this server
Parameters
- name: string
  The new name for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:144

setNestAndEgg

setNestAndEgg(nest, egg): Promise<void>
Set the new nest for this server
Parameters
- nest: number | Nest
  The new nest for this server
- egg: number | Egg
  The new egg for this server
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:393

setOomKillerState

setOomKillerState(active): Promise<void>
Enable the OOM killer
This will kill the server if it exceeds the memory limit
This may cause the server processes to exit unexpectedly
This CAN cause to data corruption
Parameters
- active: boolean
  Should the oom killer be active
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:289

setOwner

setOwner(owner): Promise<void>
Set the owner for this server
Parameters
- owner: number | PanelUser
  The ownerId or the User object
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:166

setSkipInstall

setSkipInstall(skip): Promise<void>
Skip install script
Parameters
- skip: boolean
  Whether the install script should be skipped
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:405

setStartupCommand

setStartupCommand(startup): Promise<void>
Set the startup command with which the server will start
This can include environment vars via {{ VAR_NAME }}
Parameters
- startup: string
Returns Promise<void>
Default
```
startup This will use the default startup command if you set the egg via .setEgg(egg: PanelEgg)
```
- Defined in src/ApplicationClient/PanelServer.ts:381

setSwapLimit

setSwapLimit(limit): Promise<void>
Set the new swap limit
Parameters
- limit: number
  The new swap limit in MiB
Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:251

suspend

suspend(): Promise<void>
Suspend this server

Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:459

unsuspend

unsuspend(): Promise<void>
Unsuspend this server

Returns Promise<void>
- Defined in src/ApplicationClient/PanelServer.ts:468

Class PanelServer

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PanelServer

Properties

allocation

Optional Readonlyallocations

Optional ReadonlyassociatedEgg

Optional ReadonlyassociatedNest

Optional ReadonlyassociatedNode

container

Readonlycreated_at

Optional Readonlydatabases

description

egg

OptionaleggData

Optionalexternal_id

feature_limits

Readonlyid

identifier

limits

Optional Readonlylocation

name

nest

node

Optional Readonlyowner

status

Optional Readonlysubusers

suspended

updated_at

user

Readonlyuuid

Optional Readonlyvariables

Methods

addAllocation

Parameters

Returns Promise<void>

addEnvironmentVariable

Parameters

Returns Promise<void>

createDatabase

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<void>

getDatabase

Parameters

Returns Promise<ServerDatabase>

getDatabases

Returns Promise<ServerDatabase[]>

reinstall

Returns Promise<void>

removeAllocation

Parameters

Returns Promise<void>

setAllocationLimit

Parameters

Returns Promise<void>

setBackupLimit

Parameters

Returns Promise<void>

setCpuLimit

Set the maximum cpu usage for this server Set this to 0 for no cpu limit

If you have 4 cores and want to allow to use all of them you'll need to use 400 Example: 4 * 100 = 400 | Cores * 100 = Max for this node

Parameters

Returns Promise<void>

setCpuPinning

Parameters

Returns Promise<void>

setCustomDockerImage

Parameters

Returns Promise<void>

setDatabaseLimit

`Optional` `Readonly`allocations

`Optional` `Readonly`associatedEgg

`Optional` `Readonly`associatedNest

`Optional` `Readonly`associatedNode

`Readonly`created_at

`Optional` `Readonly`databases

`Optional`eggData

`Optional`external_id

`Readonly`id

`Optional` `Readonly`location

`Optional` `Readonly`owner

`Optional` `Readonly`subusers

`Readonly`uuid

`Optional` `Readonly`variables

Set the maximum cpu usage for this server
Set this to 0 for no cpu limit

If you have 4 cores and want to allow to use all of them you'll need to use 400
Example: 4 * 100 = 400 | Cores * 100 = Max for this node