getClusterNodes

This method is deprecated. Use the new getClusterStatus (see below) service instead.

The getClusterNodes method retrieves server details on all nodes (servers) in the cluster, regardless of which node (server) was contacted.

Request Parameters

None

Response Parameters (return element children)

result

A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.

clusterNodes

0 - getClusterNodes can return multiple nodes, this is the first in the example
- address - IP address of the node
- alias - an alpha-numeric identifier for the node
- hostname - the URL of the node's host server
- primary - Boolean, true if primary node, false otherwise
- primaryNode - IP address of the primary node associated with this node. If this node is primary, same as address ClusterNodes element
- secondary - Boolean, true if secondary node, false otherwise
- type - cluster.node.type.primary if primary, cluster.node.type.secondary if secondary
1 - getClusterNodes can return multiple nodes, this is the second in the example
- address - IP address of the node
- alias - an alpha-numeric identifier for the node
- hostname - the URL of the node's host server
- primary - Boolean, true if primary node, false otherwise
- primaryNode - IP address of the primary node associated with this node. If this node is primary, same as address ClusterNodes element
- secondary - Boolean, true if secondary node, false otherwise
- type - cluster.node.type.primary if primary, cluster.node.type.secondary if secondary
2 - getClusterNodes can return multiple nodes, this is the third in the example
- address - IP address of the node
- alias - an alpha-numeric identifier for the node
- hostname - the URL of the node's host server
- primary - Boolean, true if primary node, false otherwise
- primaryNode - IP address of the primary node associated with this node. If this node is primary, same as address ClusterNodes element
- secondary - Boolean, true if secondary node, false otherwise
- type - cluster.node.type.primary if primary, cluster.node.type.secondary if secondary

Example Request and Response

Request Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<SOAP-ENV:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn:getClusterNodes</wsa:Action>
		<wsa:MessageID>uuid:e4208583-4135-416d-ad49-1a8c8f2fc593</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://server/servlet/WSACallBackHandler</wsa:Address>
			<wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType>
		</wsa:ReplyTo>
		<wsa:To>https://server/platform-services/services/ClusterNodesService.ClusterNodesServiceHttpSoap11Endpoint/</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<getClusterNodes xmlns="server_url"/>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://server/servlet/WSACallBackHandler</wsa:To>
		<wsa:MessageID>urn:uuid:9796D0EE77E740553B1299274308237</wsa:MessageID>
		<wsa:Action>urn:getClusterNodesResponse</wsa:Action>
		<wsa:RelatesTo>uuid:57e67be6-412d-42e6-ad4e-01f24b35ed54</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getClusterNodesResponse xmlns:ns="http://server_url">
			<ns:return xmlns:ax214="http://server_url/xsd" xmlns:ax213="http://server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax213:ClusterNodesResponse">
				<ax213:result>internal.request.complete</ax213:result>
				<ax213:clusterNodes xsi:type="ax213:ClusterNode">
					<ax213:address>server_address</ax213:address>
					<ax213:alias>bldr-vcm238</ax213:alias>
					<ax213:hostname>server_address</ax213:hostname>
					<ax213:primary>true</ax213:primary>
					<ax213:primaryNode>server_address</ax213:primaryNode>
					<ax213:secondary>false</ax213:secondary>
					<ax213:type>cluster.node.type.primary</ax213:type>
				</ax213:clusterNodes>
				<ax213:clusterNodes xsi:type="ax213:ClusterNode">
					<ax213:address>server_address</ax213:address>
					<ax213:alias>bldr-vcm239</ax213:alias>
					<ax213:hostname>server.address</ax213:hostname>
					<ax213:primary>false</ax213:primary>
					<ax213:primaryNode>server_address</ax213:primaryNode>
					<ax213:secondary>true</ax213:secondary>
					<ax213:type>cluster.node.type.secondary</ax213:type>
				</ax213:clusterNodes>
				<ax213:clusterNodes xsi:type="ax213:ClusterNode">
					<ax213:address>server_address</ax213:address>
					<ax213:alias/>
					<ax213:hostname>bldr-vcm253</ax213:hostname>
					<ax213:primary>false</ax213:primary>
					<ax213:primaryNode>server_address</ax213:primaryNode>
					<ax213:secondary>true</ax213:secondary>
					<ax213:type>cluster.node.type.secondary</ax213:type>
				</ax213:clusterNodes>
			</ns:return>
		</ns:getClusterNodesResponse>
	</soapenv:Body>
