Get Tape Cartridge List

Gets a tape cartridge list.

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

Copy 
curl--request POST\
--url https: //<Director_IP_address>:4443/c/router \
    --header "content-type: application/json"\
    --cookie @cookies.txt\
    --data "{
"action": "TapeCartridgeManagement",
"method": "getCartridges",
"data": [{
    "filter": {
        "start": 0,
        "count": 200,
        "sort": "NAME",
        "sortAsc": true,
        "criteria": [{
            "type": "LIKE",
            "name": "BACKUP_NAME",
            "value": "Centos7"
        }],
        "criteria": [{
            "type": "EQ",
            "name": "STATUS",
            "value": "ONLINE"
        }],
        "criteria": [{
            "type": "EQ",
            "name": "DEVICE_ID",
            "value": "3"
        }],
        "criteria": [{
            "type": "EQ",
            "name": "LOCATION_ID",
            "value": "1"
        }],
        "criteria": [{
            "type": "EQ",
            "name": "LAST_WRITTEN",
            "value": "2019-09-17T00:00:00+07:00"
        }]
    }
}],
"type": "rpc",
"tid": 1
}
"

Request Fields

Field
Type
Value(s)
action string

TapeCartridgeManagement

method string

getCartridges

data array

Filter parameters. See the filter table below
type string rpc
tid int 1

filter

Field
Type
Description

start

int

Start ID of the tape cartridge to be returned

count

int

Number of tape cartridges to be returned

sort

string

Tape cartridge parameter to be sorted with

sortAsc

boolean

true if the order is ascending

criteria

array

Filter criteria. See the rows below

type

string

Type of the criterion

name

string

Name of the criterion.  NAME means the tape cartridge name

type

string

Type of the criterion. EQ means the equality relational operator

value

string

Value of the criterion

Response Sample

Copy 
{
    "action": "TapeCartridgeManagement",
    "method": "getCartridges",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "countTapeDevices": 3,
        "children": [{
                "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": "2019-09-17T00:00:00+07:00",
                "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
            },
            {
                "uuid": "28c9afb2-82ac-4a7b-8482-5275e1bb54b4",
                "vid": "TAPE_CARTRIDGE-4",
                "name": "SLOT03",
                "barcode": "SLOT03",
                "label": null,
                "contents": "SUPPORTED",
                "status": "ONLINE",
                "state": "BACKUP",
                "stateInfo": "OK",
                "type": "RW",
                "protectedDate": null,
                "retiredDate": "2019-09-18T09:55:22.959+07:00",
                "markedAsFreeDate": "2019-09-18T10:03:11.919+07:00",
                "markedAsCleaningDate": null,
                "overWritable": null,
                "lastWritten": "2019-09-17T00:00:00+07:00",
                "numberOfBackups": 1,
                "numberOfSavePoints": 4,
                "deviceId": 3,
                "deviceName": "HP-Compag-5000",
                "deviceType": "TAPE_LIBRARY",
                "deviceCustomName": "VTl",
                "containerIndex": 0,
                "containerType": "DRIVE",
                "attachedDevice": true,
                "locationId": 1,
                "locationName": "My office",
                "mediaPoolId": -1,
                "mediaPoolName": "",
                "lockedShared": false,
                "lockedExclusive": false,
                "lockReasons": [],
                "lockDeviceReasons": [],
                "moveFromContainerType": null,
                "moveFromContainerIndex": null,
                "moveToContainerType": null,
                "moveToContainerIndex": null
            }
        ],
        "totalCount": 2
    }
}

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

Tape cartridges info. See the table below

data.children

Single tape cartridge info.

Field

Type

Description

attachedDevice

boolean

Checks if the tape device is attached

barcode

string

Barcode of the tape cartridge

containerIndex

integer

Index of the slot or drive. 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

integer

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 when the tape was marked as a cleaning tape

markedAsFreeDate

DateTime

Date when the tape was marked as a free tape

mediaPoolId

integer

Media pool ID of the tape device

mediaPoolName

string

Media pool name of the tape device

moveFromContainerIndex

integer

Index of the container the tape cartridge to be moved from

moveFromContainerType

string

Type of the container the tape cartridge to be moved from. Possible values: DRIVE, NORMAL_SLOT, MAIL_SLOT

moveToContainerIndex

integer

Index of the 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 the 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