Server Firmware Update Job

Overview

This job can be used to update the firmware on a server.

Job Template ID Resource Type Data
fd54a96c-cabc-42e3-aee3-374a2d009dba compute-ops-mgmt/server See Data section

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

Data properties marked with a * are required.

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 Description Required?
bundle_id string (uuid) Firmware Bundle UUID Yes
downgrade boolean Controls Firmware update downgrade option No
install_sw_drivers boolean Controls HPE drivers and software installation No
power_off boolean Power off server after firmware update No
prerequisite_check boolean Prerequisites check before firmware update No

Data properties

  • bundle_id : This required property is the firmware bundle UUID that should be used for the firmware update.
    • The firmware bundle UUID can be obtained using GET /compute-ops-mgmt/v1beta2/firmware-bundles and looking at the id property in the response.
  • downgrade : This flag allows a downgrade of the firmware as part of the firmware update.
    • Default: false
  • install_sw_drivers : This flag determines if HPE drivers and software should be installed in the OS as part of the firmware update.
    • Default: false
  • power_off : 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.

Example

Here's an example request payload for creating this job.

Example 1

Use the specified firmware bundle to update a server.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/086856-F17+8899086856117487",
    "data": {
        "bundle_id": "de600c7f01e29f793f26ad91b31d96ce"
    }
}

Example 2

Use the specified firmware bundle to update a server and power off the server after firmware update.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/086856-F17+8899086856117487",
    "data": {
        "bundle_id": "de600c7f01e29f793f26ad91b31d96ce",
        "power_off" : true
    }
}

Example 3

Use the specified firmware bundle to update a server including HPE drivers and software.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/086856-F17+8899086856117487",
    "data": {
        "bundle_id": "de600c7f01e29f793f26ad91b31d96ce",
        "install_sw_drivers" : true
    }
}

Example 4

Use the specified firmware bundle to update a server and allow to downgrade the firmware

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/086856-F17+8899086856117487",
    "data": {
        "bundle_id": "de600c7f01e29f793f26ad91b31d96ce",
        "downgrade" : true
    }
}

Example 5

Use the specified firmware bundle to update a server with prerequisite check.

Copy
Copied
{
    "jobTemplateUri": "/compute-ops-mgmt/v1beta2/job-templates/fd54a96c-cabc-42e3-aee3-374a2d009dba",
    "resourceUri": "/compute-ops-mgmt/v1beta2/servers/086856-F17+8899086856117487",
    "data": {
        "bundle_id": "de600c7f01e29f793f26ad91b31d96ce",
        "prerequisite_check" : true
    }
}