Get Tape Device List

Gets the list of tape devices.

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

 curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
		"action": "TapeDeviceManagement",
		"method": "getDevices",
		"data": [{"filter": {
                          "start": 0,
                          "count": 200,
                          "sort": "NAME",
                          "sortAsc": true
                     }
                }],
		"type": "rpc",
		"tid": 1}"

Request Fields

Field	Type	Value(s)
`action`	string	TapeDeviceManagement
`method`	string	getDevices
`data`	Json	Filter parameters. See the `filter` table below
`type`	string	`rpc`
`tid`	integer	1

filter

Field	Type	Description
`start`	int	A start ID of the tape device to be returned
`count`	int	Number of tape devices to be returned
`sort`	string	Tape device 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 criterion
`name`	string	Name of criterion. `NAME` means the tape device name
`type`	string	Type of the criterion. `EQ` means the equality relational operator
`value`	string	Value of the criterion

Response Sample

 {
  "action": "TapeDeviceManagement",
  "method": "getDevices",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
	"children": [
	  {
		"alertDescription": null
        "alertErrorCode": null
        "alertTitle": null
        "attached": true
        "blockSize": 524288
        "changeStatus": "NONE"
        "changers": null
        "compression": "HARDWARE_BASED"
        "deviceName": "IBM"
        "driveCount": 1
        "drives": null
        "freeCapacity": null
        "id": 67
        "locationId": 1
        "locationName": "My office"
        "lockReasons": []
        "lockedExclusive": false
        "lockedShared": false
        "mediaPoolId": null
        "mediaPoolName": null
        "name": "VT"
        "offlineLocationId": 1
        "offlineLocationName": "My office"
        "operationStart": null
        "operationStartRelative": 0
        "path": "/dev/sg0"
        "preventModification": false
        "progress": 0
        "slotCount": 3200
        "state": "OK"
        "status": "NONE"
        "tapeCartridgeCount": 1
        "tapeCartridgeId": 225
        "tapeCartridgeName": null
        "transporterId": 33
        "transporterName": "13.234.155.61"
        "type": "TAPE_LIBRARY"
        "updateChangers": false
        "updateDrives": false
        "uuid": "b1704a03-ea44-34ac-b0b8-e86cbb2349f5"
        "vid": "TAPE_LIBRARY-67"
        "wasCreated": false
        "wasDiscoveredOnce": true
        "wasEdited": false
	 },
	 {
		"alertDescription": null
		"alertErrorCode": null
		"alertTitle": null
		"attached": true
		"blockSize": 262144
		"changeStatus": "NONE"
		"changers": null
		"compression": "HARDWARE_BASED"
		"deviceName": "stdrive_2"
		"driveCount": 0
		"drives": null
		"freeCapacity": null
		"id": 1
		"locationId:" 1
		"locationName": "My office"
		"lockReasons": []
		"lockedExclusive": false
		"lockedShared": false
		"mediaPoolId": null
		"mediaPoolName": null
		"name": "st2"
		"offlineLocationId": 1
		"offlineLocationName": "My office"
		"operationStart": null
		"operationStartRelative": 0
		"path": "stdrive_2"
		"preventModification": false
		"progress": 0
		"slotCount": 0
		"state": "OK"
		"status": "NONE"
		"tapeCartridgeCount": 1
		"tapeCartridgeId": 1
		"tapeCartridgeName": "ST002"
		"transporterId": 1
		"transporterName": "1.1.1.1"
		"type": "TAPE_STANDALONE_DRIVE"
		"updateChangers": false
		"updateDrives": false
		"uuid": "17453fce-e58d-4ed1-a926-65b8ff171002"
		"vid": "TAPE_STANDALONE_DRIVE-1"
		"wasCreated": false
		"wasDiscoveredOnce": true
		"wasEdited": false
	}
    ],
    "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 device info

data.children

Field	Value	Description
`alertErrorCode`	long	Error code of the alert (if any)
`alertDescription`	string	Description of the alert (if any)
`alertTitle`	string	Title of the alert (if any)
`attached`	boolean	Checks if the tape device is attached
`blockSize`	int	Block size of the current tape device
`changeStatus`	string	Change status. Possible values: NONE, CREATE_PENDING (new item, discovery is needed), CHANGE_PENDING (some attributes have changed, discovery is needed), RECREATE_PENDING (the item was destroyed and needs to be re-created)
`changers`	Json	Media changers of the tape library
`compression`	string	Compression type
`deviceName`	string	Tape device name
`driveCount`	int	Number of the tape library drives
`drives`	Json	Tape drives of the tape library
`freeCapacity`	long	Free capacity of the tape device
`id`	long	Tape device ID
`locationId`	int	Location ID of the tape device
`locationName`	string	Location name of tape device
`mediaPoolId`	int	Media pool ID of the tape device
`mediaPoolName`	string	Media pool name of the tape device
`lockReasons`	array	Lock reasons
`lockedExclusive`	boolean	`true` if multiple updates cannot be made to the tape device at the same time
`lockedShared`	boolean	`true` if multiple read operations cannot run on the same tape device at the same time
`name`	string	Tape device name
`offlineLocationId`	int	ID of the location for tapes ejected from this tape device
`offlineLocationName`	string	Name of the location for tapes ejected from this tape device
`operationStart`	string	Timestamp of the beginning of the current operation
`operationStartRelative`	long	Relative timestamp (e.g. time since start) of the beginning of the current operation
`path`	string	Path to the tape device
`preventModification`	boolean	If `true`, prevents manual modification of the item
`progress`	int	Progress of the current operation
`slotCount`	int	Number of tape library slots
`state`	string	Tape device state
`status`	string	Status of the current operation on the tape device. `NONE` if no operations are currently running. Possible values: `NONE, UPDATING, READING, WRITING`
`tapeCartridgeCount`	int	Number of the tape device cartridges
`tapeCartridgeId`	long	Tape cartridge ID
`tapeCartridgeName`	string	Tape cartridge name
`transporterId`	long	Assigned transporter ID
`transporterName`	string	Assigned transporter name
`type`	string	Tape device type. Possible values: `TAPE_LIBRARY,` `TAPE_STANDALONE_DRIVE`
`updateChangers`	boolean	Checks if the changers of tape library were updated
`updateDrives`	boolean	Checks if the drives of tape library were updated
`uuid`	string	Tape device UUID
`vid`	string	Tape device VID
`wasCreated`	boolean	Checks if the tape device was created
`wasDiscoveredOnce`	boolean	Checks if the tape device was discovered once
`wasEdited`	boolean	Checks if the tape device was edited

Page tree