Get frames

Request syntax

Path parameters

location (string)

The unique location of the frame.

Example

> GET /v1/frames

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992
			
[
    {
       "location": "frame_F1",
       "state": "normal",
       "type": "storageOnlyExpansion",
       "mtm": "3584-S24",
       "sn": "13FA050",
       "mediaType": "LTO",
       "frontDoor": "closed",
       "frontDoorLastChanged": "2020-09-17T23:02:00-0700",
       "rearDoor": "closed",
       "rearDoorLastChanged": "2020-09-16T23:04:00-0700",
       "sideDoor": "closed",
       "sideDoorLastChanged": "2020-09-16T23:04:30-0700",
       "slots": 990,
       "cartridges": 983,
       "drives": 3,
       "ioStations": 2
    }, {
	   . . .
    }
]
			

Attributes

location (string)

The unique location of the frame.

state (string)

The health status of the frame. The following values are included in order of priority:

State	Description
unknown	The state recorded by firmware for this resource is unknown. Reset the associated LCC node card and contact IBM for support if issue persists.
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	The calibration status of this frame is in question. Initiate a calibrateFrame task on this frame.
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 (string)

The type of frame. Values include the following:

• base
• expansion
• storageOnlyExpansion

For Diamondback, base is the only supported value.

mtm (string)

The machine type and model of this frame. For information on frame models, see frame models.

sn (string)

A globally unique serial number of the frame.

mediaType (string)

The media type that is supported by the frame. Supported values include 3592 and LTO .

frontDoor (string)

The state of the front door of the frame. Supported values include open or closed.

frontDoorLastChanged (string)

The last time the front door of the frame was either opened or closed. This value is null before any state change.

rearDoor (string)

The state of the rear door of the frame. Supported values include open or closed. If rear door sensors are not installed, null is returned.

rearDoorLastChanged (string)

The last time the rear door of the frame was either opened or closed. This value is null before any state change.

sideDoor (string)

The state of the side door of the frame. Supported values include open or closed. If there is no side door, null is returned.

In a single frame TS4500 tape library, this shows the state of both side doors where null is shown if one or more doors is open. For Diamondback, there is no side door and this value is null.

sideDoorLastChanged (string)

The last time the side door of the frame was either opened or closed. This value is null before any state change. For Diamondback, there is no side door and this value is null.

slots (number)

The number of cartridges that can be stored in this frame. For high density slots, this is equal to the number of tiers within the library.

cartridges (number)

The number of cartridges currently stored in this frame.

drives (number)

The number of drives that are installed in this frame.

ioStations (number)

The number of I/O stations that are installed in this frame.