Skip to main content
REST API reference

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

  • storage shelf drawer show-slot

  • storage shelf acp show

Learn more

Parameters

Name Type In Required Description

acps.connection_state

string

query

False

Filter by acps.connection_state

  • Introduced in: 9.10

acps.subnet

string

query

False

Filter by acps.subnet

  • Introduced in: 9.10

acps.enabled

boolean

query

False

Filter by acps.enabled

  • Introduced in: 9.10

acps.channel

string

query

False

Filter by acps.channel

  • Introduced in: 9.10

acps.port

string

query

False

Filter by acps.port

  • Introduced in: 9.10

acps.error.severity

string

query

False

Filter by acps.error.severity

  • Introduced in: 9.10

acps.error.type

string

query

False

Filter by acps.error.type

  • Introduced in: 9.10

acps.error.reason.code

string

query

False

Filter by acps.error.reason.code

  • Introduced in: 9.10

acps.error.reason.message

string

query

False

Filter by acps.error.reason.message

  • Introduced in: 9.10

acps.error.reason.arguments.code

string

query

False

Filter by acps.error.reason.arguments.code

  • Introduced in: 9.10

acps.error.reason.arguments.message

string

query

False

Filter by acps.error.reason.arguments.message

  • Introduced in: 9.10

acps.address

string

query

False

Filter by acps.address

  • Introduced in: 9.10

acps.node.uuid

string

query

False

Filter by acps.node.uuid

  • Introduced in: 9.10

acps.node.name

string

query

False

Filter by acps.node.name

  • Introduced in: 9.10

acps.netmask

string

query

False

Filter by acps.netmask

  • Introduced in: 9.10

manufacturer.name

string

query

False

Filter by manufacturer.name

  • Introduced in: 9.10

uid

string

query

False

Filter by uid

connection_type

string

query

False

Filter by connection_type

temperature_sensors.id

integer

query

False

Filter by temperature_sensors.id

  • Introduced in: 9.10

temperature_sensors.state

string

query

False

Filter by temperature_sensors.state

  • Introduced in: 9.10

temperature_sensors.threshold.high.warning

integer

query

False

Filter by temperature_sensors.threshold.high.warning

  • Introduced in: 9.10

temperature_sensors.threshold.high.critical

integer

query

False

Filter by temperature_sensors.threshold.high.critical

  • Introduced in: 9.10

temperature_sensors.threshold.low.warning

integer

query

False

Filter by temperature_sensors.threshold.low.warning

  • Introduced in: 9.10

temperature_sensors.threshold.low.critical

integer

query

False

Filter by temperature_sensors.threshold.low.critical

  • Introduced in: 9.10

temperature_sensors.location

string

query

False

Filter by temperature_sensors.location

  • Introduced in: 9.10

temperature_sensors.installed

boolean

query

False

Filter by temperature_sensors.installed

  • Introduced in: 9.13

temperature_sensors.temperature

integer

query

False

Filter by temperature_sensors.temperature

  • Introduced in: 9.10

temperature_sensors.ambient

boolean

query

False

Filter by temperature_sensors.ambient

  • Introduced in: 9.10

local

boolean

query

False

Filter by local

  • Introduced in: 9.8

location_led

string

query

False

Filter by location_led

  • Introduced in: 9.10

ports.internal

boolean

query

False

Filter by ports.internal

ports.mac_address

string

query

False

Filter by ports.mac_address

ports.cable.length

string

query

False

Filter by ports.cable.length

ports.cable.part_number

string

query

False

Filter by ports.cable.part_number

ports.cable.serial_number

string

query

False

Filter by ports.cable.serial_number

ports.cable.identifier

string

query

False

Filter by ports.cable.identifier

ports.remote.device

string

query

False

Filter by ports.remote.device

  • Introduced in: 9.8

ports.remote.port

string

query

False

Filter by ports.remote.port

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.remote.phy

string

query

False

Filter by ports.remote.phy

ports.remote.wwn

string

query

False

Filter by ports.remote.wwn

ports.wwn

string

query

False

Filter by ports.wwn

ports.id

integer

query

False

Filter by ports.id

ports.speed

integer

query

False

Filter by ports.speed

  • Introduced in: 9.17

ports.designator

string

query

False

Filter by ports.designator

ports.module_id

string

query

False

Filter by ports.module_id

ports.state

string

query

False

Filter by ports.state

id

string

query

False

Filter by id

disk_count

integer

query

False

Filter by disk_count

drawers.state

string

query

False

Filter by drawers.state

drawers.disk_count

integer

query

False

Filter by drawers.disk_count

drawers.error

string

query

False

Filter by drawers.error

drawers.serial_number

string

query

False

Filter by drawers.serial_number

drawers.part_number

string

query

False

Filter by drawers.part_number

drawers.closed

boolean

query

False

Filter by drawers.closed

drawers.id

integer

query

False

Filter by drawers.id

name

string

query

False

Filter by name

internal

