You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.

You are here: Web API Reference Guide > Available API Methods > Server and Cluster Management Methods > The clusterReconfigureServer Method

The clusterReconfigureServer Method

Re-configure a cluster member to match the cluster's profile. This operation will fail on a Zend Server Cluster Manager with no valid license.

Required Permissions: full

HTTP method: POST

Supported by Editions:Zend Server Cluster Manager

Request Parameters:

Parameter	Type	Required	Description
serverId	String	Yes	The server ID.
doRestart	Boolean	No	Specify if the re-configured server should be restarted after the re-configure action. The default is FALSE.

Expected Response Code:

200 OK - The server was re-configured successfully.
202 Accepted - The server was re-configured successfully and is now in the process of being restarted.

Response Type: serverInfo with the status of the server which is being re-configured. The status is expected to be either:

OK - If the server was restarted successfully, or if a restart was not needed.
pendingRestart - If the server was re-configured but not restarted (and doRestart was FALSE).
restarting - If the server was re-configured and is in the process of restarting.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
404	noSuchServer	There is no server with the provided server ID.
500	cantConnectToServer	Zend Server Cluster Manager is unable to connect to the specified server.
500	invalidServerResponse	An invalid or unexpected response from the server.
503	temporarilyLocked	The server cannot be re-configured because it is currently in the middle of another operation (e.g. being disabled).
405	notImplementedByEdition	The method cannot executed by this edition of Zend Server.
500	serverNotLicensed	Zend Server Cluster Manager does not have a valid license.
500	restartFailed	Restarting the server failed.

Usage Example

Example:

Request (headers removed for clarity):

POST /ZendServerManager/Api/clusterReconfigureServer

serverID=5

Response:

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

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

  <responseData>
    <serverInfo>
      <id>5</id>
      <name>www-02</name>
      <address>https://www-02.local:10082/ZendServer</address>
      <status>pendingRestart</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.


	Related Links: Server and Cluster Management Methods