Events

NVIDIA Docs Hub NVIDIA Networking Networking Software NVIDIA NEO REST API Guide v2.7.20 Events

Description	Allows users to retrieve Events data in NEO
Request URL	/neo/app/events
Main Operations	Get Events Get All Events Get Event Get Events for System Get summary of events

Get Events

Description	Retrieves events data in NEO (all events or events for specific systems)
Request URL	All Events: GET /neo/app/events Specific Events: GET /neo/app/events/ Events for Systems: GET /neo/app/events?object_ids= list_of_systems: can be one or more instanceID for systems separated by comma such as .system,.system
Additional Filters	policy - filter events by specific events policy acknowledged - filter events by their acknowledgment state from - return events that occurred after a given timestamp until - return events that occurred before a given timestamp, count - limit the number of retrieved events to latest <count> events severity - filter events by severity source - filter events by source (i.e. service name or port) subcategory - filter events by subcategory
Request Data	N/A

Response:

Copy
Copied!

            
            {
	"Category": "Device", "RelatedObjectID": "10.209.36.161.system",
	"RelatedObjectUrl": "/resources/systems/10.209.36.16 1.system",
	"PolicyID": "3003",
	"Description": "Power supply is unresponsive", "RelatedObjectType": "System", "ConditionID": "3003.1", "Acknowledged": false, "CorrectiveAction": "Please try
	to reinsert the module, if the issue persists contact support", "SubCategory": "Power",
	"RelatedObjectName": "10.209.36.161",
	"Source": "PS2", "Reason": "Power supply is unresponsive",
	"EventName": "Power Fault", "Occurrences": 5,
	"Timestamp": "2018-02-25
	13:26:04",
	"RelatedSystem": "10.209.36.161",
	"RelatedJob": "",
	"ID": "24",
	"Severity": "Error"
}

Warning

If an invalid or a non-existing system is specified, an empty list will be returned.

Get Events Summary

Description	Retrieves a summary of all events. The summary is counting all events of a certain severity, grouped by hour.
Request URL	GET /neo/app/events/summary
Additional Filters	acknowledged - filter events by their acknowledgment state from - return events occurred after a given timestamp until - return events occurred before a given timestamp
Request Data	N/A

Response:

Copy
Copied!

            
            { 
    "2018-11-18 13:00:00": { 
        "Error": 1, 
     "Info": 12 
    }, 
    "2018-11-18 14:00:00": { 
        "Error": 12, 
     "Info": 1 
    } 
 }

On This Page

Get Events

Get Events Summary