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

Update a storage port

Contributors
PDFs

PATCH /storage/ports/{node.uuid}/{name}

Introduced In: 9.11

Updates a storage port.

  • storage port modify

  • storage port enable

  • storage port disable

Learn more

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

name

string

path

True

Port name

Request Body

Name Type Description

board_name

string

cable

cable

description

string

enabled

boolean

error

error

firmware_version

string

force

boolean

in_use

boolean

Specifies whether any devices are connected through this port

mac_address

string

mode

string

Operational mode of a non-dedicated Ethernet port

name

string

node

node

part_number

string

redundant

boolean

Specifies whether all devices connected through this port have a redundant path from another port

serial_number

string

speed

number

Operational port speed in Gbps

state

string

type

string

wwn

string

World Wide Name

wwpn

string

World Wide Port Name
Example request 
{
  "board_name": "string",
  "cable": {
    "identifier": "500a0980000b6c3f-50000d1703544b80",
    "length": "2m",
    "part_number": "112-00431+A0",
    "serial_number": 616930439
  },
  "description": "SAS Host Adapter 2a (PMC-Sierra PM8072 rev. C)",
  "error": {
    "corrective_action": "string",
    "message": "string"
  },
  "firmware_version": "03.08.09.00",
  "mac_address": "string",
  "mode": "storage",
  "name": "2a",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "part_number": "111-03801",
  "serial_number": "7A2463CC45B",
  "speed": 6,
  "state": "online",
  "type": "sas",
  "wwn": "50000d1703544b80",
  "wwpn": "string"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

17891328

Port operation "\" failed on port \"\". This might indicate a hardware error, an illegal request, or an aborted command.

17891329

Port "\" is invalid.

17891330

Port operation "\" failed on port \"\" because it is not supported on this port type.

17891331

Cannot complete operation on port "\". The status of the port is not available.

17891332

Port operation "\" failed on port \"\". The port is not offline.

17891333

Port operation "\" failed on port \"\". The port is already offline.

17891334

Port operation "\" failed on port \"\". One or more devices on the port is currently being sanitized.

17891338

Device operation "\" failed on port \"\". Some devices can only be accessed through this port. Disabling this port might cause multiple device failures.

17891339

Device operation "\" failed on port \"\". Some devices can only be accessed through this port. Disabling this port might cause multiple device failures. Use the \"-force\" parameter to ignore checks and the port.

17891344

Device operation "\" failed on port \"\" because the port is in use.

17891345

Device operation "\" failed on port \"\" because the port is in use. Use the \"-force\" parameter to ignore checks and the port.

17891346

Port "\" is already enabled.

17891347

Port "\" is already disabled.

17891350

Port "\" is not a valid storage Ethernet port.

17891350

Port "\" is not a valid storage Ethernet port.

17891352

Port operation "\" failed on port \"\". Reboot node \"\" to recover.

17891353

Unable to enable port "\" because it is in network mode.

17891354

Unable to disable port "\" because it is in network mode.

17891355

Port operation "\" failed on port \"\" because it is not supported on dedicated ports.

17891356

Unable to port \"\" when setting mode to \"\".

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

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

cable

Name Type Description

identifier

string

length

string

part_number

string

serial_number

string

error

Name Type Description

corrective_action

string

Error corrective action

message

string

Error message

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

storage_port

Name Type Description

board_name

string

cable

cable

description

string

enabled

boolean

error

error

firmware_version

string

force

boolean

in_use

boolean

Specifies whether any devices are connected through this port

mac_address

string

mode

string

Operational mode of a non-dedicated Ethernet port

name

string

node

node

part_number

string

redundant

boolean

Specifies whether all devices connected through this port have a redundant path from another port

serial_number

string

speed

number

Operational port speed in Gbps

state

string

type

string

wwn

string

World Wide 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.