Get library information

Request syntax

cURL example

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

[
     {
          "name": "RASFW_LIB", 
          "status": "online", 
          "totalCapacity": 2978, 
          "licensedCapacity": 100, 
          "totalCartridges": 342, 
          "assignedCartridges": 100, 
          "firmware": "1.5.0.3-30E.L4", 
          "sn": "78BA497", 
          "time": "2019-04-03T11:33:37-0700", 
          "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": "Dual active", 
          "vioStatus": "enabled", 
          "nmaDetection": "enabled", 
          "capacityUtilThresh": 99, 
          "dualAccessorUtilThresh": 98
     }
]

Attribute summary

Attribute descriptions

name

A string representing the name the tape library was given.

status

A string representing the overall health status of the library. Values include:

Table 1.

State	Description
doorOpenWhileNotAllowed	A library door is open while the cooling light indicated that this is dangerous to do so. This may cause condensation on the cartridges or drive. Close all the library doors. See frame state frontdoorOpenWhileNotAllowed.
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.
pausing	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	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.
restarting	The library is restarting. This does not affect drive read or 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. See accessor states inServiceMode, noMovementAllowed, and bothGrippersFailed. Note: Accessors being offline due to door open is handled by the doorOpen library state above.
accessorDegraded	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.
fcPortUnavailable	One or more Fibre Channel drive ports are not available.
cartridgeDegraded	One or more cartridges have been shown to have issues which may affect its ability to store data. See cartridge state cartridgeFailedMove, errorThresholdExceeded, failedVerification.
updating	The library is in the process of updating firmware.
scanningInventory	A library inventory is in progress.
online	The library status is normal.

totalCapacity

An integer representing the total physical cartridge capacity of the library.

licensedCapacity

An integer representing the total licensed cartridge capacity of the library.

totalCartridges

An integer representing the total number of cartridges currently in the library slots, I/O stations, drives, and accessors.

assignedCartridges

An integer representing the total number of cartridges assigned to logical libraries in the library.

firmware

A string representing the firmware level installed on the library.

sn

A string representing the serial number of the library.

time

A string representing the current date and time set on the library. All dates and times returned by the library are in relation to this time. 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.

location

A string showing the user-entered physical location of the library. For example, Building 9062. If not provided, this is null.

address

A string representing the physical address of the library. If not provided, this is null.

city

A string representing the city in which the library is located. If not provided, this is null.

state

A string representing the two-character state in which the library is located. For example, AZ for Arizona. If not provided, this is null.

country

A string representing the country in which the library is located. If not provided, this is null.

contact

A string representing 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

A string representing 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

A string representing 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

A string representing the current setting for secure communications. If enabled, the user is required to log into the GUI using a secure HTTPS connection. If disabled, an unsecured HTTP connection is allowed.

autoEjectCleaningCartridges

A string representing 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

A string representing the current setting for elastic capacity. Values include:

• maxCapacity

• tempOverflow

• doNotUse

activeAccessors

A string representing which accessors are currently active. Values include:

• dualActive

• accessorAOnly

• accessorBOnly

vioStatus

A string representing the current setting for Virtual I/O (VIO). This is enabled or disabled.

nmaDetection

A string representing the current setting for NMA detection. This is enabled or disabled.

capacityUtilThresh

A percentage value accurate to one decimal place.

dualAccessorUtilThresh

A percentage value accurate to one decimal place.