(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
60 Brocade Network Advisor REST API Guide
53-1003160-01
Topology
5
portId The port ID.
portIndex The port index, number used in identifying port in zoning.
areaId The area number of the port.
type The port type. The specific mode currently enabled for the port.
status The status of the port. Refer to PortStatusType.
statusMessage Any additional port level status similar to what is seen in CLI, like Segmented, Speed
Mismatch, Trunk master, and so on.
lockedPortType Indicates the locked port type. Ports can be locked down so that they can come up
only in that mode.
speed The port speed currently configured on the switch.
speedsSupported The supported port speed as a list of comma-separated values.
maxPortSpeed The maximum supported speed on the switch.
desiredCredits The number of BB credits desired by the port.
bufferAllocated The number of BB credits allocated to the port.
estimatedDistance The estimated distance of the link.
actualDistance The actual distance of the link.
longDistanceSetting Indicates if long distance setting is enabled.
remoteNodeWwn WWN of the node at the remote end of this switch port.
remotePortWwn WWN of the port at the remote end of this switch port.
licensed Indicates if the port is licensed.
swapped Indicates if the port is swapped.
trunked Indicates if the port is trunked.
trunkMaster Indicates if the port is trunk master. Applicable only if the port is trunked.
persistentlyDisabled Indicates if the port is persistently disabled.
ficonSupported Indicates if the port is FICON supported.
blocked Indicates if the port is blocked.
prohibitPortNumbers Indicates the ports prohibited with the current port as configured in the “Allow”
prohibit metric (PDCM).
prohibitPortCount The count of prohibited ports.
npivCapable Indicates if port is NPIV-capable.
npivEnabled Indicates if is NPIV-capable is enabled.
fcFastWriteEnabled Indicates if FC Fast Write is enabled.
islRrdyEnabled Indicates if ISL receiver ready is enabled.
rateLimitCapable Indicates if the port is capable of rate limiting.
rateLimited Indicates if the port has rate limiting enabled.
qosCapable Indicates if the port is QOS-capable.
qosEnabled Indicates if the port is QOS-enabled.
fcrFabricId The FCR fabric ID. Applicable if the port is configured as an EX_Port.
Property Description