(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 91
53-1003160-01
Summary data
5
Port summaries
Retrieves port summary data.
Depending on monitor and measure characteristics, there are various port summaries. The URIs in
the following table return a list of URIs for the possible port summaries in the specific context.
You can then use the returned URIs to get specific port-related summaries, such as Top N, Bottom
N, or Distribution data for a specific port measure.
GET URIs
Path parameters
Notes
• The response schema is SummariesResponse.
• The class name and parameters of the returned summary data are also in the response.
Top N and Bottom N port summary URIs
The following table shows the mapping of URIs to specific measures.
URI Description
<BASE_URI>/resourcegroups/rgkey/portsummaries Retrieves port summary data for the specified
resource group.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/por
tsummaries
Retrieves port summary data for the specified FC
fabric.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/portsummaries
Retrieves port summary data for the specified FC
switch of the specified FC fabric.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/p
ortsummaries
Retrieves port summary data for the specified FC
switch.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
fcskey FC switch identifier.
TABLE 3 Mapping of Top N and Bottom N port summary URIs to specific measures
Measure Type URI Units
Port Utilization Percentage FC utilpercentage %tage
Traf fic FC traffic
CRC Errors FC crcerrors
Link Resets FC linkresets
Signal Losses FC signallosses
Sync Losses FC synclosses