clusterAddServer

Add a new server to the cluster. On a Zend Server Cluster Manager with no valid license, this operation fails.

Required Permissions: full

HTTP method: POST

Supported by Editions: Zend Server Cluster Manager

Request Parameters:

Parameter

Type

Required

Description

serverName

String

Yes

The server name.

serverUrl

String

Yes

The server address as a full HTTP/HTTPS URL.

guiPassword

String

Yes

The server GUI password.

propagateSettings

Boolean

Propagate this server’s current settings to the rest of the cluster. The default value is "FALSE".

Expected Response Code:

200 OK - The operation was successful.

202 Accepted - The server was added successfully, but setting propagation failed. (This can only happen if propagateSettings was set to "TRUE".)

Response Type: serverInfo with information about the just-added server.

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

500

cantConnectToServer

Zend Server Cluster Manager is unable to connect to the specified server URL.

500

invalidServerResponse

An invalid or unexpected response from a new server.

400

wrongPassword

The provided GUI password is incorrect.

400

alreadyConnected

The server is already a member of a cluster (not necessarily the current cluster).

503

temporarilyLocked

The server cannot be added because a cluster member is in graceful startup/shutdown mode.

500

noActiveServers

The server cannot be added because all servers in the cluster are disabled or unreachable.

500

serverNotLicensed

Zend Server Cluster Manager is not licensed.

405

notImplementedByEdition

This method is only available on Zend Server Cluster Manager.

Example:

Request (headers removed for clarity):

POST /ZendServerManager/Api/clusterAddServer
serverName=www-05&serverURL=https://www-05.local:10081/ZendServer&
guiPassword=somepassword&doRestart=TRUE

Response:

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.0">

  <requestData>
    <apiKeyName>angel.eyes</apiKeyName>
    <method>clusterAddServer</method>
  </requestData>

  <responseData>
    <serverInfo>
      <id>25</id>
      <name>www-05</name>
      <address>https://www-05.local:10082/ZendServer</address>
      <status>OK</status>
      <messageList />
    </serverInfo>
  </responseData>
</zendServerAPIResponse>

Important Note:

For Zend Server or Zend Server Cluster Manager on Mac or Linux, this action is also available via the command line using CLI Tools. For more information see CLI Tools.