.. meta::
    :description: This documentation will guide you through the use of the Memset API.

.. index::
   double: Methods; cluster.server

.. _cluster.server:

Cluster Server Methods
----------------------

API methods for cluster servers.

.. function:: cluster.server.disable

    Disable the given Cluster Server. When disabled, the cluster server is no longer a member of the cluster.
    
    :param cluster_name: 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.
    :type cluster_name: String
    
    :param server_name: Name of the cluster server.
    :type server_name: String
    
    :returns: If the server is enabled, a dictionary as described in :func:`job.status`.
    :raises: May raise :class:`ApiErrorDoesNotExist` if the cluster or Cluster Service does not exist.

.. function:: cluster.server.enable

    Enable the given Cluster Server. When enabled, the cluster server becomes a member of the cluster.
    
    :param cluster_name: 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.
    :type cluster_name: String
    
    :param server_name: Name of the cluster server.
    :type server_name: String
    
    :returns: If the server is disabled, a dictionary as described in :func:`job.status`.
    :raises: May raise :class:`ApiErrorDoesNotExist` if the cluster or Cluster Service does not exist.

.. function:: cluster.server.info

    Return information for the specified cluster server.
    
    :param server_name: Name of the cluster server.
    :type server_name: String
    
    :returns: a dictionary with the following keys:
    
        **enabled**:
            Boolean: Whether the cluster server is enabled or not. See :func:`cluster.server.disable` and :func:`cluster.server.enable`.
        **server_name**:
            String: The name of the server.
    :raises: May raise :class:`ApiErrorDoesNotExist` if the cluster_name does not exist (in the account)

.. function:: cluster.server.list

    Returns a list of information about the cluster server in the given cluster.
    
    :param cluster_name: 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.
    :type cluster_name: String
    
    :returns: a list of dictionaries where each is as described in :func:`cluster.server.info`
    :raises: May raise :class:`ApiErrorDoesNotExist` if the cluster_name does not exist (in the account)