Retrieve a collection of chassis
Retrieves information about multiple chassis, accessing the system's hardware configuration details and related attributes. This helps you understand the physical components and their status in your environment.
HTTP method and endpoint
GET /cluster/chassis
Introduced in
ONTAP 9.6
Usage notes
Retrieves a collection of chassis.
Related ONTAP commands
-
system chassis show -
system chassis fru show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
nodes.name |
string |
query |
False |
Filter by nodes.name |
nodes.uuid |
string |
query |
False |
Filter by nodes.uuid |
nodes.pcis.cards.slot |
string |
query |
False |
Filter by nodes.pcis.cards.slot
|
nodes.pcis.cards.info |
string |
query |
False |
Filter by nodes.pcis.cards.info
|
nodes.pcis.cards.device |
string |
query |
False |
Filter by nodes.pcis.cards.device
|
nodes.usbs.supported |
boolean |
query |
False |
Filter by nodes.usbs.supported
|
nodes.usbs.ports.connected |
boolean |
query |
False |
Filter by nodes.usbs.ports.connected
|
nodes.usbs.enabled |
boolean |
query |
False |
Filter by nodes.usbs.enabled
|
nodes.position |
string |
query |
False |
Filter by nodes.position
|
shelves.uid |
string |
query |
False |
Filter by shelves.uid |
id |
string |
query |
False |
Filter by id |
state |
string |
query |
False |
Filter by state |
frus.id |
string |
query |
False |
Filter by frus.id |
frus.type |
string |
query |
False |
Filter by frus.type |
frus.state |
string |
query |
False |
Filter by frus.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.
|
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[chassis] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"frus": [
{
"id": "string",
"state": "string",
"type": "string"
}
],
"id": "021352005981",
"nodes": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"pcis": {
"cards": [
{
"device": "Intel Lewisburg series chipset SATA Controller",
"info": "Additional Info: 0 (0xaaf00000) SHM2S86Q120GLM22NP FW1146 114473MB 512B/sect (SPG190108GW)",
"slot": "0"
}
]
},
"position": "top",
"usbs": {
"ports": [
{}
]
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"shelves": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uid": "7777841915827391056"
}
],
"state": "string"
}
]
}
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 |
frus
| Name | Type | Description |
|---|---|---|
id |
string |
|
state |
string |
|
type |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
cards
| Name | Type | Description |
|---|---|---|
device |
string |
The description of the PCI card. |
info |
string |
The info string from the device driver of the PCI card. |
slot |
string |
The slot where the PCI card is placed. This can sometimes take the form of "6-1" to indicate slot and subslot. |
pcis
| Name | Type | Description |
|---|---|---|
cards |
array[cards] |
ports
| Name | Type | Description |
|---|---|---|
connected |
boolean |
Indicates whether or not the USB port has a device connected to it. |
usbs
The status of the USB ports on the controller.
| Name | Type | Description |
|---|---|---|
enabled |
boolean |
Indicates whether or not the USB ports are enabled. |
ports |
array[ports] |
|
supported |
boolean |
Indicates whether or not USB ports are supported on the current platform. |
nodes
List of nodes in chassis.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
pcis |
||
position |
string |
The position of the node in the chassis, when viewed from the rear of the system. |
usbs |
The status of the USB ports on the controller. |
|
uuid |
string |
shelf_reference
Shelf
| Name | Type | Description |
|---|---|---|
_links |
||
uid |
string |
chassis
| Name | Type | Description |
|---|---|---|
frus |
array[frus] |
List of FRUs in the chassis. |
id |
string |
|
nodes |
array[nodes] |
List of nodes in the chassis. |
shelves |
array[shelf_reference] |
List of shelves in chassis. |
state |
string |
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. |