UpgradeVIOS_VirtualIOServer Job

You can use the UpgradeVIOS job to perform an upgrade by using the installation image from a remote SFTP/NFS server, Local Disk, or USB device.

Resource

/rest/api/uom/VirtualIOServer/{UUID}/do/UpgradeVIOS

Request

Table 1. Request Parameters
Request parameter Description
ResourceType The target from where the VIOS installation image is copied. The possible values are:
  • HMC
  • NFS
  • SFTP
  • USB
Name The name of the VIOS install image to be used for installing from local HMC.
ServerHostOrIP The remote Server hostname or IP address.
UserName The user name of the remote SFTP server.
Password The password of the SFTP user.
SSHKey The SSH private key file for SFTP file copy.
PassPhrase The Passphrase of the SSH key for SFTP file copy.
RemoteDirectory The directory where the file exists.
FileNames A comma-separated list of installation iso files.
MountLocation NFS mount location.
MountOptions Additional options to be passed to the mount command.
USBDevice The name of the USB device.
SaveFile Boolean flag to indicate whether the remote VIOS installation image must be saved in HMC. In this case "Name" parameter will be mandatory to save the image with the specified name.
Disks A comma-separated list of free Physics Volumes from the VIOS where the new installation is done.

Response

Table 2. Response parameters
Response parameter Description
stdOut VIOS upgrade operation response. The log that is displayed in the terminal as part of the upgrade operation.

Sample Job Request(s)

For NFS

 <JobRequest:JobRequest
 xmlns:JobRequest="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"
 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_1_0">
    <Metadata>
        <Atom/>
    </Metadata>
    <RequestedOperation kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <OperationName kb="ROR" kxe="false">UpgradeVIOS</OperationName>
        <GroupName kb="ROR" kxe="false">VirtualIOServer</GroupName>
    </RequestedOperation>
    <JobParameters kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">ResourceType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">NFS</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Name</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">2311A_73D</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">ServerHostOrIP</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">9.3.40.147</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">MountLocation</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/hmcctnfs</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">MountOptions</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">vers=4</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RemoteDirectory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">vios/2311A_73D</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">FileNames</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">dvdimage.v1.iso,dvdimage.v2.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Disks</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">hdisk1,hdisk2</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">SaveFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For SFTP

 <JobRequest:JobRequest
 xmlns:JobRequest="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"
 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_1_0">
    <Metadata>
        <Atom/>
    </Metadata>
    <RequestedOperation kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <OperationName kb="ROR" kxe="false">UpgradeVIOS</OperationName>
        <GroupName kb="ROR" kxe="false">VirtualIOServer</GroupName>
    </RequestedOperation>
    <JobParameters kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">ResourceType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">SFTP</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Name</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">2311A_73D</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">ServerHostOrIP</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">9.3.40.147</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UserName</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">hmcct</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Password</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">abcd1234</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RemoteDirectory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">vios/2311A_73D</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">FileNames</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">dvdimage.v1.iso,dvdimage.v2.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Disks</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">hdisk1,hdisk2</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">SaveFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For USB

 <JobRequest:JobRequest
 xmlns:JobRequest="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"
 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_1_0">
    <Metadata>
        <Atom/>
    </Metadata>
    <RequestedOperation kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <OperationName kb="ROR" kxe="false">UpgradeVIOS</OperationName>
        <GroupName kb="ROR" kxe="false">VirtualIOServer</GroupName>
    </RequestedOperation>
    <JobParameters kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">ResourceType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">USB</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Name</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">2311A_73D</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">USBDevice</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/dev/sdb1</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Disks</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">hdisk1,hdisk2</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">SaveFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For HMC

<JobRequest:JobRequest
 xmlns:JobRequest="http://www.ibm.com/xmlns/systems/power/firmware/web/mc/2012_10/"
 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_1_0">
    <Metadata>
        <Atom/>
    </Metadata>
    <RequestedOperation kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <OperationName kb="ROR" kxe="false">UpgradeVIOS</OperationName>
        <GroupName kb="ROR" kxe="false">VirtualIOServer</GroupName>
    </RequestedOperation>
    <JobParameters kb="CUR" kxe="false" schemaVersion="V1_1_0">
        <Metadata>
            <Atom/>
        </Metadata>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">ResourceType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMC</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Name</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">2311A_73D</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Disks</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">hdisk1,hdisk2</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>