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
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 |
|
method
|
string |
|
data
|
array |
Filter parameters. See the |
type
|
string | rpc
|
tid
|
int | 1
|
filter
Field
|
Type
|
Description
|
---|---|---|
|
int |
Start ID of the tape cartridge to be returned |
|
int |
Number of tape cartridges to be returned |
|
string |
Tape cartridge parameter to be sorted with |
|
boolean |
|
|
array |
Filter criteria. See the rows below |
|
string |
Type of the criterion |
|
string |
Name of the criterion. |
|
string |
Type of the criterion. |
|
string |
Value of the criterion |
Response Sample
{
"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 |
|
Json |
Tape cartridges info. See the table below |
data.children
Single tape cartridge info.
Field |
Type |
Description |
---|---|---|
|
boolean |
Checks if the tape device is attached |
|
string |
Barcode of the tape cartridge |
|
integer |
Index of the slot or drive. Only for tape library |
|
string |
Type of the tape library containing the tape cartridge. Possible values: |
|
string |
Tape cartridge contents. Possible values: |
|
string |
Tape device name |
|
long |
Tape device ID |
|
string |
Tape device type. Possible values: |
|
string |
Tape cartridge label |
|
DateTime |
Date of the last write operation |
|
integer |
Location ID of the tape device |
|
string |
Location name of the tape device |
|
array |
Lock device reasons |
|
array |
Lock reasons |
|
boolean |
|
|
boolean |
|
|
DateTime |
Date when the tape was marked as a cleaning tape |
|
DateTime |
Date when the tape was marked as a free tape |
|
integer |
Media pool ID of the tape device |
|
string |
Media pool name of the tape device |
|
integer |
Index of the container the tape cartridge to be moved from |
|
string |
Type of the container the tape cartridge to be moved from. Possible values: |
|
integer |
Index of the container the tape cartridge to be moved to |
|
string |
Type of the container the tape cartridge to be moved to. Possible values: |
|
string |
Tape cartridge name |
|
long |
Number of backups on the tape cartridge |
|
long |
Number of savepoints on the tape cartridge |
|
DateTime |
Date when all recovery points on the tape will expire |
|
DateTime |
Date when the tape was protected |
|
DateTime |
Date when the tape was retired |
|
string |
Tape cartridge state. Possible values: |
|
string |
Tape cartridge state info. Possible values: |
|
string |
Tape cartridge status. Possible values: |
|
string |
Tape cartridge type. Possible values: |
|
string |
Tape cartridge UUID |
|
string |
Tape cartridge VID |