JSON examples for VMware items

Overview

This section provides additional information about JSON objects returned by various VMware items.

vmware.*.alarms.get

The items vmware.alarms.get[], vmware.cluster.alarms.get[], vmware.datastore.alarms.get[], vmware.dc.alarms.get[], vmware.hv.alarms.get[], vmware.vm.alarms.get[] return JSON objects with the following structure (values are provided as an example):

  1. {
  2. "alarms": [
  3. {
  4. "name": "Host connection and power state",
  5. "system_name": "alarm.HostConnectionStateAlarm",
  6. "description": "Default alarm to monitor host connection and power state",
  7. "enabled": true,
  8. "key": "alarm-1.host-2013",
  9. "time": "2022-06-27T05:27:38.759976Z",
  10. "overall_status": "red",
  11. "acknowledged": false
  12. },
  13. {
  14. "name": "Host memory usage",
  15. "system_name": "alarm.HostMemoryUsageAlarm",
  16. "description": "Default alarm to monitor host memory usage",
  17. "enabled": true,
  18. "key": "alarm-4.host-1004",
  19. "time": "2022-05-16T13:32:42.47863Z",
  20. "overall_status": "yellow",
  21. "acknowledged": false
  22. },
  23. {
  24. // other alarms
  25. }
  26. ]
  27. }

vmware.*.tags.get

The items vmware.cluster.tags.get[], vmware.datastore.tags.get[], vmware.dc.tags.get[], vmware.hv.tags.get[], vmware.vm.tags.get[] return JSON objects with the following structure (values are provided as an example):

  1. {
  2. "tags": [
  3. {
  4. "name": "Windows",
  5. "description": "tag for cat OS type",
  6. "category": "OS type"
  7. },
  8. {
  9. "name": "SQL Server",
  10. "description": "tag for cat application name",
  11. "category": "application name"
  12. },
  13. {
  14. // other tags
  15. }
  16. ]
  17. }

vmware.hv.diskinfo.get

The item vmware.hv.diskinfo.get[] returns JSON objects with the following structure (values are provided as an example):

  1. [
  2. {
  3. "instance": "mpx.vmhba32:C0:T0:L0",
  4. "hv_uuid": "8002299e-d7b9-8728-d224-76004bbb6100",
  5. "datastore_uuid": "",
  6. "operational_state": [
  7. "ok"
  8. ],
  9. "lun_type": "disk",
  10. "queue_depth": 1,
  11. "model": "USB DISK",
  12. "vendor": "SMI Corp",
  13. "revision": "1100",
  14. "serial_number": "CCYYMMDDHHmmSS9S62CK",
  15. "vsan": {}
  16. },
  17. {
  18. // other instances
  19. }
  20. ]

vmware.dvswitch.fetchports.get

The item vmware.dvswitch.fetchports.get[] returns JSON objects with the following structure (values are provided as an example):

  1. {
  2. "FetchDVPortsResponse":
  3. {
  4. "returnval": [
  5. {
  6. "key": "0",
  7. "dvsUuid": "50 36 6a 24 25 c0 10 9e-05 4a f6 ea 4e 3d 09 88",
  8. "portgroupKey": "dvportgroup-2023",
  9. "proxyHost":
  10. {
  11. "@type": "HostSystem",
  12. "#text": "host-2021"
  13. },
  14. "connectee":
  15. {
  16. "connectedEntity":
  17. {
  18. "@type": "HostSystem",
  19. "#text": "host-2021"
  20. },
  21. "nicKey": "vmnic0",
  22. "type": "pnic"
  23. },
  24. "conflict": "false",
  25. "state":
  26. {
  27. "runtimeInfo":
  28. {
  29. "linkUp": "true",
  30. "blocked": "false",
  31. "vlanIds":
  32. {
  33. "start": "0",
  34. "end": "4094"
  35. },
  36. "trunkingMode": "true",
  37. "linkPeer": "vmnic0",
  38. "macAddress": "00:00:00:00:00:00",
  39. "statusDetail": null,
  40. "vmDirectPathGen2Active": "false",
  41. "vmDirectPathGen2InactiveReasonOther": "portNptIncompatibleConnectee"
  42. },
  43. "stats":
  44. {
  45. "packetsInMulticast": "2385470",
  46. "packetsOutMulticast": "45",
  47. "bytesInMulticast": "309250248",
  48. "bytesOutMulticast": "5890",
  49. "packetsInUnicast": "155601537",
  50. "packetsOutUnicast": "113008658",
  51. "bytesInUnicast": "121609489384",
  52. "bytesOutUnicast": "47240279759",
  53. "packetsInBroadcast": "1040420",
  54. "packetsOutBroadcast": "7051",
  55. "bytesInBroadcast": "77339771",
  56. "bytesOutBroadcast": "430392",
  57. "packetsInDropped": "0",
  58. "packetsOutDropped": "0",
  59. "packetsInException": "0",
  60. "packetsOutException": "0"
  61. }
  62. },
  63. "connectionCookie": "1702765133",
  64. "lastStatusChange": "2022-03-25T14:01:11Z",
  65. "hostLocalPort": "false"
  66. },
  67. {
  68. //other keys
  69. }
  70. ]
  71. }
  72. }

