Monitoring Data

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

Get Monitoring Data

Description	Retrieves monitoring data in NEO
Request URL	All monitoring data for all network ports in NEO: GET /neo/app/monitoring Filter and get specific counters for specific systems: GET /neo/app/monitoring/?device_ids=<List of systems>&port_ids=<List of ports>&counters=<List of counters>
Supported Counters	OutBroadcastPkts OutUcastPkts OutMulticastPkts InMulticastPkts OutOctetsRate OutErrors InBroadcastPkts InOctetsRate InOctets OutDiscards InUnknownProtos InUcastPkts InErrors OutOctets SymbolError InDiscards NormalizedCongestedBandwidth NormalizedBandwidth XmitWait
Additional Traffic Counters	Supported only for x86 Ethernet systems with Mellanox OS version 3.6.4006 and higher (except for OutHoqDiscardPacketsRate counter. See below). Supported via live monitoring session only. Supported via REST API only.
Supported Counters List	"InPacketsOf64BytesRate", "InPacketsOf65To127BytesRate", "InPacketsOf128To255BytesRate", "InPacketsOf256To511BytesRate", "InPacketsOf512To1023BytesRate", "InPacketsOf1024To1518BytesRate", "InPacketsJumboRate", "InDiscardPacketsByStormControlRate", "InFcsErrorsRate", "InUndersizePacketsRate", "InOversizePacketsRate", "InPausePacketsRate", "OutPausePacketsRate", "OutHoqDiscardPacketsRate", # Supported only from 3.6.4930 "OutPauseDuration"

Warning

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

Get RoCE Monitoring Data

Description	Retrieves RoCE related counters data in NEO. The counters can be gathered by telemetry agent or JSON API. This is configurable in the Telemetry section of the controller.cfg file.
Request URL	All monitoring data for all network ports in NEO: GET /neo/app/monitoring/roce
Additional Filters	device_ids - list of devices for which data will be retrieved port_ids - list of ports for which data will be retrieved counters - list of counter names to retrieve from - retrieve data gathered after a given time until - retrieve data gathered before a given time tz - timezone to use when retrieving data
Supported Counters	NormalizedDiscardedPackets Pfc<priority>NormalizedCongestedBandwidth tc<priority>NormalizedBandwidth TC<priority>NormalizedDiscardedPackets NormalizedBandwidth NormalizedECNPackets

Response:

Copy
Copied!

            
            { 
     "2018-11-29 17:20:00+02:00": { 
         "devices": { 
             "10.209.36.161": { 
                 "interfaces": { 
                     "Eth1/2": { 
                         "NormalizedDiscardedPackets": 1, 
                         "NormalizedBandwidth": 0, 
                         "NormalizedECNPackets": "N/A" 
                     } 
                 } 
             } 
         } 
     }, 
     "2018-11-29 18:05:00+02:00": { 
         "devices": { 
             "10.209.36.161": { 
                 "interfaces": { 
                     "Eth1/2": { 
                         "NormalizedDiscardedPackets": 2, 
                         "NormalizedBandwidth": 1, 
                         "NormalizedECNPackets": "N/A" 
                     } 
                 } 
             } 
         } 
     } 
 }

On This Page

Get Monitoring Data

Get RoCE Monitoring Data