beautypg.com

Using the events api, Using the zoning api, Zoning uris – Brocade Network Advisor REST API Guide (Supporting Network Advisor 12.3.0) User Manual

Page 43: Zoning operations

background image

Brocade Network Advisor REST API Guide

29

53-1003160-01

Using the Events API

3

Using the Events API

The Events API provides URIs that you can use to retrieve Network Advisor events. The URIs provide
query parameters that allow you to filter the results.

For example, to retrieve the first 100 special trap events, you could use the following URI:

/resourcegroups/All/events?startindex=0&count=100&specialEvent=true&ori

gin=trap

In this example, you instruct the server to send 100 events that are categorized as specialEvents
and that originated as TARP events.

Using the Zoning API

The Zoning API provides GET and POST URIs for zone administration.

Zoning URIs

The HTTP request header “Accept” must be specified to indicate the content type of the response
payload. For more information, refer to

“Specifying content type.”

The HTTP request header “WSToken” must be specified with the token received from login. For
more information, refer to

“Logging in and out.”

Zoning operations

When performing POST zoning operations for creating, deleting, and updating zoning objects, note
the following:

All POST zoning operations are valid only within the context of a zoning transaction.

The appropriate request instance must be formed and sent through the POST request.

All operations within the context of a zoning transaction are local to Network Advisor. Only on
the commit of a zoning transaction, the data is pushed as a big blob to the switch.

Multiple zoning objects can be created, deleted, or updated in one call.

Unlike on the switch, Network Advisor does support the creation of empty zoning objects.
Before data can be committed to the switch, the zoning objects must contain data.

Operations such as CreateZoningObject map to multiple operations within Network Advisor.
Failure of such an operation could internally be partial success. As a best practice, check the
contents of the zoning database before proceeding or abort the transaction and proceed with a
new transaction.

Because in the case of a commit, there could be multiple reasons for failure, the REST API
returns the exact same error messages returned by the switch in response to commit failures.

For LSAN zoning, zone names must start with LSAN_. And the members must be identified by
WWNs only.

Empty LSAN zones cannot be created.

LSAN zoning is supported only in the context of a backbone fabric.