(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
vi Brocade Network Advisor REST API Guide
53-1003160-01
Historical performance data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134
Authentication and session management. . . . . . . . . . . . . . . . . . . .144
Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
Logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
Appendix A Request and Response Schemas
Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
ResourceGroupsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
FcFabricsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
FcSwitchesResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
PhysicalSwitchesResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
AccessGatewaysResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
FcPortsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
EndDevicePortsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
TrunksResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
IslsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
IflsResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
EndDeviceConnectionsResponse . . . . . . . . . . . . . . . . . . . . . . .154
AgConnectionsResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
EndDevicesResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
SAN fabric discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
DiscoverFabricRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
DiscoverFabricResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
UpdateCredentialsRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
FlowDefinitionsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
FlowsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
Summary data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
SummaryResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
StatusSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160
AssetClassificationSummary. . . . . . . . . . . . . . . . . . . . . . . . . . .161
NetworkObjectCountSummary . . . . . . . . . . . . . . . . . . . . . . . . .162
EventsSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .162
BottleneckViolationsSummary . . . . . . . . . . . . . . . . . . . . . . . . .163
OutOfRangeViolationsSummary . . . . . . . . . . . . . . . . . . . . . . . .164
PortHealthViolationsSummary . . . . . . . . . . . . . . . . . . . . . . . . .164
VmViolationsSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
SummariesResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166
PortsMonitorSummaryData . . . . . . . . . . . . . . . . . . . . . . . . . . .166
MonitorDistributionData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167
ProductsMonitorSummaryData . . . . . . . . . . . . . . . . . . . . . . . .167
FlowMonitorSummaryData . . . . . . . . . . . . . . . . . . . . . . . . . . . .168
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168
EventsResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168
CountResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171