Table of Contents
1 VMware monitoring item keys
Item keys
The table provides details on the simple checks that can be used to monitor VMware environments.
Parameters without angle brackets are mandatory. Parameters marked with angle brackets < > are optional.
| Key | ||||
|---|---|---|---|---|
| Description | Return value | Parameters | Comments | |
| vmware.cluster.discovery[url] | ||||
| Discovery of VMware clusters. | JSON object | url - VMware service URL | ||
| vmware.cluster.status[url,name] | ||||
| VMware cluster status. | Integer: 0 - gray; 1 - green; 2 - yellow; 3 - red |
url - VMware service URL name - VMware cluster name |
||
| vmware.datastore.discovery[url] | ||||
| Discovery of VMware datastores. | JSON object | url - VMware service URL | ||
| vmware.datastore.hv.list[url,datastore] | ||||
| List of datastore hypervisors. | JSON object | url - VMware service URL datastore - datastore name |
||
| vmware.datastore.read[url,datastore,<mode>] | ||||
| Amount of time for a read operation from the datastore (milliseconds). | Integer 2 | url - VMware service URL datastore - datastore name mode - latency (average value, default), maxlatency (maximum value) |
||
| vmware.datastore.size[url,datastore,<mode>] | ||||
| VMware datastore space in bytes or in percentage from total. | Integer - for bytes Float - for percentage |
url - VMware service URL datastore - datastore name mode - possible values: total (default), free, pfree (free, percentage), uncommitted |
||
| vmware.datastore.write[url,datastore,<mode>] | ||||
| Amount of time for a write operation to the datastore (milliseconds). | Integer 2 | url - VMware service URL datastore - datastore name mode - latency (average value, default), maxlatency (maximum value) |
||
| vmware.dc.discovery[url] | ||||
| Discovery of VMware datacenters. | JSON object | url - VMware service URL | This item is supported since Zabbix 5.0.3. | |
| vmware.eventlog[url,<mode>] | ||||
| VMware event log. | Log | url - VMware service URL mode - all (default), skip - skip processing of older data |
There must be only one vmware.eventlog[] item key per URL. See also: example of filtering VMware event log records. |
|
| vmware.fullname[url] | ||||
| VMware service full name. | String | url - VMware service URL | ||
| vmware.hv.cluster.name[url,uuid] | ||||
| VMware hypervisor cluster name. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.cpu.usage[url,uuid] | ||||
| VMware hypervisor processor usage (Hz). | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.datacenter.name[url,uuid] | ||||
| VMware hypervisor datacenter name. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.datastore.discovery[url,uuid] | ||||
| Discovery of VMware hypervisor datastores. | JSON object | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.datastore.list[url,uuid] | ||||
| List of VMware hypervisor datastores. | JSON object | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.datastore.read[url,uuid,datastore,<mode>] | ||||
| Average amount of time for a read operation from the datastore (milliseconds). | Integer 2 | url - VMware service URL uuid - VMware hypervisor global unique identifier datastore - datastore name mode - latency (default) |
||
| vmware.hv.datastore.size[url,uuid,datastore,<mode>] | ||||
| VMware datastore space in bytes or in percentage from total. | Integer - for bytes Float - for percentage |
url - VMware service URL uuid - VMware hypervisor global unique identifier datastore - datastore name mode - possible values: total (default), free, pfree (free, percentage), uncommitted |
Available since Zabbix versions 3.0.6, 3.2.2 | |
| vmware.hv.datastore.write[url,uuid,datastore,<mode>] | ||||
| Average amount of time for a write operation to the datastore (milliseconds). | Integer 2 | url - VMware service URL uuid - VMware hypervisor global unique identifier datastore - datastore name mode - latency (default) |
||
| vmware.hv.discovery[url] | ||||
| Discovery of VMware hypervisors. | JSON object | url - VMware service URL | ||
| vmware.hv.fullname[url,uuid] | ||||
| VMware hypervisor name. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.cpu.freq[url,uuid] | ||||
| VMware hypervisor processor frequency (Hz). | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.cpu.model[url,uuid] | ||||
| VMware hypervisor processor model. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.cpu.num[url,uuid] | ||||
| Number of processor cores on VMware hypervisor. | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.cpu.threads[url,uuid] | ||||
| Number of processor threads on VMware hypervisor. | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.memory[url,uuid] | ||||
| VMware hypervisor total memory size (bytes). | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.model[url,uuid] | ||||
| VMware hypervisor model. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.uuid[url,uuid] | ||||
| VMware hypervisor BIOS UUID. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.hw.vendor[url,uuid] | ||||
| VMware hypervisor vendor name. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.maintenance[url,uuid] | ||||
| VMware hypervisor maintenance status. | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
Returns '0' - not in maintenance or '1' - in maintenance This item is supported since Zabbix 5.0.18. |
|
| vmware.hv.memory.size.ballooned[url,uuid] | ||||
| VMware hypervisor ballooned memory size (bytes). | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.memory.used[url,uuid] | ||||
| VMware hypervisor used memory size (bytes). | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.network.in[url,uuid,<mode>] | ||||
| VMware hypervisor network input statistics (bytes per second). | Integer 2 | url - VMware service URL uuid - VMware hypervisor global unique identifier mode - bps (default) |
||
| vmware.hv.network.out[url,uuid,<mode>] | ||||
| VMware hypervisor network output statistics (bytes per second). | Integer 2 | url - VMware service URL uuid - VMware hypervisor global unique identifier mode - bps (default) |
||
| vmware.hv.perfcounter[url,uuid,path,<instance>] | ||||
| VMware hypervisor performance counter value. | Integer 2 | url - VMware service URL uuid - VMware hypervisor global unique identifier path - performance counter path 1 instance - performance counter instance. Use empty instance for aggregate values (default) |
Available since Zabbix versions 2.2.9, 2.4.4 | |
| vmware.hv.sensor.health.state[url,uuid] | ||||
| VMware hypervisor health state rollup sensor. | Integer: 0 - gray; 1 - green; 2 - yellow; 3 - red |
url - VMware service URL uuid - VMware hypervisor global unique identifier |
The item might not work in the VMware vSphere 6.5 and newer, because VMware has deprecated the VMware Rollup Health State sensor. | |
| vmware.hv.sensors.get[url,uuid] | ||||
| VMware hypervisor HW vendor state sensors. | JSON | url - VMware service URL uuid - VMware hypervisor global unique identifier |
This item is supported since Zabbix 5.0.18. | |
| vmware.hv.status[url,uuid] | ||||
| VMware hypervisor status. | Integer: 0 - gray; 1 - green; 2 - yellow; 3 - red |
url - VMware service URL uuid - VMware hypervisor global unique identifier |
Uses host system overall status property since Zabbix 2.2.16, 3.0.6, 3.2.2 | |
| vmware.hv.uptime[url,uuid] | ||||
| VMware hypervisor uptime (seconds). | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.version[url,uuid] | ||||
| VMware hypervisor version. | String | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.hv.vm.num[url,uuid] | ||||
| Number of virtual machines on VMware hypervisor. | Integer | url - VMware service URL uuid - VMware hypervisor global unique identifier |
||
| vmware.version[url] | ||||
| VMware service version. | String | url - VMware service URL | ||
| vmware.vm.cluster.name[url,uuid] | ||||
| VMware virtual machine name. | String | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.cpu.num[url,uuid] | ||||
| Number of processors on VMware virtual machine. | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.cpu.ready[url,uuid] | ||||
| Time (in milliseconds) that the virtual machine was ready, but could not get scheduled to run on the physical CPU. CPU ready time is dependent on the number of virtual machines on the host and their CPU loads (%). | Integer 2 | url - VMware service URL uuid - VMware virtual machine global unique identifier |
Available since Zabbix version 3.0.0 | |
| vmware.vm.cpu.usage[url,uuid] | ||||
| VMware virtual machine processor usage (Hz). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.datacenter.name[url,uuid] | ||||
| VMware virtual machine datacenter name. | String | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.discovery[url] | ||||
| Discovery of VMware virtual machines. | JSON object | url - VMware service URL | ||
| vmware.vm.hv.name[url,uuid] | ||||
| VMware virtual machine hypervisor name. | String | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size[url,uuid] | ||||
| VMware virtual machine total memory size (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.ballooned[url,uuid] | ||||
| VMware virtual machine ballooned memory size (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.compressed[url,uuid] | ||||
| VMware virtual machine compressed memory size (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.private[url,uuid] | ||||
| VMware virtual machine private memory size (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.shared[url,uuid] | ||||
| VMware virtual machine shared memory size (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.swapped[url,uuid] | ||||
| VMware virtual machine swapped memory size (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.usage.guest[url,uuid] | ||||
| VMware virtual machine guest memory usage (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.memory.size.usage.host[url,uuid] | ||||
| VMware virtual machine host memory usage (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.net.if.discovery[url,uuid] | ||||
| Discovery of VMware virtual machine network interfaces. | JSON object | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.net.if.in[url,uuid,instance,<mode>] | ||||
| VMware virtual machine network interface input statistics (bytes/packets per second). | Integer 2 | url - VMware service URL uuid - VMware virtual machine global unique identifier instance - network interface instance mode - bps (default)/pps - bytes/packets per second |
||
| vmware.vm.net.if.out[url,uuid,instance,<mode>] | ||||
| VMware virtual machine network interface output statistics (bytes/packets per second). | Integer 2 | url - VMware service URL uuid - VMware virtual machine global unique identifier instance - network interface instance mode - bps (default)/pps - bytes/packets per second |
||
| vmware.vm.perfcounter[url,uuid,path,<instance>] | ||||
| VMware virtual machine performance counter value. | Integer 2 | url - VMware service URL uuid - VMware virtual machine global unique identifier path - performance counter path 1 instance - performance counter instance. Use empty instance for aggregate values (default) |
Available since Zabbix versions 2.2.9, 2.4.4 | |
| vmware.vm.powerstate[url,uuid] | ||||
| VMware virtual machine power state. | Integer: 0 - poweredOff; 1 - poweredOn; 2 - suspended |
url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.storage.committed[url,uuid] | ||||
| VMware virtual machine committed storage space (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.storage.uncommitted[url,uuid] | ||||
| VMware virtual machine uncommitted storage space (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.storage.unshared[url,uuid] | ||||
| VMware virtual machine unshared storage space (bytes). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.uptime[url,uuid] | ||||
| VMware virtual machine uptime (seconds). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.vfs.dev.discovery[url,uuid] | ||||
| Discovery of VMware virtual machine disk devices. | JSON object | url - VMware service URL uuid - VMware virtual machine global unique identifier |
||
| vmware.vm.vfs.dev.read[url,uuid,instance,<mode>] | ||||
| VMware virtual machine disk device read statistics (bytes/operations per second). | Integer 2 | url - VMware service URL uuid - VMware virtual machine global unique identifier instance - disk device instance mode - bps (default)/ops - bytes/operations per second |
||
| vmware.vm.vfs.dev.write[url,uuid,instance,<mode>] | ||||
| VMware virtual machine disk device write statistics (bytes/operations per second). | Integer 2 | url - VMware service URL uuid - VMware virtual machine global unique identifier instance - disk device instance mode - bps (default)/ops - bytes/operations per second |
||
| vmware.vm.vfs.fs.discovery[url,uuid] | ||||
| Discovery of VMware virtual machine file systems. | JSON object | url - VMware service URL uuid - VMware virtual machine global unique identifier |
VMware Tools must be installed on the guest virtual machine. | |
| vmware.vm.vfs.fs.size[url,uuid,fsname,<mode>] | ||||
| VMware virtual machine file system statistics (bytes/percentages). | Integer | url - VMware service URL uuid - VMware virtual machine global unique identifier fsname - file system name mode - total/free/used/pfree/pused |
VMware Tools must be installed on the guest virtual machine. | |
Footnotes
1 The VMware performance counter path has the group/counter[rollup] format where:
group- the performance counter group, for example cpucounter- the performance counter name, for example usagemhzrollup- the performance counter rollup type, for example average
So the above example would give the following counter path: cpu/usagemhz[average]
The performance counter group descriptions, counter names and rollup types can be found in VMware documentation.
2 The value of these items is obtained from VMware performance counters and the VMwarePerfFrequency parameter is used to refresh their data in Zabbix VMware cache:
- vmware.hv.datastore.read
- vmware.hv.datastore.write
- vmware.hv.network.in
- vmware.hv.network.out
- vmware.hv.perfcounter
- vmware.vm.cpu.ready
- vmware.vm.net.if.in
- vmware.vm.net.if.out
- vmware.vm.perfcounter
- vmware.vm.vfs.dev.read
- vmware.vm.vfs.dev.write
More info
See Virtual machine monitoring for detailed information how to configure Zabbix to monitor VMware environments.