List Remote Firmware Updates of the Console

The List Remote Firmware Updates of the Console operation returns a list of the remote firmware update operations on a Console.

HTTP method and URI

GET /api/console/remote-firmware-updates

Query Parameters

Name Type Rqd/Opt Description
state String Enum Optional Filter string to limit returned objects to those that have a matching state property.

Value must be a valid Remote Firmware Update element object state property value.

Response body contents

On successful completion, the response body contains a JSON object with the following fields:

Field name Type Description
remote-firmware-updates Array of remote-firmware-update-info objects A list of the remote firmware update operations scheduled on the console. Each element in the list is a remote-firmware-update-info nested object defined in Table 1.
remote-firmware-update-tokens Array of remote-firmware-update-token-info objects A list of remote firmware update token information. Each element in the list is a remote-firmware-update-token-info nested object defined in Table 2.

Each nested remote-firmware-update-info object contains the following fields:

Table 1. List Remote Firmware Updates of the Console: remote-firmware-update-info objects
Field name Type Description
element-uri String/ URI Canonical URI path (element-uri) of the Remote Firmware Update element object.
scheduled-execution-time Timestamp The scheduled-execution-time property of the Remote Firmware Update element object.
target-bundle String The target-bundle property of the Remote Firmware Update element object.
state String Enum The state property of the Remote Firmware Update element object.

Each nested remote-firmware-update-token-info object contains the following fields:

Table 2. List Remote Firmware Updates of the Console: remote-firmware-update-token-info objects
Field name Type Description
authorization-token String (6-8) The authorization token value
expiration-date Timestamp The date and time at which this token expires and can no longer be used to create a new remote firmware update.

Description

The List Remote Firmware Updates of the Console operation returns a list of the remote firmware update operations that are scheduled to run at a future time on a Console, or were scheduled and are currently running. The Remote Firmware Update Console Element URI, scheduled execution start time, bundle level and current state are returned for each.

The operation also returns a list of information about the authorization tokens that are currently defined on the Console. The authorization token value and expiration date are returned for each.

See Authorize Remote Firmware Updates for a description of the complete remote firmware update process.

If the state query parameter is specified, it is validated to ensure it is a valid value for the Remote Firmware Update Console Element state property. If the value is not valid, a 400 (Bad Request) is returned. If the value is valid, the returned list is limited to those remote firmware updates that have a matching state property. If the state parameter is omitted, this filtering is not done.

If no remote firmware updates are to be included in the results due to filtering or lack of any remote firmware updates, an empty list is provided and the operation completes successfully. If no remote firmware update tokens exist, an empty list is provided and the operation completes successfully.

Authorization requirements

This operation has the following authorization requirement:
  • Action/task permission to the Manage Remote Firmware Updates task.

HTTP status and reason codes

On success, HTTP status code 200 (OK) is returned and the response body is provided as described in Response body contents.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

Table 3. List Remote Firmware Updates of the Console: HTTP status and reason codes
HTTP error status code Reason code Description
400 (Bad Request) Various Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.
14 A query parameter defines and invalid value.
403 (Forbidden) 1 The API user does not have action/task permission to the Manage Remote Firmware Updates task.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. List Remote Firmware Updates of the Console: Request
GET /api/console/remote-firmware-updates HTTP/1.1
x-api-session: 3ay4lwilrq0obc6cpxoi2449ddfry3fr2k99xmm41qqo5ut221
Figure 2. List Remote Firmware Updates of the Console: Response
200 OK
server: Hardware management console API web server / 2.0
cache-control: no-cache
date: Fri, 19 Feb 2021 17:51:07 GMT
content-type: application/json;charset=UTF-8
content-length: 547
{
   "remote-firmware-update-tokens":[
      {
         "authorization-token":"736466C5",
         "expiration-date":1614294535719
      },
      {
         "authorization-token":"7993D9ED",
         "expiration-date":1614303108266
      }
   ],
   "remote-firmware-updates":[
      {
         "element-uri":"/api/console/remote-firmware-updates/de52dc87-adb4-4cba-a8c7-
           cb1c4516f495",
         "scheduled-execution-time":1614924900000,
         "state":"scheduled",
         "target-bundle":"H33"
      },
      {
         "element-uri":"/api/console/remote-firmware-updates/97add8d4-d1de-4f91-
           aa80-89e5d5ca5b50",
         "scheduled-execution-time":1615011300000,
         "state":"scheduled",
         "target-bundle":"H34"
      }
   ]
}