(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 21
53-1003160-01
Chapter
3
Using the Brocade Network Advisor REST API
In this chapter
•Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
•Logging in and out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
•Specifying content type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
•Versioning (backward compatibility). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
•Using the Topology API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
•Using the SAN Fabric Discovery API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
•Using the Traffic Flow API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
•Using the Summary Data API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
•Using the Events API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
•Using the Zoning API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
•Using the Historical Performance Data API . . . . . . . . . . . . . . . . . . . . . . . . . . 30
•Fibre Channel Routing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
•Handling errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Introduction
This chapter describes how to use the Brocade Network Advisor REST API.
Logging in and out
The Network Advisor REST API provides URIs for logging in and out.
Logging in
Use the /login POST URI to log in. This URI returns the BNA Server credentials in a LoginResponse.
<BASE_URI>/login
Login request headers
A valid user name and password are required for login and this is sent through the HTTP request
headers. You must add the headers while forming the HTTP POST request.