prepareRemoteUpgrade

The prepareRemoteUpgrade method downloads and prepares an upgrade or Cisco Option Package (COP) file for installation. This call should always be made asynchronously.

Request Parameters

args0

name - The name of the upgrade file
path - The path/directory containing the upgrade file
password - The S/FTP file server password
server - The S/FTP file server hostname or IP address
upgradeLocation - One of two values:
upgradefile.location.remote.sftp - indicating the upgrade is located on an SFTP server
upgradefile.location.remote.ftp - indicating the upgrade is located on a FTP server.
upgradeType - Currently always "patch". More types may be supported in the future.
user - The S/FTP file server user

args1

A unique session ID provided by the client. When the prepare service starts, this session ID is associated with the upgrade. Subsequent calls to the start upgrade service should provide the same session ID otherwise a error.upgrade.anotheruser is generated. This allows the services to differentiate between multiple clients and prevent accidental overrides/interruptions. pm238 - sample sessionID

args2

Boolean - true or false

Set this parameter to false initially. If the value is true, allows the session ID to be overridden. This is useful when one client decides to take over the upgrade from another client which can happen when the first client crashed and a second client instance is used to start the upgrade. The admin who prepared the upgrade hands it off to a coworker, and so on. If the SOAP request returns with an error.upgrade.anotheruser message, then the SOAP client should prompt the user if they would like to override the session ID. If the user says yes, then submit the request again with arg2="true”.