boolean

query

False

Filter by internal

paths.name

string

query

False

Filter by paths.name

paths.node.uuid

string

query

False

Filter by paths.node.uuid

paths.node.name

string

query

False

Filter by paths.node.name

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

errors.reason.arguments.code

string

query

False

Filter by errors.reason.arguments.code

  • Introduced in: 9.10

errors.reason.arguments.message

string

query

False

Filter by errors.reason.arguments.message

  • Introduced in: 9.10

serial_number

string

query

False

Filter by serial_number

current_sensors.current

integer

query

False

Filter by current_sensors.current

  • Introduced in: 9.10

current_sensors.id

integer

query

False

Filter by current_sensors.id

  • Introduced in: 9.10

current_sensors.state

string

query

False

Filter by current_sensors.state

  • Introduced in: 9.10

current_sensors.installed

boolean

query

False

Filter by current_sensors.installed

  • Introduced in: 9.13

current_sensors.location

string

query

False

Filter by current_sensors.location

  • Introduced in: 9.10

module_type

string

query

False

Filter by module_type

model

string

query

False

Filter by model

bays.id

integer

query

False

Filter by bays.id

bays.drawer.id

integer

query

False

Filter by bays.drawer.id

  • Introduced in: 9.11

bays.drawer.slot

integer

query

False

Filter by bays.drawer.slot

  • Introduced in: 9.11

bays.type

string

query

False

Filter by bays.type

bays.has_disk

boolean

query

False

Filter by bays.has_disk

bays.state

string

query

False

Filter by bays.state

raw_capacity

integer

query

False

Filter by raw_capacity

  • Introduced in: 9.17

voltage_sensors.state

string

query

False

Filter by voltage_sensors.state

  • Introduced in: 9.10

voltage_sensors.location

string

query

False

Filter by voltage_sensors.location

  • Introduced in: 9.10

voltage_sensors.installed

boolean

query

False

Filter by voltage_sensors.installed

  • Introduced in: 9.13

voltage_sensors.voltage

number

query

False

Filter by voltage_sensors.voltage

  • Introduced in: 9.10

voltage_sensors.id

integer

query

False

Filter by voltage_sensors.id

  • Introduced in: 9.10

vendor.product

string

query

False

Filter by vendor.product

  • 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

vendor.part_number

string

query

False

Filter by vendor.part_number

  • Introduced in: 9.8

vendor.name

string

query

False

Filter by vendor.name

  • Introduced in: 9.10

frus.serial_number

string

query

False

Filter by frus.serial_number

frus.psu.power_rating

integer

query

False

Filter by frus.psu.power_rating

  • Introduced in: 9.10

frus.psu.crest_factor

integer

query

False

Filter by frus.psu.crest_factor

  • Introduced in: 9.10

frus.psu.power_drawn

integer

query

False

Filter by frus.psu.power_drawn

  • Introduced in: 9.10

frus.psu.model

string

query

False

Filter by frus.psu.model

  • Introduced in: 9.10

frus.type

string

query

False

Filter by frus.type

frus.id

integer

query

False

Filter by frus.id

frus.part_number

string

query

False

Filter by frus.part_number

frus.installed

boolean

query

False

Filter by frus.installed

  • Introduced in: 9.10

frus.state

string

query

False

Filter by frus.state

frus.firmware_version

string

query

False

Filter by frus.firmware_version

fans.state

string

query

False

Filter by fans.state

  • Introduced in: 9.9

fans.installed

boolean

query

False

Filter by fans.installed

  • Introduced in: 9.13

fans.location

string

query

False

Filter by fans.location

  • Introduced in: 9.9

fans.id

integer

query

False

Filter by fans.id

  • Introduced in: 9.9

fans.rpm

integer

query

False

Filter by fans.rpm

  • Introduced in: 9.9

state

string

query

False

