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
Contains these child elements:
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)
remoteMessages
error - Boolean: true, message is an error message, false it is not
info - Boolean: true,message is an informational message, false it is not
messageKey - identifies info, warning or error message
messageType - identifies messagekey as info, warning, or error
warning - Boolean: true,message is a warning message, false it is not
messageParams - identifies messagekey parameters
result
A result code such as internal.request.complete that describes the result. See Error Codes in the
Developer's Guide for details.
upgradeFile
name - upgrade ot 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"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="server_url" xmlns:xsd="server_url/xsd">
  <soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
    <wsa:Action>urn:prepareRemoteUpgrade</wsa:Action>
    <wsa:ReplyTo>
      <wsa:Address>http://server/prepareRemoteUpgradeResponse</wsa:Address>
    </wsa:ReplyTo>
    <wsa:MessageID>uuid:bf236011-7a84-441c-ab2d-9a92ea143223</wsa:MessageID>
  </soapenv:Header>
  <soapenv:Body>
    <ser:prepareRemoteUpgrade>
      <!--Optional:-->
      <ser:args0>
        <!--Optional:-->
        <xsd:name>UCSInstall_UCOS_9.0.0.95045-30.iso</xsd:name>
        <!--Optional:-->
        <xsd:password>password</xsd:password>
        <!--Optional:-->
        <xsd:path>/ks/sw/ccm/official-patches</xsd:path>
        <!--Optional:-->
        <xsd:server>bldr-ccm77</xsd:server>
        <!--Optional:-->
        <xsd:upgradeLocation>upgradefile.location.remote.sftp</xsd:upgradeLocation>
        <!--Optional:-->
        <xsd:upgradeType>patch</xsd:upgradeType>
        <!--Optional:-->
        <xsd:user>root</xsd:user>
      </ser:args0>
      <!--Optional:-->
      <ser:args1>pm123</ser:args1>
      <!--Optional:-->
      <ser:args2>false</ser:args2>
    </ser:prepareRemoteUpgrade>
  </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://www.w3.org/2005/08/addressing">
    <wsa:To>http://10.89.8.217:8091/prepareRemoteUpgradeResponse</wsa:To>
    <wsa:ReplyTo>
      <wsa:Address>http://www.w3.org/2005/08/addressing/none</wsa:Address>
    </wsa:ReplyTo>
    <wsa:MessageID>urn:uuid:2E9309CBD4C3AB8A7C1327618913582</wsa:MessageID>
    <wsa:Action>urn:prepareRemoteUpgradeResponse</wsa:Action>
    <wsa:RelatesTo>uuid:bf236011-7a84-441c-ab2d-9a92ea143223</wsa:RelatesTo>
  </soapenv:Header>
  <soapenv:Body>
    <ns:prepareRemoteUpgradeResponse xmlns:ns="server_url">
      <ns:return xmlns:ax241="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ax243="http://api.platform.vos.cisco.com/xsd" xsi:type="ax241:PrepareRemoteUpgradeResponse">
        <ax241:remoteMessages xsi:type="ax241:RemoteMessage">
          <ax243:error>false</ax243:error>
          <ax243:info>false</ax243:info>
          <ax243:messageKey>warning.upgrade.rebootrequired</ax243:messageKey>
          <ax243:messageType>internal.message.warning</ax243:messageType>
          <ax243:warning>true</ax243:warning>
        </ax241:remoteMessages>
        <ax241:result>internal.request.complete.message</ax241:result>
        <ax241:upgradeFile xsi:type="ax241:UpgradeFile">
          <ax241:name>UCSInstall_UCOS_9.0.0.95045-30.iso</ax241:name>
          <ax241:password>password</ax241:password>
          <ax241:path>/ks/sw/ccm/official-patches</ax241:path>
          <ax241:server>bldr-ccm77</ax241:server>
          <ax241:upgradeLocation>upgradefile.location.remote.sftp</ax241:upgradeLocation>
          <ax241:upgradeType>patch</ax241:upgradeType>
          <ax241:user>root</ax241:user>
        </ax241:upgradeFile>
      </ns:return>
    </ns:prepareRemoteUpgradeResponse>
  </soapenv:Body>
</soapenv:Envelope>