(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
56 Brocade Network Advisor REST API Guide
53-1003160-01
Topology
5
PhysicalSwitch
Retrieves information about physical switches. This includes properties such as IP address, switch
serial number, model, and so on.
GET URIs
Path parameters
Response parameters
URI Description
<BASE_URI>/resourcegroups/rgkey/fcswitches/fcskey/p
hysicalswitches
Retrieves the PhysicalSwitch for a given FC switch.
<BASE_URI>/resourcegroups/rgkey/fcfabrics/fcfkey/fcs
witches/fcskey/physicalswitches
Retrieves the physical switch of the given FC switch.
Name Description
rgkey Resource group identifier.
fcfkey FC fabric identifier.
fcskey FC switch identifier.
Property Description
key The unique identifier for the switch, which is the WWN.
wwn The WWN of the switch.
ipAddress The IP address of the switch. Could be either IPv4 or IPv6 address.
userId The Telnet user name used to log in to switch.
firmwareVersion The firmware version of the switch.
vendor The vendor information of the switch
supplierSerialNumber The supplier serial number of the switch.
partNumber The part number of the switch.
modelNumber The model of the switch, such as Brocade 6505 and Brocade 6520.
manufacturer The manufacturer for the switch.
switchSerialNumber The factory serial number of the switch.
vendorVersion The vendor version of the switch.
vendorPartNumber The vendor part number of the switch.
snmpInformsEnabled Indicates if the SNMP informs is enabled.
contact The contact details of the switch. Syscontact from the RFC 1213 MIB.
location The location details for the switch. Syslocation from RFC 1213 MIB.
description The description of the switch. Sysdescr from RFC 1213 MIB.