Collect alarms from all NSX nodes (Experimental) (Deprecated)

This API is executed on a manager node to return current alarms from all NSX nodes.
This API is deprecated as part of alarm framework enhancements.
Please use below new APIs:
GET /alarms
GET /alarms/<alarm-id>
POST /alarms/<alarm-id>?action=set_status
POST /alarms?action=set_status
GET /events
GET /events/<event-id>
PUT /events/<event-id>
POST /events/<event-id>?action=set_default

Request:

Method:

GET

URI Path(s):

/api/v1/hpm/alarms

Request Headers:

n/a

Query Parameters:

AlarmQueryParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page) A log cursor points to a specific line number in the alarm list	integer
fields	Fields to include in query results Comma-separated field names to include in query result	string
page_size	Maximum number of results to return in this page (server may return fewer) The page size determines the number of alarms to be returned	integer	Minimum: 0 Maximum: 100 Default: "100"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/hpm/alarms

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AlarmListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Alarm results	array of Alarm	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 1, "results": [ { "id": "vmwNSXPlatformPasswordExpiryStatus_97492720", "message": "audit user password expires within 3 day(s)", "severity": "MAJOR", "source_comp": "nsx-manager", "source_comp_id": "aab00442-95a1-f09b-31bc-18e67f056b24", "source_subcomp": "passwd_monitor", "sources": { "user_id": "10002", "user_name": "audit" }, "state": "ACTIVE", "timestamp": 1566511461.0 } ] }

Collect alarms from all NSX nodes (Experimental) (Deprecated)

Request:

AlarmQueryParameters (schema)

Example Request:

Successful Response:

AlarmListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: