Config2_ServerManager

Server management interface for the Version 2 API.

Instances of this class are obtained from:

Methods

MethodReturnsDescription
add() Config2_Server

Add a server to cluster

.
get() Config2_Server

Get a server by name

.
remove() void

Remove a server from cluster

.
toArray() Array.<Config2_Server>

Get all servers as array

.

Method Details

add(localUserName, localPassword, remoteAddress, remotePort, remoteUserName, remotePassword) → {Config2_Server}

Description:
  • Add a server to cluster

Parameters:
Name Type Description
localUserName String

Local admin username

localPassword String

Local admin password

remoteAddress String

Remote server hostname or IP

remotePort Number

Remote server port

remoteUserName String

Remote admin username

remotePassword String

Remote admin password

Returns:

Created server object

Type
Config2_Server

get(serverName) → {Config2_Server|null}

Description:
  • Get a server by name

Parameters:
Name Type Description
serverName String

Server name

Returns:

Server object or null if not found

Type
Config2_Server | null

remove(serverName)

Description:
  • Remove a server from cluster

Parameters:
Name Type Description
serverName String

Server name to remove

toArray() → {Array.<Config2_Server>}

Description:
  • Get all servers as array

Returns:

Array of all server objects

Type
Array.<Config2_Server>