Create a job

post/compute-ops-mgmt/v1beta3/jobs

Create a job for a given resource. A job is a multi-step task performed by Compute Ops Manager.

This table summarizes the jobs and their template IDs. For more information about each job template, expand the Job Definitions section and click on Overview to get started.

Name Description Resource Type Template ID
Server Power Off Power off a server compute-ops/server d0c13b58-748c-461f-9a61-c0c5c71f1bb4
Server Power On Power on a server compute-ops/server 0cbb2377-1834-488d-840c-d5bf788c34fb
Server Restart Restart a server compute-ops/server 30110551-cad6-4069-95b8-dbce9bbd8525
Server Cold Boot Cold boot a server compute-ops/server aacfb3e0-6575-4d4f-a711-1ee1ae768407
Server Firmware Update Update firmware on a server compute-ops/server fd54a96c-cabc-42e3-aee3-374a2d009dba
Server iLO Firmware Update Update iLO component firmware on a server compute-ops/server 94caa4ef-9ff8-4805-9e97-18a09e673b66
Server External Storage Details Collect external storage details for a server compute-ops/server 139cc26b-ac93-4da0-826c-220d15e3a422
Group Firmware Update Update firmware on servers in a group compute-ops/group 91159b5e-9eeb-11ec-a9da-00155dc0a0c0
Group Firmware Compliance Calculate firmware compliance of servers in a group compute-ops/group 23b8ba2a-6c46-4223-b028-919382c7dcac
Group Internal Storage Configuration Configures internal storage volume for servers in a group compute-ops/group c708eb57-235d-4ea8-9e21-8ceea2438773
Group Apply Server Setting Apply server setting on a group compute-ops/group beff07ce-f36d-4699-9ac3-f872dcd63133
Group Apply External Storage Settings Apply external storage settings on servers in a group compute-ops/group 1262f08e-79eb-4e9f-91d2-6984da9d31cd
Group External Storage Compliance Calculate external storage compliance of servers in a group compute-ops/group 977139e0-f9d9-4940-9418-e0c321b5a458
Carbon Footprint Report Create carbon footprint report compute-ops/filter b0001d36-6490-48ac-93af-a87adfb997ed
Collect Server Inventory Collect complete or filtered server inventory compute-ops/server d6595f1b-84e6-4587-ade5-656e2a5ea20d
Collect Server Network Connectivity Collect server adapter port to switch port mappings compute-ops/server b21ca9e2-8a1b-11ee-b9d1-0242ac120002
Group Operating System Installation Install operating system on servers in a group compute-ops/group e2952628-2629-4088-93db-91742304ef0c
Group iLO Settings Compliance Calculate ilo settings compliance of servers in a group compute-ops/group a55c8b26-3c57-4044-a4ee-1d0e3c108286
URI PATH PREFIX RENAME

This API now supports the URI path prefix /compute-ops-mgmt which used to be /compute-ops. The old prefix will continue to be supported to allow for a smooth transition. The Guide contains more information about this change.

SecurityBearer
Request
header Parameters
Content-Type
required
string

Content-Type header must designate 'application/json' in order for the request to be performed.

Value: "application/json"
Tenant-Acid
string <uuid>

Tenant-Acid header can be used by an MSP workspace to make API calls on behalf of their tenant by specifying the tenant's application customer ID.

In order to make such an API call, the Bearer token must belong to an MSP workspace and this header value must be the application customer ID of a tenant within the MSP workspace. Use the /compute-ops-mgmt/v1beta1/accounts API to determine the application customer IDs for your tenant accounts.

Request Body schema: application/json
required

Job request

jobTemplateUri
required
string

Identifier of the job template for this job. Supports ID(aacfb3e0-6575-4d4f-a711-1ee1ae768407) in addition to URI(/compute-ops-mgmt/v1beta3/job-templates/aacfb3e0-6575-4d4f-a711-1ee1ae768407)

resourceUri
required
string

Reference to the resource to run this job on

object

Data needed for this job (based on the job schema)

Responses
200

Job data

400

Bad request

401

Unauthorized

403

Forbidden

406

Not acceptable

415

Unsupported media type

500

Internal server error

Request samples
application/json
{
  • "jobTemplateUri": "/compute-ops-mgmt/v1beta3/job-templates/aacfb3e0-6575-4d4f-a711-1ee1ae768407",
  • "resourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
  • "data": {
    }
}
Response samples
application/json
{
  • "id": "2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  • "parentJobId": "284f3b7a-7a17-4f0a-9b40-a51bc887c7d0",
  • "type": "compute-ops-mgmt/job",
  • "resourceUri": "/compute-ops-mgmt/v1beta3/jobs/2500759c-b7dd-4c68-ab7e-6b644bcf4b9c",
  • "name": "FirmwareUpdate.New",
  • "generation": 9,
  • "deleteOnComplete": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
  • "associatedResourceUri": "/compute-ops-mgmt/v1beta2/servers/744674-N19+8899744674319686",
  • "resource": {
    },
  • "data": {
    },
  • "jobParams": {
    },
  • "results": {
    },
  • "state": "PENDING",
  • "resultCode": { },
  • "status": "string",
  • "statusDetails": { }
}