(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 109
53-1003160-01
Summary data
5
Traffic flow summaries
Retrieves URIs that retrieve traffic flow summary data.
Depending on monitor and measure charateristics, there are various traffic flow summaries. The
URIs in the following table return a list of URIs for the possible traffic flow summaries in the
specific context.
You can use these URIs to get specific traffic flow-related summary data, such as Top N or Bottom
N data for a specific traffic measure.
GET URIs
Path parameters
Notes
• The response schema is SummariesResponse.
Top N and Bottom N traffic flow summary URIs
The following table states the mapping of the URI for the specific measure.
URI Description
<BASE_URI>/resourcegroups/rgkey/trafficflowsummarie
s
Retrieves traffic flow summary data for the specified
resource group.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/traf
ficflowsummaries
Retrieves traffic flow summary data for the specified
FC fabric.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/trafficflowsummaries
Retrieves traffic flow summary data for the specified
FC switch of the specified FC fabric.
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/t
rafficflowsummaries
Retrieves traffic flow summary data for the specified
FC switch.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
fcfkey FC switch identifier.
TABLE 7 Mapping of the Top N and Bottom N traffic flow summary URIs to the specific measures
Measure Type URI Units
SCSI Read Frame Count (frames) SCSI scsireadframecount count
SCSI Write Frame Count (frames SCSI scsiwriteframecount count
SCSI Read Frame Rate (f/s) SCSI scsireadframerate
SCSI Write Frame Rate (f/s) SCSI scsiwriteframerate
SCSI Read Data (bytes) SCSI scsireaddata
SCSI Write Data (bytes) SCSI scsiwritedata