Get Single Tape Device

Product version: 10.11

Last modified: 31 July 2024

Gets a tape device 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": "TapeDeviceManagement",
            "method": "getDeviceInfo",
            "data": [1],
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`TapeDeviceManagement`
`method`	string	`getDeviceInfo`
`data`	array	ID of the tape device
`type`	string	`rpc`
`tid`	int	1

Response Sample

curl

Copy

{
  "action": "TapeDeviceManagement",
  "method": "getDeviceInfo",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "alertDescription": null,
    "alertErrorCode": null,
    "alertTitle": null,
    "attached": true,
    "blockSize": 262144,
    "changeStatus": "NONE",
    "changers": null,
    "compression": "HARDWARE_BASED",
    "deviceName": "HP-Compag-5000",
    "driveCount": 2,
    "drives": null,
    "freeCapacity": null,
    "id": 3,
    "locationId": 1,
    "locationName": "My office",
    "lockReasons": [],
    "lockedExclusive": false,
    "lockedShared": false,
    "mediaPoolId": null,
    "mediaPoolName": null,
    "name": "VTl",
    "offlineLocationId": 1,
    "offlineLocationName": "My office",
    "operationStart": null,
    "operationStartRelative": 0,
    "path": "library_2",
    "preventModification": false,
    "progress": 0,
    "slotCount": 11,
    "state": "OK",
    "status": "NONE",
    "tapeCartridgeCount": 4,
    "tapeCartridgeId": 0,
    "tapeCartridgeName": null,
    "transporterId": 1,
    "transporterName": "1.1.1.1",
    "type": "TAPE_LIBRARY",
    "updateChangers": false,
    "updateDrives": false,
    "uuid": "67453fce-e58d-4ed1-a926-65b8ff16202",
    "vid": "TAPE_LIBRARY-3",
    "wasCreated": false,
    "wasDiscoveredOnce": true,
    "wasEdited": false
  }
}

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 parameters. See the `data` table below

data

Field	Value	Description
`alertErrorCode`	`long`	The error code of the alert (if any)
`alertDescription`	string	The description of the alert (if any)
`alertTitle`	string	The 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 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	ID of the location of tape device
`locationName`	string	Name of the location of tape device
`mediaPoolId`	int	ID of the media pool of tape device
`mediaPoolName`	string	Name of the media pool of 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 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