Authorize Remote Firmware Updates
The Authorize Remote Firmware Updates operation returns a token that allows a service representative to remotely schedule a firmware update.
HTTP method and URI
POST /api/console/operations/authorize-remote-firmware-updates
Response body contents
On successful completion, the response body contains a JSON object with the following fields:
Field name | Type | Description |
---|---|---|
authorization-token | String (6-8) | The authorization token that a service representative will need to remotely schedule a firmware update. |
expiration-date | Timestamp | The date and time at which the token expires and can no longer be used to create a new remote firmware update. |
Description
The Authorize Remote Firmware Updates operation returns a token that allows a service representative to remotely schedule a firmware update to run at a future time. By invoking this operation and giving the returned token to a service representative, the user is authorizing that service representative to remotely create scheduled operations through a Resource Link® interface that will update the firmware on the Console, or any of the CPCs that it manages. At the scheduled update time, a job will be started on the targeted console or CPC that will update its firmware. The service representative will remotely check the results of that operation and take appropriate actions if the update was not successful.
Authorization tokens are valid for 7 days after they are created. After that point, a service representative will no longer be able to use the token to create new remote firmware updates. Note that the expiration of an authorization token does not affect firmware updates that have already been scheduled using that token. They will run at the scheduled time unless explicitly deleted.
The set of remote firmware update operations that have been created by service representatives can be queried using the List Remote Firmware Updates of a Console and List Remote Firmware Updates of a CPC operations. Additional details about an individual operation can be retrieved using the Get Console Remote Firmware Update Properties and Get CPC Remote Firmware Update Properties operations. Individual scheduled operations can be deleted using the Delete Console Remote Firmware Update and Delete CPC Remote Firmware Update operations.
If the API user does not have action/task permission to the Generate Token task, a 403 (Forbidden) status code is returned. A 409 (Conflict) is returned if a Support System connection is not configured on the target console.
If the request is valid, a new authorization token is generated and returned as the value of the authorization-token field in the response body.
Authorization requirements
- Action/task permission to the Generate Token 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.
Otherwise, 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.
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. |
403 (Forbidden) | 1 | The API user does not have action/task permission to the Generate Token task. |
409 (Conflict) | 341 | The Console is not configured to connect to the Support System. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.