</soapenv:Envelope>

getClusterStatus

This method returns all cluster node information including each node's cluster authentication status.

Request Parameters

None

Response Parameters (return element children)

result

A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.

clusterNodeStatus

address - IP address of the node
alias - an alpha-numeric identifier for the node
hostname - the URL of the node's host server
primaryNode - IP address of the primary node associated with this node, if node is primary, same as address ClusterNodes element
type - cluster.node.type.primary if primary node and cluster.node.type.secondary if secondary node
dbRole - cluster.node.type.primary if primary node and cluster.node.type.secondary if secondary node
role - The number of the role
status - cluster.node.status.online if online

Example Request and Response

Request Response

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
        <wsa:Action>urn: getClusterStatus</wsa:Action>
        <wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
        <wsa:ReplyTo>
            <wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
        </wsa:ReplyTo>
        <wsa:To></wsa:To>
    </soapenv:Header>
    <soapenv:Body>
        <getClusterStatus xmlns="http://services.api.platform.vos.cisco.com"/>
    </soapenv:Body>
</soapenv:Envelope>

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:98240059-2dc0-4024-aa91-0b93a3ede219</wsa:MessageID>
		<wsa:Action>urn:getClusterStatusResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getClusterStatusResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax217="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax218="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax217:ClusterNodeStatusResponse">
				<ax217:result>internal.request.complete</ax217:result>
				<ax217:clusterNodeStatus xsi:type="ax217:ClusterNodeStatus">
					<ax217:address>10.106.3.82</ax217:address>
					<ax217:alias></ax217:alias>
					<ax217:hostname>rwerer</ax217:hostname>
					<ax217:primaryNode>10.106.3.82</ax217:primaryNode>
					<ax217:type>cluster.node.type.primary</ax217:type>
					<ax217:dbRole>cluster.node.type.primary</ax217:dbRole>
					<ax217:role>1</ax217:role>
					<ax217:status>cluster.node.status.online</ax217:status>
				</ax217:clusterNodeStatus>
			</ns:return>
		</ns:getClusterStatusResponse>
	</soapenv:Body>
</soapenv:Envelope>

getMyClusterNode

The getMyClusterNode method retrieves information for the node (server) in the cluster that was contacted.

Request Parameters

None

Response Parameters (return element children)

result

A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.

clusterNodes

address - IP address of the node
alias - an alpha-numeric identifier for the node
hostname - the URL of the node's host server
primary - Boolean, true if primary node, false otherwise
primaryNode - IP address of the primary node associated with this node. If this node is primary, same as address ClusterNodes element
secondary - Boolean, true if secondary node, false otherwise
type - cluster.node.type.primary if primary, cluster.node.type.secondary if secondary

Example Request and Response

