Get Single Tape Cartridge

Product version: 10.11

Last modified: 31 July 2024

Gets a tape cartridge by its ID.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

curl --request POST \
     --url https://<Director_IP_address>:4443/c/router \
     --header "content-type: application/json" \
     --cookie @cookies.txt \
     --data '{
            "action": "TapeCartridgeManagement",
            "method": "getCartridge",
            "data": [6],
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`TapeCartridgeManagement`
`method`	string	`getCartridge`
`data`	array	ID of the tape cartridge
`type`	string	`rpc`
`tid`	integer	`1`

Response Sample

curl

Copy

{
    "action": "TapeCartridgeManagement",
    "method": "getCartridge",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "uuid": null,
        "vid": "TAPE_CARTRIDGE-6",
        "name": "DRI01",
        "barcode": "DRI01",
        "label": null,
        "contents": "EMPTY",
        "status": "ONLINE",
        "state": "AVAILABLE",
        "stateInfo": "OK",
        "type": "RW",
        "protectedDate": null,
        "retiredDate": null,
        "markedAsFreeDate": null,
        "markedAsCleaningDate": null,
        "overWritable": null,
        "lastWritten": null,
        "numberOfBackups": 0,
        "numberOfSavePoints": 0,
        "deviceId": 3,
        "deviceName": "HP-Compag-5000",
        "deviceType": "TAPE_LIBRARY",
        "deviceCustomName": "VTl",
        "containerIndex": 4,
        "containerType": "NORMAL_SLOT",
        "attachedDevice": true,
        "locationId": 1,
        "locationName": "My office",
        "mediaPoolId": -1,
        "mediaPoolName": "",
        "lockedShared": false,
        "lockedExclusive": false,
        "lockReasons": [],
        "lockDeviceReasons": [],
        "moveFromContainerType": null,
        "moveFromContainerIndex": null,
        "moveToContainerType": null,
        "moveToContainerIndex": null
    }
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
data	Json	Cartridge parameters. See the table below

data

Field	Type	Description
`attachedDevice`	boolean	Checks if the tape device is attached
`barcode`	string	Barcode of the tape cartridge
`containerIndex`	int	Number of slots or drives. Only for tape library
`containerType`	string	Type of the tape library containing the tape cartridge. Possible values: `DRIVE,` `NORMAL_SLOT, MAIL_SLOT`
`contents`	string	Tape cartridge contents. Possible values: `EMPTY, ALIEN, SUPPORTED, UNKNOWN`
`deviceCustomName`	string	Tape device name
`deviceId`	`long`	Tape device ID
`deviceType`	string	Tape device type. Possible values: `TAPE_LIBRARY,` `TAPE_STANDALONE_DRIVE`
`label`	string	Tape cartridge label
`lastWritten`	`DateTime`	Date of the last write operation
`locationId`	int	Location ID of the tape device
`locationName`	string	Location name of the tape device
`lockDeviceReasons`	array	Lock device reasons
`lockReasons`	array	Lock reasons
`lockedExclusive`	boolean	`true` if multiple updates cannot be made to the tape cartridge at the same time
`lockedShared`	boolean	`true` if multiple read operations cannot run on the same tape cartridge at the same time
`markedAsCleaningDate`	DateTime	Date that the tape was marked as a cleaning tape
`markedAsFreeDate`	DateTime	Date that the tape was marked as a free tape
`mediaPoolId`	int	Media pool ID of the tape device
`mediaPoolName`	string	Media pool name of the tape device
`moveFromContainerIndex`	int	Index of the container the tape cartridge to be moved from
`moveFromContainerType`	string	The type of the container the tape cartridge to be moved from. Possible values: `DRIVE,` `NORMAL_SLOT, MAIL_SLOT`
`moveToContainerIndex`	int	Index of the to container the tape cartridge to be moved to
`moveToContainerType`	string	Type of the container the tape cartridge to be moved to. Possible values: `DRIVE`, `NORMAL_SLOT`, `MAIL_SLOT`
`name`	string	Tape cartridge name
`numberOfBackups`	`long`	Number of backups on the tape cartridge
`numberOfSavePoints`	`long`	Number of savepoints on the tape cartridge
`overWritable`	`DateTime`	Date when all recovery points on the tape will expire
`protectedDate`	`DateTime`	Date when the tape was protected
`retiredDate`	`DateTime`	Date when he tape was retired
`state`	string	Tape cartridge state. Possible values: `NEW, ALIEN_DATA, AVAILABLE, UNKNOWN, BACKUP_OLD, BACKUP_EMPTY, BACKUP, BACKUP_FULL`
`stateInfo`	string	Tape cartridge state info. Possible values : `OK, WARNING, ERROR`
`status`	string	Tape cartridge status. Possible values: `OFFLINE, ONLINE, SCANNING, ERASING, READING, WRITING, MOVING, ERROR`
`type`	string	Tape cartridge type. Possible values : `RW, READ_ONLY, CLEANING`
`uuid`	string	Tape cartridge UUID
`vid`	string	Tape cartridge VID