checkNetworkChangeStatus

Use the checkNetworkChangeStatus method to determine when the NetworkService setXXX services have completed. Calling this service will set the returned NetworkResponse.networkChangeSuccessful flag appropriately.

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.

remoteMessages

If xsi:nil="true" then there are no remote messages. Otherwise:

error - Boolean, true if an error occurred, false otherwise
info - Boolean
messageKey - A result code such as internal.request.denied.lock if such an error occurred
messageType - The type of error, such as internal.message.error
warning - Boolean, true if this is a warning, false if not
messageParams - Information about the message (there can be more than one messageParam)

DHCPEnabled

Boolean, true if DHCP is enabled.

The default gateway.

The IP address for the host.

IPMask

The IP subnet mask.

networkChangeStatus

A change status, if available.

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: checkNetworkChangeStatus</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>
		<checkNetworkChangeStatus 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:9f02e36b-5e61-4fd1-8542-e27f36f4c3d9</wsa:MessageID>
		<wsa:Action>urn:checkNetworkChangeStatusResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:checkNetworkChangeStatusResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax285="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax286="http://api.platform.vos.cisco.com/xsd" xsi:type="ax285:NetworkResponse">
				<ax285:remoteMessages xsi:nil="true" />
				<ax285:result>internal.request.complete</ax285:result>
				<ax285:DHCPEnabled>false</ax285:DHCPEnabled>
				<ax285:GW></ax285:GW>
				<ax285:IP></ax285:IP>
				<ax285:IPMask></ax285:IPMask>
				<ax285:networkChangeStatus></ax285:networkChangeStatus>
			</ns:return>
		</ns:checkNetworkChangeStatusResponse>
	</soapenv:Body>
</soapenv:Envelope>

setHostname

This method sets the hostname to a different value.

- Use NetworkService checkNetworkChangeStatus to check the status of your change.
- It is highly recommended that you call NetworkDiagnosticService checkNetworkStatus and isClusterReplicationOK along with checking the node status returned by getClusterStatus. It should be set to cluster.node.status.online before attempting changes to the network settings.

This service will restart the server; an asynchronous response is not guaranteed.

Request Parameters

args0

string - The new hostname.

This example returns an error internal.request.denied.lock, with other details in remoteMessages.

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.

remoteMessages

If xsi:nil="true" then there are no remote messages. Otherwise:

error - Boolean, true if an error occurred, false otherwise
info - Boolean
messageKey - A result code such as internal.request.denied.lock if such an error occurred
messageType - The type of error, such as internal.message.error
warning - Boolean, true if this is a warning, false if not
messageParams - Information about the message (there can be more than one messageParam)

DHCPEnabled

Boolean, true if DHCP is enabled.

The default gateway.

The IP address for the host.

IPMask

The IP subnet mask.

networkChangeStatus

A change status, if available.

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" xmlns:ser="http://services.api.platform.vos.cisco.com">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: setIpAddress</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>
		<setIpAddress xmlns="http://services.api.platform.vos.cisco.com">
			<ser:args0>infyvoscm28-lnx.cisco.com.</ser:args0>
		</setIpAddress >
    </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:c611810e-49a3-4232-bc8a-7e92ca81dc37</wsa:MessageID>
		<wsa:Action>urn:setHostnameResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:setHostnameResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax285="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax286="http://api.platform.vos.cisco.com/xsd" xsi:type="ax285:NetworkResponse">
				<ax285:remoteMessages xsi:type="ax285:RemoteMessage">
					<ax286:error>true</ax286:error>
					<ax286:info>false</ax286:info>
					<ax286:messageKey>internal.request.denied.lock</ax286:messageKey>
					<ax286:messageType>internal.message.error</ax286:messageType>
					<ax286:warning>false</ax286:warning>
					<ax285:messageParams>platform.api.network.address</ax285:messageParams>
					<ax285:messageParams>27543@rwerer</ax285:messageParams>
					<ax285:messageParams>CreateUffDbImportExportThread-211</ax285:messageParams>
				</ax285:remoteMessages>
				<ax285:result>internal.request.failed</ax285:result>
				<ax285:DHCPEnabled>false</ax285:DHCPEnabled>
				<ax285:GW></ax285:GW>
				<ax285:IP></ax285:IP>
				<ax285:IPMask></ax285:IPMask>
				<ax285:networkChangeStatus></ax285:networkChangeStatus>
			</ns:return>
		</ns:setHostnameResponse>
	</soapenv:Body>
