Go to main content

Oracle® ILOM Web Service REST API

Exit Print View

Updated: December 2019
 
 

Upload Backup Image for Deferred Installation - Using REST API

The process to upload a backup image for deferred installation involves the following three steps:

Step 1: Upload a Backup Firmware Package to SP

Use a POST request to upload a firmware package to the SP as a backup image.

HTTP Request Format

POST /rest/v<version>/SP/firmware/backupimage/update HTTP/1.1
<Header Name>: <Value>

<request body>

Where:

  • The <Request body> contains the package file contents in a multi-part data form format.


Note -  The backup image remains in a pending state until it is activated for installation. To active the backup image for immediate installation using the Oracle ILOM web interface or CLI, see Activate Firmware Backup Image for Immediate Installation in Oracle ILOM Administrator’s Guide for Configuration and Maintenance Firmware Release 5.0.x.

Request Headers Required

The following request headers are required to post the backup firmware package on the SP.

  • Accept header – The Accept: header must specify the value of application/json or a superset of application/json.

  • Content-Type header – The Content-Type: header must specify the value of multipart/form-data.


    Note -  Some tools such as cURL provide the Content-Type and file contents when the user supplies the file path.
  • Other headers– Authentication and Host headers are required. For a description of these headers, see Common Request Header Fields.

Step 2: Store Posted Backup Image As a Secondary Image

Use a PATCH request to place the posted backup firmware image on the SP in the secondary storage bank.

HTTP Request Format

PATCH /rest/v<version>/SP/firmware/backupimage/update/1 HTTP/1.1
<Header Name>: <Value>

{
"start": true
}

Where:

  • "start": true updates the secondary storage bank on the SP with the posted backup image.


Note -  The backup image remains in a pending state until it is activated for installation. To active the backup image for immediate installation using the Oracle ILOM web interface or CLI, see Activate Firmware Backup Image for Immediate Installation in Oracle ILOM Administrator’s Guide for Configuration and Maintenance Firmware Release 5.0.x.

Request Headers Required

The request header fields required to update a resource are as follows: Content-Type, Accept, Authorization, and Host.

For a description of these required header fields, see Common Request Header Fields.

Step 3: Verify Backup Operations Succeeded for Steps 1 and 2

Use a GET request to verify the backup operations for Steps 1 and 2 succeeded.

HTTP Request Format

GET /rest/v<version>/SP/firmware/backupimage/update/1/status HTTP/1.1
<Header Name>: <Value>

Note -  The backup image remains in a pending state until it is activated for installation. To active the backup image for immediate installation using the Oracle ILOM web interface or CLI, see Activate Firmware Backup Image for Immediate Installation in Oracle ILOM Administrator’s Guide for Configuration and Maintenance Firmware Release 5.0.x.

Request Headers Required

The request header fields required to retrieve the status of the backup operations performed in Steps 1 and 2 are as follows: Accept, Authorization, and Host.

For a description of these required header fields, see Common Request Header Fields.

Response: Status Codes

  • Success: HTTP Status = 200 OK

  • Failure: HTTP Status = 4xx, 5xx

Response Body:


Note -  To identify the exact response body media type, refer to the Oracle ILOM Swagger Model (swagger.json) description. For more details, see Discovering Management Resources.
{
  "Target":"/rest/v<version>/SP/firmware/backupimage/update/1/status",
  "state":"<value>",
  "result":"<value>",
  "component":"<value>",
  "component_progress":"value>"
}