Cluster Server Methods¶

API methods for cluster servers.

cluster.server.disable()¶

Disable the given Cluster Server. When disabled, the cluster server is no longer a member of the cluster.

Parameters:	cluster_name (String) – Name of the cluster. Cluster names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters. server_name (String) – Name of the cluster server.
Returns:	If the server is enabled, a dictionary as described in `job.status()`.
Raises :	May raise `ApiErrorDoesNotExist` if the cluster or Cluster Service does not exist.

cluster.server.enable()¶

Enable the given Cluster Server. When enabled, the cluster server becomes a member of the cluster.

Parameters:	cluster_name (String) – Name of the cluster. Cluster names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters. server_name (String) – Name of the cluster server.
Returns:	If the server is disabled, a dictionary as described in `job.status()`.
Raises :	May raise `ApiErrorDoesNotExist` if the cluster or Cluster Service does not exist.

cluster.server.info()¶

Return information for the specified cluster server.

Parameters:	server_name (String) – Name of the cluster server.
Returns:	a dictionary with the following keys: enabled: Boolean: Whether the cluster server is enabled or not. See `cluster.server.disable()` and `cluster.server.enable()`. server_name: String: The name of the server.
Raises :	May raise `ApiErrorDoesNotExist` if the cluster_name does not exist (in the account)

cluster.server.list()¶

Returns a list of information about the cluster server in the given cluster.

Parameters:	cluster_name (String) – Name of the cluster. Cluster names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
Returns:	a list of dictionaries where each is as described in `cluster.server.info()`
Raises :	May raise `ApiErrorDoesNotExist` if the cluster_name does not exist (in the account)