Naming a Cluster

      A cluster can be named, by means of the REST API.

      HTTP Method and URI

      POST /pools/default


      Establishes a name for the cluster. Either the Full Admin or the Cluster Admin role is required.

      Once defined, the cluster name provides a convenient, verbal reference, which will never be used in programmatic or networked access. The name can be of any length, can make use of any symbols (for example: %, $, !, #), and can include spaces. The name can be changed at any time during the life of the cluster, irrespective of the cluster’s configuration.

      Curl Syntax

      curl -X POST http://<ip-address-or-domain-name>:8091/pools/default \
        -d clusterName=<cluster-name>
        -u <username>:<password>

      The cluster-name argument is a string that is to be the name of the cluster.

      Note that during the process of provisioning a single-node cluster, username and password are required after the administrator has established credentials, as described in Establishing Credentials.


      Success returns 200 OK. If a username and password have already been assigned, failure to authenticate returns 401 Unauthorized. If the URI is incorrectly expressee, 404 Object Not Found is returned. If the flag is incorrectly expressed, 400 Bad Request is returned, with an error message such as: {"errors":{"cl3usterName":"Unsupported key"}}.


      The following example establishes a name for the cluster.

      curl -X POST \
      -d clusterName=MyNewCluster -u Administrator:password

      See Also

      The sequence of tasks divided into initialization and provisioning is explained in Cluster Initialization and Provisioning.

      For each of the other specific steps required in the provisioning process, see Configuring Memory, Naming a Node, Assigning Services, and Establishing Credentials.

      For general information on naming, see Naming Clusters and Nodes.

      For further information on initialization and provisioning — using the UI, the CLI, and the REST API — see Manage Nodes and Clusters.