(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
Brocade Network Advisor REST API Guide 59
53-1003160-01
Topology
5
FCPorts
Retrieves information about FC ports.
GET URIs
Path parameters
Response parameters
URI Description
<BASE_URI>/resourcegroups/rgkey/fcports Returns a list of FC ports for the given resource
group.
<BASE_URI>/resourcegroups/rgkey/fcports/fcpkey Returns details of the given port.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/f
cports
Returns a list of FC ports for the given FC switch.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/f
cports/fcpkey
Returns details of the given port.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/fcports
Returns a list of FC ports for the given FC switch
under the given FC fabric.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/fcports/fcpkey
Returns details of the given port.
<BASE_URI>/resourcegroups/rgkey/accessgateways/ag
key/fcports
Returns a list of FC ports for the given access
gateway.
<BASE_URI>/resourcegroups/rgkey/accessgateways/ag
key/fcports/fcpkey
Returns details of the given port of the given access
gateway.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
fcskey FC switch identifier.
fcpkey FC port identifier.
agkey Access gateway identifier.
Property Description
key The unique identifier for the port, which is the WWN.
NOTE: The key of the Front phantom port is FF-wwn.
The key of Xlate phantom port is XF-wwn.
wwn The WWN of the port.
name The user-assigned port name.
slotNumber The slot number. The default value is 0.
portNumber The logical port number within the slot. In case of directors, this port number is unique
within the slot.
userPortNumber The user port number. This is a unique port number within a chassis.