Get drives

Edit online

Retrieves information about the drives in the library.

Request syntax

GET /v1/drives
Retrieves information about all drives in the tape library.

GET /v1/drives/<location>
Retrieves information about the drive in the specified location.

GET /v1/drives/<sn>
Retrieves information about the drive with the specified serial number.

Path parameters

location (string): The unique location of the drive.
sn (string): The globally unique serial number of the drive.

Example

> GET /v1/drives
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1907

[
     {
          "location": "drive_F2C4R2", 
          "sn": "60441355FD", 
          "mediaType": "3592", 
          "state": "online",
          "operation": "loading",
          "accessible": "normal"
          "mtm": "3592-EH7", 
          "barcode": "11S00VJ876Y81013000124",
          "interface": "SAS", 
          "interfaceMode": null, 
          "logicalLibrary": "JAGTEST", 
          "use": "controlPath", 
          "firmware": "3A88", 
          "encryption": "disabled", 
          "wwnn": "50050760441355fd", 
          "elementAddress": 257,
          "beacon": "disabled",
          "volser": "SG1353L2",
          "lastCleaned": null
     }, {
          "location": "drive_F3C2R1", 
          "sn": "00078A3444", 
          "mediaType": "LTO", 
          "state": "online",
          "operation": "unloading",
          "accessible": "normal" 
          "barcode": "11S00VJ876Y81013000125",
          "mtm": "3588-F5C", 
          "interface": "fibreChannel", 
          "interfaceMode": "multi-mode", 
          "logicalLibrary": "LTOGU", 
          "use": "verification", 
          "firmware": "H8AF", 
          "encryption": "enabled", 
          "wwnn": "5005076044135504", 
          "elementAddress": 448,
          "beacon": "disabled",
          "volser": null,
          "lastCleaned": "2022-01-28T12:10:46-0700"

     }, {
          .   .   .
     }
]

Attributes

location (string)

The unique location of the drive.

sn (string)

The globally unique serial number of the drive.

For TS4500, if a drive is replaced, the sn of the replaced drive will match this one. For Diamondback, the serial number is based on the wwnn and does not change.

mediaType (string)

The media type of the cartridge. Supported values include 3592 and LTO.

state (string)

The health status of the tape drive. Values include the following in priority order:

State	Description
`unknown`	LCC Node Card that is associated with this drive might be unreachable or the state that is recorded by firmware for this resource is unknown. Reset the associated LCC node card and contact IBM for support if issue persists.
`inServiceMode`	The drive is offline for service. The drive is not online to the SCSI interface for data path or control path commands. Any commands for mounting a data cartridge to this drive that is coming through a different control path will be rejected.
`restarting`	A library-controlled reset, such as a firmware update or manual reset, is in progress.
`initializing`	The drive has answered network ping from the library but is not fully logged in to the library yet. This includes drive reset scenarios that are not initiated by the library.
`unreachable`	The drive has not answered network ping from library for over two minutes. The drive may be responding to the SCSI commands, but it is not reachable by the library. The drive is still eligible for mount or unmount activity. A power cycle reset (`POST /v1/drives/<location>/reset {mode:hard}`) is recommended for this drive if the drive is also not responding to SCSI commands. Ports that are contained in this drive will no longer have their state updated while the drive is in this state.
`resetRequired`	The control path drive firmware was updated. A drive reset (`POST /v1/drives/<location>/reset {mode:normal}`) is now required to activate the new firmware level. This state is displayed only for control path drives as the non-control path drives are restarted automatically after firmware update.
`updating`	The drive firmware is being updated.
`cleaning`	Drive cleaning is in progress.
`online`	The drive is communicating with the library and reporting that it is responding to SCSI commands. See the `operation` attribute for details about the operation being performed while in this state.

operation (string)

The current operation that the tape drive is performing. Values include the following in order of priority:

Operation	Description
`null`	The drive is not online.
`empty`	No cartridge is present.
`loading`	Cartridge is loading and doing initial optimization after first mount.
`ready`	Cartridge is loaded and ready for host operations.
`unloading`	Cartridge is unloading after eject.
`unloaded`	Cartridge is ejected but still present.

accessible (string)

Indicates whether the cartridge is accessible by all accessors or not. Values include normal when all installed accessors have normal access to the cartridge as defined by the elastic capacity library setting, limited when one accessor in a dual-accessor library is unable to reach the cartridge due to errors, and no when none of the installed accessors can reach the drive due to errors.

Table 1.
Accessible	Description
`normal`	When all installed accessors have normal access to the cartridge as defined by the elastic capacity library setting,
`limited`	When one accessor in a dual-accessor library is unable to reach the cartridge due to errors,
`no`	When none of the installed accessors can reach the drive due to errors.

mtm (string)

The machine type and model of the tape drive. For Diamondback, this is null.

barcode (string)

The 11S bar code label found on the tape drive. This is a 22-character string with the following format:

interface (string)

The type of ports this tape drive includes. Values include fibreChannel, iSCSI, and SAS.

interfaceMode (string)

The interface mode that is supported by the ports this tape drive includes. Values include single-mode for single-mode fiber and multi-mode for multi-mode fiber. If the interface type is SAS, this is null.

logicalLibrary (string)

The name of the logical library this tape drive has been assigned to. If it is not assigned to a logical library, this is null.

use (string)

The assigned use of the tape drive within the logical library. Values include:

Use	Description
`access`	Data access drives.
`controlPath`	Data access and control path drives.
`verification`	Media verification drives.

firmware (string)

The firmware version installed on the tape drive.

encryption (string)

The state of encryption on this tape drive. Values include enabled and disabled.

wwnn (string)

The worldwide node name of the tape drive represented by a 16-character hex string.

elementAddress (number)

The SCSI element address of the cartridge drive. This value is reported to hosts via the Read Element Status SCSI command. This is null if not yet reported to the host.

beacon (string)

The state of the drive beacon LED. Values include enabled (LED is flashing) and disabled (LED is off).

volser (string)

The VOLSER of the cartridge that is mounted in the tape drive. This is null if the tape drive does not have a cartridge mounted or the currently loaded cartridge’s VOLSER is unknown.

lastCleaned (string)

The last date and time the drive was cleaned. If no cleaning was recorded, this is null. Time format is YYYY-MM-DDThh:mm:ss±hh:mm