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

.. index::
   double: Methods; cluster

.. _cluster:

Cluster Methods
---------------

API Methods for clusters.

.. function:: cluster.info

    Return information for the specified 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 dictionary with the following keys:
    
        **name**
            String: Name of the cluster.
        **enabled**:
            Boolean: Whether the cluster is enabled or not.
        **private_class_c**:
            String: The network address (subnet mask 255.255.255.0) of the VLAN.
        **vlan_id**:
            Integer: The VLAN id the cluster is in.

.. function:: cluster.list

    Returns a list of clusters.
    
    :param enabled: Only return enabled/disabled clusters.
    :type enabled: Boolean, Optional
    
    :returns: a list of dictionaries where each is as described in :func:`cluster.info`