Description


This function lists the servers in the server's configuration cluster.


  • If you log in to a configuration cluster server that is not the master server, nothing will indicate that the server is part of a configuration cluster. You can only view and modify this information from the master server.


Examples 




https://hostname.example.com:2087/cpsess##########/json-api/list_configclusterservers&api.version=1




https://hostname.example.com:2087/cpsess##########/xml-api/list_configclusterservers?api.version=1




whmapi1 list_configclusterservers



{
  "data": {
    "example.com": {
      "signature": "d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0",
      "user": "root"
    },
    "example2.com": {
      "signature": "d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d1",
      "user": "root"
    }
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "list_configclusterservers"
  }
}




<result>
   <data>
     <example.com>
       <signature>d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0</signature>
       <user>root</user>
     </example.com>
     <example2.com>
       <signature>d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d1</signature>
       <user>root</user>
     </example2.com>
   </data>
   <metadata>
     <version>1</version>
     <reason>OK</reason>
     <result>1</result>
     <command>list_configclusterservers</command>
   </metadata>
</result>



   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
server name
hash

A hash of database data.

The server's hostname is the hash name.


This hash includes the signature and user returns. 

signature

string

A truncated version of the server's remote access key.

The function returns this value in the server name hash.

A valid string.


d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0:d0


user

string

The root-level username for the server.

The function returns this value in the server name hash.

A valid username.root