Group Firmware Update Job

Overview

This job initiates a server group firmware update that will affect some or all of the server group members.

Note Firmware update is not supported on HPE Edgeline e920 server blades.

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:

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.

Data properties

• devices : This property is a list of server IDs to include in the server group firmware update. All devices in the list must belong to the group.
• parallel : This flag determines if the firmware updates to each device in the group should occur in parallel or not.
  • Default: false
• stopOnFailure : This flag is applicable for serial firmware updates (i.e. parallel: false ). It determines if the group firmware update process will continue after the first failure. If the flag is false , the update continues after a failure. If the flag is true , the update stops after a failure and the remaining devices in the group will not be updated.
  • Default: false
• downgrade : This flag allows a downgrade of the firmware as part of the firmware update.
  • Default: false
• installSWDrivers : This flag determines if HPE drivers and software should be installed in the OS as part of the firmware update.
  • Default: false
• powerOff : This flag determines if server needs to be powered off after firmware update.
  • Default: false
• prerequisite_check :This flag determines whether the prerequisites are checked before a firmware update.
  • Default: true
  • If the prerequisites check passed without recommendations, the firmware update proceeds.
  • If the prerequisites check fails with recommendations, the user must fix the reported issues to continue with the firmware update.

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:

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.

Input

This table summarizes the supported properties for input.

Input properties

• stopOnRequest : This flag is applicable for serial firmware updates (i.e. parallel: false ). It determines whether the firmware update has to be cancelled. If the flag is true , the ongoing firmware update will run to complete, however, the update is cancelled on all servers that have not started the update.

Examples

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

Example 1

Update firmware for all servers in a group.

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/04460955-6038-4339-ba72-c9b05a03876e",
}

Example 2

Update firmware for two servers in a group in parallel.

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "parallel": true
    }
}

Example 3

Update firmware for two servers in a group and power off them after firmware update.

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "parallel": true,
        "powerOff": true
    }
}

Example 4

Update firmware for two servers in a group including HPE drivers and software.

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "installSWDrivers": true
    }
}

Example 5

Update firmware for two servers in a group and allow to downgrade the firmware.

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "downgrade": true
    }
}

Example 6

Update firmware for two servers in a group with a prerequisite check.

{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/91159b5e-9eeb-11ec-a9da-00155dc0a0c0",
    "resourceUri": "/compute-ops-mgmt/v1beta2/groups/a3853ee1-da05-47d6-bcc4-d35244d59605",
    "data": {
        "devices": [
            "063573-L08+8899063573208133",
             "855308-N51+8899855308351678"
        ],
        "prerequisite_check": true
    }
}

An example of patching this job

Example 7

Cancel the ongoing group firmware update job triggered with the serial option.

Patch the ongoing group firmware update job triggered with serial option (ie parallel=false) with the following option.

{
    "input": {
        "stopOnRequest": true
    }
}