1 VMware monitoring item keys

Overview

This page provides details on the simple checks that can be used to monitor VMware environments. The metrics are grouped by the monitoring target.

Supported item keys

The item keys are listed without parameters and additional information. Click on the item key to see the full details.

Item key details

Parameters without angle brackets are mandatory. Parameters marked with angle brackets < > are optional.

vmware.eventlog[url,<mode>,<severity>]

The VMware event log.
Return value: Log.

Parameters:

• url - the VMware service URL;
• mode - all (default) or skip - skip the processing of older data;
• severity - filter by severity: error, warning, info or user. This parameter must be quoted if more than one severity is specified in a comma-delimited list (e.g."error,warning,info,user"). Disabled by default.

Comments:

• There must be only one vmware.eventlog item key per URL;
• See also example of filtering VMware event log records.

vmware.fullname[url]

The VMware service full name.
Return value: String.

Parameters:

• url - the VMware service URL.

vmware.version[url]

The VMware service version.
Return value: String.

Parameters:

• url - the VMware service URL.

vmware.cl.perfcounter[url,id,path,<instance>]

The VMware cluster performance counter metrics.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• id - the VMware cluster ID. id can be received from vmware.cluster.discovery[] as {#CLUSTER.ID}.
• path - the performance counter path¹;
• instance - the performance counter instance.

vmware.cluster.alarms.get[url,id]

The VMware cluster alarms data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• id - the VMware cluster ID.

vmware.cluster.discovery[url]

The discovery of VMware clusters.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.cluster.property[url,id,prop]

The VMware cluster property.
Return value: String.

Parameters:

• url - the VMware service URL;
• id - the VMware cluster ID;
• prop - the property path which is the name of a property of the VM object as defined in the VMware SDK.

Examples:

vmware.vm.property[{$VMWARE.URL},{$VMWARE.VM.UUID},overallStatus]
       vmware.vm.property[{$VMWARE.URL},{$VMWARE.VM.UUID},runtime.powerState]

vmware.cluster.status[url,name]

The VMware cluster status.
Return value: 0 - gray; 1 - green; 2 - yellow; 3 - red.

Parameters:

• url - the VMware service URL;
• name - the VMware cluster name.

vmware.cluster.tags.get[url,id]

The VMware cluster tags array.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• id - the VMware cluster ID.

This item works with vSphere 6.5 and newer.

vmware.datastore.alarms.get[url,uuid]

The VMware datastore alarms data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware datastore global unique identifier.

vmware.datastore.discovery[url]

The discovery of VMware datastores.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.datastore.hv.list[url,datastore]

The list of datastore hypervisors.
Return value: String.

Parameters:

• url - the VMware service URL;
• datastore - the datastore name.

Output example:

esx7-01-host.zabbix.sandbox
       esx7-02-host.zabbix.sandbox

vmware.datastore.perfcounter[url,uuid,path,<instance>]

The VMware datastore performance counter value.
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware datastore global unique identifier;
• path - the performance counter path¹;
• instance - the performance counter instance. Use empty instance for aggregate values (default).

vmware.datastore.property[url,uuid,prop]

The VMware datastore property.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware datastore global unique identifier;
• prop - the property path.

vmware.datastore.read[url,datastore,<mode>]

The amount of time for a read operation from the datastore (milliseconds).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• datastore - the datastore name;
• mode - latency (average value, default) or maxlatency (maximum value).

vmware.datastore.size[url,datastore,<mode>]

The VMware datastore space in bytes or in percentage from total.
Return value: Integer - for bytes; Float - for percentage.

Parameters:

• url - the VMware service URL;
• datastore - the datastore name;
• mode - possible values: total (default), free, pfree (free percentage), uncommitted.

vmware.datastore.tags.get[url,uuid]

The VMware datastore tags array.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware datastore global unique identifier.

This item works with vSphere 6.5 and newer.

vmware.datastore.write[url,datastore,<mode>]

The amount of time for a write operation to the datastore (milliseconds).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• datastore - the datastore name;
• mode - latency (average value, default) or maxlatency (maximum value).

vmware.dc.alarms.get[url,id]

The VMware datacenter alarms data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• id - the VMware datacenter ID.

vmware.dc.discovery[url]

The discovery of VMware datacenters.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.dc.tags.get[url,id]

The VMware datacenter tags array.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• id - the VMware datacenter ID.

This item works with vSphere 6.5 and newer.

vmware.dvswitch.discovery[url]

The discovery of VMware vSphere Distributed Switches.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.dvswitch.fetchports.get[url,uuid,<filter>,<mode>]

The VMware vSphere Distributed Switch ports data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware DVSwitch global unique identifier.
• filter - a single string with comma-separated criteria for selecting ports;
• mode - state (all XML without "config" XML nodes, default) or full.

The filter parameter supports the criteria available in the VMware data object DistributedVirtualSwitchPortCriteria.

Example:

vmware.dvswitch.fetchports.get[{$VMWARE.URL},{$VMWARE.DVS.UUID},"active:true,connected:false,host:host-18,inside:true,nsxPort:true,uplinkPort:false",state]

vmware.hv.alarms.get[url,uuid]

The VMware hypervisor alarms data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.cluster.name[url,uuid]

The VMware hypervisor cluster name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.connectionstate[url,uuid]

The VMware hypervisor connection state.
Return value: String: connected, disconnected, or notResponding.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.cpu.usage[url,uuid]

The VMware hypervisor processor usage (Hz).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.cpu.usage.perf[url,uuid]

The VMware hypervisor processor usage as a percentage during the interval.
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.cpu.utilization[url,uuid]

The VMware hypervisor processor usage as a percentage during the interval, depends on power management or HT.
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.datacenter.name[url,uuid]

The VMware hypervisor datacenter name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.datastore.discovery[url,uuid]

The discovery of VMware hypervisor datastores.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.datastore.list[url,uuid]

The list of VMware hypervisor datastores.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

Output example:

SSD-RAID1-VAULT1
       SSD-RAID1-VAULT2
       SSD-RAID10

vmware.hv.datastore.multipath[url,uuid,<datastore>,<partitionid>]

The number of available datastore paths.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• datastore - the datastore name;
• partitionid - the internal ID of physical device from vmware.hv.datastore.discovery.

vmware.hv.datastore.read[url,uuid,datastore,<mode>]

The average amount of time for a read operation from the datastore (milliseconds).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• datastore - the datastore name;
• mode - latency (default).

vmware.hv.datastore.size[url,uuid,datastore,<mode>]

The VMware datastore space in bytes or in percentage from total.
Return value: Integer - for bytes; Float - for percentage.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• datastore - the datastore name;
• mode - possible values: total (default), free, pfree (free percentage), uncommitted.

vmware.hv.datastore.write[url,uuid,datastore,<mode>]

The average amount of time for a write operation to the datastore (milliseconds).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• datastore - the datastore name;
• mode - latency (default).

vmware.hv.discovery[url]

The discovery of VMware hypervisors.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.hv.diskinfo.get[url,uuid]

The VMware hypervisor disk data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.fullname[url,uuid]

The VMware hypervisor name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.cpu.freq[url,uuid]

The VMware hypervisor processor frequency (Hz).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.cpu.model[url,uuid]

The VMware hypervisor processor model.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.cpu.num[url,uuid]

The number of processor cores on VMware hypervisor.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.cpu.threads[url,uuid]

The number of processor threads on VMware hypervisor.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.memory[url,uuid]

The VMware hypervisor total memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.model[url,uuid]

The VMware hypervisor model.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.sensors.get[url,uuid]

The VMware hypervisor hardware sensors value.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.hw.serialnumber[url,uuid]

The VMware hypervisor serial number.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

This item works with vSphere API 6.7 and newer.

vmware.hv.hw.uuid[url,uuid]

The VMware hypervisor BIOS UUID.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

This item works with vSphere API 6.7 and newer.

vmware.hv.hw.vendor[url,uuid]

The VMware hypervisor vendor name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

This item works with vSphere API 6.7 and newer.

vmware.hv.maintenance[url,uuid]

The VMware hypervisor maintenance status.
Return value: 0 - not in maintenance; 1 - in maintenance.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.memory.size.ballooned[url,uuid]

The VMware hypervisor ballooned memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.memory.used[url,uuid]

The VMware hypervisor used memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.net.if.discovery[url,uuid]

The discovery of VMware hypervisor network interfaces.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.network.in[url,uuid,<mode>]

The VMware hypervisor network input statistics (bytes per second).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• mode - bps (default), packets, dropped, errors, broadcast.

vmware.hv.network.linkspeed[url,uuid,ifname]

The VMware hypervisor network interface speed.
Return value: Integer. Returns 0, if the network interface is down, otherwise the speed value of the interface.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• ifname - the interface name.

vmware.hv.network.out[url,uuid,<mode>]

The VMware hypervisor network output statistics (bytes per second).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• mode - bps (default), packets, dropped, errors, broadcast.

vmware.hv.perfcounter[url,uuid,path,<instance>]

The VMware hypervisor performance counter value.
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• path - the performance counter path ¹;
• instance - the performance counter instance. Use empty instance for aggregate values (default).

vmware.hv.property[url,uuid,prop]

The VMware hypervisor property.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• prop - the property path.

vmware.hv.power[url,uuid,<max>]

The VMware hypervisor power usage (W).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier;
• max - the maximum allowed power usage.

vmware.hv.sensor.health.state[url,uuid]

The VMware hypervisor health state rollup sensor.
Return value: Integer: 0 - gray; 1 - green; 2 - yellow; 3 - red.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

Note that the item might not work in VMware vSphere 6.5 and newer, because VMware has deprecated the VMware Rollup Health State sensor.

vmware.hv.sensors.get[url,uuid]

The VMware hypervisor HW vendor state sensors.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.status[url,uuid]

The VMware hypervisor status.
Return value: Integer: 0 - gray; 1 - green; 2 - yellow; 3 - red.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

This item uses the host system overall status property.

vmware.hv.tags.get[url,uuid]

The VMware hypervisor tags array.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

This item works with vSphere 6.5 and newer.

vmware.hv.uptime[url,uuid]

The VMware hypervisor uptime (seconds).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

This item uses the host system overall status property.

vmware.hv.version[url,uuid]

The VMware hypervisor version.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.hv.vm.num[url,uuid]

The number of virtual machines on the VMware hypervisor.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware hypervisor global unique identifier.

vmware.rp.cpu.usage[url,rpid]

The CPU usage in hertz during the interval on VMware Resource Pool.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• rpid - the VMware resource pool ID.

vmware.rp.memory[url,rpid,<mode>]

The memory metrics of VMware resource pool.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• rpid - the VMware resource pool ID;
• mode - possible values:
  consumed (default) - the amount of host physical memory consumed for backing up guest physical memory pages
  ballooned - the amount of guest physical memory reclaimed from the virtual machine by the balloon driver in the guest
  overhead - the host physical memory consumed by ESXi data structures for running the virtual machines

vmware.alarms.get[url]

The VMware virtual center alarms data.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.vm.alarms.get[url,uuid]

The VMware virtual machine alarms data.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.attribute[url,uuid,name]

The VMware virtual machine custom attribute value.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• name - the custom attribute name.

vmware.vm.cluster.name[url,uuid]

The VMware virtual machine name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• name - the custom attribute name.

vmware.vm.consolidationneeded[url,uuid]

The VMware virtual machine disk requires consolidation.
Return value: String: true - consolidation is needed; false - consolidation is not needed.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.cpu.latency[url,uuid]

The percentage of time the virtual machine is unable to run because it is contending for access to the physical CPU(s).
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.cpu.num[url,uuid]

The number of processors on VMware virtual machine.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.cpu.readiness[url,uuid,<instance>]

The percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the CPU instance.

vmware.vm.cpu.ready[url,uuid]

The 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 (%).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.cpu.swapwait[url,uuid,<instance>]

The percentage of CPU time spent waiting for swap-in.
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the CPU instance.

vmware.vm.cpu.usage[url,uuid]

The VMware virtual machine processor usage (Hz).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.cpu.usage.perf[url,uuid]

The VMware virtual machine processor usage as a percentage during the interval.
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.datacenter.name[url,uuid]

The VMware virtual machine datacenter name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.discovery[url]

The discovery of VMware virtual machines.
Return value: JSON object.

Parameters:

• url - the VMware service URL.

vmware.vm.guest.memory.size.swapped[url,uuid]

The amount of guest physical memory that is swapped out to the swap space (KB).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.guest.osuptime[url,uuid]

The total time elapsed since the last operating system boot-up (in seconds).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.hv.maintenance[url,uuid]

The VMware virtual machine hypervisor maintenance status.
Return value: 0 - not in maintenance; 1 - in maintenance.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.hv.name[url,uuid]

The VMware virtual machine hypervisor name.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size[url,uuid]

The VMware virtual machine total memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.ballooned[url,uuid]

The VMware virtual machine ballooned memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.compressed[url,uuid]

The VMware virtual machine compressed memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.consumed[url,uuid]

The amount of host physical memory consumed for backing up guest physical memory pages (KB).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.private[url,uuid]

The VMware virtual machine private memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.shared[url,uuid]

The VMware virtual machine shared memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.swapped[url,uuid]

The VMware virtual machine swapped memory size (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.usage.guest[url,uuid]

The VMware virtual machine guest memory usage (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.size.usage.host[url,uuid]

The VMware virtual machine host memory usage (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.memory.usage[url,uuid]

The percentage of host physical memory that has been consumed.
Return value: Float.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.net.if.discovery[url,uuid]

The discovery of VMware virtual machine network interfaces.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.net.if.in[url,uuid,instance,<mode>]

The VMware virtual machine network interface input statistics (bytes/packets per second).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the network interface instance;
• mode - bps (default) or pps - bytes or packets per second.

vmware.vm.net.if.out[url,uuid,instance,<mode>]

The VMware virtual machine network interface output statistics (bytes/packets per second).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the network interface instance;
• mode - bps (default) or pps - bytes or packets per second.

vmware.vm.net.if.usage[url,uuid,<instance>]

The VMware virtual machine network utilization (combined transmit-rates and receive-rates) during the interval (KBps).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the network interface instance.

vmware.vm.perfcounter[url,uuid,path,<instance>]

The VMware virtual machine performance counter value.
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• path - the performance counter path ¹;
• instance - the performance counter instance. Use empty instance for aggregate values (default).

vmware.vm.powerstate[url,uuid]

The VMware virtual machine power state.
Return value: 0 - poweredOff; 1 - poweredOn; 2 - suspended.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.property[url,uuid,prop]

The VMware virtual machine property.
Return value: String.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• prop - the property path.

vmware.vm.snapshot.get[url,uuid]

The VMware virtual machine snapshot state.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.state[url,uuid]

The VMware virtual machine state.
Return value: String: notRunning, resetting, running, shuttingDown, standby, or unknown.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.storage.committed[url,uuid]

The VMware virtual machine committed storage space (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.storage.readoio[url,uuid,instance]

The average number of outstanding read requests to the virtual disk during the collection interval.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the disk device instance.

vmware.vm.storage.totalreadlatency[url,uuid,instance]

The average time a read from the virtual disk takes (milliseconds).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the disk device instance.

vmware.vm.storage.totalwritelatency[url,uuid,instance]

The average time a write to the virtual disk takes (milliseconds).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the disk device instance.

vmware.vm.storage.uncommitted[url,uuid]

The VMware virtual machine uncommitted storage space (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.storage.unshared[url,uuid]

The VMware virtual machine unshared storage space (bytes).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.storage.writeoio[url,uuid,instance]

The average number of outstanding write requests to the virtual disk during the collection interval.
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the disk device instance.

vmware.vm.tags.get[url,uuid]

The VMware virtual machine tags array.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

This item works with vSphere 6.5 and newer.

vmware.vm.tools[url,uuid,mode]

The VMware virtual machine guest tools state.
Return value: String: guestToolsExecutingScripts - VMware Tools is starting; guestToolsNotRunning - VMware Tools is not running; guestToolsRunning - VMware Tools is running.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• mode - version, status.

vmware.vm.uptime[url,uuid]

The VMware virtual machine uptime (seconds).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.vfs.dev.discovery[url,uuid]

The discovery of VMware virtual machine disk devices.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

vmware.vm.vfs.dev.read[url,uuid,instance,<mode>]

The VMware virtual machine disk device read statistics (bytes/operations per second).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the disk device instance;
• mode - bps (default) or ops - bytes or operations per second.

vmware.vm.vfs.dev.write[url,uuid,instance,<mode>]

The VMware virtual machine disk device write statistics (bytes/operations per second).
Return value: Integer ².

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• instance - the disk device instance;
• mode - bps (default) or ops - bytes or operations per second.

vmware.vm.vfs.fs.discovery[url,uuid]

The discovery of VMware virtual machine file systems.
Return value: JSON object.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier.

VMware Tools must be installed on the guest virtual machine for this item to work.

vmware.vm.vfs.fs.size[url,uuid,fsname,<mode>]

The VMware virtual machine file system statistics (bytes/percentages).
Return value: Integer.

Parameters:

• url - the VMware service URL;
• uuid - the VMware virtual machine global unique identifier;
• fsname - the file system name;
• mode - total, free, used, pfree, or pused.

VMware Tools must be installed on the guest virtual machine for this item to work.

Footnotes

¹ See Creating custom performance counter names for VMware.

² 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.cl.perfcounter
• 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.