Group Operating System Installation Job

Overview

This job initiates a server group operating system installation that will affect some or all of the server group members.

Job Template ID Resource Type Data
e2952628-2629-4088-93db-91742304ef0c compute-ops-mgmt/group See Data section

Note Before initiating the group operating system installation job, run the Analyze server configuration for operating system installation API to validate the presence of at least one storage volume on the server. If the server does not have any storage volumes, failing to run this API will lead to the failure of the OS installation job.

Create Job

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

The following properties are used when creating a job:

Property JSON Type Description Required?
jobTemplateUri string (uri) A job-template URI with the durable Template ID of the job Yes
resourceUri string (uri) A resource URI that the job will operate on Yes
data object Any additional data required by the job No

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.

Data

This table summarizes the supported properties in data.

Property JSON Type Values Required?
devices array List of server IDs No
parallel boolean Perform server OS installation in parallel No
stopOnFailure boolean Stop after the first server OS installation failure No
osCompletionTimeoutMin integer Amount of time (minutes) that Compute Ops Management waits before automatically marking an OS installation job complete No

Data properties

  • devices : This property is a list of server IDs to include in the server group Operating system installation. If specified, this non-empty list of server IDs limits the scope of the operation to the specified servers in the group. If left unspecified, all servers in the group are targeted.
  • parallel : This flag determines if the operating system installation to each device in the group should occur in parallel or not.
    • Default: true
  • stopOnFailure : This flag is applicable for serial operating system installation (i.e. parallel: false ). It determines if the group operating system installation process will continue after the first failure. If the flag is false , the installation continues after a failure. If the flag is true , the installation stops after a failure and the remaining devices in the group will not undergo operating system installation.
    • Default: false
  • osCompletionTimeoutMin : This property determines the amount of time (minutes) that Compute Ops Management waits before automatically marking an OS installation job complete. The operating system image is then unmounted from the server. The specified timeout value applies to each server group member.
    • Default: 240
    • Minimum: 60
    • Maximum: 720

Patch Job

A job can be patched by issuing a PATCH to the /compute-ops-mgmt/v1beta3/jobs/<job-id> endpoint with the correct payload for the job.

The following property is used when patching a job:

Property JSON Type Description
input object Any input data required by the job.

If the job was patched successfully, a 200 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.

Examples

Here are a couple of example request payloads for creating this job.

Example 1

Operating system installation for all servers in a group.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/e2952628-2629-4088-93db-91742304ef0c",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/04460955-6038-4339-ba72-c9b05a03876e",
}

Example 2

Operating system installation for two servers in a group in parallel.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/e2952628-2629-4088-93db-91742304ef0c",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "parallel": true
    }
}

Example 3

Operating system installation for two servers in a group in serial.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/e2952628-2629-4088-93db-91742304ef0c",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "parallel": false
    }
}

Example 4

Operating system installation for two servers in a group with the timeout value set to 200 minutes.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/e2952628-2629-4088-93db-91742304ef0c",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "parallel": true,
        "osCompletionTimeoutMin": 200
    }
}