Skip to main content
A newer release of this product is available.

Retrieve a tape device

Contributors
PDFs

GET /storage/tape-devices/{node.uuid}/{device_id}

Introduced In: 9.9

Retrieves a specific tape device.

  • storage tape show

Learn more

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

device_id

string

path

True

Device ID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

alias

alias

aliases

array[aliases]

block_number

integer

Block number.

density

string

Density.

description

string

device_id

string

device_names

array[device_names]

device_state

string

Operational state of the device.

file_number

integer

File number.

formats

array[string]

Tape cartridge format.

interface

string

Device interface type.

node

node

online

boolean

position

position

reservation_type

string

residual_count

integer

Residual count of the last I/O operation.

serial_number

string

storage_port

storage_port

type

string

Device type.

wwnn

string

World Wide Node Name.

wwpn

string

World Wide Port Name.
Example response 
{
  "alias": {
    "mapping": "SN[10WT000933]",
    "name": "st6"
  },
  "aliases": {
    "mapping": "SN[10WT000933]",
    "name": "st6"
  },
  "block_number": 0,
  "density": "low",
  "description": "QUANTUM LTO-8 ULTRIUM",
  "device_id": "1a.0",
  "device_names": {
    "no_rewind_device": "nrst6l",
    "rewind_device": "rst6l",
    "unload_reload_device": "urst6l"
  },
  "device_state": "read_write_enabled",
  "file_number": 0,
  "formats": [
    "LTO-7 6TB",
    "LTO-7 15TB Compressed",
    "LTO-8 12TB",
    "LTO-8 30TB Compressed"
  ],
  "interface": "sas",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "position": {
    "count": 5,
    "operation": "rewind"
  },
  "reservation_type": "off",
  "residual_count": 0,
  "serial_number": "10WT00093",
  "storage_port": {
    "name": "2b"
  },
  "type": "tape",
  "wwnn": "500507631295741c",
  "wwpn": "500507631295741c"
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

alias

Name Type Description

mapping

string

This field will no longer be supported in a future release. Use aliases.mapping instead.

name

string

This field will no longer be supported in a future release. Use aliases.name instead.

aliases

Name Type Description

mapping

string

Alias mapping.

name

string

Alias name.

device_names

Name Type Description

no_rewind_device

string

Device name for no rewind.

rewind_device

string

Device name for rewind.

unload_reload_device

string

Device name for unload or reload operations.

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

position

Name Type Description

count

integer

Number of times to run position operation.

operation

string

Position operation.

storage_port

Name Type Description

name

string

Initiator port.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.