REST API reference
Retrieve a shelf
Suggest changes
PDFs
GET /storage/shelves/{uid}
Introduced In: 9.6
Retrieves a specific shelf.
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 |
|---|---|---|---|---|
uid |
string |
path |
True |
Shelf UID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| 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 |
||
model |
string |
|
module_type |
string |
|
name |
string |
|
paths |
array[paths] |
|
ports |
array[ports] |
|
serial_number |
string |
|
state |
string |
|
temperature_sensors |
array[temperature_sensors] |
|
uid |
string |
|
vendor |
||
voltage_sensors |
array[voltage_sensors] |
Example response
{
"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"
},
"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
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 |
||
severity |
string |
|
type |
string |
href
| Name | Type | Description |
|---|---|---|
href |
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 |
string |
|
state |
string |
errors
| Name | Type | Description |
|---|---|---|
reason |
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 |
||
serial_number |
string |
|
state |
string |
|
type |
string |
manufacturer
| Name | Type | Description |
|---|---|---|
name |
string |
paths
Storage port
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
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 |
||
designator |
string |
|
id |
integer |
|
internal |
boolean |
|
mac_address |
string |
|
module_id |
string |
|
remote |
||
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 |
||
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 |
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 |
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. |