(Supporting Network Advisor 12.3.0)
Table Of Contents
- Contents
- About This Document
- Overview of the Network Advisor REST API
- Getting Started
- Using the Brocade Network Advisor REST API
- Introduction
- Logging in and out
- Specifying content type
- Versioning (backward compatibility)
- Using the Topology API
- Using the SAN Fabric Discovery API
- Using the Traffic Flow API
- Using the Summary Data API
- Using the Events API
- Using the Zoning API
- Using the Historical Performance Data API
- Fibre Channel Routing
- Handling errors
- Use Cases
- API Reference
- Request and Response Schemas
- Topology
- SAN fabric discovery
- Summary data
- SummaryResponse
- StatusSummary
- AssetClassificationSummary
- NetworkObjectCountSummary
- EventsSummary
- BottleneckViolationsSummary
- OutOfRangeViolationsSummary
- PortHealthViolationsSummary
- VmViolationsSummary
- SummariesResponse
- PortsMonitorSummaryData
- MonitorDistributionData
- ProductsMonitorSummaryData
- FlowMonitorSummaryData
- Events
- Zoning
- Historical performance data
- Authentication and session management
54 Brocade Network Advisor REST API Guide
53-1003160-01
Topology
5
FC Switch
Retrieves information about FC switches.
GET URIs
Path parameters
Response parameters
URI Description
<BASE_URI>/resourcegroups/rgkey/fcswitches Retrieves the FC switches of the given resource
group.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey Retrieves information about the specified FC switch.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches
Retrieves the FC switches of the given FC fabric.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey
Retrieves information about the specified FC switch.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
fcskey FC switch identifier.
Property Description
key The unique identifier for the switch, which is the switch WWN.
type The switch type, the sw_bd_type of the switch.
name The switch name.
wwn The switch WWN.
virtualFabricId The virtual fabric ID. A positive value indicates VF is enabled; otherwise -1.
domainId The domain ID of the switch.
baseSwitch Indicates whether it is a base switch.
role The role of the switch. Refer to RoleType.
fcsRole The FCS role of the switch. This is applicable only when FCS policy is on.
adCapable Indicates the switch’s capability for Admin domain.
operationalStatus The operational status of the switch. Refer to OperStatusType.
state The state of the switch. Refer to StateType.
statusReason The status reason, the contributors to the status.
lfEnabled Indicates if logical fabric is enabled on the switch.
defaultLogicalSwitch Indicates if the switch is the default logical switch.
fmsMode Indicates the FMS mode in FICON environment.