(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
150 Brocade Network Advisor REST API Guide
53-1003160-01
Topology
A
AccessGatewaysResponse
<xs:complexType name="AccessGateway">
<xs:sequence>
<xs:element name="key" type="xs:string"/>
<xs:element name="name" type="xs:string"/>
<xs:element name="wwn" type="xs:string"/>
<xs:element name="operationalStatus" type="tns:OperStatusType"/>
<xs:element name="state" type="tns:StateType"/>
<xs:element name="statusReason" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="firmwareVersion" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AccessGatewaysResponse">
<xs:sequence>
<xs:element name="accessGateways" type="ns1:AccessGateway" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
FcPortsResponse
<xs:complexType name="FcPort">
<xs:sequence>
<xs:element name="key" type="xs:string"/>
<xs:element name="wwn" type="xs:string"/>
<xs:element name="name" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="slotNumber" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="portNumber" type="xs:short"/>
<xs:element name="userPortNumber" type="xs:short"/>
<xs:element name="portId" type="xs:string"/>
<xs:element name="portIndex" type="xs:short"/>
<xs:element name="areaId" type="xs:short"/>
<xs:element name="type" type="tns:PortType"/>
<xs:element name="status" type="tns:PortStatusType"/>
<xs:element name="statusMessage" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="lockedPortType" type="tns:PortType" nillable="true" minOccurs="0"/>
<xs:element name="speed" type="xs:string"/>
<xs:element name="speedsSupported" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="maxPortSpeed" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="desiredCredits" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="bufferAllocated" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="estimatedDistance" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="actualDistance" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="longDistanceSetting" type="xs:int" nillable="true" minOccurs="0"/>
<xs:element name="remoteNodeWwn" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="remotePortWwn" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="licensed" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="swapped" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="trunked" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="trunkMaster" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="persistentlyDisabled" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="ficonSupported" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="blocked" type="xs:boolean" nillable="true" minOccurs="0"/>
<xs:element name="prohibitPortNumbers" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="prohibitPortCount" type="xs:short" nillable="true" minOccurs="0"/>
<xs:element name="npivCapable" type="xs:boolean" nillable="true" minOccurs="0"/>