</soapenv:Envelope>

setIpAddress

This method sets the IP address to a different value.

- Use NetworkService checkNetworkChangeStatus to check the status of your change.
- It is highly recommended that you call NetworkDiagnosticService checkNetworkStatus and isClusterReplicationOK along with checking the node status returned by getClusterStatus. It should be set to cluster.node.status.online before attempting changes to the network settings.

This service will restart the server; an asynchronous response is not guaranteed.

Request Parameters

args0

string - The new IP address.

This example returns an error internal.request.denied.lock, with other details in remoteMessages.

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.

remoteMessages

If xsi:nil="true" then there are no remote messages. Otherwise:

error - Boolean, true if an error occurred, false otherwise
info - Boolean
messageKey - A result code such as internal.request.denied.lock if such an error occurred
messageType - The type of error, such as internal.message.error
warning - Boolean, true if this is a warning, false if not
messageParams - Information about the message (there can be more than one messageParam)

DHCPEnabled

Boolean, true if DHCP is enabled.

The default gateway.

The IP address for the host.

IPMask

The IP subnet mask.

networkChangeStatus

A change status, if available.

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" xmlns:ser="http://services.api.platform.vos.cisco.com">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: setIpAddress</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>
		<setIpAddress xmlns="http://services.api.platform.vos.cisco.com">
			<ser:args0>10.106.3.82</ser:args0>
		</setIpAddress>
	</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:48fab7bd-dcd0-4e57-85ab-f108526d4d53</wsa:MessageID>
		<wsa:Action>urn:setIpAddressResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:setIpAddressResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax285="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax286="http://api.platform.vos.cisco.com/xsd" xsi:type="ax285:NetworkResponse">
				<ax285:remoteMessages xsi:type="ax285:RemoteMessage">
					<ax286:error>true</ax286:error>
					<ax286:info>false</ax286:info>
					<ax286:messageKey>internal.request.denied.lock</ax286:messageKey>
					<ax286:messageType>internal.message.error</ax286:messageType>
					<ax286:warning>false</ax286:warning>
					<ax285:messageParams>platform.api.network.address</ax285:messageParams>
					<ax285:messageParams>27543@rwerer</ax285:messageParams>
					<ax285:messageParams>CreateUffDbImportExportThread-211</ax285:messageParams>
				</ax285:remoteMessages>
				<ax285:result>internal.request.failed</ax285:result>
				<ax285:DHCPEnabled>false</ax285:DHCPEnabled>
				<ax285:GW></ax285:GW>
				<ax285:IP></ax285:IP>
				<ax285:IPMask></ax285:IPMask>
				<ax285:networkChangeStatus></ax285:networkChangeStatus>
			</ns:return>
		</ns:setIpAddressResponse>
	</soapenv:Body>
</soapenv:Envelope>

setNetworkInfo

This method sets the hostname, IP address, IP address mask, and default gateway to different values.

- Use NetworkService checkNetworkChangeStatus to check the status of your change.
- It is highly recommended that you call NetworkDiagnosticService checkNetworkStatus and isClusterReplicationOK along with checking the node status returned by getClusterStatus. It should be set to cluster.node.status.online before attempting changes to the network settings.

This service will restart the server; an asynchronous response is not guaranteed.

Request Parameters

args0

string - The new hostname.

args1

string - The new IP address.

args2

string - The IP subnet address mask.

args3

string - The default gateway.

This example returns an error internal.request.failed, with other details, such as error.validation.invald in remoteMessages.

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.

remoteMessages

