startUpgrade

The startUpgrade method starts the upgrade or COP file installation previously prepared via prepareRemoteUpgrade This method returns a response:

  • As soon as the upgrade is complete for normal upgrades, and before booting the new partition if a reboot was requested.
  • Before rebooting if a refresh upgrade is being performed.

For refresh upgrades, the upgrade is not complete when the response is received. Refresh upgrades
do not have platform services running after the first reboot, so Platform Administrative Web Services are unavailable.
In particular, UpgradeStageService and UpgradeProgressStageService are not available for
monitoring the upgrade progress after performing a refresh upgrade.

This call should always be made asynchronously.

This service may restart the server (e.g. - RU upgrade); an asynchronous response is not guaranteed in those situations.

Request Parameters
args0


string - The session ID

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 an error.upgrade.anotheruser is generated.
This allows the services to differentiate between multiple clients and prevent accidental overrides/interruptions.
args1


Boolean - True 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.
args2


Boolean - True false

True if the server should automatically switch to the new version if the upgrade completes successfully.

This result occurs if the upgrade is cancelled.

Response Parameters (return element children)
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)
result


A message such as internal.request.failed - request call failed - see messageKey child of remoteMessages for cause of failure
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:95C57A73325A726E721299707179251</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:b6bcfda4-e62c-43d6-8f52-3770286b8ccb</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>true</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>error.upgrade.canceled</ax248:messageKey>
					<ax248:messageType>internal.message.error</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.failed</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result tells you that a reboot is required.

Response Parameters (return element children)
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)
There may be more than one remoteMessages section.
result


A message such as internal.request.failed - request call failed - see messageKey child of remoteMessages for cause of failure
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:8109AEDEE509351D941300141228195</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:f263eb8f-1fbb-4b2f-8ea9-271e2472059f</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>true</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>errors.system</ax248:messageKey>
					<ax248:messageType>internal.message.error</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>false</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>warning.upgrade.rebootrequired</ax248:messageKey>
					<ax248:messageType>internal.message.warning</ax248:messageType>
					<ax248:warning>true</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.failed</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result occurs because the ugrade failed due to a missing argument. Missing arguments cause precipitous failure of these services with a
stack traceback. The example below is of a StartUpgrade that did not supply the reboot flag.

Response Parameters (return element children)
faultcode


The code for the fault that occurred
faultstring


Human readable text of exception
detail


Exception - A raw exception message
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:A5F07DE6D3D5A6D5611297466742075</wsa:MessageID>
		<wsa:Action>http://schemas.xmlsoap.org/ws/2004/08/addressing/fault</wsa:Action>
		<wsa:RelatesTo>uuid:0f60b096-509e-4190-b377-316907051c5e</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<soapenv:Fault>
			<faultcode>soapenv:Server</faultcode>
			<faultstring>Exception occurred while trying to invoke service method startUpgrade</faultstring>
			<detail>
				<Exception>org.apache.axis2.AxisFault: Exception occurred while trying to invoke service method startUpgrade at org.apache.axis2.rpc.receivers .RPCInOutAsyncMessageReceiver .invokeBusinessLogic(RPCInOutAsyncMessageReceiver.java:150) at org.apache.axis2.receivers.AbstractInOutMessageReceiver. invokeBusinessLogic(AbstractInOutMessageReceiver.java:40) at org.apache.axis2.receivers .AbstractMessageReceiver$AsyncMessageReceiverWorker .run(AbstractMessageReceiver.java:316) at java.util.concurrent.ThreadPoolExecutor$Worker .runTask(ThreadPoolExecutor.java:886) at java.util.concurrent.ThreadPoolExecutor$Worker .run(ThreadPoolExecutor.java:908) at java.lang.Thread.run(Thread.java:662) Caused by: java.lang.IllegalArgumentException at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl .invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl .invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at org.apache.axis2.rpc.receivers.RPCUtil .invokeServiceClass(RPCUtil.java:194) at org.apache.axis2.rpc.receivers .RPCInOutAsyncMessageReceiver .invokeBusinessLogic(RPCInOutAsyncMessageReceiver.java:89) ... 5 more</Exception>
			</detail>
		</soapenv:Fault>
	</soapenv:Body>
</soapenv:Envelope>

This result indicates the upgrade failed because the previous startUpgrade is still running.

Response Parameters (return element children)
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)
result