vmware.hv.hw.sensors.get

The item vmware.hv.hw.sensors.get[] returns JSON objects with the following structure (values are provided as an example):

  1. {
  2. "val":
  3. {
  4. "@type": "HostHardwareStatusInfo",
  5. "storageStatusInfo": [
  6. {
  7. "name": "Intel Corporation HD Graphics 630 #2",
  8. "status":
  9. {
  10. "label": "Unknown",
  11. "summary": "Cannot report on the current status of the physical element",
  12. "key": "Unknown"
  13. }
  14. },
  15. {
  16. "name": "Intel Corporation 200 Series/Z370 Chipset Family USB 3.0 xHCI Controller #20",
  17. "status":
  18. {
  19. "label": "Unknown",
  20. "summary": "Cannot report on the current status of the physical element",
  21. "key": "Unknown"
  22. }
  23. },
  24. {
  25. // other hv hw sensors
  26. }
  27. ]
  28. }
  29. }

vmware.hv.sensors.get

The item vmware.hv.sensors.get[] returns JSON objects with the following structure (values are provided as an example):

  1. {
  2. "val":
  3. {
  4. "@type": "ArrayOfHostNumericSensorInfo", "HostNumericSensorInfo": [
  5. {
  6. "@type": "HostNumericSensorInfo",
  7. "name": "System Board 1 PwrMeter Output --- Normal",
  8. "healthState":
  9. {
  10. "label": "Green",
  11. "summary": "Sensor is operating under normal conditions",
  12. "key": "green"
  13. },
  14. "currentReading": "10500",
  15. "unitModifier": "-2",
  16. "baseUnits": "Watts",
  17. "sensorType": "other"
  18. },
  19. {
  20. "@type": "HostNumericSensorInfo",
  21. "name": "Power Supply 1 PS 1 Output --- Normal",
  22. "healthState":
  23. {
  24. "label": "Green",
  25. "summary": "Sensor is operating under normal conditions",
  26. "key": "green"
  27. },
  28. "currentReading": "10000",
  29. "unitModifier": "-2",
  30. "baseUnits": "Watts",
  31. "sensorType": "power"
  32. },
  33. {
  34. // other hv sensors
  35. }
  36. ]
  37. }
  38. }

vmware.vm.snapshot.get

If any snapshots exist, the item vmware.snapshot.get[] returns a JSON object with the following structure (values are provided as an example):

  1. {
  2. "snapshot": [
  3. {
  4. "name": "VM Snapshot 4%2f1%2f2022, 9:16:39 AM",
  5. "description": "Descr 1",
  6. "createtime": "2022-04-01T06:16:51.761Z",
  7. "size": 5755795171,
  8. "uniquesize": 5755795171
  9. },
  10. {
  11. "name": "VM Snapshot 4%2f1%2f2022, 9:18:21 AM",
  12. "description": "Descr 2",
  13. "createtime": "2022-04-01T06:18:29.164999Z",
  14. "size": 118650595,
  15. "uniquesize": 118650595
  16. },
  17. {
  18. "name": "VM Snapshot 4%2f1%2f2022, 9:37:29 AM",
  19. "description": "Descr 3",
  20. "createtime": "2022-04-01T06:37:53.534999Z",
  21. "size": 62935016,
  22. "uniquesize": 62935016
  23. }
  24. ],
  25. "count": 3,
  26. "latestdate": "2022-04-01T06:37:53.534999Z",
  27. "latestage": 22729203,
  28. "oldestdate": "2022-04-01T06:16:51.761Z",
  29. "oldestage": 22730465,
  30. "size": 5937380782,
  31. "uniquesize": 5937380782
  32. }

If no snapshot exists, the item vmware.snapshot.get[] returns a JSON object with empty values:

  1. {
  2. "snapshot": [],
  3. "count": 0,
  4. "latestdate": null,
  5. "latestage": 0,
  6. "oldestdate": null,
  7. "oldestage": 0,
  8. "size": 0,
  9. "uniquesize": 0
  10. }