Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function removes a server from a configuration cluster.

Warning
titleImportant:
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.
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/delete_configclusterserver?api.version=1&name=example.com
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/delete_configclusterserver?api.version=1&name=example.com
Expand
titleCommand Line
Code Block
languagebash
whmapi1 delete_configclusterserver name=example.com

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
        "metadata":{
            "version":1,
            "name":"example.com",
            "reason":"OK",
            "result":1,
            "command":"delete_configclusterserver"
        }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
  <metadata>
    <version>1</version>
    <name>example.com</name>
    <reason>OK</reason>
    <result>1</result>
    <command>delete_configclusterserver</command>
  </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The remote configuration cluster server's name.

A valid hostname or IP address.example.com

Returns

Note
titleNote:

The function's return data appears in the metadata section of its output.

ReturnTypeDescriptionPossible valuesExample
name
string

The remote configuration cluster server's name.

A valid hostname or IP address.example.com