Brocade Network Advisor REST API Guide (Supporting Network User Manual download pdf (Page 17)

Brocade Network Advisor REST API Guide 3

53-1003160-01

Edition support

The following table lists the REST API support for the Network Advisor editions.l

TABLE 1 Edition support

Network Advisor edition REST API availability

Enterprise YES

Professional Plus YES

Professional NO

Headless YES

1 2 ... 12 13 14 15 16 17 18 19 20 21 22 ... 189 190

Brocade Network Advisor 1
Contents 3
Chapter 4 Use Cases 4
Chapter 5 API Reference 5
About This Document 9
Document conventions 10
Notes, cautions, and warnings 11
Key terms 11
Notice to the reader 12
Additional information 12
Getting technical help 13
Document feedback 13
In this chapter 15
Introduction 15
Network Advisor URIs 16
Protocol support 16
Edition support 17
Getting Started 19
Logging in 20
Retrieving resource groups 21
Retrieving FC fabrics 22
TABLE 4 Request headers 23
Login response header 36
Sample login request (Java) 36
Sample JSON response 37
Sample XML response 37
Sample error response 37
Logging out 38
Specifying content type 39
Accept HTTP request header 40
Using the Topology API 41
Using the Traffic Flow API 42
Using the Summary Data API 42
Using the Events API 43
Using the Zoning API 43
Fibre Channel Routing 44
Handling errors 44
TABLE 10 Error codes 45
Error codes (Continued) 46
URI error return behavior 50
Use Cases 51
Sample request payload 52
Sample JSON responses 53
Sample Java code 56
Deleting an FC fabric 61
Binding the schema 62
API Reference 65
ResourceGroups 66
FC Switch 68
AccessGateway 72
GigePorts 76
Connected-switch ports 78
ISL Connections 83
IFL connections 84
EndDeviceConnection 86
Access Gateway connection 87
End devices 88
Fabric discovery 91
Fabric deletion 92
Switch credentials update 93
Status summary 95
Asset classification summary 96
Network object count summary 99
Events summary 100
Bottleneck violations summary 101
GET URIs 102
Path parameters 102
VM violations summary 104
Port summaries 105
URIs for FC measures 106
Summary data 106
URIs for FCIP measures 110
Measure-to-URI mapping 111
Product summaries 118
Product summary URIs 119
53-1003160-01 120
URIs for SCSI measures 124
URIs for frame measures 125
Traffic flow summary notes 127
• “Event retrieval” 128
• “Event count” 128
• “Event acknowledgement” 128
Event retrieval 129
Property Description 130
Event count 131
Event acknowledgement 132
Query parameters 135
Response parameters 135
Name Description 136
Zone aliases 137
Zone sets 138
Zone transactions 139
Zoning object creation 141
Zoning object deletion 142
Zoning object updating 143
Initiator target zoning 146
Limitations 149
Historical performance data 150
• “Login” 158
• “Logout” 158
POST URIs 159
HTTP request headers 159
HTTP response header 159
Request and Response Schemas 161
FcFabricsResponse 162
FcSwitchesResponse 162
PhysicalSwitchesResponse 163
AccessGatewaysResponse 164
FcPortsResponse 164
Topology 165
EndDevicePortsResponse 166
TrunksResponse 167
IslsResponse 167
IflsResponse 168
EndDeviceConnectionsResponse 168
AgConnectionsResponse 169
EndDevicesResponse 169
SAN fabric discovery 170
DiscoverFabricResponse 171
UpdateCredentialsRequest 171
FlowDefinitionsResponse 172
StatusSummary 174
AssetClassificationSummary 175
NetworkObjectCountSummary 176
EventsSummary 176
BottleneckViolationsSummary 177
OutOfRangeViolationsSummary 178
PortHealthViolationsSummary 178
VmViolationsSummary 179
SummariesResponse 180
PortsMonitorSummaryData 180
MonitorDistributionData 181
ProductsMonitorSummaryData 181
FlowMonitorSummaryData 182
EventsResponse 182
CountResponse 185
ZoneDbsResponse 185
ZonesResponse 186
ZoneAliasesResponse 186
ZoneSetsResponse 186
ZoneTransactionResponse 186
ControlZoneTransactionRequest 187
CreateZoningObjectRequest 187
DeleteZoningObjectRequest 187
UpdateZoningObjectRequest 187
LoginResponse 189

Comments to this Manuals

No comments

Brocade Network Advisor REST API Guide (Supporting Network User Manual Page 17

Comments to this Manuals

Related products and manuals for Software Brocade Network Advisor REST API Guide (Supporting Network