Get library

Request syntax

Example

> GET /v1/library
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 693

[
     {
          "name": "RASFW_LIB", 
          "status": "online", 
          "cartridgeAccess": "normal",
          "totalCapacity": 2978, 
          "licensedCapacity": 1000, 
          "totalCartridges": 346, 
          "assignedCartridges": 100, 
          "firmware": "1.8.0.2-A00", 
          "sn": "13FA057", 
          "mtm": "3584-L55",
          "time": "2022-01-28T12:10:46-0700",
          "timezone": "Europe/London";
          "ntpMode": "enabled",
          "primaryNtpAddress": "time-a-g.nist.gov",
          "secondaryNtpAddress": "time-b-g.nist.gov",
          "location": "Firmware Lab", 
          "address": "9000 S Rita Rd", 
          "city": "Tucson", 
          "state": "AZ", 
          "country": "USA", 
          "contact": "Kevin Elliott", 
          "telephone": "222-333-3333", 
          "secondaryTelephone": "222-333-3333", 
          "secureCommunications": "enabled", 
          "autoEjectCleaningCartridges": "enabled", 
          "elasticCapacity": "disabled", 
          "activeAccessors": null, 
          "vioStatus": "enabled", 
          "nmaDetection": "enabled", 
          "capacityUtilThresh": 98.0, 
          "dualAccessorUtilThresh": 80.0,
          "requestDoorOpenStatus": "safeToOpen"
     }
]

Attributes

name (string)

The name the tape library was given.

status (string)

The health status of the library. Values include:

Table 1.

State	Description
unknown	The state recorded by firmware for this resource is unknown. Reset the LCC node card and contact IBM for support if issue persists.
doorOpenWhileNotAllowed	A library door is open while the cooling light indicated that this is dangerous to do so. This might cause condensation on the cartridges or drive. Close all the library doors.
notConfigured	The library is not configured. The initial setup wizard on the IMC should be run.
doorOpen	A library front door is open. No cartridge movement is allowed, and all accessors are powered down. This is not applicable to a side door that was opened for dual accessor service. See accessor state inServiceMode.
overTemperature	The library is over temperature and is disabling components to avoid damage. For Climate-Controlled Diamondback: Open all doors to exhaust heat and contact IBM for Support.
initializing	Initialization is in progress. This does not affect drive read pr write activity, but no cartridge movement will be processed.
inServiceMode	The library is offline for service. This does not affect drive read/write activity, but no cartridge movement will be processed.
accessorsUnavailable	All accessors within the library are unavailable to move cartridges within the library. This includes accessor states inServiceMode, noMovementAllowed, failedToInitialize, and bothGrippersFailed. The accessors being offline due to door open is handled by the doorOpen library state.
calibrationRequired	One or more frames is in the calibrationRequired state.
accessorDegraded	TS4500 dual accessor only One or more accessors are degraded and cartridge movement within the library will be slower as a result. See accessor state scannerFailed, gripperXfailed, and all unavailable states where one accessor is not able to move cartridges in dual accessor environment.
nodeCardDegraded	One or more node cards are having issues communicating with other node cards or managing the library. See node card states, unreachable, noEthernet inServiceMode, and noCAN.
driveDegraded	One or more drives are detecting errors, causing issues with communication or cartridge read/write operations. See drive state inServiceMode.
cartridgeDegraded	One or more cartridges have been shown to have issues which might affect its ability to store data. See cartridge state cartridgeFailedMove, errorThresholdExceeded, failedVerification.
preparingForDoorOpen	Preparing the library so it is safe to open doors without creating condensation.
updating	Firmware update is in progress.
pausing	TS4500 only The Pause button was pressed so the library can be gracefully shut down before opening doors or powering off the library. The library will process current queued cartridge movement operations and then move the accessors to the home position.
paused	TS4500 only The library is paused for 60 seconds or until a door is opened, or the library is powered down. The accessors have been moved to the home position, and the library doors are ready to be opened or the library powered down. New cartridge movement requests will be queued in case the 60 second timer expires.
scanningInventory	A user-initiated inventory is in progress. Cartridge movement can be processed normally.
online	The library status is normal.

cartridgeAccess (string)

Indicates whether the accessor can access the cartridge or not.

In the case of a single-accessor library, this attribute is normal when the accessor is in a state that allows it to access the cartridges of the library. Otherwise, limited is reported. In the case of a dual-accessor library, this attribute also depends on the state of the other accessor. If the other accessor is in the noMovementAllowed state and in a position that blocks this accessor from reaching cartridges that it can normally access given the LibraryelasticCapacity setting, a value of limited is reported.