Request Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <SOAP-ENV:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
        <wsa:Action>urn:getMyClusterNode</wsa:Action>
        <wsa:MessageID>uuid:cd3169b4-9595-4b60-bbfa-ae768423dbea</wsa:MessageID>
        <wsa:ReplyTo>
            <wsa:Address>http://server/servlet/WSACallBackHandler</wsa:Address>
            <wsa:PortType xmlns:ns1="http://example.org">ns1:LocalPart</wsa:PortType>
        </wsa:ReplyTo>
        <wsa:To>https://server/platform-services/services/ClusterNodesService.ClusterNodesServiceHttpSoap11Endpoint/</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <getMyClusterNode xmlns="http://server_url"/>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://server/servlet/WSACallBackHandler</wsa:To>
		<wsa:MessageID>urn:uuid:8109AEDEE509351D941299799673199</wsa:MessageID>
		<wsa:Action>urn:getMyClusterNodeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:feb14e8c-ca0a-448a-bf91-447effb66eb1</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getMyClusterNodeResponse xmlns:ns="http://server_url">
			<ns:return xmlns:ax214="http://server_url/xsd" xmlns:ax213="http://server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax213:ClusterNodesResponse">
				<ax213:result>internal.request.complete</ax213:result>
				<ax213:clusterNodes xsi:type="ax213:ClusterNode">
					<ax213:address>server</ax213:address>
					<ax213:alias>bldr-vcm238</ax213:alias>
					<ax213:hostname>server_address</ax213:hostname>
					<ax213:primary>true</ax213:primary>
					<ax213:primaryNode>server</ax213:primaryNode>
					<ax213:secondary>false</ax213:secondary>
					<ax213:type>cluster.node.type.primary</ax213:type>
				</ax213:clusterNodes>
			</ns:return>
		</ns:getMyClusterNodeResponse>
	</soapenv:Body>
</soapenv:Envelope>

isClusterReplicationOK

The method checks if the replication status of the cluster is OK.

Request Parameters

None

Response Parameters (return element children)

result

A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.

clusterReplicationStatusOK

Boolean - True if status is ok, false if not.

Example Request and Response

Request Response

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: isClusterReplicationOK</wsa:Action>
		<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:To></wsa:To>
	</soapenv:Header>
	<soapenv:Body>
		<isClusterReplicationOK xmlns="http://services.api.platform.vos.cisco.com"/>
	</soapenv:Body>
</soapenv:Envelope>

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:277fd3ae-533f-48ce-ad0a-c05d5d9b44a0</wsa:MessageID>
		<wsa:Action>urn:isClusterReplicationOKResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:isClusterReplicationOKResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax217="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax218="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax217:ClusterReplicationStatusResponse">
				<ax217:result>internal.request.complete</ax217:result>
				<ax217:clusterReplicationStatusOK>true</ax217:clusterReplicationStatusOK>
			</ns:return>
		</ns:isClusterReplicationOKResponse>
	</soapenv:Body>
</soapenv:Envelope>

IsNodeReplicationOK

The method checks if the replication status of the cluster node is OK.

Request Parameters

None

Response Parameters (return element children)

result

A result code such as internal.request.complete that describes the result. See Error Codes in the Developer's Guide for details.

nodeReplicationStatusOK

Boolean - True if status is ok, false if not.

Example Request and Response

Request Response

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: isNodeReplicationOK</wsa:Action>
		<wsa:MessageID>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:MessageID>
		<wsa:ReplyTo>
			<wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
		</wsa:ReplyTo>
		<wsa:To></wsa:To>
	</soapenv:Header>
	<soapenv:Body>
		<isNodeReplicationOK xmlns="http://services.api.platform.vos.cisco.com"/>
	</soapenv:Body>
</soapenv:Envelope>

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
		<wsa:MessageID>urn:uuid:51ac89c6-6725-40af-b54e-aa21dfdee8b9</wsa:MessageID>
		<wsa:Action>urn:isNodeReplicationOKResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:isNodeReplicationOKResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax217="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:ax218="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax217:NodeReplicationStatusResponse">
				<ax217:result>internal.request.complete</ax217:result>
				<ax217:nodeReplicationStatusOK>true</ax217:nodeReplicationStatusOK>
			</ns:return>
		</ns:isNodeReplicationOKResponse>
	</soapenv:Body>
</soapenv:Envelope>

Platform Administrative Web Services (PAWS) API Reference

getClusterNodes

getClusterStatus

getMyClusterNode

isClusterReplicationOK

IsNodeReplicationOK