REST API reference
Retrieve a specific bridge
Suggest changes
PDFs
GET /storage/bridges/{wwn}
Introduced In: 9.9
Retrieves a specific bridge
Related ONTAP commands
-
storage bridge show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
wwn |
string |
path |
True |
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| 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 |
Example response
{
"chassis_throughput_state": "ok",
"errors": {
"severity": "unknown",
"type": "unknown"
},
"fc_ports": {
"configured_data_rate": "0",
"connection_mode": "loop",
"data_rate_capability": "2",
"negotiated_data_rate": "0",
"peer_wwn": "200650eb1a238892",
"sfp": {
"data_rate_capability": "2"
},
"state": "error",
"wwn": "2100001086a54100"
},
"firmware_version": "4.10 007A",
"ip_address": "string",
"last_reboot": {
"reason": {
"code": "39321683",
"message": "FirmwareRestart Command"
},
"time": "2020-12-09T00:47:58-05:00"
},
"managed_by": "snmp",
"model": "FibreBridge6500N",
"name": "ATTO_FibreBridge6500N_1",
"paths": {
"name": "2c",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"source_port": {
"id": "100050eb1a238892",
"name": "rtp-fc03-41kk11:1"
},
"target_port": {
"id": "100050eb1a238892",
"name": "rtp-fc03-41kk11:6",
"wwn": "2100001086a54100"
}
},
"power_supply_units": {
"state": "ok"
},
"sas_ports": {
"data_rate_capability": "0",
"negotiated_data_rate": "0",
"state": "error",
"wwn": "2100001086a54100"
},
"serial_number": "FB7600N100004",
"state": "unknown",
"symbolic_name": "rtp-fcsas03-41kk11",
"temperature_sensor": {
"name": "Chassis temperature sensor",
"state": "ok"
},
"vendor": "atto",
"wwn": "2000001086600476"
}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
component
| Name | Type | Description |
|---|---|---|
id |
integer |
Bridge error component ID |
name |
string |
Bridge error component name |
unique_id |
string |
Bridge error component unique ID |
reason
| Name | Type | Description |
|---|---|---|
code |
string |
|
message |
string |
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 |
reason
| Name | Type | Description |
|---|---|---|
code |
string |
This field provides the error code explaining why did the bridge reboot. |
message |
string |
This field provides the error message explaining why did the bridge reboot. |
last_reboot
| Name | Type | Description |
|---|---|---|
reason |
||
time |
string |
href
| Name | Type | Description |
|---|---|---|
href |
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 |
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. |