Restore library configuration

Edit online

Restores the library configuration by using the library configuration data exported earlier from the same library.

If you are restoring the configuration from a saved configuration file that was exported by the CLI, the entire file contents can be sent down as the binary data for this action.

If you are restoring from a saved configuration that was exported from the saveConfig REST command, ensure that only the binary data, and not the header information is included in the binary data for this action.

The following guidelines for restoring configuration should be followed:
  1. Restore back to original library.
  2. Restore to the same code level that the save file was taken on.

The library will be restarted after this command completes successfully. While a REST API response will always be created, the SCSI Read Buffer method of querying for that response will not necessarily occur before the library restart has begun. After restarting, the library status should be monitored until online.

After the library comes back online, an inventory of all tiers should be run if any moves have occurred since the configuration was saved. A recalibration might be required if any hardware was serviced during this time. If an NTP server is not in use, then a restart of the library time or date might be needed as well.

The Content-Length HTTP header is required for this command when sent by using REST over SCSI so that the library can ensure that all data is transferred properly.

Request syntax

POST /v1/library/restoreConfigContent-Type: application/octet-streamContent-Length: <length of file><binary file data>
Restores the library configuration by using a library configuration data exported earlier from the same library.

Request body parameters

binary file data (octet-stream)

The contents of the saved configuration file that was exported from the CLI using the saveConfiguration command or the binary (not header) part of the data that is returned by thesaveConfig REST command.

Example

> POST /v1/library/restoreConfig
Content-Type: application/octet-stream
Content-Length: 4068268556
<binary file data>
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

  • Returns 415 Unsupported Media Type if the Content-Type header is not application or octet-stream.
  • Returns 400 Bad Request if the Content-Length HTTP header is not included.
  • Returns 500 Internal Server Error if the library configuration could not be restored with a message describing why.