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

Retrieve storage ports

Contributors
PDFs

GET /storage/ports

Retrieves a collection of storage ports.

  • storage port show

Learn more

Parameters

Name Type In Required Description

wwn

string

query

False

Filter by wwn

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

description

string

query

False

Filter by description

serial_number

string

query

False

Filter by serial_number

cable.identifier

string

query

False

Filter by cable.identifier

cable.serial_number

string

query

False

Filter by cable.serial_number

cable.part_number

string

query

False

Filter by cable.part_number

cable.length

string

query

False

Filter by cable.length

error.message

string

query

False

Filter by error.message

error.corrective_action

string

query

False

Filter by error.corrective_action

board_name

string

query

False

Filter by board_name

mac_address

string

query

False

Filter by mac_address

speed

number

query

False

Filter by speed

state

string

query

False

Filter by state

part_number

string

query

False

Filter by part_number

name

string

query

False

Filter by 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.

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.

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"
    }
  },
  "records": [
    {
      "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"
      },
      "mac_address": "string",
      "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",
      "wwn": "50000d1703544b80"
    }
  ]
}

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

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

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

error

error

mac_address

string

name

string

node

node

part_number

string

serial_number

string

speed

number

Operational port speed in Gbps

state

string

wwn

string

World Wide Name

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.