Retrieve a collection of bridges
GET /storage/bridges
Introduced In: 9.9
Retrieves a collection of bridges.
Related ONTAP commands
-
storage bridge show
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
wwn |
string |
query |
False |
Filter by wwn |
dram_single_bit_error_count |
integer |
query |
False |
Filter by dram_single_bit_error_count |
temperature_sensor.state |
string |
query |
False |
Filter by temperature_sensor.state |
temperature_sensor.minimum |
integer |
query |
False |
Filter by temperature_sensor.minimum |
temperature_sensor.name |
string |
query |
False |
Filter by temperature_sensor.name |
temperature_sensor.maximum |
integer |
query |
False |
Filter by temperature_sensor.maximum |
temperature_sensor.reading |
integer |
query |
False |
Filter by temperature_sensor.reading |
symbolic_name |
string |
query |
False |
Filter by symbolic_name |
managed_by |
string |
query |
False |
Filter by managed_by |
ip_address |
string |
query |
False |
Filter by ip_address |
power_supply_units.name |
string |
query |
False |
Filter by power_supply_units.name |
power_supply_units.state |
string |
query |
False |
Filter by power_supply_units.state |
name |
string |
query |
False |
Filter by name |
serial_number |
string |
query |
False |
Filter by serial_number |
fc_ports.configured_data_rate |
number |
query |
False |
Filter by fc_ports.configured_data_rate |
fc_ports.enabled |
boolean |
query |
False |
Filter by fc_ports.enabled |
fc_ports.id |
integer |
query |
False |
Filter by fc_ports.id |
fc_ports.peer_wwn |
string |
query |
False |
Filter by fc_ports.peer_wwn |
fc_ports.connection_mode |
string |
query |
False |
Filter by fc_ports.connection_mode |
fc_ports.sfp.vendor |
string |
query |
False |
Filter by fc_ports.sfp.vendor |
fc_ports.sfp.data_rate_capability |
number |
query |
False |
Filter by fc_ports.sfp.data_rate_capability |
fc_ports.sfp.part_number |
string |
query |
False |
Filter by fc_ports.sfp.part_number |
fc_ports.sfp.serial_number |
string |
query |
False |
Filter by fc_ports.sfp.serial_number |
fc_ports.negotiated_data_rate |
number |
query |
False |
Filter by fc_ports.negotiated_data_rate |
fc_ports.wwn |
string |
query |
False |
Filter by fc_ports.wwn |
fc_ports.state |
string |
query |
False |
Filter by fc_ports.state |
fc_ports.data_rate_capability |
number |
query |
False |
Filter by fc_ports.data_rate_capability |
monitoring_enabled |
boolean |
query |
False |
Filter by monitoring_enabled |
last_reboot.time |
string |
query |
False |
Filter by last_reboot.time |
last_reboot.reason.code |
string |
query |
False |
Filter by last_reboot.reason.code |
last_reboot.reason.arguments.code |
string |
query |
False |
Filter by last_reboot.reason.arguments.code
|
last_reboot.reason.arguments.message |
string |
query |
False |
Filter by last_reboot.reason.arguments.message
|
last_reboot.reason.message |
string |
query |
False |
Filter by last_reboot.reason.message |
firmware_version |
string |
query |
False |
Filter by firmware_version |
paths.target_port.wwn |
string |
query |
False |
Filter by paths.target_port.wwn |
paths.target_port.name |
string |
query |
False |
Filter by paths.target_port.name |
paths.target_port.id |
string |
query |
False |
Filter by paths.target_port.id |
paths.source_port.name |
string |
query |
False |
Filter by paths.source_port.name |
paths.source_port.id |
string |
query |
False |
Filter by paths.source_port.id |
paths.node.name |
string |
query |
False |
Filter by paths.node.name |
paths.node.uuid |
string |
query |
False |
Filter by paths.node.uuid |
paths.name |
string |
query |
False |
Filter by paths.name |
state |
string |
query |
False |
Filter by state |
chassis_throughput_state |
string |
query |
False |
Filter by chassis_throughput_state |
security_enabled |
boolean |
query |
False |
Filter by security_enabled |
errors.type |
string |
query |
False |
Filter by errors.type |
errors.reason.code |
string |
query |
False |
Filter by errors.reason.code |
errors.reason.arguments.code |
string |
query |
False |
Filter by errors.reason.arguments.code
|
errors.reason.arguments.message |
string |
query |
False |
Filter by errors.reason.arguments.message
|
errors.reason.message |
string |
query |
False |
Filter by errors.reason.message |
errors.severity |
string |
query |
False |
Filter by errors.severity |
errors.component.unique_id |
string |
query |
False |
Filter by errors.component.unique_id |
errors.component.name |
string |
query |
False |
Filter by errors.component.name |
errors.component.id |
integer |
query |
False |
Filter by errors.component.id |
model |
string |
query |
False |
Filter by model |
vendor |
string |
query |
False |
Filter by vendor |
sas_ports.state |
string |
query |
False |
Filter by sas_ports.state |
sas_ports.wwn |
string |
query |
False |
Filter by sas_ports.wwn |
sas_ports.negotiated_data_rate |
number |
query |
False |
Filter by sas_ports.negotiated_data_rate |
sas_ports.phy_3.state |
string |
query |
False |
Filter by sas_ports.phy_3.state |
sas_ports.data_rate_capability |
number |
query |
False |
Filter by sas_ports.data_rate_capability |
sas_ports.phy_1.state |
string |
query |
False |
Filter by sas_ports.phy_1.state |
sas_ports.enabled |
boolean |
query |
False |
Filter by sas_ports.enabled |
sas_ports.phy_2.state |
string |
query |
False |
Filter by sas_ports.phy_2.state |
sas_ports.id |
integer |
query |
False |
Filter by sas_ports.id |
sas_ports.phy_4.state |
string |
query |
False |
Filter by sas_ports.phy_4.state |
sas_ports.cable.technology |
string |
query |
False |
Filter by sas_ports.cable.technology |
sas_ports.cable.part_number |
string |
query |
False |
Filter by sas_ports.cable.part_number |
sas_ports.cable.serial_number |
string |
query |
False |
Filter by sas_ports.cable.serial_number |
sas_ports.cable.vendor |
string |
query |
False |
Filter by sas_ports.cable.vendor |
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_bridge] |
Example response
Error
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
next |
||
self |
component
Name | Type | Description |
---|---|---|
id |
integer |
Bridge error component ID |
name |
string |
Bridge error component name |
unique_id |
string |
Bridge error component unique ID |
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 |
Bridge error severity |
type |
string |
Bridge error type |
sfp
Name | Type | Description |
---|---|---|
data_rate_capability |
number |
Bridge FC port SFP data rate capability, in Gbps |
part_number |
string |
|
serial_number |
string |
Bridge FC port SFP serial number |
vendor |
string |
Bridge FC port SFP vendor |
fc_ports
Name | Type | Description |
---|---|---|
configured_data_rate |
number |
Bridge FC port configured data rate, in Gbps |
connection_mode |
string |
Bridge FC port configured connection mode |
data_rate_capability |
number |
Bridge FC port data rate capability, in Gbps |
enabled |
boolean |
Indicates whether the bridge FC port is enabled. |
id |
integer |
Bridge FC port index |
negotiated_data_rate |
number |
Bridge FC port negotiated data rate, in Gbps |
peer_wwn |
string |
Bridge FC port peer port world wide name |
sfp |
||
state |
string |
Bridge FC port state |
wwn |
string |
Bridge FC port world wide name |
error
The error message and code explaining why the bridge rebooted.
Name | Type | Description |
---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
last_reboot
Name | Type | Description |
---|---|---|
reason |
The error message and code explaining why the bridge rebooted. |
|
time |
string |
_links
Name | Type | Description |
---|---|---|
self |
node
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
source_port
Name | Type | Description |
---|---|---|
id |
string |
Initiator side switch port id |
name |
string |
Initiator side switch port name |
target_port
Name | Type | Description |
---|---|---|
id |
string |
Target side switch port id |
name |
string |
Target side switch port name |
wwn |
string |
Target side switch port world wide name |
paths
Name | Type | Description |
---|---|---|
name |
string |
|
node |
||
source_port |
||
target_port |
power_supply_units
Name | Type | Description |
---|---|---|
name |
string |
Power supply unit name |
state |
string |
Power supply unit state |
cable
Name | Type | Description |
---|---|---|
part_number |
string |
Bridge cable part number |
serial_number |
string |
Bridge cable serial number |
technology |
string |
Bridge cable type |
vendor |
string |
Bridge cable vendor |
phy_1
Name | Type | Description |
---|---|---|
state |
string |
Bridge SAS port PHY1 state |
phy_2
Name | Type | Description |
---|---|---|
state |
string |
Bridge SAS port PHY2 state |
phy_3
Name | Type | Description |
---|---|---|
state |
string |
Bridge SAS port PHY3 state |
phy_4
Name | Type | Description |
---|---|---|
state |
string |
Bridge SAS port PHY4 state |
sas_ports
Name | Type | Description |
---|---|---|
cable |
||
data_rate_capability |
number |
Bridge SAS port data rate capability, in Gbps |
enabled |
boolean |
Indicates whether a bridge SAS port is enabled. |
id |
integer |
Bridge SAS port index |
negotiated_data_rate |
number |
Bridge SAS port negotiated data rate, in Gbps |
phy_1 |
||
phy_2 |
||
phy_3 |
||
phy_4 |
||
state |
string |
Bridge SAS port state |
wwn |
string |
Bridge SAS port world wide name |
temperature_sensor
Name | Type | Description |
---|---|---|
maximum |
integer |
Maximum safe operating temperature, in degrees Celsius. |
minimum |
integer |
Minimum safe operating temperature, in degrees Celsius. |
name |
string |
Temperature sensor name |
reading |
integer |
Chassis temperature sensor reading, in degrees Celsius. |
state |
string |
storage_bridge
Name | Type | Description |
---|---|---|
chassis_throughput_state |
string |
Chassis throughput status |
dram_single_bit_error_count |
integer |
|
errors |
array[errors] |
|
fc_ports |
array[fc_ports] |
|
firmware_version |
string |
Bridge firmware version |
ip_address |
string |
IP Address |
last_reboot |
||
managed_by |
string |
|
model |
string |
Bridge model |
monitoring_enabled |
boolean |
Indicates whether monitoring is enabled for the bridge. |
name |
string |
Bridge name |
paths |
array[paths] |
|
power_supply_units |
array[power_supply_units] |
|
sas_ports |
array[sas_ports] |
|
security_enabled |
boolean |
Indicates whether security is enabled for the bridge. |
serial_number |
string |
Bridge serial number |
state |
string |
Bridge state |
symbolic_name |
string |
Bridge symbolic name |
temperature_sensor |
||
vendor |
string |
Bridge vendor |
wwn |
string |
Bridge world wide name |
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. |