totalCapacity (number)

The total physical cartridge capacity of the library. This includes all tiers in all the slots capable of holding cartridges. This does not include I/O slots in the I/O station magazine or drives where cartridges can be mounted. This is same regardless of the licensedCapacity of the library.

licensedCapacity (number)

The total licensed cartridge capacity of the library. This only applies to data cartridges as it can be thought of as assignable (or host viewable) capacity.

totalCartridges (number)

The total number of cartridges in the library slots, I/O stations, drives, and accessors. This includes all cleaning, diagnostic, and data cartridges.

assignedCartridges (number)

The total number of cartridges that are assigned to the logical libraries in the library.

firmware (string)

The firmware level installed on the library.

sn (string)

The globally unique serial number of the library

time (string)

The current date and time set on the library. Time format is YYYY-MM-DDThh:mm:ss±hh:mm.

timezone (string)

The time zone used when fetching the data and time from a network time protocol (NTP) server, or if the date and time were set manually for the library.

ntpMode (string)

This is enabled if the NTP servers are being used to set the date/time or disabled if the date/time is set manually.

primaryNtpAddress (string)

The unique host name or IP address of the primary NTP server. If not set, this is null.

secondaryNtpAddress (string)

The unique host name or IP address of the secondary NTP server. If not set, this is null.

location (string)

The user-entered physical location of the library. If not provided, this is null.

address (string)

The user-entered physical address of the library. If not provided, this is null.

city (string)

The user-entered city in which the library is located. If not provided, this is null.

state (string)

The user-entered two-character state in which the library is located. If not provided, this is null.

country (string)

The user-entered country in which the library is located. If not provided, this is null.

contact (string)

The name of the primary contact for the tape library. This is used by IBM Support during repair and service. If not provided, this is null.

telephone (string)

The primary telephone number for the primary contact. This is used by IBM Support during repair and service. If not provided, this is null.

secondaryTelephone (string)

The secondary telephone number for the primary contact. This is used by IBM Support during repair and service. If not provided, this is null.

secureCommunications (string)

The current setting for secure communications. If enabled, the user is required to log in to the GUI by using a secure HTTPS connection. If disabled, an unsecured HTTP connection is allowed. For Diamondback, this cannot be modified by the user and always returns enabled.

autoEjectCleaningCartridges (string)

The current setting for automatically ejecting cleaning cartridges to the I/O station. If enabled, cleaning cartridges are auto-ejected from the library when they have no cleans remaining. If disabled, they must be ejected manually.

elasticCapacity (string)

The current setting for elastic capacity. Values include maxCapacity, tempOverflow, and doNotUse.

For Diamondback, this is not supported and returns null.

activeAccessors (string)

Indicates which accessors are currently active. Values include dualActive, accessorAOnly, and accessorBOnly.

For Diamondback and single accessor TS4500 libraries, this returns null.

vioStatus (string)

The current setting for Virtual I/O (VIO). If VIO is enabled, the maximum VIO cartridge value for a logical library can be increased. This value cannot be modified by the user and always returns enabled for both TS4500 and Diamondback.

nmaDetection (string)

The current setting for NMA detection. This value cannot be modified by the user and always returns enabled for both TS4500 and Diamondback.

capacityUtilThresh (number)

A user modifiable percentage value accurate to one decimal place. If the totalCartridges is over the capacityUtilThreshold of filling the totalCaapcity, an event and warnings will trigger. The default is 98.3% for Diamondback and 99.0% for TS4500.

dualAccessorUtilThresh (number)

A percentage value accurate to one decimal place. The cartridge capacity threshold at which cartridges are moved to accessor service areas in the end frames for a dual-accessor library that has elastic capacity enabled. If the cartridge capacity of the area of the library that both accessors can reach gets higher than this percentage, cartridges will start to be placed in the elastic capacity areas where only a single accessor can reach them. The default is 98.0%. For single accessor libraries or libraries that do not have elastic capacity enabled, this returns null.

requestDoorOpenStatus (string)

The status of a door open request on a library that has an AC unit. If the library does not have an AC unit or this is an IBM TS4500 tape library, null is returned. Otherwise, this is one of "safeToOpen" when the doors are safe to open; "notSafeToOpen" when the doors are not safe to open and no AC door open request is pending; or one of "preparingForDoorOpen30min", "preparingForDoorOpen15min", and "preparingForDoorOpen5min" when a door open request is pending and the doors should not be opened.