Geneos - How to use REST API to get a snapshot of a dataview

You can query the Gateway for a specific dataview and publish the output.

Note : This feature is only available from GA5.14 Gateway version onwards.

Example. Syntax. To display the Hardware sampler of a specific managed entity run the following command

curl -u <username>:<password> -X GET -s --data '{ "target":"/geneos/gateway[(@name=\"gatewayname\")]/directory/probe[(@name=\"myprobename\")]/managedEntity[(@name=\"myentity\")]/sampler[(@name=\"Hardware\")]/dataview[(@name=\"Hardware\")]", "scope": {"value": true, "severity": true, "snooze": true, "user-assignment": true } }' http://mygatewayhostname:gatewayport/rest/snapshot/dataview | python -m json.tool

Output

{
"dataview": {
"headlines": {
"samplingStatus": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "OK"
}
},
"sample-time": "2023-01-23T09:14:04.065Z",
"snoozed": false,
"snoozed-ancestors": false,
"table": {
"OS": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "Linux 3.10.0-1062.9.1.el7.x86_64 #1 SMP Fri Dec 6 15:49:49 UTC 2019 x86_64 CentOS Linux release 7.9.2009 (Core)"
}
},
"coresPerCPU": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "2"
}
},
"cpuClockSpeed": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "2599.996 MHz"
}
},
"cpuModel": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "Common KVM processor"
}
},
"cpuUtilisation": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "5.68 % (average load)"
}
},
"hostid": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "007f0100"
}
},
"hostname": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "prodserver.prod.uk.itrs"
}
},
"hyperThreadingStatus": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "DISABLED"
}
},
"lastRebootTime": {
"Value": {
"assigned": false,
"severity": "CRITICAL",
"snoozed": false,
"value": "Wed Oct 12 06:35:53 PM 2022"
}
},
"memoryAvailable": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "1790.8 MB"
}
},
"memoryAvailablePct": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "47.3 %"
}
},
"memoryBuffers": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "13.1 MB"
}
},
"memoryCached": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "1549.6 MB"
}
},
"memoryIdle": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "2129.7 MB"
}
},
"memoryIdlePercent": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "56.2 %"
}
},
"memoryUse": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "1564.3 MB"
}
},
"memoryUsedPercent": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "41.3 %"
}
},
"numPhysicalCPUs": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "1"
}
},
"paging": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "12"
}
},
"swapSize": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "2047 MB"
}
},
"swapSize (virtual)": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "NA"
}
},
"swapUsed": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "9 %"
}
},
"swapUsed (virtual)": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "NA"
}
},
"systemModel": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "NA"
}
},
"systemType": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "NA"
}
},
"timeDifference": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "0 seconds"
}
},
"timeSyncOffset": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "-0.002 ms"
}
},
"timeSyncSource": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "ntp"
}
},
"timezone": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "GMT (+0000)"
}
},
"totalPhysicalMemory": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "3789.3 MB"
}
},
"totalProcesses": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "158"
}
},
"uptime": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "102 days"
}
},
"vendor": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "NA"
}
},
"zombieProcesses": {
"Value": {
"assigned": false,
"severity": "UNDEFINED",
"snoozed": false,
"value": "1"
}
}
}
}
}

Related Articles

Rest Service/REST API Documentation

If you have further questions:

• Please contact our Client Services team via the chat service box available in any of our websites or email us at support@itrsgroup.com
  
  
  
• Make sure you provide to us:
  • Command executed
  • Time the command was run 
  • Gateway log 
  • Any accompanying screenshot you think might be useful to present the issue