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

Update a tape device

PDFs

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

Introduced In: 9.11

Updates a specific tape device.

  • storage tape alias-set

  • storage tape alias-clear

  • storage tape online

  • storage tape offline

  • storage tape position

Learn more

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

device_id

string

path

True

Device ID

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 0

  • Max value: 120

  • Min value: 0

Request Body

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 request 
{
  "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": {
    "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"
}

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

11403264

Tape operation "\" failed on tape device \"\". This may indicate tape reached end of data, a hardware error, an illegal request, an invalid name format, or an aborted command.

11403265

Tape operation "\" failed because it encountered an unexpected file mark on tape device \"\".

11403266

Internal error. Unknown tape parameter for tape device "\".

11403267

Tape device "\" is busy.

11403268

No tape loaded for "\" operation on tape drive \"\".

11403269

Tape device "\" unknown.

11403270

Tape alias name "\" already exists.

11403271

The format of the tape alias name "\" is invalid. Use \"st\" or \"mc\" followed by one or more digits.

11403273

Internal error. Tape alias name "\" not saved.

11403274

Internal error. Tape alias operation "\" for alias name \"\" failed.

11403275

Tape alias name "\" not found.

11403277

Tape device "\" is reserved by another host.

11403278

Invalid count value specified with operation "\". Valid values are from 0 to {1}.

Also see the table of common errors in the Response body overview section of this documentation.

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

node

Name Type Description

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.