(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 159
53-1003160-01
Summary data
A
<xs:enumeration value="DEACTIVATED"/>
<xs:enumeration value="ACTIVATED"/>
</xs:restriction>
</xs:simpleType>
FlowsResponse
<xs:complexType name="FlowsResponse">
<xs:sequence>
<xs:element name="flows" type="ns1:Flow" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Flow">
<xs:sequence>
<xs:element name="key" type="xs:string"/> ' the format is fldbid-<database id>
<xs:element name="flowDefinitionName" type="xs:string"/>
<xs:element name="featureType" type="tns:FlowFeatureType" default="MONITOR"/>
<xs:element name="srcDevicePorts" type="xs:string" maxOccurs="unbounded"/>
<xs:element name="destDevicePorts" type="xs:string" maxOccurs="unbounded"/>
<xs:element name="srcSwitchPort" type="xs:string"/>
<xs:element name="destSwitchPort" type="xs:string"/>
<xs:element name="bidirectional" type="xs:boolean" default="false"/>
<xs:element name="sfid" type="xs:string" minOccurs="0"/>
<xs:element name="dfid" type="xs:string" minOccurs="0"/>
<xs:element name="lunIds" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="frameSize" type="xs:int" minOccurs="0"/>
<xs:element name="framePattern" type="xs:string" minOccurs="0"/>
<xs:element name="subFlowMd5hash" type="xs:string" minOccurs="0"/>
<xs:element name="mirrorPort" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="FlowFeatureType">
<xs:restriction base="xs:string">
<xs:enumeration value="MONITOR"/>
<xs:enumeration value="GENERATOR"/>
<xs:enumeration value="MIRROR"/>
</xs:restriction>
</xs:simpleType>
Summary data
SummaryResponse
<xs:complexType name="SummaryResponse">
<xs:sequence>
<xs:element name="summary" type="xs:anyType"/>
<xs:element name="summaryName" type="xs:string"/>
<xs:element name="timeLine" type="xs:long" nillable="true" minOccurs="0"/>
<xs:element name="timeScope" type="ns1:TimeScope" nillable="true" minOccurs="0"/>
<xs:element name="limit" type="xs:short" nillable="true" minOccurs="0"/>
<xs:element name="portScope" type="ns1:MonitorPortType" nillable="true" minOccurs="0"/>
<xs:element name="descending" type="xs:boolean" nillable="true" minOccurs="0"/>
</xs:sequence>