If xsi:nil="true" then there are no remote messages. Otherwise:

error - Boolean, true if an error occurred, false otherwise
info - Boolean
messageKey - A result code such as internal.request.denied.lock if such an error occurred
messageType - The type of error, such as internal.message.error
warning - Boolean, true if this is a warning, false if not
messageParams - Information about the message (there can be more than one messageParam)

DHCPEnabled

Boolean, true if DHCP is enabled.

The default gateway.

The IP address for the host.

IPMask

The IP subnet mask.

networkChangeStatus

A change status, if available.

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" xmlns:ser="http://services.api.platform.vos.cisco.com">
	<soapenv:Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
		<wsa:Action>urn: setNetworkInfo</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>
		<setNetworkInfo xmlns="http://services.api.platform.vos.cisco.com">
			<ser:args0>10.106.3.82</ser:args0>
			<ser:args1>infyvoscm28-lnx.cisco.com.</ser:args1>
		</setNetworkInfo ></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:e03d6a9e-00af-46d0-822b-23e131413770</wsa:MessageID>
		<wsa:Action>urn:setNetworkInfoResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:setNetworkInfoResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax285="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax286="http://api.platform.vos.cisco.com/xsd" xsi:type="ax285:NetworkResponse">
				<ax285:remoteMessages xsi:type="ax285:RemoteMessage">
					<ax286:error>true</ax286:error>
					<ax286:info>false</ax286:info>
					<ax286:messageKey>error.validation.invalid</ax286:messageKey>
					<ax286:messageType>internal.message.error</ax286:messageType>
					<ax286:warning>false</ax286:warning>
					<ax285:messageParams>node.host</ax285:messageParams>
				</ax285:remoteMessages>
				<ax285:result>internal.request.failed</ax285:result>
				<ax285:DHCPEnabled>false</ax285:DHCPEnabled>
				<ax285:GW></ax285:GW>
				<ax285:IP></ax285:IP>
				<ax285:IPMask></ax285:IPMask>
				<ax285:networkChangeStatus></ax285:networkChangeStatus>
			</ns:return>
		</ns:setNetworkInfoResponse>
	</soapenv:Body>
</soapenv:Envelope>

getNetworkInfo

The 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.

remoteMessages

If xsi:nil="true" then there are no remote messages. Otherwise:

error - Boolean, true if an error occurred, false otherwise
info - Boolean
messageKey - A result code such as internal.request.denied.lock if such an error occurred
messageType - The type of error, such as internal.message.error
warning - Boolean, true if this is a warning, false if not
messageParams - Information about the message (there can be more than one messageParam)

DHCPEnabled

Boolean, true if DHCP is enabled.

The default gateway.

The IP address for the host.

IPMask

The IP subnet mask.

networkChangeStatus

A change status, if available.

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: getNetworkInfo</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>
		<getNetworkInfo 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:f0953a43-2376-4038-9526-d31c602432d8</wsa:MessageID>
		<wsa:Action>urn:getNetworkInfoResponse</wsa:Action>
		<wsa:RelatesTo>uuid:63e5d8ca-dcac-40af-916b-d32ec3382d0f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:getNetworkInfoResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax285="http://element.services.api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax286="http://api.platform.vos.cisco.com/xsd" xsi:type="ax285:NetworkResponse">
				<ax285:result>internal.request.complete</ax285:result>
				<ax285:DHCPEnabled>false</ax285:DHCPEnabled>
				<ax285:GW>10.106.3.1</ax285:GW>
				<ax285:IP>10.106.3.82</ax285:IP>
				<ax285:IPMask>255.255.255.000</ax285:IPMask>
				<ax285:networkChangeStatus></ax285:networkChangeStatus>
			</ns:return>
		</ns:getNetworkInfoResponse>
	</soapenv:Body>
</soapenv:Envelope>

Platform Administrative Web Services (PAWS) API Reference

checkNetworkChangeStatus

setHostname

setIpAddress

setNetworkInfo

getNetworkInfo