This result shows that the upgrade was cancelled.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService.PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="http://server_url/xs" xsi:nil="true"/>
                <ns16:server xmlns:ns16="http://server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="http://server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:A76367D3A705D7D5591299705914148</wsa:MessageID>
		<wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:19896bfb-dbb4-4f2a-8c84-a34c13b42ac5</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
				<ax243:remoteMessages xsi:type="ax243:RemoteMessage">
					<ax244:error>true</ax244:error>
					<ax244:info>false</ax244:info>
					<ax244:messageKey>error.upgrade.canceled</ax244:messageKey>
					<ax244:messageType>internal.message.error</ax244:messageType>
					<ax244:warning>false</ax244:warning>
				</ax243:remoteMessages>
				<ax243:result>internal.request.failed</ax243:result>
				<ax243:upgradeFile xsi:type="ax243:UpgradeFile">
					<ax243:checksum/>
					<ax243:essuTimestamp/>
					<ax243:name>UCSInstall_UCOS_8.6.0.98000-9009.iso</ax243:name>
					<ax243:path>/common/download/</ax243:path>
					<ax243:postValidatedFilename>UCSInstall_UCOS_8.6.0.98000-9009.iso</ax243:postValidatedFilename>
					<ax243:rebootRequired>false</ax243:rebootRequired>
					<ax243:rejectCode/>
					<ax243:server/>
					<ax243:signed>false</ax243:signed>
					<ax243:unrestrictedVersion>false</ax243:unrestrictedVersion>
					<ax243:upgradeLocation/>
					<ax243:upgradeType>upgradefile.type.patch</ax243:upgradeType>
					<ax243:user/>
					<ax243:validated>false</ax243:validated>
					<ax243:version>8.6.0.98000-9009</ax243:version>
				</ax243:upgradeFile>
			</ns:return>
		</ns:prepareRemoteUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade failed because of a bad password.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService.PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="http://server_url/xsd" xsi:nil="true"/>
                <ns16:server xmlns:ns16="server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:A76367D3A705D7D5591299705914148</wsa:MessageID>
        <wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
        <wsa:RelatesTo>uuid:cd72c8e9-ee9a-4f29-a797-51e3b1d6a482</wsa:RelatesTo>
    </soapenv:Header>
    <soapenv:Body>
        <ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
            <ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
                <ax243:remoteMessages xsi:type="ax243:RemoteMessage">
                    <ax244:error>true</ax244:error>
                    <ax244:info>false</ax244:info>
                    <ax244:messageKey>error.upgrade.badpassword</ax244:messageKey>
                    <ax244:messageType>internal.message.error</ax244:messageType>
                    <ax244:warning>false</ax244:warning>
                </ax243:remoteMessages>
                <ax243:result>internal.request.failed</ax243:result>
                <ax243:upgradeFile xsi:nil="true"/>
            </ns:return>
        </ns:prepareRemoteUpgradeResponse>
    </soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade was not able to proceed because it encountered a remote file lock on the upgrade file.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService.PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http/;//server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="http://server_url/xsd" xsi:nil="true"/>
                <ns16:server xmlns:ns16="http://server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:A76367D3A705D7D5591299705914148</wsa:MessageID>
		<wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:19896bfb-dbb4-4f2a-8c84-a34c13b42ac5</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
				<ax243:remoteMessages xsi:type="ax243:RemoteMessage">
					<ax244:error>true</ax244:error>
					<ax244:info>false</ax244:info>
					<ax244:messageKey>internal.request.denied.lock</ax244:messageKey>
					<ax244:messageType>internal.message.error</ax244:messageType>
					<ax244:warning>false</ax244:warning>
				</ax243:remoteMessages>
				<ax243:result>internal.request.failed</ax243:result>
				<ax243:upgradeFile xsi:nil="true"/>
			</ns:return>
		</ns:prepareRemoteUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade failed because the upgrade file name was not correct.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService.PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="http://server_url/xsd" xsi:nil="true"/>
                <ns16:server xmlns:ns16="server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:BF1C7434AEA69934961297007865266</wsa:MessageID>
        <wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
        <wsa:RelatesTo>uuid:f9b40da8-b4a1-4831-8564-d97a61c90d8c</wsa:RelatesTo>
    </soapenv:Header>
    <soapenv:Body>
        <ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
            <ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
                <ax243:upgradeFile xsi:type="ax243:UpgradeFile">
                    <ax243:checksum/>
                    <ax243:essuTimestamp/>
                    <ax243:name>UCSInstall_UCOS_8.6.0.96000-9005.iso</ax243:name>
                    <ax243:path>/common/download/</ax243:path>
                    <ax243:postValidatedFilename>UCSInstall_UCOS_8.6.0.96000-9005.iso</ax243:postValidatedFilename>
                    <ax243:rebootRequired>false</ax243:rebootRequired>
                    <ax243:rejectCode/>
                    <ax243:server/>
                    <ax243:signed>false</ax243:signed>
                    <ax243:unrestrictedVersion>false</ax243:unrestrictedVersion>
                    <ax243:upgradeLocation/>
                    <ax243:upgradeType>upgradefile.type.patch</ax243:upgradeType>
                    <ax243:user/>
                    <ax243:validated>false</ax243:validated>
                    <ax243:version>8.6.0.96000-9005</ax243:version>
                </ax243:upgradeFile>
                <ax243:remoteMessages xsi:type="ax243:RemoteMessage">
                    <ax244:error>true</ax244:error>
                    <ax244:info>false</ax244:info>
                    <ax244:messageKey>error.upgrade.filenotdownloaded</ax244:messageKey>
                    <ax244:messageType>internal.message.error</ax244:messageType>
                    <ax244:warning>false</ax244:warning>
                </ax243:remoteMessages>
                <ax243:result>internal.request.failed</ax243:result>
            </ns:return>
        </ns:prepareRemoteUpgradeResponse>
    </soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade file location provided was not correct.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService.PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="http://server_url/xsd" xsi:nil="true"/>
                <ns16:server xmlns:ns16="server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:BF1C7434AEA69934961297007752603</wsa:MessageID>
		<wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:ca87837d-6fac-4548-be64-9ed6ee4399c1</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
				<ax243:upgradeFile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
				<ax243:remoteMessages xsi:type="ax243:RemoteMessage">
					<ax244:error>true</ax244:error>
					<ax244:info>false</ax244:info>
					<ax244:messageKey>error.upgrade.file.notready</ax244:messageKey>
					<ax244:messageType>internal.message.error</ax244:messageType>
					<ax244:warning>false</ax244:warning>
				</ax243:remoteMessages>
				<ax243:result>internal.request.failed</ax243:result>
			</ns:return>
		</ns:prepareRemoteUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade was not performed because the user name provided was not correct.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService. PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="http://server_url/xsd" xsi:nil="true"/>
                <ns16:server xmlns:ns16="server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:BF1C7434AEA69934961297007648759</wsa:MessageID>
		<wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:c56692c3-00c1-4468-85cb-0df1af813d2a</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
				<ax243:upgradeFile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
				<ax243:remoteMessages xsi:type="ax243:RemoteMessage">
					<ax244:error>true</ax244:error>
					<ax244:info>false</ax244:info>
					<ax244:messageKey>errors.upgrade.badpassword</ax244:messageKey>
					<ax244:messageType>internal.message.error</ax244:messageType>
					<ax244:warning>false</ax244:warning>
				</ax243:remoteMessages>
				<ax243:result>internal.request.failed</ax243:result>
			</ns:return>
		</ns:prepareRemoteUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade was completed successfully, and that a reboot is required.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
        <wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService. PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
            <args0>
                <ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
                <ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
                <ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
                <ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
                <ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
                <ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
                <ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
                <ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
                <ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
                <ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
                <ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
                <ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
                <ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
                <ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
                <ns15:rejectCode xmlns:ns15="server_url/xsd" xsi:nil="true"/>
                <ns16:server xmlns:ns16="server_url/xsd">bcodev1</ns16:server>
                <ns17:systemUpgradeLocation xmlns:ns17="http://=server_url/xsd" xsi:nil="true"/>
                <ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
                <ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
                <ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
                <ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
            </args0>
            <args1>pm238</args1>
            <args2>false</args2>
        </prepareRemoteUpgrade>
    </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:A76367D3A705D7D5591299705914148</wsa:MessageID>
        <wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
        <wsa:RelatesTo>uuid:19896bfb-dbb4-4f2a-8c84-a34c13b42ac5</wsa:RelatesTo>
    </soapenv:Header>
    <soapenv:Body>
        <ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
            <ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
                <ax243:upgradeFile xsi:type="ax243:UpgradeFile">
                    <ax243:checksum>71:9c:bc:17:73:05:e7:ab:05:a4:0e:b0:c6:cd:dc:20</ax243:checksum>
                    <ax243:essuTimestamp/>
                    <ax243:name>UCSInstall_UCOS_8.6.0.96000-9006.iso</ax243:name>
                    <ax243:path>/common/download/</ax243:path>
                    <ax243:postValidatedFilename>UCSInstall_UCOS_8.6.0.96000-9006.iso</ax243:postValidatedFilename>
                    <ax243:rebootRequired>false</ax243:rebootRequired>
                    <ax243:rejectCode/>
                    <ax243:server/>
                    <ax243:signed>false</ax243:signed>
                    <ax243:unrestrictedVersion>false</ax243:unrestrictedVersion>
                    <ax243:upgradeLocation/>
                    <ax243:upgradeType>upgradefile.type.patch</ax243:upgradeType>
                    <ax243:user/>
                    <ax243:validated>true</ax243:validated>
                    <ax243:version>8.6.0.96000-9006</ax243:version>
                </ax243:upgradeFile>
                <ax243:remoteMessages xsi:type="ax243:RemoteMessage">
                    <ax244:error>false</ax244:error>
                    <ax244:info>false</ax244:info>
                    <ax244:messageKey>warning.upgrade.rebootrequired</ax244:messageKey>
                    <ax244:messageType>internal.message.warning</ax244:messageType>
                    <ax244:warning>true</ax244:warning>
                </ax243:remoteMessages>
                <ax243:result>internal.request.complete.message</ax243:result>
            </ns:return>
        </ns:prepareRemoteUpgradeResponse>
    </soapenv:Body>
