Broadcom Brocade SANnav Management Portal REST API Reference , 1.1.1 User guide

Broadcom
Brand
Broadcom
Model
Brocade SANnav Management Portal REST API Reference , 1.1.1
Type
User guide

Broadcom Brocade SANnav Management Portal REST API Reference , 1.1.1 provides you with a web-services interface for accessing the SANnav Management Portal server system. It enables you to build your own Management application clients or use third-party REST API clients to interact with the Management application. Some of its features include:

  • Authenticate with the SANnav Management Portal server and get the session ID
  • List all discovered fabrics in the scope of user’s Area Of Responsibility (AOR)
  • Get all the fabric members in the fabric
  • Retrieve the topology of the fabrics
  • Retrieve the latest list of events, filter them based on severity, time, and acknowledge status, and also acknowledge or unacknowledge them

Broadcom Brocade SANnav Management Portal REST API Reference , 1.1.1 provides you with a web-services interface for accessing the SANnav Management Portal server system. It enables you to build your own Management application clients or use third-party REST API clients to interact with the Management application. Some of its features include:

  • Authenticate with the SANnav Management Portal server and get the session ID
  • List all discovered fabrics in the scope of user’s Area Of Responsibility (AOR)
  • Get all the fabric members in the fabric
  • Retrieve the topology of the fabrics
  • Retrieve the latest list of events, filter them based on severity, time, and acknowledge status, and also acknowledge or unacknowledge them
