NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Live Monitoring

Description

Creates and saves live monitoring sessions

Request URL

/neo/app/monitoring/live

Main Operations

  • Start a live monitoring session

  • Get live monitoring session attributes values

  • Save a live monitoring session

  • Delete a live monitoring session

Description

Starts a session of live monitoring. The session ID will be returned in the response

Request URL

POST /neo/app/monitoring/live

Restrictions

  • Device IP - must be of a device that NEO recognizes.

  • Interface name - must be an interface of a device IP that NEO recognizes.

  • Counter and general statistics must be from the following list:

  • CPU Load

  • Memory Free

  • Memory Total

  • Memory Used

  • In Octets Rate (InOctetsRate)

  • Out Octets Rate (OutOctetsRate)

  • In Packets Rate (InPacketsRate)

  • Out Packets Rate (OutPacketsRate)

  • In Discards (InDiscards)

  • In Errors (InErrors)

  • Out Discards (OutDiscards)

  • Only one option can be allowed in the session: interfaces or general_statistics.

Response

{ 

"location": "/neo/app/monitoring/live/1",

"objectID": "1"

}

Status Codes

Note:

Status code 409 CONFLICT means that session is already running and that the previous session needs to be DELETED.

Status code 503 SERVICE UNAVAILABLE Monitor Provider is down

Request Data:

Copy
Copied!
            

{ "interval": 20, "global_counters":[ "counter name",…..] "device ip 1 ": { "interfaces": { "interface name":{ "counters": ["counter name",…..] } }, "general_statistics": ["general statistic item",…] }, " device ip 2":{….}, …….. } }

Description

Gets the results of a live monitoring session. This rest call should run every interval time

Request URL

GET /neo/app/monitoring/live/<session_id>

Example: GET /neo/app/monitoring/live/2

Attributes

  • &tz=<time_zone> (Asia/Jerusalem ….. (default UTC))

  • &from = <time_stamp> ("2015-12-21 13:30:00")

Request Data

N/A

Response:

Copy
Copied!
            

{   "2016-04-17 19:08:39": {   "devices": {   "10.209.36.224": {   "general_statistics": {   "MemoryTotal": 2027   }   }   }   }   }

Warning

When sending "from" attribute the response will include the whole samples from the "from" timestamp until current timestamp.

Description

Saves the current session of live monitoring

Request URL

POST /neo/app/monitoring/live/session_id/save

Exmaple: POST /neo/app/monitoring/live/2/save

Attributes

&tz=<time_zone> (Asia/Jerusalem ….. (default UTC))

Response

N/A

Request Data

{
"title" : <Live_monitor_title>
"description" : <Live_monitor_description>
}

Description

Deletes a current session of live monitoring

Request URL

DELETE /neo/app/monitoring/live/session_id

Example: DELETE /neo/app/monitoring/live/2

Attributes

&tz=<time_zone> (Asia/Jerusalem ….. (default UTC))

Data Request

{
   "title" : <live_monitor_title>
   "description" : <live_monitor_description>
}

Response

N/A

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.