Jobs
HMC REST API Framework supports invocation of long running operations through the use of Jobs.
For every Job there are two main semantics:
- Job Object
- Job Operation
On invoking any Job, a Job ID is returned to the user. This Job ID is to be used to poll the Status of the Job.
Resource to obtain Job Status using Job ID
rest/api/uom/jobs/{job_id}
Methods
Method Name | Description | Internet Media Type |
---|---|---|
PUT | Request web server to perform an operation on the specified object based on the specified parameters. | application/vnd.ibm.powervm.web+xml; type=JobRequest |
- EventLogger_ManagementConsole Job
Operation can be invoked to Log events to Developers Logs till the Job is Cancelled. - CLIRunner_ManagementConsole Job
Operation to run CLI Commands using REST Framework on Hardware Management Console. - AddManagedSystem_ManagementConsole Job
Operation to add a particular Managed System to Management Console. - PowerOn_ManagedSystem Job
Operation to PowerOn a particular ManagedSystem. - PowerOff_ManagedSystem Job
Operation to power off a particular managed system. - ResetConnection_ManagedSystem Job
Operation to remove a particular Managed System connection from a Management Console. - RemoveConnection_ManagedSystem Job
Operation to remove a particular Managed System connection from a Management Console. - QueryReservedMemoryRequiredForPartition_ManagedSystem Job
Operation to QueryReservedMemoryRequiredForPartition for a Managed System. - ModifySRIOVAdapterMode_ManagedSystem Job
Operation to modify the state of SRIOV Adapter of a Managed System. - ClearSRIOVPhysicalPortStatistics_ManagedSystem Job
Operation to clear the statistical data available on a particular SRIOV physical port of the Managed System. - GetNetworkBootDevices_LogicalPartition Job
Get Network Boot devices job is used to get network devices from the profile of logical partition. - LogicalPartition_RemoteRestart Job
Logical Partition remote restart Job is used to perform the remote restart operations on the logical partition. You can perform validate, recover, restart, cleanup, and cancel operations using this job. - Migrate_LogicalPartition Job
Operation to Migrate a particular Logical Partition from one Managed System to another. - MigrateAbort_LogicalPartition Job
Operation to Abort the previously invoked Migration of a Logical Partition. - MigrateRecover_LogicalPartition Job
Operation to recover a logical partition that has been stuck in an intermediate state after failure of the preceding migrate operation. - MigrateValidate_LogicalPartition Job
Operation to Validate the Migrate operation of a particular Logical Partition from one Managed System to another. - PowerOff_LogicalPartition Job
Operation to Power Off a particular Logical Partition of a Managed System. - PowerOn_LogicalPartition Job
The PowerOn_LogicalPartition job is used to power on a logical partition. - ConfigDevice_VirtualIOServer Job
Configure device Job on Virtual IO Server will help to configure the devices on VirtualIOServers. - GetNetworkBootDevices_VirtualIOServer Job
Get Network Boot devices job is used to get network devices from the profile of Virtual I/O Server (VIOS). - PowerOff_VirtualIOServer Job
Operation to power off a logical partition of a Managed System. - PowerOn_VirtualIOServer Job
The PowerOn_VirtualIOServer Job is used to power on a Virtual I/O Server. - GetFreePhysicalVolumes_VirtualIOServer Job
The GetFreePhysicalVolumes job returns the free physical volumes that belong to Virtual I/O Server (VIOS) on which it was queried. It also provides the FibreChannelBackedOnly option to filter the Fibre-Channel-backed physical volumes. - Create_Cluster Job
The cluster create job is used to create a cluster with shared storage pool. The cluster and shared storage pool details are available in an XML format. - Create_Cluster2 Job
The create cluster job is used to create a cluster with shared storage pool, and with one or more tiers. The details of the cluster, shared storage pool, and the tier are available in an XML format. - Delete_Cluster Job
Delete_Cluster Job is used to delete a cluster with Shared Storage Pool (SSP). - CreateLogicalUnit_Cluster Job
CreateLogicalUnit_Cluster Job is used to create a logical unit (LU) in a cluster or Shared Storage Pool (SSP). - DeleteLogicalUnit_Cluster Job
The DeleteLogicalUnit_Cluster job is used to remove or delete a logical unit from the cluster or a shared storage pool. - MigrateLogicalUnit_Cluster Job
The MigrateLogicalUnit_Cluster job is used to move a logical unit from one tier to another tier within the same cluster. - LULinkedClone_Cluster Job
Logical Unit Clone job is used to create a clone of link clone of logical units. - Cluster_Replace_Repository_Disk Job
The Cluster_Replace_Repository_Disk job is used to replace the existing repository disk of the cluster with a new one. - GetFreePhysicalVolumes_Cluster Job
The GetFreePhysicalVolumes_Cluster job returns the free physical volumes that can be added to the cluster. - ManagePhysicalVolume_Cluster Job
The ManagePhysicalVolume_Cluster job allows you to add, remove, or replace the physical volumes that are associated to the failure group of the specified tier. - ClearStatistics_SRIOVEthernetLogicalPort Job
Operation to clear Statistical data available on a particular SRIOV Ethernet Logical Port of Logical Partition / VirtualIOServer. - ClearStatistics_SRIOVFibreChannelOverEthernetLogicalPort Job
Operation to clear Statistical data available on a particular SRIOV FibreChannelOverEthernet Logical Port of Logical Partition / VirtualIOServer. - CreatePowerEnterprisePool_PowerEnterprisePool Job
Creates a Capacity on Demand (CoD) Power enterprise pool. - SetMasterConsole_PowerEnterprisePool Job
Change the master management console for a Power enterprise pool. - SyncSystemPool_PowerEnterprisePool Job
Synchronize the pool information between the master management console for the pool and the systems in the pool. - UpdatePowerEnterprisePool_PowerEnterprisePool Job
Update a Power enterprise pool with the specified pool configuration file.
Parent topic: HMC REST APIs
Last updated: Fri, June 23, 2017