A message such as internal.request.failed - request call failed - see messageKey child of remoteMessages for cause of failure
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:51A6356E639A5F2D5F1299024560404</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:141eb843-c958-4c58-8c8c-82c801426645</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>true</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>internal.request.denied.locked</ax248:messageKey>
					<ax248:messageType>internal.message.error</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.failed</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This response, error.upgrade.anotheruser and info.upgrade.rebooting, indicates failure, but the
request was processed and the server booted on the new partition.

Response Parameters (return element children)
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)
There may be more than one remoteMessages section.
result


A message such as internal.request.failed - request call failed - see messageKey child of remoteMessages for cause of failure
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:4B76E43AA4F2A4FD641298944152371</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:2b502b5c-adeb-472b-afc2-adb028eceef0</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>true</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>error.upgrade.anotheruser</ax248:messageKey>
					<ax248:messageType>internal.message.error</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>false</ax248:error>
					<ax248:info>true</ax248:info>
					<ax248:messageKey>info.upgrade.rebooting</ax248:messageKey>
					<ax248:messageType>internal.message.info</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.failed</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This response indicates that the upgrade was successsful and a reboot in under way.

Response Parameters (return element children) Reboot, Success
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)
There may be more than one remoteMessages section.
result


A message such as internal.request.failed
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:4B76E43AA4F2A4FD641298944152371</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:2b502b5c-adeb-472b-afc2-adb028eceef0</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>true</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>error.upgrade.anotheruser</ax248:messageKey>
					<ax248:messageType>internal.message.error</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>false</ax248:error>
					<ax248:info>true</ax248:info>
					<ax248:messageKey>info.upgrade.rebooting</ax248:messageKey>
					<ax248:messageType>internal.message.info</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.failed</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This result indicates that the system upgrade was successful. Please switch versions to activate
the upgrade or reboot the system to ensure services affected by the upgrade process are functioning properly.

Response Parameters (return element children)
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)
result


A message such as internal.request.complete.message
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:51A6356E639A5F2D5F1299024533991</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:5bc5de83-7f4a-42b4-bdfc-36614668113a</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>false</ax248:error>
					<ax248:info>true</ax248:info>
					<ax248:messageKey>error.upgrade.switchrequired</ax248:messageKey>
					<ax248:messageType>internal.message.info</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.complete.message</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This response indicates there was an error and the node should not be rebooted.

Response Parameters (return element children)
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)
result


A message such as internal.request.complete.message
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:5F212FB67F794618871299081184478</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:41bb9e1f-410c-4273-b1c7-a9e0a043d57b</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>true</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>error.upgrade.switchrequired</ax248:messageKey>
					<ax248:messageType>internal.message.info</ax248:messageType>
					<ax248:warning>false</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.complete.message</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>

This response indicates that the COP file was deployed and a reboot is required.

Response Parameters (return element children)
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)
result


A message such as internal.request.complete.message
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:startUpgrade</wsa:Action>
		<wsa:MessageID>uuid:b4d705b2-eb27-4f63-8ca7-1421e5e11535</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/StartUpgradeService. StartUpgradeServiceHttpSoap11Endpoint</wsa:To>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<startUpgrade xmlns="server_url">
			<args0>pm238</args0>
			<args1>false</args1>
			<args2>false</args2>
		</startUpgrade>
	</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:B8E556B192135F3CC31299011778593</wsa:MessageID>
		<wsa:Action>urn:startUpgradeResponse</wsa:Action>
		<wsa:RelatesTo>uuid:4827efb0-6c4e-4efe-af9b-1ae18ed782f1</wsa:RelatesTo>
	</soapenv:Header>
	<soapenv:Body>
		<ns:startUpgradeResponse xmlns:ns="server_url">
			<ns:return xmlns:ax248="server_url/xsd" xmlns:ax247="server_url/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ax247:StartUpgradeResponse">
				<ax247:remoteMessages xsi:type="ax247:RemoteMessage">
					<ax248:error>false</ax248:error>
					<ax248:info>false</ax248:info>
					<ax248:messageKey>error.upgrade.rebootrequired</ax248:messageKey>
					<ax248:messageType>internal.message.warning</ax248:messageType>
					<ax248:warning>true</ax248:warning>
				</ax247:remoteMessages>
				<ax247:result>internal.request.complete.message</ax247:result>
			</ns:return>
		</ns:startUpgradeResponse>
	</soapenv:Body>
</soapenv:Envelope>