(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
156 Brocade Network Advisor REST API Guide
53-1003160-01
SAN fabric discovery
A
<xs:element name="fdmiHardwareVersion" type="xs:string" minOccurs="0"/>
<xs:element name="fdmiModelDescription" type="xs:string" minOccurs="0"/>
<xs:element name="fdmiNodeName" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="DeviceType">
<xs:restriction base="xs:string">
<xs:enumeration value="PHYSICAL"/>
<xs:enumeration value="VIRTUAL"/>
<xs:enumeration value="NPIV"/>
<xs:enumeration value="ISCSI"/>
<xs:enumeration value="PHYSICAL_VIRTUAL"/>
<xs:enumeration value="UNKNOWN"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="EndDevicesResponse">
<xs:complexContent>
<xs:extension base="ns2:PaginatedResponse">
<xs:sequence>
<xs:element name="endDevices" type="ns1:EndDevice" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
SAN fabric discovery
DiscoverFabricRequest
<xs:complexType name="DiscoverFabricRequest">
<xs:sequence>
<xs:element name="switchIpAddress" type="xs:string"/>
<xs:element name="userName" type="xs:string" default="admin" minOccurs="0"/>
<xs:element name="password" type="xs:string" default="password" minOccurs="0"/>
<xs:element name="fabricName" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="snmpVersion" type="ns1:SnmpVersionType" nillable="true" default="v3"
minOccurs="0"/>
<xs:element name="snmpTimeout" type="xs:int" default="5" minOccurs="0"/>
<xs:element name="snmpRetries" type="xs:int" default="3" minOccurs="0"/>
<xs:element name="snmpReadCommunityString" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="snmpWriteCommunityString" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="snmpUserName" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="snmpContextName" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="snmpAuthorizationProtocol" type="ns1:AuthorizationProtocolType"
nillable="true" minOccurs="0"/>
<xs:element name="snmpAuthorizationPassword" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="snmpPrivacyProtocol" type="ns1:PrivacyProtocolType" nillable="true"
minOccurs="0"/>
<xs:element name="snmpPrivacyPassword" type="xs:string" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="SnmpVersionType">
<xs:restriction base="xs:string">