Brocade Network Advisor REST API Guide (Supporting Network Advisor 12.3.0) - Manual (Page 4)

iv Brocade Network Advisor REST API Guide
53-1003160-01
Logging in and out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Logging in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Logging out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Specifying content type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Accept HTTP request header. . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Content-type HTTP request header. . . . . . . . . . . . . . . . . . . . . . .26
Versioning (backward compatibility) . . . . . . . . . . . . . . . . . . . . . . . . .26
Using the Topology API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Using the SAN Fabric Discovery API. . . . . . . . . . . . . . . . . . . . . . . . . . 27
Notes about the SAN Fabric Discovery API URIs . . . . . . . . . . . . 27
Limitations for the SAN Fabric Discovery API. . . . . . . . . . . . . . .28
Using the Traffic Flow API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Using the Summary Data API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Using the Events API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Using the Zoning API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Zoning URIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Zoning operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29
Using the Historical Performance Data API . . . . . . . . . . . . . . . . . . . .30
Fibre Channel Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Handling errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
URI error return behavior. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Chapter 4 Use Cases
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Zoning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Sample request payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38
Sample Java code for performing the attach operation . . . . . .38
Sample JSON responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Getting Traffic Flow Performance Data . . . . . . . . . . . . . . . . . . . . . . .40
Sample Java code for retrieving flow information . . . . . . . . . . .40
Sample JSON response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Retrieving performance data for the Transmit Frame Rate measure
42
Getting the Top N CRC errors port summary. . . . . . . . . . . . . . . . . . .44
SAN fabric discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Discovering an FC fabric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
Deleting an FC fabric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Binding the schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48