Verify library

Edit online

Starts a test that runs cartridge movement tests to verify library health.

This allows an optional short read/write test of all drives. If individual drives need testing or more specific tests need run on the drives, use the “testDrive” task. Drive tests require the drives to be empty. If any drives are mounted at the time this option is used, the command will fail.

This test may take 5-10 minutes to run plus an additional 10 minutes for every drive tested.

Request syntax

POST /v1/tasks {"type": "verifyLibrary", "testDrives": <"all"|"none>, "accessor": "accessor_A<a|b>"} Starts a test that runs cartridge movement tests to verify library health.


Request body parameters

type (string, required)

The task type to run. In this case, verifyLibrary.

testDrives (string, optional)

Either “all” if all drives should be tested after the library verification completes, or “none” if no drive test should be performed. This defaults to “none”.

accessor (string, optional)

The location of the accessor to use during this test. If this is a single accessor library, this is not required.

Example

> POST /v1/tasks {"type": "verifyLibrary"}
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 10
{"ID": 42}

Error handling

  • Returns 400 Bad Request if the accessor location given is invalid.
  • Returns 422 Unprocessable Entry if any drives are mounted when using the "all" option for "test Drives".