Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
GetAlwaysOnCluster SOAP Command

Get Server

Authorization token required true
Admin Authorization token required true

GetAlwaysOnClusterRequest

    <GetAlwaysOnClusterRequest [attrs="{request-attrs}"]> ## GetAlwaysOnClusterRequest
        <alwaysOnCluster [by="{alwaysOnCluster-key} (id|name)"]>{key}</alwaysOnCluster> ## AlwaysOnClusterSelector
    </GetAlwaysOnClusterRequest>

The following table describes elements and attributes you can define within a <GetAlwaysOnClusterRequest> element:

XPath Required / Optional Description
@attrs Optional (0 or 1) Type:String
Comma separated list of attributes
/alwaysOnCluster Optional (0 or 1) Type:{key}
Server
Description for element text content:Key for choosing alwaysOnCluster
{server-by}="id" Use cluster's zimbraId as the Key
{server-by}="name" Use name of the cluster as the Key
/alwaysOnCluster@by Optional (0 or 1) Type:id|name
Selects the meaning of {alwaysOnCluster-key}

GetAlwaysOnClusterResponse

    <GetAlwaysOnClusterResponse> ## GetAlwaysOnClusterResponse
        <alwaysOnCluster name="{name}" id="{id}"> ## AlwaysOnClusterInfo
            (<a n="{key}" /> ## Attr)*
         </alwaysOnCluster>
    </GetAlwaysOnClusterResponse>

The following table describes elements and attributes you can define within a <GetAlwaysOnClusterResponse> element:

XPath Required / Optional Description
/alwaysOnCluster Optional (0 or 1) Information about server
/alwaysOnCluster@name Required (only 1) Type:String
Name
/alwaysOnCluster@id Required (only 1) Type:String
ID
/alwaysOnCluster/a Optional (0 or more) Attributes
/alwaysOnCluster/a@n Required (only 1) Type:String
Key