Get cleaning cartridges

Request syntax

Path parameters

volser (string)

The volume serial number (VOLSER) or bar code number of the cartridge.

internalAddress (string)

The unique identifier of the cartridge within the library represented by a 6-character hex string. If there are duplicate VOLSERs, this value is used to identify the cartridge. The value changes if the cartridge is assigned or unassigned from a logical library or if the cartridge is moved by the host or library. Query the value before you use.

Example

> GET /v1/cleaningCartridges
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 330

[
     {
          "volser": "CLNI01L1", 
          "state": "normal", 
          "accessible":"normal",
          "cleansRemaining": 45, 
          "location": "slot_F1C6R13T0", 
          "mediaType": "LTO", 
          "mostRecentUsage": "2019-03-25T13:33:58-0700"
          "internalAddress": "FF0402"
     }, {
          "volser": "CLNI01L1", 
          "state": "normal",
          "accessible":"normal", 
          "cleansRemaining": 44, 
          "location": "slot_F1C10R4T0", 
          "mediaType": "LTO", 
          "mostRecentUsage": "2019-03-25T13:34:17-0700"
          "internalAddress": "FF0403"
     }
]

Attributes

volser (string)

The volume serial number (VOLSER) or bar code number of the cartridge.

state (string)

The health status of the cleaning cartridge. Values include the following in priority order:

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.
uncertainBarcode	Possible mismatch between a scanned bar code label and the copy of the bar code stored on cartridge memory. The library will try to resolve on the next mount/demount cycle of this cartridge. If issue persists, contact IBM Support.
exportQueued	The cartridge is queued to be moved to an I/O station.
importing	The cartridge is being imported. The import is complete when the host application performs a move of the cartridge.
normal	The cartridge status is normal.

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.

cleansRemaining (number)

The number of clean operations that remain for this cleaning cartridge.

location (string)

The current location of the cartridge. This is the location of a gripper, drive, slot, or I/O slot.

mediaType (string)

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

mostRecentUsage (string)

The last date and time this cartridge was mounted into a drive, or null if this is unknown or the cartridge has not been mounted. Time format is YYYY-MM-DDThh:mm:ss±hh:mm.

internalAddress (string)

The unique identifier of the cartridge within the library represented by a 6-character hex string. If there are duplicate VOLSERs, this value is used to identify the cartridge. The value changes if the cartridge is assigned or unassigned from a logical library or if the cartridge is moved by the host or library. Query the value before you use.