(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 77
53-1003160-01
SAN fabric discovery
5
Fabric discovery
Discovers fabrics.
POST URIs
Request parameters
Notes
• The FC fabric that is discovered contains the IP address and WWN of the seed switch that was
used for discovery in the DiscoverFabricRequest XML payload.
• The request schema is DiscoverFabricRequest.
• The response schema is DiscoverFabricResponse.
URI Description
<BASE_URI>/resourcegroups/All/discoverfabric Initiates fabric discovery.
Returns a list of the fabric VFIDs that failed discovery,
if any. The XML payload associated with this request
is the Discoverfabricrequest schema.
Property Description
switchIpAddress The IP address of the seed switch used for discovering the fabric.
userName The user name required for discovering the fabric.
password The password required for discovering the fabric.
fabricName The user-defined name of the fabric to be assigned.
snmpVersion The SNMP version to be used in discovering the fabric.
snmpTimeout The SNMP timeout to be used in discovering the fabric.
snmpRetries The number of SNMP retries to be used in discovering the fabric.
snmpReadCommunityString The SNMP read community string to be used in discovering the fabric
(SNMP V1 only).
snmpWriteCommunityString The SNMP write community string to be used in discovering the fabric (SNMP
V1 only).
snmpUserName The SNMP user name for discovering the fabric (SNMP V3 only).
snmpContextName The SNMP context name for discovering the fabric (SNMP V3 only).
snmpAuthorizationProtocol The SNMP authorization protocol for discovering the fabric. Refer to
AuthorizationProtocolType (SNMP V3 only).
snmpAuthorizationPassword The SNMP authorization password for discovering the fabric (SNMP V3 only).
snmpPrivacyProtocol The SNMP privacy protocol for discovering the fabric. Refer to
PrivacyProtocolType (SNMP V3 only).
snmpPrivacyPassword The SNMP privacy protocol for discovering the fabric (SNMP V3 only).