</soapenv:Envelope>

This result shows that the upgrade was a COP file.

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)

upgradeFile

name - upgrade or COP file name
password - the passsword for the server that contains the upgrade file
path - upgrade file path
server - the name of the server that provided the upgrade file
upgradeLocation - url of upgrade serve
upgradeType - upgradefile.type.patch
user - user name on upgrade server

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:prepareRemoteUpgrade</wsa:Action>
		<wsa:MessageID>uuid:88042ed4-0c17-4aba-acfe-f6c68c1c6f0c</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/PrepareRemoteUpgradeService. PrepareRemoteUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<prepareRemoteUpgrade xmlns="http://services.api.platform.vos.cisco.com">
			<args0>
				<ns1:errorMessages xmlns:ns1="http://server_url/xsd" xsi:nil="true"/>
				<ns2:infoMessages xmlns:ns2="http://server_url/xsd" xsi:nil="true"/>
				<ns3:status xmlns:ns3="http://server_url/xsd" xsi:nil="true"/>
				<ns4:validationMessages xmlns:ns4="http://server_url/xsd" xsi:nil="true"/>
				<ns5:warningMessages xmlns:ns5="http://server_url/xsd" xsi:nil="true"/>
				<ns6:completePath xmlns:ns6="http://server_url/xsd" xsi:nil="true"/>
				<ns7:name xmlns:ns7="http://server_url/xsd">UCSInstall_UCOS_8.6.0.98000-9015.iso</ns7:name>
				<ns8:path xmlns:ns8="http://server_url/xsd">/ws/jschmaus-rcd/jschmaus-cc_mainline-cct-ccm/iso</ns8:path>
				<ns9:checksum xmlns:ns9="http://server_url/xsd" xsi:nil="true"/>
				<ns10:essuTimestamp xmlns:ns10="http://server_url/xsd" xsi:nil="true"/>
				<ns11:internalUpgradeType xmlns:ns11="http://server_url/xsd" xsi:nil="true"/>
				<ns12:password xmlns:ns12="server_url/xsd">ftpuser</ns12:password>
				<ns13:postValidatedCompletePath xmlns:ns13="http://server_url/xsd" xsi:nil="true"/>
				<ns14:postValidatedFilename xmlns:ns14="http://server_url/xsd" xsi:nil="true"/>
				<ns15:rejectCode xmlns:ns15="server_url/xsd" xsi:nil="true"/>
				<ns16:server xmlns:ns16="server_url/xsd">bcodev1</ns16:server>
				<ns17:systemUpgradeLocation xmlns:ns17="http://server_url/xsd" xsi:nil="true"/>
				<ns18:upgradeLocation xmlns:ns18="http//server_url/xsd">upgradefile.location.remote.sftp</ns18:upgradeLocation>
				<ns19:upgradeType xmlns:ns19="http?://server_url/xsd">patch</ns19:upgradeType>
				<ns20:user xmlns:ns20="http://server_url/xsd">ftpuser</ns20:user>
				<ns21:version xmlns:ns21="server_url/xsd" xsi:nil="true"/>
			</args0>
			<args1>pm238</args1>
			<args2>false</args2>
		</prepareRemoteUpgrade>
	</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:B8E556B192135F3CC31299011707746</wsa:MessageID>
		<wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:62f615cc-1f40-4fd4-bdfd-74a5d42ba876</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:prepareRemoteUpgradeResponse xmlns:ns="http://services.api.platform.vos.cisco.com">
			<ns:return xmlns:ax241="server_url/xsd" xmlns:ax244="http://api.platform.vos.cisco.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://element.services.api.platform.vos.cisco.com/xsd" xsi:type="ax243:PrepareRemoteUpgradeResponse">
				<ax243:remoteMessages xsi:type="ax243:RemoteMessage">
					<ax244:error>false</ax244:error>
					<ax244:info>false</ax244:info>
					<ax244:messageKey>warning.upgrade.rebootrequired</ax244:messageKey>
					<ax244:messageType>internal.message.warning</ax244:messageType>
					<ax244:warning>true</ax244:warning>
				</ax243:remoteMessages>
				<ax243:result>internal.request.complete.message</ax243:result>
				<ax243:upgradeFile xsi:type="ax243:UpgradeFile">
					<ax243:checksum>54:13:ff:48:bb:be:5f:39:b6:ba:a4:49:b5:79:30:5a</ax243:checksum>
					<ax243:essuTimestamp/>
					<ax243:name>ciscocm.test.cop</ax243:name>
					<ax243:path>/common/download/</ax243:path>
					<ax243:postValidatedFilename>ciscocm.test.cop</ax243:postValidatedFilename>
					<ax243:rebootRequired>false</ax243:rebootRequired>
					<ax243:rejectCode/>
					<ax243:server/>
					<ax243:signed>false</ax243:signed>
					<ax243:unrestrictedVersion>false</ax243:unrestrictedVersion>
					<ax243:upgradeLocation/>
					<ax243:upgradeType>upgradefile.type.cop</ax243:upgradeType>
					<ax243:user/>
					<ax243:validated>true</ax243:validated>
					<ax243:version>0.0.0.0-0</ax243:version>
				</ax243:upgradeFile>
			</ns:return>
		</ns:prepareRemoteUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

Platform Administrative Web Services (PAWS) API Reference

prepareRemoteUpgrade