Retrieve shelves
GET /storage/shelves
Introduced In: 9.6
Retrieves a collection of shelves.
Related ONTAP commands
-
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.channel |
string |
query |
False |
Filter by acps.channel
|
acps.connection_state |
string |
query |
False |
Filter by acps.connection_state
|
acps.port |
string |
query |
False |
Filter by acps.port
|
acps.error.severity |
string |
query |
False |
Filter by acps.error.severity
|
acps.error.reason.arguments.message |
string |
query |
False |
Filter by acps.error.reason.arguments.message
|
acps.error.reason.arguments.code |
string |
query |
False |
Filter by acps.error.reason.arguments.code
|
acps.error.reason.message |
string |
query |
False |
Filter by acps.error.reason.message
|
acps.error.reason.code |
string |
query |
False |
Filter by acps.error.reason.code
|
acps.error.reason.target |
string |
query |
False |
Filter by acps.error.reason.target
|
acps.error.type |
string |
query |
False |
Filter by acps.error.type
|
acps.node.uuid |
string |
query |
False |
Filter by acps.node.uuid
|
acps.node.name |
string |
query |
False |
Filter by acps.node.name
|
acps.subnet |
string |
query |
False |
Filter by acps.subnet
|
acps.address |
string |
query |
False |
Filter by acps.address
|
acps.enabled |
boolean |
query |
False |
Filter by acps.enabled
|
acps.netmask |
string |
query |
False |
Filter by acps.netmask
|
id |
string |
query |
False |
Filter by id |
uid |
string |
query |
False |
Filter by uid |
connection_type |
string |
query |
False |
Filter by connection_type |
vendor.product |
string |
query |
False |
Filter by vendor.product
|
vendor.name |
string |
query |
False |
Filter by vendor.name
|
vendor.part_number |
string |
query |
False |
Filter by vendor.part_number
|
vendor.serial_number |
string |
query |
False |
Filter by vendor.serial_number
|
vendor.manufacturer |
string |
query |
False |
Filter by vendor.manufacturer
|
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 |
bays.has_disk |
boolean |
query |
False |
Filter by bays.has_disk |
bays.drawer.id |
integer |
query |
False |
Filter by bays.drawer.id
|
bays.drawer.slot |
integer |
query |
False |
Filter by bays.drawer.slot
|
location_led |
string |
query |
False |
Filter by location_led
|
current_sensors.current |
integer |
query |
False |
Filter by current_sensors.current
|
current_sensors.id |
integer |
query |
False |
Filter by current_sensors.id
|
current_sensors.location |
string |
query |
False |
Filter by current_sensors.location
|
current_sensors.state |
string |
query |
False |
Filter by current_sensors.state
|
current_sensors.installed |
boolean |
query |
False |
Filter by current_sensors.installed
|
errors.reason.arguments.message |
string |
query |
False |
Filter by errors.reason.arguments.message
|
errors.reason.arguments.code |
string |
query |
False |
Filter by errors.reason.arguments.code
|
errors.reason.message |
string |
query |
False |
Filter by errors.reason.message
|
errors.reason.code |
string |
query |
False |
Filter by errors.reason.code
|
errors.reason.target |
string |
query |
False |
Filter by errors.reason.target
|
serial_number |
string |
query |
False |
Filter by serial_number |
manufacturer.name |
string |
query |
False |
Filter by manufacturer.name
|
model |
string |
query |
False |
Filter by model |
voltage_sensors.id |
integer |
query |
False |
Filter by voltage_sensors.id
|
voltage_sensors.location |
string |
query |
False |
Filter by voltage_sensors.location
|
voltage_sensors.installed |
boolean |
query |
False |
Filter by voltage_sensors.installed
|
voltage_sensors.state |
string |
query |
False |
Filter by voltage_sensors.state
|
voltage_sensors.voltage |
number |
query |
False |
Filter by voltage_sensors.voltage
|
drawers.error |
string |
query |
False |
Filter by drawers.error |
drawers.state |
string |
query |
False |
Filter by drawers.state |
drawers.closed |
boolean |
query |
False |
Filter by drawers.closed |
drawers.part_number |
string |
query |
False |
Filter by drawers.part_number |
drawers.serial_number |
string |
query |
False |
Filter by drawers.serial_number |
drawers.id |
integer |
query |
False |
Filter by drawers.id |
drawers.disk_count |
integer |
query |
False |
Filter by drawers.disk_count |
local |
boolean |
query |
False |
Filter by local
|
internal |
boolean |
query |
False |
Filter by internal |
ports.id |
integer |
query |
False |
Filter by ports.id |
ports.internal |
boolean |
query |
False |
Filter by ports.internal |
ports.module_id |
string |
query |
False |
Filter by ports.module_id |
ports.state |
string |
query |
False |
Filter by ports.state |
ports.mac_address |
string |
query |
False |
Filter by ports.mac_address |
ports.cable.identifier |
string |
query |
False |
Filter by ports.cable.identifier |
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.wwn |
string |
query |
False |
Filter by ports.wwn |
ports.remote.device |
string |
query |
False |
Filter by ports.remote.device
|
ports.remote.phy |
string |
query |
False |
Filter by ports.remote.phy |
ports.remote.wwn |
string |
query |
False |
Filter by ports.remote.wwn |
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.designator |
string |
query |
False |
Filter by ports.designator |
frus.psu.power_rating |
integer |
query |
False |
Filter by frus.psu.power_rating
|
frus.psu.model |
string |
query |
False |
Filter by frus.psu.model
|
frus.psu.power_drawn |
integer |
query |
False |
Filter by frus.psu.power_drawn
|
frus.psu.crest_factor |
integer |
query |
False |
Filter by frus.psu.crest_factor
|
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 |
frus.state |
string |
query |
False |
Filter by frus.state |
frus.installed |
boolean |
query |
False |
Filter by frus.installed
|
frus.serial_number |
string |
query |
False |
Filter by frus.serial_number |
frus.part_number |
string |
query |
False |
Filter by frus.part_number |
fans.state |
string |
query |
False |
Filter by fans.state
|
fans.installed |
boolean |
query |
False |
Filter by fans.installed
|
fans.location |
string |
query |
False |
Filter by fans.location
|
fans.rpm |
integer |
query |
False |
Filter by fans.rpm
|
fans.id |
integer |
query |
False |
Filter by fans.id
|
disk_count |
integer |
query |
False |
Filter by disk_count |
state |
string |
query |
False |
Filter by state |
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 |
name |
string |
query |
False |
Filter by name |
temperature_sensors.threshold.low.critical |
integer |
query |
False |
Filter by temperature_sensors.threshold.low.critical
|
temperature_sensors.threshold.low.warning |
integer |
query |
False |
Filter by temperature_sensors.threshold.low.warning
|
temperature_sensors.threshold.high.warning |
integer |
query |
False |
Filter by temperature_sensors.threshold.high.warning
|
temperature_sensors.threshold.high.critical |
integer |
query |
False |
Filter by temperature_sensors.threshold.high.critical
|
temperature_sensors.installed |
boolean |
query |
False |
Filter by temperature_sensors.installed
|
temperature_sensors.temperature |
integer |
query |
False |
Filter by temperature_sensors.temperature
|
temperature_sensors.state |
string |
query |
False |
Filter by temperature_sensors.state
|
temperature_sensors.location |
string |
query |
False |
Filter by temperature_sensors.location
|
temperature_sensors.id |
integer |
query |
False |
Filter by temperature_sensors.id
|
temperature_sensors.ambient |
boolean |
query |
False |
Filter by temperature_sensors.ambient
|
module_type |
string |
query |
False |
Filter by module_type |
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 |
||
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",
"target": "uuid"
},
"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",
"target": "uuid"
}
}
],
"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"
},
"state": "connected",
"wwn": "500A0980000B6C3F"
}
],
"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 |
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 |
||
self |
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. |
error
Error object is populated when connection_state becomes non-optimal
Name | Type | Description |
---|---|---|
reason |
||
severity |
string |
|
type |
string |
_links
Name | Type | Description |
---|---|---|
self |
node
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
acps
Name | Type | Description |
---|---|---|
address |
string |
|
channel |
string |
|
connection_state |
string |
|
enabled |
boolean |
|
error |
Error object is populated when connection_state becomes non-optimal |
|
netmask |
string |
|
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 |
||
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 |