Overview | Service | Command |
Get all servers defined in the system or all servers that have a particular service enabled (eg, mta, antispam, spell).
Authorization token required | true |
Admin Authorization token required | true |
<GetAllServersRequest [service="{service-name}"] [alwaysOnClusterId="{alwaysOnClusterId}"]
[applyConfig="{apply-config} (0|1)"] /> ## GetAllServersRequest
The following table describes elements and attributes you can define within a
<GetAllServersRequest>
element:
XPath | Required / Optional | Description |
@service | Optional (0 or 1) | Type:String Service name. e.g. mta, antispam, spell. |
@alwaysOnClusterId | Optional (0 or 1) | Type:String alwaysOnClusterId. |
@applyConfig | Optional (0 or 1) | Type:0|1 if {apply-config} is 1 (true), then certain unset attrs on a server will get their value from the global config. if {apply-config} is 0 (false), then only attributes directly set on the server will be returned |
<GetAllServersResponse> ## GetAllServersResponse
(<server name="{name}" id="{id}"> ## ServerInfo
(<a n="{key}" /> ## Attr)*
</server>)*
</GetAllServersResponse>
The following table describes elements and attributes you can define within a
<GetAllServersResponse>
element:
XPath | Required / Optional | Description |
/server | Optional (0 or more) | Information about servers |
/server@name | Required (only 1) | Type:String Name |
/server@id | Required (only 1) | Type:String ID |
/server/a | Optional (0 or more) | Attributes |
/server/a@n | Required (only 1) | Type:String Key |