Class VirtualServerManager

constructor

• new VirtualServerManager(query: Query): VirtualServerManager

  Parameters

  • query: Query

  Returns VirtualServerManager

currentId

current

• get current(): VirtualServer | null

  Returns VirtualServer | null

create

• create(
      options: VirtualServerCreateOptions,
  ): Promise<{ token: string; virtualServer: VirtualServer }>

  Creates a virtual server.

  Parameters

  • options: VirtualServerCreateOptions

    The options for creating the virtual server.

  Returns Promise<{ token: string; virtualServer: VirtualServer }>

  The created virtual server and its token.

delete

• delete(virtualServer: VirtualServerResolvable): Promise<void>

  Delete a virtual server. Note: Only stopped virtual servers can be deleted.

  Parameters

  • virtualServer: VirtualServerResolvable

    The virtual server to delete.

  Returns Promise<void>

  A promise that resolves when the virtual server has been deleted.

edit

• edit(options: VirtualServerEditOptions): Promise<VirtualServer>

  Edits the currently used virtual server.

  Parameters

  • options: VirtualServerEditOptions

    The options for editing the virtual server.

  Returns Promise<VirtualServer>

  The updated virtual server.

fetch

• fetch(): Promise<Collection<number, VirtualServer>>

  Fetches all virtual servers.

  Returns Promise<Collection<number, VirtualServer>>

fetchCurrent

• fetchCurrent(): Promise<VirtualServer>

  Fetches the currently used virtual server.

  Returns Promise<VirtualServer>

fetchServerIdByPort

• fetchServerIdByPort(port: number): Promise<number>

  Fetches a virtual server id by its port.

  Parameters

  • port: number

    The virtual server port.

  Returns Promise<number>

  The virtual server ID.

resolveId

• resolveId(virtualServer: VirtualServerResolvable): number

  Resolves a virtual server ID.

  Parameters

  • virtualServer: VirtualServerResolvable

    The object to resolve.

  Returns number

  The virtual server ID.

start

• start(virtualServer: VirtualServerResolvable): Promise<void>

  Start a virtual server.

  Parameters

  • virtualServer: VirtualServerResolvable

    The virtual server to start.

  Returns Promise<void>

  A promise that resolves when the virtual server has started.

stop

• stop(virtualServer: VirtualServerResolvable, reason?: string): Promise<void>

  Stop a virtual server.

  Parameters

  • virtualServer: VirtualServerResolvable

    The virtual server to stop.

  • Optionalreason: string

    The reason for stopping the virtual server. (optional)

  Returns Promise<void>

  A promise that resolves when the virtual server has stopped.

use

• use(virtualServer: VirtualServerResolvable): Promise<void>

  Use a virtual server.

  Parameters

  • virtualServer: VirtualServerResolvable

    The virtual server to use.

  Returns Promise<void>

• use(options: VirtualServerUseOptions): Promise<void>

  Use a virtual server.

  Parameters

  • options: VirtualServerUseOptions

    The options for using the virtual server. Either id or port must be provided.

  Returns Promise<void>