PowerOff_VirtualIOServer Job

With the PowerOff_VirtualIOServer job, you can power off a Virtual I/O Server of a managed system.

Resource

/rest/api/uom/VirtualIOServer/{VirtualIOServer_UUID}/do/PowerOff

/rest/api/uom/ManagedSystem/{ManagedSystem_uuid}/VirtualIOServer/{VirtualIOServer_UUID}/do/PowerOff

Request

Table 1. Request parameters
Request parameter	Description
immediate	Boolean flag to indicate whether the power off operation of the logical partition must be immediate.
restart	Boolean flag to indicate whether the logical partition must be restarted.
operation	This parameter specifies the type of operation to be performed to power off the logical partition. The possible values are: shutdown osshutdown dumprestart dumpretry

Response

Table 2. Response parameters
Response parameter	Description
returnCode	The return code value from the invoked Command-Line Interface (CLI).
result	If the job fails with a status of COMPLETED_WITH_ERROR, the error output is displayed in the result parameter of the response.

Sample request payload

Table 3. Supported methods for JSON
Method	Content-type	Type	Accept
PUT	application/ vnd.ibm.powervm.web +json	JobRequest	application/json

Sample job request

JSON:
	{
	"JobRequest": {
		"RequestedOperation": {
			"OperationName": "PowerOff",
			"GroupName": "VirtualIOServer"
		},
		"JobParameters": {
			"JobParameter": [
				{
					"ParameterName": "immediate",
					"ParameterValue": true
				},
				{
					"ParameterName": "restart",
					"ParameterValue": false
				},
				{
					"ParameterName": "operation",
					"ParameterValue": "shutdown"
				}
			]
		}
	 }
}

Table 4. Supported methods for XML
Method	Content-type	Type
PUT	application/ vnd.ibm.powervm.web+xml	JobRequest

Sample job request

XML:
	<JobRequest
 xmlns="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"  xmlns:ns2="http://www.w3.org/XML/1998/namespace/k2" schemaVersion="V1_0">
 <Metadata>
  <Atom/>
 </Metadata>
 <RequestedOperation kxe="false" kb="CUR" schemaVersion="V1_0">
  <Metadata>
   <Atom/>
  </Metadata>
  <OperationName kxe="false" kb="ROR">PowerOff</OperationName>
  <GroupName kxe="false" kb="ROR">VirtualIOServer</GroupName>
 </RequestedOperation>
 <JobParameters kxe="false" kb="CUR" schemaVersion="V1_0">
  <Metadata>
   <Atom/>
  </Metadata>
  <JobParameter schemaVersion="V1_0">
   <Metadata>
    <Atom/>
   </Metadata>
   <ParameterName kb="ROR" kxe="false">immediate</ParameterName>
   <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
  </JobParameter>
              <JobParameter schemaVersion="V1_0">
   <Metadata>
    <Atom/>
   </Metadata>
   <ParameterName kb="ROR" kxe="false">restart</ParameterName>
   <ParameterValue kxe="false" kb="CUR">false</ParameterValue>
  </JobParameter>
  <JobParameter schemaVersion="V1_0">
   <Metadata>
    <Atom/>
   </Metadata>
   <ParameterName kb="ROR" kxe="false">operation</ParameterName>
   <ParameterValue kxe="false" kb="CUR">shutdown</
ParameterValue>
  </JobParameter>
 </JobParameters>
</JobRequest>