Document Outline

• Contents
• About This Document
  • How this document is organized
  • Document conventions
    • Text formatting
    • Command syntax conventions
    • Notes, cautions, and warnings
    • Key terms
  • Notice to the reader
  • Additional information
    • Brocade resources
    • Other industry resources
  • Getting technical help
  • Document feedback
• Overview of the Network Advisor REST API
  • Introduction
  • Network Advisor URIs
  • Protocol support
    • Default HTTPS port (443)
    • Non-Default HTTPS port
  • Edition support
• Getting Started
  • Introduction
  • Before you begin
  • Logging in
  • Retrieving resource groups
  • Retrieving FC fabrics
  • Retrieving a specific FC fabric
  • Retrieving switches in the context of a fabric
  • Retrieving switches and ports
  • Creating a sample Python client
• Using the Brocade Network Advisor REST API
  • Introduction
  • Logging in and out
    • Logging in
    • Logging out
  • Specifying content type
    • Accept HTTP request header
    • Content-type HTTP request header
  • Versioning (backward compatibility)
  • Using the Topology API
  • Using the SAN Fabric Discovery API
    • Notes about the SAN Fabric Discovery API URIs
    • Limitations for the SAN Fabric Discovery API
  • Using the Traffic Flow API
  • Using the Summary Data API
  • Using the Events API
  • Using the Zoning API
    • Zoning URIs
    • Zoning operations
  • Using the Historical Performance Data API
  • Fibre Channel Routing
  • Handling errors
    • URI error return behavior
• Use Cases
  • Introduction
  • Zoning
    • Sample request payload
    • Sample Java code for performing the attach operation
    • Sample JSON responses
  • Getting Traffic Flow Performance Data
    • Sample Java code for retrieving flow information
    • Sample JSON response
    • Retrieving performance data for the Transmit Frame Rate measure
  • Getting the Top N CRC errors port summary
  • SAN fabric discovery
    • Discovering an FC fabric
    • Deleting an FC fabric
  • Binding the schema
• API Reference
  • Topology
    • ResourceGroups
    • Fabrics
    • FC Switch
    • PhysicalSwitch
    • AccessGateway
    • FCPorts
    • GigePorts
    • Connected-switch ports
    • End-device ports
    • Trunks
    • ISL Connections
    • IFL connections
    • EndDeviceConnection
    • Access Gateway connection
    • End devices
  • SAN fabric discovery
    • Fabric discovery
    • Fabric deletion
    • Switch credentials update
  • Summary data
    • Status summary
    • Asset classification summary
    • Network object count summary
    • Events summary
    • Bottleneck violations summary
    • Out-of-range violations summary
    • Port health violations summary
    • VM violations summary
    • Port summaries
    • Product summaries
    • Traffic flow summaries
  • Events
    • Event retrieval
    • Event count
    • Event acknowledgement
  • Zoning
    • Zone DBs
    • Zones
    • Zone aliases
    • Zone sets
    • Zone transactions
    • Zone transaction management
    • Zoning object creation
    • Zoning object deletion
    • Zoning object updating
    • Zone set activation
    • Initiator target zoning
  • Historical performance data
  • Authentication and session management
    • Login
    • Logout
• Request and Response Schemas
  • Topology
    • ResourceGroupsResponse
    • FcFabricsResponse
    • FcSwitchesResponse
    • PhysicalSwitchesResponse
    • AccessGatewaysResponse
    • FcPortsResponse
    • EndDevicePortsResponse
    • TrunksResponse
    • IslsResponse
    • IflsResponse
    • EndDeviceConnectionsResponse
    • AgConnectionsResponse
    • EndDevicesResponse
  • SAN fabric discovery
    • DiscoverFabricRequest
    • DiscoverFabricResponse
    • UpdateCredentialsRequest
    • FlowDefinitionsResponse
    • FlowsResponse
  • Summary data
    • SummaryResponse
    • StatusSummary
    • AssetClassificationSummary
    • NetworkObjectCountSummary
    • EventsSummary
    • BottleneckViolationsSummary
    • OutOfRangeViolationsSummary
    • PortHealthViolationsSummary
    • VmViolationsSummary
    • SummariesResponse
    • PortsMonitorSummaryData
    • MonitorDistributionData
    • ProductsMonitorSummaryData
    • FlowMonitorSummaryData
  • Events
    • EventsResponse
    • CountResponse
  • Zoning
    • ZoneDbsResponse
    • ZonesResponse
    • ZoneAliasesResponse
    • ZoneSetsResponse
    • ZoneTransactionResponse
    • ControlZoneTransactionRequest
    • CreateZoningObjectRequest
    • DeleteZoningObjectRequest
    • UpdateZoningObjectRequest
    • InitiatorTargetsRequest
  • Historical performance data
    • PerformanceDataResponse
  • Authentication and session management
    • LoginResponse