(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
62 Brocade Network Advisor REST API Guide
53-1003160-01
Topology
5
GigePorts
Retrieves information about GigE ports.
GET URIs
Path parameters
Response parameters
URI Description
<BASE_URI>/resourcegroups/rgkey/gigeports Returns a list of GigE ports for the given resource
group.
<BASE_URI>/resourcegroups/rgkey/gigeports/gpkey Returns details of the given GigE port.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/g
igeports
Returns a list of GigE ports for the given FC switch.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/g
igeports/gpkey
Returns details of the given GigE port.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/gigeports
Returns a list of GigE ports for the given FC switch
under the given FC fabric.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/gigeports/gpkey
Returns details of the given GigE port.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
fcskey FC switch identifier.
gpkey GigE port identifier.
Property Description
key The unique identifier for the port, which is the MAC address.
portNumber The GigE port number, 0 for ge0 and 1 for ge1.
slotNumber The slot number on which the GigE port is present.
enabled Indicates if the port is enabled.
speed The port speed.
maxSpeed The maximum port speed.
macAddress The MAC address of the port.
portName The GigE port name.
operationalStatus The status of the port.
ledState The LED state.
speedLedState The speed LED state.
portType The port type.