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

Retrieve a storage port

Contributors
PDFs

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

Introduced In: 9.6

Retrieves a specific storage port.

  • storage port show

Learn more

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

name

string

path

True

Port name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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 response 
{
  "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"
}

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

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

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.