Broadcom SANnav-111-REST-API-RM100
May 1, 2019
SANnav Management Portal
REST API Reference Manual
Reference Manual
Software Release 1.1.1
SANnav Management Portal Reference Manual REST API Reference Manual
Broadcom SANnav-111-REST-API-RM100
Copyright © 2019 Broadcom. All Rights Reserved. Broadcom, the pulse logo, Brocade, and the stylized B logo are
among the trademarks of Broadcom in the United States, the EU, and/or other countries. The term “Broadcom” refers
to Broadcom Inc. and/or its subsidiaries.
Broadcom reserves the right to make changes without further notice to any products or data herein to improve
reliability, function, or design. Information furnished by Broadcom is believed to be accurate and reliable. However,
Broadcom does not assume any liability arising out of the application or use of this information, nor the application or
use of any product or circuit described herein, neither does it convey any license under its patent rights nor the rights
of others.
The product described by this document may contain open source software covered by the GNU General Public
License or other open source license agreements. To find out which open source software is included in Broadcom
products, view the licensing terms applicable to the open source software, and obtain a copy of the programming
source code, please visit www.broadcom.com.
Table of Contents
1. Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2. Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.1. Login And Logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.1.1. Login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.1.2. Logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.2. Discovery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2.1. Listing Fabrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2.2. Listing Fabric Members. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.3. FCR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3.1. FCR Topology Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4. Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4.1. Listing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4.2. Subscribing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.4.3. Unsubscribing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4.4. Bulk Update Events-acknowledgement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.4.5. Bulk Update Events-unacknowledgement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1. BackboneSwitch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.2. EdgeFabric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.3. ErrorResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.4. EventCategory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.5. EventFilterColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.6. EventFilterCriteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.7. EventRecipientDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.8. EventSeverityGroupSummary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.9. EventsAcknowledge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.10. EventsFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.11. FCRTopologyView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.12. FabricDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.13. FabricMemberResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.14. FabricResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.15. FaultEventInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.16. FaultEventsCriteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3.17. FaultEventsResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.18. FilterCategoryCriteria. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.19. FilterEventDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.20. LoginResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.21. SeverityLevels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.22. SuccessResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.23. SwitchDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.24. TopologyResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4. Release History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.1. SANnav-111-REST-API-RM100; May 1, 2019. . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 1. Overview
The Management application REST API provides you with a web-services interface for accessing the SANnav
Management Portal server system. The REST APIs are organized into various services such as Login, Discovery,
FCR, and Fault. You can use the Management application REST API to build your own Management application
clients. You can also use third-party REST API clients to interact with the Management application.
All the APIs are exposed using the HTTPS protocol.
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 1
Chapter 2. Resources
2.1. Login And Logout
2.1.1. Login
POST /external-api/v1/login/
Description
Authenticates with the SANnav Management Portal server and gets the session ID to be used for subsequent REST
API calls to the SANnav Management Portal server.
Parameters
Type Name Description Schema
Header
username
required
Username to login using external-api. string
Header
password
required
Password to login using external-api. string (password)
Responses
HTTP
Code
Description Schema
200 Return the session ID for successful login LoginResponse
401 Unauthorized No Content
500 Unexpected error occurred ErrorResponse
Consumes
•
application/json
Produces
•
application/json
2.1.2. Logout
POST /external-api/v1/logout/
SANnav Management Portal Reference Manual REST API Reference Manual
2 SANnav-111-REST-API-RM100
Description
Logs out of the SANnav Management Portal Server.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Responses
HTTP
Code
Description Schema
200 Successfully Logged Out No Content
401 Unauthorized ErrorResponse
500 Unexpected error occurred ErrorResponse
Consumes
•
application/json
Produces
•
application/json
2.2. Discovery
2.2.1. Listing Fabrics
GET /external-api/v1/discovery/fabrics/
Description
Lists all discovered fabrics in the scope of user’s Area Of Responsibility (AOR).
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 3
Responses
HTTP
Code
Description Schema
200 All fabrics details are retrieved successfully FabricResponse
401 Unauthorized No Content
500 Unexpected error occurred ErrorResponse
Produces
•
application/json
2.2.2. Listing Fabric Members
GET /external-api/v1/discovery/fabric-members/
Description
Gets all the fabric members in the fabric.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Query
principalSwitchW
WN
required
Principal Switch WWN string
Responses
HTTP
Code
Description Schema
200 All switch details are retrieved successfully
FabricMemberRespon
se
400 Bad Request ErrorResponse
401 Unauthorized No Content
404 Not Found ErrorResponse
500 Unexpected error occurred ErrorResponse
Produces
•
application/json
SANnav Management Portal Reference Manual REST API Reference Manual
4 SANnav-111-REST-API-RM100
2.3. FCR
2.3.1. FCR Topology Information
GET /external-api/v1/fcr/topology/
Description
Provides FCR topology information for various routing topologies such as edge-to-edge, backbone-to-edge and edge-
to-backbone including the translate and front domain details.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Responses
HTTP
Code
Description Schema
200 FCR Topology information. TopologyResponse
401 Unauthorized No Content
500 Unexpected error occurred ErrorResponse
Produces
•
application/json
2.4. Fault
2.4.1. Listing Events
POST /external-api/v1/fault/events/
Description
Lists the events matching the given criteria.
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 5
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Body
eventCriteria
optional
The attributes to be considered for fetching events. FaultEventsCriteria
Responses
HTTP
Code
Description Schema
200 Events Response Object. It contains a list of event counts for each severity group FaultEventsResponse
400 Bad Request ErrorResponse
401 Unauthorized No Content
500 Unexpected error occurred ErrorResponse
Consumes
•
application/json
Produces
•
application/json
2.4.2. Subscribing Events
POST /external-api/v1/fault/events/forwarding/subscribe
Description
Create the trap/syslog forwarding targets.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Body
messageDetail
required
Event forwarding target details object. EventRecipientDetails
Responses
SANnav Management Portal Reference Manual REST API Reference Manual
6 SANnav-111-REST-API-RM100
HTTP
Code
Description Schema
200 Successful creation of resource SuccessResponse
400 Bad Request ErrorResponse
401 Unauthorized No Content
412 Precondition failed, will occur if recipient already exists. ErrorResponse
500 Unexpected error occurred ErrorResponse
Consumes
•
application/json
Produces
•
application/json
2.4.3. Unsubscribing Events
POST /external-api/v1/fault/events/forwarding/unsubscribe
Description
Delete the trap/syslog forwarding targets.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Body
messageDetail
required
Event forwarding target details object. EventRecipientDetails
Responses
HTTP
Code
Description Schema
200 Successful deletion of resource SuccessResponse
400 Bad Request ErrorResponse
401 Unauthorized No Content
412 Precondition Failed, will occur if recipient does not exist. ErrorResponse
500 Unexpected error occurred ErrorResponse
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 7
Consumes
•
application/json
Produces
•
application/json
2.4.4. Bulk Update Events-acknowledgement
POST /external-api/v1/fault/events/acknowledge
Description
Updates the given acknowledgement details for a given list of events.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Body
acknowledgeEve
nts
required
Payload having event identifiers and
acknowledgment/unacknowledge notes.
EventsAcknowledge
Responses
HTTP
Code
Description Schema
200 Successfully updated acknowledgement details in event(s). SuccessResponse
400 Bad Request ErrorResponse
401 Unauthorized No Content
500 Unexpected error occurred ErrorResponse
Consumes
•
application/json
Produces
•
application/json
SANnav Management Portal Reference Manual REST API Reference Manual
8 SANnav-111-REST-API-RM100
2.4.5. Bulk Update Events-unacknowledgement
POST /external-api/v1/fault/events/unacknowledge
Description
Updates the given unacknowledgement details for a given list of events.
Parameters
Type Name Description Schema
Header
Authorization
required
Session ID string
Body
unacknowledgeE
vents
required
Payload having event identifiers and
acknowledgment/unacknowledge notes.
EventsAcknowledge
Responses
HTTP
Code
Description Schema
200 Successfully updated unacknowledgement details in event(s). SuccessResponse
400 Bad Request ErrorResponse
401 Unauthorized No Content
500 Unexpected error occurred ErrorResponse
Consumes
•
application/json
Produces
•
application/json
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 9
Chapter 3. Definitions
3.1. BackboneSwitch
Backbone Switch details.
Name Description Schema
backboneIPAddr
ess
optional
Router IP Address string
backboneSwitch
Wwn
optional
Backbone Switch WWN string
edgeFabric
optional
List of Edge fabrics. < EdgeFabric > array
3.2. EdgeFabric
Edge Fabric details.
Name Description Schema
exPortWwn
optional
Ex Port WWN string
edgeFCRFabricID
optional
FCR Fabric ID assigned by backbone fabric for this edge fabric integer
edgeIPAddress
optional
Edge connected Switch IP Adrress string
edgeSwitchWwn
optional
Edge switch WWN string
edgePortWwn
optional
Edge port WWN string
frontDomainId
optional
Front DomainId integer
translateDomainI
d
optional
List of translate domain ids < integer > array
edgeFID
optional
Edge FID (This will return -1 if virtual fabrics is not enable for the
fabric/switch)
integer
3.3. ErrorResponse
Name Description Schema
code
optional
Error code string
errorMessage
optional
Error message string
detailedErrorMes
sage
optional
Detailed error message string
SANnav Management Portal Reference Manual REST API Reference Manual
10 SANnav-111-REST-API-RM100
3.4. EventCategory
The enum provides a set of event category labels.
Type : enum (PRODUCT_EVENT, LINK_INCIDENT_EVENT, PRODUCT_AUDIT_EVENT,
PRODUCT_STATUS_EVENT, SECURITY_EVENT, USER_ACTION_EVENT, MANAGEMENT_SERVER_EVENT,
CORRELATION_EVENT, ALL)
3.5. EventFilterColumn
The enum provides a set of columns to filter events.
Type : enum (ACKNOWLEDGED, ACKNOWLEDGED_BY, MAINTENANCE_MODE, MESSAGE_ID, ORIGIN,
SPECIAL_EVENT, USER_NAME)
3.6. EventFilterCriteria
Name Description Schema
categories
optional
Include specific event categories while searching. FilterCategoryCriteria
includedEvents
optional
Include specific events while searching.
< FilterEventDetails >
array
excludedEvents
optional
Exclude specific events while searching.
< FilterEventDetails >
array
3.7. EventRecipientDetails
Attributes for event forwarding.
Name Description Schema
recipientAddress
required
Recipient IP Address. string
port
required
Port number for recipient. Valid range will be 1-65535. integer
recipientType
required
Either SNMP or SYSLOG enum (SNMP, SYSLOG)
description
optional
Description about the recipient. string
includeSourceAd
dress
optional
Adds source address in the trap. boolean
forwardApplicati
onEvents
optional
Enable or Disable forwarding of application events. boolean
forwardCorrelate
dEvents
optional
Enable or Disable forwarding of correated events. boolean
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 11
Name Description Schema
severityLevel
optional
Trap or Syslog severity that needs to be considered while forwarding of
the events. If severity is Emergency all the traps will be forwarded. If
severity passed is ALERT the events having severity Alert, Critical,
Error, Warning and Info will be forwarded and so on.
SeverityLevels
products
optional
Virtual switch WWN(s). Events from these products will be forwarded. < string > array
eventDescription
Pattern
optional
Check for the Regular expression of the event description that needs to
be considered while forwarding of the events.
string
trapOid
optional
TRAP OID details. Only these traps will be forwarded. < string > array
3.8. EventSeverityGroupSummary
Maps the number of event occurrences with their severity group.
Name Schema
severityGroup
optional
string
counter
optional
integer
3.9. EventsAcknowledge
Defines the auto acknowledge details.
Name Description Schema
eventIdentifiers
required
ID of events that needs to be acknowledged. < string > array
eventNotes
required
Notes for the acknowledging/unacknowledging event. string
3.10. EventsFilter
User can define categories/severities or include/exclude event criteria that needs to be used while fetching the event
data.
Name Schema
filter
optional
< EventFilterCriteria > array
3.11. FCRTopologyView
FCR Topology view.
SANnav Management Portal Reference Manual REST API Reference Manual
12 SANnav-111-REST-API-RM100
Name Description Schema
backboneFabricI
D
optional
Backbone Fabric ID integer
backboneSwitch
optional
List of Backbone Switches.
< BackboneSwitch >
array
3.12. FabricDetails
Attributes of a fabric.
Name Description Schema
name
optional
Name of the fabric string
description
optional
Description of the fabric defined in SANnav string
seedSwitchName
optional
Name of the Seed switch string
seedSwitchIPAdd
ress
optional
IP Address of the seed switch string
seedSwitchWwn
optional
Wwn of the Seed switch string
principalSwitchIP
Address
optional
IP Address of the Principal switch string
principalSwitchW
wn
optional
Wwn of the Principal switch string
3.13. FabricMemberResponse
Wrapper object used for fabric member API response that contains fabric member(switch) information.
Name Schema
Switches
optional
< SwitchDetails > array
3.14. FabricResponse
Wrapper object used for fabric API response that contains fabric’s meta-data information.
Name Schema
Fabrics
optional
< FabricDetails > array
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 13
3.15. FaultEventInfo
Event Details info object.
Name Description Schema
eventID
optional
Unique event ID. string
severity
optional
Severity for the event. Is one of Emergency, Alert, Critical, Error,
Warning and Info.
string
sourceName
optional
Node name where service is running incase of application event and
switch name for the product events.
string
sourceAddress
optional
Node IP where service is running incase of application event and
switch IP for the product events.
string
lastOccurrenceH
ostTime
optional
Last time the event was received by the host that is running the
application.
integer (int64)
firstOccurenceHo
stTime
optional
First time the event was received by the host that is running the
application.
integer (int64)
eventCount
optional
Number of times the event is received between first and last host
occurrence times.
integer
origin
optional
Indicates event origin. Will be One of SNMP Trap, Syslog, Application
Event or Other.
string
eventCategory
optional
Indicates event category such as Product Event, Link incident Event,
Product Audit Event, Product Status Event, Security Event, User Action
Event, Management Server Event and Correlation Event.
string
description
optional
The detailed description of the event. string
module
optional
The module of the event. string
productName
optional
Name of the product. string
productAddress
optional
The IP address of the product/switch. string
operationalStatu
s
optional
Indicates the operational status of the product associated with the
event.
string
firstOccurrenceS
witchTime
optional
First time the event was received by the host that is running Network
Advisor application.
integer (int64)
productUpTime
optional
Switch uptime. integer (int64)
userName
optional
User ID for application events. string
portName
optional
Name of the Port that caused this event. Will be populated only for few
application events.
string
correlatedEventI
Ds
optional
Captures the eventIDs for the individual events which are part of
correlation events.
string
recommendedAc
tions
optional
Recommended action to address the this event. string
SANnav Management Portal Reference Manual REST API Reference Manual
14 SANnav-111-REST-API-RM100
Name Description Schema
probableCause
optional
Describes the probable cause of the event. string
messageId
optional
Describes the message ID of the event. string
sourceWwn
optional
WWN for source of event. string
fabricName
optional
The name of the fabric. string
ruleName
optional
Rule name.(Applicable for Correlation event) string
rulePolicy
optional
Policy of the event rule.(Applicable for Correlation event) string
acknowledged
optional
Event acknowledgement status. integer
ackNotes
optional
Acknowledgement notes provided by user. string
ackBy
optional
User details performing the action. string
ackedTime
optional
Acknowledged time in long milliseconds. integer (int64)
callhomeEvent
optional
Indicates if event is call home event. integer
specialEvent
optional
Indicates if event is special event. integer
sourceType
optional
Indicats source type can be one Core Switch, Virtual Switch, Server,
Storage, Vcenter, Initiator port, Target port, Fabric, Switch Port or
Others.
string
trapOID
optional
The OID of the trap string
portWwn
optional
The WWN of the port. string
3.16. FaultEventsCriteria
Defines criteria like time duration filters and provides options for paginated result.
Name Description Schema
filters
optional
Event filter criteria based on event attributes. EventsFilter
startIndex
optional
Indicates the start index of results set. integer
pageSize
optional
Indicates the number of entries to be included in a paged result. Default
is 100 events and maximum of 5000.
integer
startTime
optional
Start time of the events occurred. Use this field to specify custom start
time for events in milliseconds.
integer (int64)
endTime
optional
End time of the events occurred in milliseconds. The maximum time
duration between start and end time should not be more than two
hours.
integer (int64)
SANnav Management Portal Reference Manual REST API Reference Manual
SANnav-111-REST-API-RM100 15
Name Description Schema
nextPageIndex
optional
Used for pagination when events exceed page limit. Attribute will not
have any value for first request. If the totalRecords are more than the
resultCount then user will have to set this to fetch next set of records. It
will have the eventID and lastoccurred host time value that needs to be
set during subsequent request.
string
eventProductDet
ails
optional
Virtual switch WWN(s) that needs to be considered while fetching
events.
< string > array
3.17. FaultEventsResponse
The Event Response includes the list of matched events, event search criteria used to fetch events, a list of event
counts by severity group.
Name Description Schema
events
optional
A list of matched events. < FaultEventInfo > array
eventSeverityGro
upSummaryList
optional
A list of event counts by severity group.
<
EventSeverityGroupSum
mary > array
startIndex
optional
Indicates the start index of results set. Should be 0 for first request and
can be incremented based on the subsequent requests.
integer
pageSize
optional
Results set Page Size. Default is 100 events. integer
resultsCount
optional
The number of records returned as per search criteria and pageSize. integer
pageNumber
optional
Page number of current page of results set. integer
totalRecords
optional
Total records matching the entered Criteria. integer (int64)
nextPageIndex
optional
Event identifier and last occurrence host time that needs to be used for
subsequent requests if totalRecords is more than the resultsCount.
string
3.18. FilterCategoryCriteria
Name Description Schema
correlationEvent
optional
Selected severity for correlation event. Selcted severity one of
Emergency, Alert, Critical, Error, Warning and Info.
< SeverityLevels > array
managementServ
erEvent
optional
Selected severity for management server event. < SeverityLevels > array
userActionEvent
optional
Selected severity for user action event. < SeverityLevels > array
securityEvent
optional
Selected severity for security event. < SeverityLevels > array
productStatusEv
ent
optional
Selected severity for product status event. < SeverityLevels > array
productEvent
optional
Selected severity for product event. < SeverityLevels > array
SANnav Management Portal Reference Manual REST API Reference Manual
16 SANnav-111-REST-API-RM100
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24

Broadcom Brocade SANnav Management Portal REST API Reference , 1.1.1 User guide

Broadcom
Brand
Broadcom
Model
Brocade SANnav Management Portal REST API Reference , 1.1.1
Type
User guide

Broadcom Brocade SANnav Management Portal REST API Reference , 1.1.1 provides you with a web-services interface for accessing the SANnav Management Portal server system. It enables you to build your own Management application clients or use third-party REST API clients to interact with the Management application. Some of its features include:

  • Authenticate with the SANnav Management Portal server and get the session ID
  • List all discovered fabrics in the scope of user’s Area Of Responsibility (AOR)
  • Get all the fabric members in the fabric
  • Retrieve the topology of the fabrics
  • Retrieve the latest list of events, filter them based on severity, time, and acknowledge status, and also acknowledge or unacknowledge them
Download PDF
report

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI

Related papers

Other documents