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

Retrieve shelves

PDFs

GET /storage/shelves

Introduced In: 9.6

Retrieves a collection of shelves.

  • storage shelf show

  • storage shelf port show

  • storage shelf drawer show

Learn more

Parameters

Name Type In Required Description

uid

string

query

False

Filter by uid

paths.name

string

query

False

Filter by paths.name

paths.node.name

string

query

False

Filter by paths.node.name

paths.node.uuid

string

query

False

Filter by paths.node.uuid

disk_count

integer

query

False

Filter by disk_count

connection_type

string

query

False

Filter by connection_type

vendor.product

string

query

False

Filter by vendor.product

  • Introduced in: 9.8

vendor.part_number

string

query

False

Filter by vendor.part_number

  • Introduced in: 9.8

vendor.manufacturer

string

query

False

Filter by vendor.manufacturer

  • Introduced in: 9.8

vendor.serial_number

string

query

False

Filter by vendor.serial_number

  • Introduced in: 9.8

errors.reason.code

string

query

False

Filter by errors.reason.code

  • Introduced in: 9.9

errors.reason.message

string

query

False

Filter by errors.reason.message

  • Introduced in: 9.9

model

string

query

False

Filter by model

ports.internal

boolean

query

False

Filter by ports.internal

ports.mac_address

string

query

False

Filter by ports.mac_address

ports.designator

string

query

False

Filter by ports.designator

ports.state

string

query

False

Filter by ports.state

ports.remote.port

string

query

False

Filter by ports.remote.port

ports.remote.phy

string

query

False

Filter by ports.remote.phy

ports.remote.device

string

query

False

Filter by ports.remote.device

  • Introduced in: 9.8

ports.remote.wwn

string

query

False

Filter by ports.remote.wwn

ports.remote.mac_address

string

query

False

Filter by ports.remote.mac_address

ports.remote.chassis

string

query

False

Filter by ports.remote.chassis

ports.id

integer

query

False

Filter by ports.id

ports.wwn

string

query

False

Filter by ports.wwn

ports.cable.identifier

string

query

False

Filter by ports.cable.identifier

ports.cable.serial_number

string

query

False

Filter by ports.cable.serial_number

ports.cable.part_number

string

query

False

Filter by ports.cable.part_number

ports.cable.length

string

query

False

Filter by ports.cable.length

ports.module_id

string

query

False

Filter by ports.module_id

bays.has_disk

boolean

query

False

Filter by bays.has_disk

bays.state

string

query

False

Filter by bays.state

bays.id

integer

query

False

Filter by bays.id

bays.type

string

query

False

Filter by bays.type

fans.location

string

query

False

Filter by fans.location

  • Introduced in: 9.9

fans.state

string

query

False

Filter by fans.state

  • Introduced in: 9.9

fans.rpm

integer

query

False

Filter by fans.rpm

  • Introduced in: 9.9

fans.id

integer

query

False

Filter by fans.id

  • Introduced in: 9.9

name

string

query

False

Filter by name

internal

boolean

query

False

Filter by internal

frus.serial_number

string

query

False

Filter by frus.serial_number

frus.state

string

query

False

Filter by frus.state

frus.part_number

string

query

False

Filter by frus.part_number

frus.type

string

query

False

Filter by frus.type

frus.id

integer

query

False

Filter by frus.id

frus.firmware_version

string

query

False

Filter by frus.firmware_version

module_type

string

query

False

Filter by module_type

local

boolean

query

False

Filter by local

  • Introduced in: 9.8

drawers.closed

boolean

query

False

Filter by drawers.closed

drawers.error

string

query

False

Filter by drawers.error

drawers.part_number

string

query

False

Filter by drawers.part_number

drawers.id

integer

query

False

Filter by drawers.id

drawers.disk_count

integer

query

False

Filter by drawers.disk_count

drawers.serial_number

string

query

False

Filter by drawers.serial_number

drawers.state

string

query

False

Filter by drawers.state

id

string

query

False

Filter by id

state

string

query

False

Filter by state

serial_number

string

query

False

Filter by serial_number

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: 15

  • 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[shelf]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "bays": [
        {
          "id": "0",
          "state": "ok",
          "type": "single_disk"
        }
      ],
      "connection_type": "sas",
      "disk_count": "12",
      "drawers": [
        {
          "disk_count": "12",
          "error": "string",
          "part_number": "111-03071",
          "serial_number": "021604008263",
          "state": "ok"
        }
      ],
      "errors": [
        {
          "reason": {
            "code": "string",
            "message": "string"
          }
        }
      ],
      "fans": [
        {
          "id": "1",
          "location": "rear of the shelf on the lower left power supply",
          "rpm": "3020",
          "state": "ok"
        }
      ],
      "frus": [
        {
          "firmware_version": "0191",
          "part_number": "111-00690+A2",
          "serial_number": "8000166294",
          "state": "error",
          "type": "module"
        }
      ],
      "id": "1",
      "model": "DS2246",
      "module_type": "iom6",
      "name": "1.1",
      "paths": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "2a",
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          }
        }
      ],
      "ports": [
        {
          "cable": {
            "identifier": "500a0980000b6c3f-50000d1703544b80",
            "length": "2m",
            "part_number": "112-00431+A0",
            "serial_number": "616930439"
          },
          "designator": "square",
          "id": "0",
          "mac_address": "string",
          "module_id": "a",
          "remote": {
            "chassis": "string",
            "device": "string",
            "mac_address": "string",
            "phy": "12",
            "port": "string",
            "wwn": "50000D1703544B80"
          },
          "state": "connected",
          "wwn": "500A0980000B6C3F"
        }
      ],
      "serial_number": "SHFMS1514000895",
      "state": "ok",
      "uid": "7777841915827391056",
      "vendor": {
        "manufacturer": "XYZ",
        "part_number": "A92831142733",
        "product": "LS2246",
        "serial_number": "891234572210221"
      }
    }
  ]
}

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

bays

Name Type Description

has_disk

boolean

id

integer

state

string

type

string

drawers

Name Type Description

closed

boolean

disk_count

integer

error

string

id

integer

part_number

string

serial_number

string

state

string

reason

Name Type Description

code

string

Error code

message

string

Error message

errors

Name Type Description

reason

reason

fans

Name Type Description

id

integer

location

string

rpm

integer

state

string

frus

Name Type Description

firmware_version

string

id

integer

part_number

string

serial_number

string

state

string

type

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

paths

Storage port

Name Type Description

_links

_links

name

string

node

node

cable

Name Type Description

identifier

string

length

string

part_number

string

serial_number

string

remote

Name Type Description

chassis

string

device

string

mac_address

string

phy

string

port

string

wwn

string

ports

Name Type Description

cable

cable

designator

string

id

integer

internal

boolean

mac_address

string

module_id

string

remote

remote

state

string

wwn

string

vendor

Name Type Description

manufacturer

string

Manufacturer name

part_number

string

Part number

product

string

Product name

serial_number

string

Serial number

shelf

Name Type Description

bays

array[bays]

connection_type

string

disk_count

integer

drawers

array[drawers]

errors

array[errors]

fans

array[fans]

frus

array[frus]

id

string

internal

boolean

local

boolean

model

string

module_type

string

name

string

paths

array[paths]

ports

array[ports]

serial_number

string

state

string

uid

string

vendor

vendor

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.