Skip to main content

Retrieve storage ports

Contributors
PDFs

GET /storage/ports

Introduced In: 9.6

Retrieves a collection of storage ports.

  • storage port show

Learn more

Parameters

Name Type In Required Description

error.message

string

query

False

Filter by error.message

error.corrective_action

string

query

False

Filter by error.corrective_action

mac_address

string

query

False

Filter by mac_address

wwpn

string

query

False

Filter by wwpn

  • Introduced in: 9.9

name

string

query

False

Filter by name

enabled

boolean

query

False

Filter by enabled

  • Introduced in: 9.9

redundant

boolean

query

False

Filter by redundant

  • Introduced in: 9.9

speed

number

query

False

Filter by speed

serial_number

string

query

False

Filter by serial_number

mode

string

query

False

Filter by mode

  • Introduced in: 9.8

part_number

string

query

False

Filter by part_number

in_use

boolean

query

False

Filter by in_use

  • Introduced in: 9.9

type

string

query

False

Filter by type

  • Introduced in: 9.9

state

string

query

False

Filter by state

firmware_version

string

query

False

Filter by firmware_version

  • Introduced in: 9.9

wwn

string

query

False

Filter by wwn

description

string

query

False

Filter by description

cable.length

string

query

False

Filter by cable.length

cable.identifier

string

query

False

Filter by cable.identifier

cable.vendor

string

query

False

Filter by cable.vendor

  • Introduced in: 9.15

cable.serial_number

string

query

False

Filter by cable.serial_number

cable.transceiver

string

query

False

Filter by cable.transceiver

  • Introduced in: 9.15

cable.part_number

string

query

False

Filter by cable.part_number

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

board_name

string

query

False

Filter by board_name

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[storage_port]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "board_name": "string",
      "cable": {
        "identifier": "500a0980000b6c3f-50000d1703544b80",
        "length": "2m",
        "part_number": "112-00431+A0",
        "serial_number": 616930439,
        "transceiver": "mini_sas_hd",
        "vendor": "Molex Inc."
      },
      "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

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

cable

Name Type Description

identifier

string

length

string

part_number

string

serial_number

string

transceiver

string

vendor

string

error

Name Type Description

corrective_action

string

Error corrective action

message

string

Error message

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