Prepare for ship

Issued before physical shipment of the library to ensure cartridges, drives, and other library components are in a safe state during this process.

The following steps are performed to ensure the library is prepared for shipment.
  • Ensure that there are enough cartridges to ensure the populated slots are full. For example, for Diamondback, there should be an even multiple of 9 LTO cartridges so that, when the cartridges are consolidated, all populated slots are full.
  • Move cartridges such that none are left in I/O stations or drives and try to consolidate them into fully populated slots while maintaining balance of weight across library.
  • Set frame to the calibrationRequired state. A calibration of the library is required after the library is powered on for the first time.

After the library is powered on for the first time after this command is run, the library must be calibrated so that it can exit the calibrationRequired state, and automatically run a Tier 1 inventory.

Request syntax

POST /v1/library/prepareForShip
Issued before physical shipment of the library to ensure cartridges, drives, and other library components are in a safe state during this process.

Example

> POST /v1/library/prepareForShip
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0

Error handling

  • Returns 500 Server Error if there is no combination of populated slots that will ensure that there are no partially full slot remaining after cartridges are consolidated.
  • Returns 501 Bad Request if this is a TS4500 library.