Skip to main content

Retrieve tape devices

Contributors
PDFs

GET /storage/tape-devices

Introduced In: 9.9

Retrieves a collection of tape devices.

  • storage tape show

Learn more

Parameters

Name Type In Required Description

density

string

query

False

Filter by density

  • Introduced in: 9.11

description

string

query

False

Filter by description

block_number

integer

query

False

Filter by block_number

reservation_type

string

query

False

Filter by reservation_type

file_number

integer

query

False

Filter by file_number

online

boolean

query

False

Filter by online

  • Introduced in: 9.11

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

alias.name

string

query

False

Filter by alias.name

alias.mapping

string

query

False

Filter by alias.mapping

formats

string

query

False

Filter by formats

wwnn

string

query

False

Filter by wwnn

wwpn

string

query

False

Filter by wwpn

device_names.unload_reload_device

string

query

False

Filter by device_names.unload_reload_device

device_names.no_rewind_device

string

query

False

Filter by device_names.no_rewind_device

device_names.rewind_device

string

query

False

Filter by device_names.rewind_device

storage_port.name

string

query

False

Filter by storage_port.name

type

string

query

False

Filter by type

device_state

string

query

False

Filter by device_state

device_id

string

query

False

Filter by device_id

serial_number

string

query

False

Filter by serial_number

interface

string

query

False

Filter by interface

residual_count

integer

query

False

Filter by residual_count

aliases.name

string

query

False

Filter by aliases.name

  • Introduced in: 9.11

aliases.mapping

string

query

False

Filter by aliases.mapping

  • Introduced in: 9.11

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[tape_device]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "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

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

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.

_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.

tape_device

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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.