(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 1
53-1003160-01
Chapter
1
Overview of the Network Advisor REST API
In this chapter
•Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
•Network Advisor URIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
•Protocol support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
•Edition support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
•
Introduction
The Network Advisor REST API provides you with a Web services interface for configuring and
monitoring Brocade switches. Brocade Network Advisor 12.3.0 has been updated to provide a
REST API for storage area network (SAN) provisioning. The REST APIs are organized into various
services such as Topology, Authentication, and Zoning.
You can use the Network Advisor REST API to build your own Network Advisor clients. You can also
use third-party REST API clients to interact with Network Advisor.
FIGURE 1 Architectural overview
The Network Advisor REST API provides GET and POST uniform resource identifiers (URIs) that you
can use to retrieve information and perform certain management and configuration tasks.
NOTE
This release of the Network Advisor REST API supports only SAN fabrics.