REST API reference
Retrieve storage switches
Suggest changes
PDFs
GET /storage/switches
Introduced In: 9.9
Retrieves a collection of storage switches.
Related ONTAP commands
-
storage switch show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
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[storage_switch] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"connections": [
{
"peer_port": {
"connection": "string",
"type": "string",
"unique_id": "string",
"wwn": "string"
},
"source_port": {
"mode": "string",
"name": "string",
"wwn": "string"
}
}
],
"errors": [
{
"component": {
"name": "string"
},
"reason": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist"
},
"severity": "string",
"type": "string"
}
],
"fabric_name": "string",
"fans": [
{
"name": "string",
"state": "string"
}
],
"firmware_version": "string",
"ip_address": "string",
"model": "string",
"monitored_blades": [
"integer"
],
"name": "string",
"paths": [
{
"adapter": {
"name": "string",
"type": "string",
"wwn": "string"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"port": {
"name": "string"
}
}
],
"ports": [
{
"mode": "string",
"name": "string",
"sfp": {
"serial_number": "string",
"transmitter_type": "string",
"type": "string"
},
"state": "string",
"wwn": "string"
}
],
"power_supply_units": [
{
"name": "string",
"state": "string"
}
],
"role": "string",
"state": "string",
"symbolic_name": "string",
"temperature_sensors": [
{
"name": "string",
"state": "string"
}
],
"vendor": "string",
"vsans": [
{
"load_balancing_types": "string",
"name": "string",
"state": "string"
}
],
"wwn": "string",
"zones": [
{
"name": "string",
"port": {
"id": "string",
"name": "string"
},
"wwn": "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 |
peer_port
| Name | Type | Description |
|---|---|---|
connection |
string |
Storage switch peer port host and name |
type |
string |
Storage switch peer type |
unique_id |
string |
Storage switch peer unique ID |
wwn |
string |
Storage switch peer port world wide name |
source_port
| Name | Type | Description |
|---|---|---|
mode |
string |
Storage switch port operating mode |
name |
string |
Storage switch port name |
wwn |
string |
Storage switch peer port world wide name |
connections
| Name | Type | Description |
|---|---|---|
peer_port |
||
source_port |
component
| Name | Type | Description |
|---|---|---|
id |
integer |
Error component ID |
name |
string |
Error component name |
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 |
errors
| Name | Type | Description |
|---|---|---|
component |
||
reason |
||
severity |
string |
Error component severity |
type |
string |
Error component type |
fans
| Name | Type | Description |
|---|---|---|
name |
string |
Storage switch fan name |
speed |
integer |
Storage switch fan speed |
state |
string |
Storage switch fan state |
adapter
| Name | Type | Description |
|---|---|---|
name |
string |
Node adapter name |
type |
string |
Node adapter type |
wwn |
string |
Node adapter world wide name |
_links
| Name | Type | Description |
|---|---|---|
self |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
port
| Name | Type | Description |
|---|---|---|
name |
string |
Storage switch port name |
speed |
integer |
Storage switch port speed, in Gbps |
paths
| Name | Type | Description |
|---|---|---|
adapter |
||
node |
||
port |
sfp
| Name | Type | Description |
|---|---|---|
serial_number |
string |
Storage switch port SFP serial number |
transmitter_type |
string |
Storage switch port SFP transmitter type |
type |
string |
Storage switch port SFP type |
ports
| Name | Type | Description |
|---|---|---|
enabled |
boolean |
Indicates whether the storage switch port is enabled. |
mode |
string |
Storage switch port mode |
name |
string |
Storage switch port name |
sfp |
||
speed |
integer |
Storage switch port speed, in Gbps |
state |
string |
Storage switch port state |
wwn |
string |
Storage switch port world wide name |
power_supply_units
| Name | Type | Description |
|---|---|---|
name |
string |
Power supply unit name |
state |
string |
Power supply unit state |
temperature_sensors
| Name | Type | Description |
|---|---|---|
name |
string |
Temperature sensor name |
reading |
integer |
Temperature sensor reading, in degrees celsius. |
state |
string |
Temperature sensor state |
vsans
| Name | Type | Description |
|---|---|---|
id |
integer |
Storage switch VSAN ID |
iod |
boolean |
Indicates whether in-order delivery is set for a zone. |
load_balancing_types |
string |
Storage switch VSAN load balancing type |
name |
string |
Storage switch VSAN name |
state |
string |
Storage switch VSAN Port state |
port
| Name | Type | Description |
|---|---|---|
id |
string |
Storage switch zone port ID |
name |
string |
Storage switch zone port |
zones
| Name | Type | Description |
|---|---|---|
id |
integer |
Storage switch zone ID |
name |
string |
Storage switch zone name |
port |
||
wwn |
string |
Storage switch zone world wide name |
storage_switch
The Storage switch object describes the storage switch properties, features and cabling.
| Name | Type | Description |
|---|---|---|
connections |
array[connections] |
|
director_class |
boolean |
|
domain_id |
integer |
Domain ID |
errors |
array[errors] |
|
fabric_name |
string |
Storage switch fabric name |
fans |
array[fans] |
|
firmware_version |
string |
Storage switch firmware version |
ip_address |
string |
IP Address |
local |
boolean |
Indicates whether the storage switch is directly connected to the reporting cluster. |
model |
string |
Storage switch model. |
monitored_blades |
array[integer] |
Indicates the blades that are being monitored for a director-class switch. |
monitoring_enabled |
boolean |
Indicates whether monitoring is enabled for the storage switch. |
name |
string |
Storage switch name |
paths |
array[paths] |
|
ports |
array[ports] |
|
power_supply_units |
array[power_supply_units] |
|
role |
string |
Storage switch role in fabric. |
state |
string |
Storage switch state |
symbolic_name |
string |
Storage switch symbolic name |
temperature_sensors |
array[temperature_sensors] |
|
vendor |
string |
Storage switch vendor |
vsans |
array[vsans] |
|
wwn |
string |
Storage switch world wide name |
zones |
array[zones] |
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. |