Get frame information

Request syntax

Path parameters

location

A string that represents the unique location of the frame in the library. The format is frame_F<f>, where f is the frame position.

cURL example

> GET /v1/frames
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992

[
     {
          "location": "frame_F1", 
          "state": "normal", 
          "type": "Storage-only expansion frame", 
          "mtm": "3584-S24", 
          "sn": "13FA050", 
          "mediaType": "LTO",
          "frontDoor": "closed",
          "frontDoorLastChanged": "2018-09-17T23:02:00",
          "rearDoor": "closed",
          "rearDoorLastChanged": "2018-09-16T23:04:00",
          "sideDoor": "closed",
          "sideDoorLastChanged": "2018-09-16T23:04:30",
          "slots": 990,
          "cartridges": 983,
          "drives": 3,
          "ioStations": 2
     }, {
          . . .
     }
]

Attribute summary

Attribute descriptions

location

A string that represents the unique location of the frame in the library. The format is frame_F<f>, where f is the frame position.

state

A string that represents the current state of the frame. The following values are included in order of priority:

State	Description
frontDoorOpenWhileNotAllowed	The front door was opened while the AC light indicated it is not safe.
acUnreachable	The AC unit is not communicating with the library.
calibrationRequired	When the library determines that the calibration status of this frame is in question, this state is surfaced.
inventoryPending	The inventory of this frame is in question. After a door is closed on this frame or the system is restarted, the library queues an inventory of this frame. If the library is unable to complete the inventory action, service might be required.
normal	The frame has no reported errors.

type

A string describing the type of frame. Values include the following:

• Base frame
• Expansion frame
• Storage-only expansion frame

mtm

A string representing the machine type and model of this frame.

Frame MTM	Type	Media type	Capacity		Other
			Frame 1	Frame 2+
3584-L25	Base frame	3592	Up to 12 drives and 550 slots	Up to 16 drives and 660 slots	Equipped with two 16-slot I/O stations Optionally equipped with top rack (Model TR1)
3584-L55	Base frame	LTO	Up to 12 drives and 730 slots	Up to 16 drives and 882 slots	Equipped with two 18-slot I/O stations Optionally equipped with top rack (Model TR1)
3584-D25	Expansion frame	3592	Up to 12 drives and 590 slots	Up to 16 drives and 740 slots	Optionally equipped with two 16-slot I/O stations Optionally equipped with top rack (Model TR1) Limited to any combination of seven D25 and D55 frames
3584-D55	Expansion frame	LTO	Up to 12 drives and 774 slots	Up to 16 drives and 970 slots	Optionally equipped with two 18-slot I/O stations Optionally equipped with top rack (Model TR1) Limited to any combination of seven D25 and D55 frames
3584-S25	Storage-only expansion frame	3592	798 slots	1000 slots	Optionally equipped with top rack (Model TR1)
3584-S55	Storage-only expansion frame	LTO	1054 slots	1320 slots	Optionally equipped with top rack (Model TR1)
3584-S24	Storage-only expansion frame	3592	Unsupported	1000 slots	Requires a TS4500 control upgrade Cannot be installed to the left of an Lx5 frame Cannot be installed as the rightmost frame in a dual accessor tape library
3584-S54	Storage-only expansion frame	LTO	Unsupported	1320 slots	Requires a TS4500 control upgrade Cannot be installed to the left of an Lx5 frame Cannot be installed as the rightmost frame in a dual accessor tape library

sn

A string that represents the unique serial number of the frame.

mediaType

A string that represents the media type that is supported by the tape drive. Supported values include 3592 and LTO.

frontDoor

A string that represents the state of the front door of the frame. The values that are returned are either “open” or “closed”.

frontDoorLastChanged

A string that represents the last time the front door of the frame was either opened or closed. This is null before any state change. The time format is in ISO 8601 format of YYYY-MM-DDThh:mm:ss+-hhmm or YYYY-MM-DDThh:mm:ss. For example, 2018-09-17T23:02:00.

rearDoor

A string that represents the state of the rear door of the frame. The values that are returned are either “open” or “closed”. In libraries, where rear door sensors are not installed, null is returned.

rearDoorLastChanged

A string that represents the last time the rear door of the frame was either opened or closed. In libraries, where rear door sensors are not installed, null is returned. This value is also null before any state change. The time format is in ISO 8601 format of YYYY-MM-DDThh:mm:ss+-hhmm or YYYY-MM-DDThh:mm:ss. For example, 2018-09-17T23:02:00.

sideDoor

A string that represents the state of the side door of the frame, if it is installed. The values that are returned are either “open” or “closed”. If there is no side door, null is returned.

sideDoorLastChanged

A string that represents the last time the side door of the frame was either opened or closed. If there is no side door, null is returned. The value is also null before any state change. The time format is in ISO 8601 format of YYYY-MM-DDThh:mm:ss+-hhmm or YYYY-MM-DDThh:mm:ss. For example, 2018-09-17T23:02:00.

slots

An integer that represents the number of available physical slots in this frame. This value might be different for a given frame type depending on if that frame is installed in position 1 or not.

cartridges

An integer that represents the number of cartridges currently in slots or drives in this frame.

drives

An integer that represents the number of drives that are installed in this frame.

ioStations

An integer that represents the number of I/O stations that are installed in this frame.