Class PanelServer

constructor

• new PanelServer(
      applicationClient: ApplicationClient,
      serverProperties: RawServer,
  ): PanelServer

  Parameters

  • applicationClient: ApplicationClient
  • serverProperties: RawServer

  Returns PanelServer

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

addAllocation

• addAllocation(allocation: number | NodeAllocation): Promise<void>

  Add a allocation to this server

  Parameters

  • allocation: number | NodeAllocation

    The allocation id or the NodeAllocation object

  Returns Promise<void>

addEnvironmentVariable

• addEnvironmentVariable(key: string, value: string): Promise<void>

  Add environment vars with which the server will start

  Parameters

  • key: string
  • value: string

  Returns Promise<void>

createDatabase

• createDatabase(databaseCreateProperties: DatabaseBuilder): Promise<void>

  Create a database for this server

  Parameters

  • databaseCreateProperties: DatabaseBuilder

  Returns Promise<void>

delete

• delete(force?: boolean): Promise<void>

  Delete this server

  Parameters

  • force: boolean = false

    Should the server be force-deleted

  Returns Promise<void>

getDatabase

• getDatabase(databaseId: number): Promise<ServerDatabase>

  Get a database for this server

  Parameters

  • databaseId: number

  Returns Promise<ServerDatabase>

getDatabases

• getDatabases(): Promise<ServerDatabase[]>

  Get the databases for this server

  Returns Promise<ServerDatabase[]>

reinstall

• reinstall(): Promise<void>

  Reinstall this server

  Returns Promise<void>

removeAllocation

• removeAllocation(allocation: number | NodeAllocation): Promise<void>

  Remove a allocation from this server

  Parameters

  • allocation: number | NodeAllocation

    The allocation id or the NodeAllocation object

  Returns Promise<void>

setAllocationLimit

• setAllocationLimit(limit: number): Promise<void>

  Set the new allocation limit

  Parameters

  • limit: number

    How many allocations can be created for this server

  Returns Promise<void>

setBackupLimit

• setBackupLimit(limit: number): Promise<void>

  Set the new backup limit

  Parameters

  • limit: number

    How many backups can be created for this server

  Returns Promise<void>

setCpuLimit

• setCpuLimit(limit: number): 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>

setCpuPinning

• setCpuPinning(pinning: string | (string | number)[]): 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>

setCustomDockerImage

• setCustomDockerImage(image: string): Promise<void>

  Set the custom docker image for this server

  Parameters

  • image: string

    The new image for this container

  Returns Promise<void>

setDatabaseLimit

• setDatabaseLimit(limit: number): Promise<void>

  Set the new database limit

  Parameters

  • limit: number

    How many databases can be created for this server

  Returns Promise<void>

setDescription

• setDescription(description: string): Promise<void>

  Set the description for this server

  Parameters

  • description: string

    The new description for this server

  Returns Promise<void>

setDiskLimit

• setDiskLimit(limit: number): Promise<void>

  Set the new disk limit

  Parameters

  • limit: number

    The new disk limit in MiB

  Returns Promise<void>

setDockerImage

• setDockerImage(image: string): Promise<void>

  Set the docker image for this server

  Parameters

  • image: string

    The new image for this container

  Returns Promise<void>

setEnvironment

• setEnvironment(environment: { [environment: string]: string }): Promise<void>

  Set the environment vars with which the server will start

  Parameters

  • environment: { [environment: string]: string }

    Overwrites all current variables

  Returns Promise<void>

setExternalId

• setExternalId(externalId: string): Promise<void>

  Set the external id for this server

  Parameters

  • externalId: string

    The new external id for this server

  Returns Promise<void>

setIoLimit

• setIoLimit(limit: number): 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>

setMemoryLimit

• setMemoryLimit(limit: number): Promise<void>

  Set the new memory limit

  Parameters

  • limit: number

    The new memory limit in MiB

  Returns Promise<void>

setName

• setName(name: string): Promise<void>

  Set the name for this server

  Parameters

  • name: string

    The new name for this server

  Returns Promise<void>

setNestAndEgg

• setNestAndEgg(nest: number | Nest, egg: number | 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>

setOomKillerState

• setOomKillerState(active: boolean): 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>

setOwner

• setOwner(owner: number | PanelUser): Promise<void>

  Set the owner for this server

  Parameters

  • owner: number | PanelUser

    The ownerId or the User object

  Returns Promise<void>

setSkipInstall

• setSkipInstall(skip: boolean): Promise<void>

  Skip install script

  Parameters

  • skip: boolean

    Whether the install script should be skipped

  Returns Promise<void>

setStartupCommand

• setStartupCommand(startup: string): 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)
  Copy

setSwapLimit

• setSwapLimit(limit: number): Promise<void>

  Set the new swap limit

  Parameters

  • limit: number

    The new swap limit in MiB

  Returns Promise<void>

suspend

• suspend(): Promise<void>

  Suspend this server

  Returns Promise<void>

unsuspend

• unsuspend(): Promise<void>

  Unsuspend this server

  Returns Promise<void>