HPE Compute Ops Management Jobs

Job Definition

A job is a multi-step task that is managed by Compute Ops Management to perform an action on a resource. For example performing power operations or firmware updates on a server.

Available Jobs

The following table summarizes the jobs that can be performed in COM.

Note: Click on the job name to learn more about the required and optional data on the job details page.

Create Job

A job can be created by issuing a POST to the /compute-ops-mgmt/v1/jobs endpoint with the correct payload for the job.

The following properties are used when creating a job:

If the job was created successfully, a 201 Created response is returned. The response includes the job resource which has a job resourceUri that you can use to track the progress of the job.

Migrating Job Creation to the Stable v1 API

To transition from the deprecated beta versions (v1beta2 and v1beta3) to the stable v1 API for job creation, refer to the following. It outlines how to replace previous parameters.

This migration ensures compatibility with the stable API and aligns with the latest Compute Ops Management standards.

Template Identifier The template is now identified only by the template's durable ID.

• Deprecated:
  • jobTemplateUri= "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0"
• V1 Stable:
  • jobTemplate= "91159b5e-9eeb-11ec-a9da-00155dc0a0c0"

Resource Identifier The resource is now identified by two attributes the resourceType and resourceId

• Deprecated:
  • resourceUri= "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605"
• V1 Stable:
  • resourceType= "compute-ops-mgmt/group"
  • resourceId= "a3853ee1-da05-47d6-bcc4-d35244d59605"

Job Parameters The parameters for the job haven't changed, but now go to the jobParams property.

• Deprecated:
  • data= {json body}
• V1 Stable:
  • jobParams= {json body (same contents)}

Monitoring Jobs

In order to track job progress, request the current job using GET /compute-ops-mgmt/{version}/jobs/{job-id} with v1 as the {version}, or the deprecated values v1beta3 and v1beta2.

Using v1

The response includes a state and resultCode which allow you to monitor the current job state and result. The job also includes a status which can provide more details about the current job progress.

The job state and resultCode are defined as follows:

Note: ERROR and COMPLETE are both terminal states for a job.

Example

The following example shows a completed GroupFirmwareCompliance job using the v1 jobs route.

{
  "id": "2b8540fc-f275-48bb-ae4b-bf9a42b6cc91",
  "parentJobId": null,
  "type": "compute-ops-mgmt/job",
  "resourceUri": "/compute-ops-mgmt/v1/jobs/2b8540fc-f275-48bb-ae4b-bf9a42b6cc91",
  "createdAt": "2022-08-04T18:52:26.278608+00:00",
  "updatedAt": "2022-08-04T18:54:09.903588+00:00",
  "deleteOnComplete": false,
  "cancelable": true,
  "name": "GroupFirmwareCompliance",
  "jobTemplate": "23b8ba2a-6c46-4223-b028-919382c7dcac",
  "resource": {
    "type": "compute-ops-mgmt/group",
    "id": "8a3a2a46-0102-48e2-bdd9-a29ee6909860"
  },
  "jobParams": {},
  "state": "COMPLETE",
  "resultCode": "SUCCESS",
  "status": "Complete",
  "statusDetails": {},
  "generation": 6
}

Using v1beta3

The older v1bets3 response tracks resource by URIs, not ID & TYPE like in the stable 'v1 api.

Example

The following example shows a completed GroupFirmwareCompliance job using the v1beta3 jobs route.

{
  "id": "2b8540fc-f275-48bb-ae4b-bf9a42b6cc91",
  "parentJobId": null,
  "type": "compute-ops-mgmt/job",
  "resourceUri": "/compute-ops-mgmt/v1beta3/jobs/2b8540fc-f275-48bb-ae4b-bf9a42b6cc91",
  "createdAt": "2022-08-04T18:52:26.278608+00:00",
  "updatedAt": "2022-08-04T18:54:09.903588+00:00",
  "displayName": "GroupFirmwareCompliance",
  "name": "GroupFirmwareCompliance",
  "jobTemplateUri": "/compute-ops-mgmt/v1beta3/job-templates/23b8ba2a-6c46-4223-b028-919382c7dcac",
  "associatedResourceUri": "/compute-ops-mgmt/v1beta3/groups/8a3a2a46-0102-48e2-bdd9-a29ee6909860",
  "resource": {
    "resourceUri": "/compute-ops-mgmt/v1beta3/groups/8a3a2a46-0102-48e2-bdd9-a29ee6909860",
    "type": "groups"
  },
  "data": {},
  "state": "COMPLETE",
  "resultCode": "SUCCESS",
  "status": "Complete",
  "statusDetails": {},
  "generation": 6
}

Using v1beta2

The older v1beta2 response uses URIs, and does not have resultCode, but includes a state and status.

Example

The following example shows a completed GroupFirmwareCompliance job using the v1beta2 jobs route.

{
  "id": "2b8540fc-f275-48bb-ae4b-bf9a42b6cc91",
  "parentJobId": null,
  "type": "compute-ops-mgmt/job",
  "resourceUri": "/compute-ops-mgmt/v1beta2/jobs/2b8540fc-f275-48bb-ae4b-bf9a42b6cc91",
  "createdAt": "2022-08-04T18:52:26.278608+00:00",
  "updatedAt": "2022-08-04T18:54:09.903588+00:00",
  "displayName": "GroupFirmwareCompliance",
  "name": "GroupFirmwareCompliance",
  "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/23b8ba2a-6c46-4223-b028-919382c7dcac",
  "associatedResourceUri": "/compute-ops-mgmt/v1beta2/groups/8a3a2a46-0102-48e2-bdd9-a29ee6909860",
  "resource": {
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/8a3a2a46-0102-48e2-bdd9-a29ee6909860",
    "type": "groups"
  },
  "data": {},
  "state": "COMPLETE",
  "status": "Complete",
  "statusDetails": {},
  "generation": 6
}