Filter by state

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"
    }
  },
  "num_records": 1,
  "records": [
    {
      "acps": [
        {
          "address": "192.168.1.104",
          "channel": "out_of_band",
          "connection_state": "full_connectivity",
          "error": {
            "reason": {
              "arguments": [
                {
                  "code": "string",
                  "message": "string"
                }
              ],
              "code": "4",
              "message": "entry doesn't exist"
            },
            "severity": "string",
            "type": "string"
          },
          "netmask": "255.255.252.0",
          "node": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "node1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "port": "e0P",
          "subnet": "192.168.0.1"
        }
      ],
      "bays": [
        {
          "drawer": {
            "id": 1,
            "slot": 0
          },
          "id": 0,
          "state": "ok",
          "type": "single_disk"
        }
      ],
      "connection_type": "sas",
      "current_sensors": [
        {
          "current": 14410,
          "id": 1,
          "installed": 1,
          "location": "rear of the shelf on the lower left power supply",
          "state": "ok"
        }
      ],
      "disk_count": 12,
      "drawers": [
        {
          "disk_count": 12,
          "error": "string",
          "part_number": "111-03071",
          "serial_number": "021604008263",
          "state": "ok"
        }
      ],
      "errors": [
        {
          "reason": {
            "arguments": [
              {
                "code": "string",
                "message": "string"
              }
            ],
            "code": "4",
            "message": "entry doesn't exist"
          }
        }
      ],
      "fans": [
        {
          "id": 1,
          "installed": 1,
          "location": "rear of the shelf on the lower left power supply",
          "rpm": 3020,
          "state": "ok"
        }
      ],
      "frus": [
        {
          "firmware_version": "0191",
          "installed": 1,
          "part_number": "111-00690+A2",
          "psu": {
            "crest_factor": 92,
            "model": "00",
            "power_drawn": 210,
            "power_rating": 1600
          },
          "serial_number": "8000166294",
          "state": "error",
          "type": "module"
        }
      ],
      "id": "1",
      "location_led": "off",
      "manufacturer": {
        "name": "NETAPP"
      },
      "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"
          },
          "speed": 100,
          "state": "connected",
          "wwn": "500A0980000B6C3F"
        }
      ],
      "raw_capacity": 5157308772,
      "serial_number": "SHFMS1514000895",
      "state": "ok",
      "temperature_sensors": [
        {
          "ambient": "",
          "id": 1,
          "installed": 1,
          "location": "temp sensor on midplane left",
          "state": "ok",
          "temperature": 32,
          "threshold": {
            "high": {
              "critical": 60,
              "warning": 55
            },
            "low": {
              "critical": 0,
              "warning": 5
            }
          }
        }
      ],
      "uid": "7777841915827391056",
      "vendor": {
        "manufacturer": "XYZ",
        "name": "XYZ",
        "part_number": "A92831142733",
        "product": "LS2246",
        "serial_number": "891234572210221"
      },
      "voltage_sensors": [
        {
          "id": 1,
          "installed": 1,
          "location": "rear of the shelf on the lower left power supply",
          "state": "ok",
          "voltage": 12.18
        }
      ]
    }
  ]
}

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

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

error

Error object is populated when connection_state becomes non-optimal

Name Type Description

reason

error

severity

string

type

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

acps

Name Type Description

address

string

channel

string

connection_state

string

enabled

boolean

error

error

Error object is populated when connection_state becomes non-optimal

netmask

string

node

node

port

string

subnet

string

drawer

Name Type Description

id

integer

The drawer containing this bay

slot

integer

The drawer slot for this bay

bays

Name Type Description

drawer

drawer

has_disk

boolean

id

integer

state

string

type

string

current_sensors

Name Type Description

current

integer

Current, in milliamps

id

integer

installed

boolean

location

string

state

string

drawers

Name Type Description

closed

boolean

disk_count

integer

error

string

id

integer

part_number

string

serial_number

string

state

string

errors

Name Type Description

reason

error

fans

Name Type Description

id

integer

installed

boolean

location

string

rpm

integer

state

string

psu

Name Type Description

crest_factor

integer

The ratio of the peak voltage to the root-mean-square voltage

model

string

power_drawn

integer

Power drawn, in watts

power_rating

integer

Power rating, in watts

frus

Name Type Description

firmware_version

string

id

integer

installed

boolean

part_number

string

psu

psu

serial_number

string

state

string

type

string

manufacturer

Name Type Description

name

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

speed

integer

state

string

wwn

string

high

Name Type Description

critical

integer

High critical threshold, in degrees Celsius

warning

integer

High warning threshold, in degrees Celsius

low

Name Type Description

critical

integer

Low critical threshold, in degrees Celsius

warning

integer

Low warning threshold, in degrees Celsius

threshold

Name Type Description

high

high

low

low

temperature_sensors

Name Type Description

ambient

boolean

Sensor that measures the ambient temperature

id

integer

installed

boolean

location

string

state

string

temperature

integer

Temperature, in degrees Celsius

threshold

threshold

vendor

Name Type Description

manufacturer

string

Support for this field will be removed in a future release. Please use vendor.name for this field.

name

string

part_number

string

Part number

product

string

Product name

serial_number

string

Serial number

voltage_sensors

Name Type Description

id

integer

installed

boolean

location

string

state

string

voltage

number

Voltage, in volts

shelf

Name Type Description

acps

array[acps]

Alternate Control Paths to ACP processors/functions in shelf modules and expanders

bays

array[bays]

connection_type

string

current_sensors

array[current_sensors]

disk_count

integer

drawers

array[drawers]

errors

array[errors]

fans

array[fans]

frus

array[frus]

id

string

internal

boolean

local

boolean

location_led

string

manufacturer

manufacturer

model

string

module_type

string

name

string

paths

array[paths]

ports

array[ports]

raw_capacity

integer

Raw capacity of drives in shelf in 4k blocks

serial_number

string

state

string

temperature_sensors

array[temperature_sensors]

uid

string

vendor

vendor

voltage_sensors

array[voltage_sensors]

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.