(Supporting Network Advisor 12.3.0)

Brocade Network Advisor REST API Guide v
53-1003160-01
Chapter 5 API Reference
Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
ResourceGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Fabrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
FC Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
PhysicalSwitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56
AccessGateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
FCPorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
GigePorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62
Connected-switch ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
End-device ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Trunks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
ISL Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
IFL connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
EndDeviceConnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Access Gateway connection . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
End devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
SAN fabric discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Fabric discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Fabric deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Switch credentials update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Summary data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
Status summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Asset classification summary . . . . . . . . . . . . . . . . . . . . . . . . . . .82
Network object count summary . . . . . . . . . . . . . . . . . . . . . . . . .85
Events summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
Bottleneck violations summary. . . . . . . . . . . . . . . . . . . . . . . . . . 87
Out-of-range violations summary . . . . . . . . . . . . . . . . . . . . . . . .88
Port health violations summary . . . . . . . . . . . . . . . . . . . . . . . . .89
VM violations summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
Port summaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Product summaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
Traffic flow summaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
Event retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
Event count. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117
Event acknowledgement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
Zoning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
Zone DBs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
Zone aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123
Zone sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Zone transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Zone transaction management. . . . . . . . . . . . . . . . . . . . . . . . .126
Zoning object creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Zoning object deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
Zoning object updating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Zone set activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Initiator target zoning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132