UpdateManagementConsole_ManagementConsole Job

You can use the UpdateManagementConsole job to update the Hardware Management Console (HMC). The update image can be downloaded from a remote SFTP or FTP or NFS server, or IBM website, or a local disk, or a USB device, or a CD, or a DVD.

Resource

/rest/api/uom/ManagementConsole/{UUID}/do/UpdateManagementConsole

Request

Table 1. Request Parameters
Request parameter Description
MediaType The target from where the update image must be downloaded. The possible values are:
  • USB
  • NFS
  • SFTP
  • FTP
  • IBMWebsite
  • Disk
  • VirtualMedia
  • CDDVD
ServerHostOrIP The hostname or IP address of the remote server
UserName The username of the remote server
Password The password of the remote user
SFTPKey The SSH private key file for SFTP file
PassPhrase The Passphrase of the SSH key for SFTP file
Directory The HMC local directory where the update image exists
UpdateFile The name of the update image file
MountLocation NFS mount location
MountOptions Options that can be passed to the mount command.
PTFNumber PTF number (for IBMWebsite)
Device Name of the USB or CDDVD or VirtualMedia device
RestartConsole Flag to indicate whether the HMC must be restarted to complete the update. The possible values are:
  • True
  • False

Response

Table 2. Response parameters
Response parameter Description
NOT_STARTED The parameter validation failed.
RUNNING
  1. The corrective service file offload from remote server is in progress.
  2. The corrective service file offload was successful and continuing with HMC service installation.
  3. Verifying certificate information.
  4. Authenticating installation packages.
  5. Installing the packages.
  6. The corrective service file was successfully applied.
  7. Restarting the console.
FAILED_BEFORE_COMPLETION The update operation failed.
COMPLETED_OK The update operation is successfully completed.

Sample Job Requests

For SFTP with password:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">SFTP</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">Directory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMCUpdates</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UpdateFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">H24094294.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>
For SFTP with key:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">SFTP</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">SFTPKey</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/home/hscroot/serverkey</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Directory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMCUpdates </ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UpdateFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">H24094294.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For FTP:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">FTP</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">Directory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMCUpdates </ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UpdateFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">H24094294.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For FTP:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">NFS</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">Directory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMCUpdates</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UpdateFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">H24094294.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">USB</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Device</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/dev/sdb1</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UpdateFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMC-Update.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For CDDVD:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">CDDVD</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Device</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/dev/sr0</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>

For Virtual Media:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">VirtualMedia</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Device</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/dev/sdb</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For IBMWebsite:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">IBMWebsite</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">PTFNumber</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">MH01234</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>

For Disk:

<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">UpdateManagementConsole</OperationName>
        <GroupName kb="ROR" kxe="false">ManagementConsole</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">MediaType</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">Disk</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">Directory</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">/home/hscroot/HMCupdates/</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">UpdateFile</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">HMC-Update.iso</ParameterValue>
		</JobParameter>
        <JobParameter schemaVersion="V1_0">
		    <Metadata>
		        <Atom/>
		    </Metadata>
		    <ParameterName kb="ROR" kxe="false">RestartConsole</ParameterName>
		    <ParameterValue kxe="false" kb="CUR">true</ParameterValue>
		</JobParameter>
    </JobParameters>
</JobRequest:JobRequest>