The clusterRemoveServer Method

This method removes a server from the cluster. The removal
process may be asynchronous if Session Clustering is used. If this
is the case, the initial operation will return an HTTP 202 response.
As long as the server is not fully removed, further calls to remove
the same server should be idempotent. On a Zend Server Cluster Manager
with no valid license, this operation fails.
license New BSD License
link for the canonical source repository
author Ingo Walz
category Zend
package Zend_Service
subpackage ZendServerAPI

 Methods

Base constructor for the method implementations

__construct() 
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::__construct()

Returns the parameter array for index $index

buildParameterArray(string $index, array $values) : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::buildParameterArray()

Parameters

$index

string

$values

array

Returns

string

Configures all needed information for the method implementation

configure() : void

Returns the default accept header

getAcceptHeader() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getAcceptHeader()

Returns

string

Content for POST request

getContent() : string

Returns

string

Returns the default content type

getContentType() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getContentType()

Returns

string

Get the values for preparing the post

getContentValues() : array
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getContentValues()

Returns

array

Getter for the path to server method

getFunctionPath() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getFunctionPath()

Returns

string

Get method for the api call

getMethod() : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getMethod()

Returns

string

Get class for result mapping

getParser() : \ZendService\ZendServerAPI\Adapter\Adapter
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getParser()

Returns

Returns the default post files

getPostFiles() : array
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::getPostFiles()

Returns

array

Get result from parser

parseResponse(string $xml) : \ZendService\ZendServerAPI\Method\DataTypes\DataType
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::parseResponse()

Parameters

$xml

string

Returns

\ZendService\ZendServerAPI\Method\DataTypes\DataType

Set arguments for ClusterRemoveServer

setArgs(int $server, bool $force) 

Parameters

$server

int

ServerId to remove

$force

bool

Force remove

Setter for the function path

setFunctionPath(string $functionPath) : void
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setFunctionPath()

Parameters

$functionPath

string

e.g. /ZendServerManager/Api/Foo

Set method for the api call

setMethod(string $method) 
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setMethod()

Parameters

$method

string

GET|POST

Set the implementation for the result mapping

setParser(\ZendService\ZendServerAPI\Adapter\Adapter $parser) : void
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setParser()

Parameters

$parser

\ZendService\ZendServerAPI\Adapter\Adapter

for result mapping

Set the Zend HTTP Response

setResponse(\Zend\Http\Response $response) : void
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::setResponse()

Parameters

$response

\Zend\Http\Response

 Properties

 

$functionPath : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::$$functionPath
 

$method : string
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::$$method
 

$parser : \ZendService\ZendServerAPI\Adapter\Adapter
Inherited
inherited_from \ZendService\ZendServerAPI\Method\Method::$$parser
 

$force : bool
 

$server : int