(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 53
53-1003160-01
Topology
5
Fabrics
Retrieves information about FC fabrics.
GET URIs
Path parameters
Response parameters
Notes
• The resource group “All” encompasses all fabrics while the resource group FC_FABRIC
retrieves a subset of the fabrics.
• Even though a user-defined resource group can be a group of fabrics, products, or ports, FC
fabrics can be retrieved in the context of an FC fabric or user-defined resource group of only
fabrics. As there is no containment hierarchy within products or ports for FC fabrics, for a
PRODUCT_GROUP, PORT_GROUP, or USER_DEFINED resource group of products or ports, the
list is empty.
• The fabric is keyed by its unique principal switch WWN.
URI Description
<BASE_URI>/resourcegroups/rgkey/fcfabrics Retrieves FC fabrics for the given resource group.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey Retrieves the details of the specified FC fabric.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
Property Description
key Unique identifier for the fabric. The key is the principal switch WWN.
seedSwitchWwn WWN of the switch used as the seed switch to discover the fabric.
name The name of the fabric as configured in Network Advisor.
secure Whether the fabric is running secure Fabric OS.
adEnvironment The admin domain environment of the fabric.
contact User-assigned fabric contact.
location User-assigned fabric location.
description User-assigned fabric description.
principalSwitchWwn WWN of the principal fabric switch.
fabricName Fabric name persisted on switches running Fabric OS 7.0 and later.
virtualFabricId Virtual fabric ID. A positive value indicates VF is enabled; otherwise -1.
seedSwitchIpAddress IP address of the seed switch. Could be either an IPv4 or IPv6 address.