nworks Metric Definitions December 16, 2011

(See also OpenView, and Types)
339 entries

[top]   Class Cluster (24 entries)
Name Type Since
nworks
Description
clusterId text 3.0 A system-wide identifier of the cluster.
Default rollup: lastvalue
Length: 128
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
clusterName text 3.0 The cluster name.
Default rollup: lastvalue
Length: 60
Sample data: "My First Cluster"
cpuUsedPct percent 3.6 The average of the physical usage of each esx server in the cluster. For example, if a cluster was composed of 2 esx servers and their HostStats.cpuUsedPct values were 50% and 60%, then this value would show 55%.
Default rollup: average
Sample data: "58"
effectiveCpu gauge 3.0 Effective CPU resources (in GHz) available to run virtual machines. This is the aggregated effective resource level from all running hosts. Hosts that are in maintenance mode or are unresponsive are not counted. Resources used by the VMware Service Console are not included in the aggregate. This value represents the amount of resources available for the root resource pool for running virtual machines.
Default rollup: average
Sample data: "32"
effectiveMemory gauge 3.0 Effective memory resources (in GB) available to run virtual machines. This is the aggregated effective resource level from all running hosts. Hosts that are in maintenance mode or are unresponsive are not counted. Resources used by the VMware Service Console are not included in the aggregate. This value represents the amount of resources available for the root resource pool for running virtual machines.
Default rollup: average
Sample data: "64"
entityId text 3.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", and bob's entityId will differentiate it from the host "john.acme.com", even for the same class of data. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId. And lastly, to differentiate components such as CPUs and disks, etc. multiple fields may be concatenated together to arrive at the entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com"
memoryPressure percent 3.6 This metric is a rolled up total for all ESX Hosts in the Cluster of HostStats.memoryPressure . It is expressed as a percentage, which can go above 100%. It shows potential memory over-commitment issues in the Cluster. This value is calculated internally in the nworks Collector, so is not visible in vCenter. Factors used in the calculation include - Total allocated memory for powered-on VMs, Memory overhead , the effects of TPS (Transparent Page Sharing), and total available physical memory in all Hosts.
Default rollup: average
Sample data: "80"
memoryUsedPct percent 3.0 This value is calculated by taking the ratio of the sum of all memoryUsageMb for all hosts in the cluster vs. the sum of all memoryTotalMem for all hosts in the cluster.
Default rollup: average
numCpuCores gauge 3.0 Number of physical CPU cores in the cluster. Physical CPU cores are the processors contained by a CPU package.
Default rollup: average
Sample data: "4"
numCpuThreads gauge 3.0 Aggregated number of CPU threads in the cluster.
Default rollup: average
Sample data: "8"
numEffectiveHosts gauge 3.0 Total number of effective hosts in the cluster.
Default rollup: average
Sample data: "2"
numHosts gauge 3.0 Total number of hosts in the Cluster.
Default rollup: average
Sample data: "2"
overallStatus text 3.0 The overall alarm status of the Cluster.
"green" - The Cluster is OK.
"yellow" - The Cluster might have a problem.
"red" - The Cluster definitely has a problem
"gray" - The status is unknown
Default rollup: lastvalue
Length: 7
Sample data: "green"
timestamp time 3.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
totalCpu gauge 3.0 Aggregated CPU resources of all hosts, in GHz.
Default rollup: average
Sample data: "128"
totalDiskKb number 5.5 This is the rolled up total for all disk (vmhba) traffic in KB (GB for nworks SPI) for all Hosts in the Cluster.
Default rollup: lastvalue
totalMemory gauge 3.0 Aggregated memory resources of all hosts, in GB.
Default rollup: average
Sample data: "128"
totalNetKb number 5.5 This is the rolled up total for all network traffic in KB (GB for nworks SPI) for all Hosts in the Cluster.
Default rollup: lastvalue
uniqueId number 3.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
vcName text 5.6 The vCenter name.
Default rollup: lastvalue
Length: 128
vmActive gauge 3.0 Number of active (i.e., powered up) virtual machines belonging to this cluster.
Default rollup: average
vmShutdown gauge 3.0 Number of virtual machines in a shutdown (i.e., powered off) state belonging to this cluster.
Default rollup: average
vmSuspended gauge 3.0 Number of virtual machines in a suspended state belonging to this cluster.
Default rollup: average
vmTotal gauge 3.0 Total number of virtual machines in all states belonging to this cluster.
Default rollup: average

[top]   Class ResourcePool (25 entries)
Name Type Since
nworks
Description
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 128
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
cpuExpandableReservation boolean 3.0 Indicates whether the pool is expandable or not. In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
Default rollup: lastvalue
Sample data: "True"
cpuLimit number 3.0 The maximum allowed CPU (in Mhz) that will be consumed by the VMs in this resource pool. The utilization of a resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines / resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares).
Default rollup: lastvalue
Sample data: "5780"
cpuReservation number 3.0 The specified reservations for this resource pool (in Mhz). Reservations are guaranteed, minimal allotments of resources (CPU in this case). VMs can consume more than this amount, but are guaranteed that the reservation will always be available to VMs in the pool. This value corresponds to the "CPU Reservation" field in the "Resource Allocation" tab of the VI Client.
Default rollup: lastvalue
Sample data: "5780"
cpuReservationCapacity number 3.0 The total of cpu reservations (in Mhz) that can be supplied by this pool (i.e., the sum of cpuReservation and the unused reservations). If the pool is expandable, cpuUsage can exceed this value. This value corresponds to the sum of the "CPU Reservation" and "CPU Unreserved" fields in the "Resource Allocation" tab of the VI Client.
Default rollup: lastvalue
Sample data: "11560"
cpuShares number 3.0 The specified cpu shares for this pool.
Default rollup: lastvalue
Sample data: "4000"
cpuUsageMhz gauge 3.0 The current CPU usage for the pool (in Mhz).
Default rollup: average
Sample data: "0"
cpuUsedPct percent 3.0 CPU used by the resource pool, as a percentage of the available Limit. If the Pool is set "Unlimited" then this will be a percentage of total CPU available in the Cluster
Default rollup: average
Sample data: "0"
entityId text 3.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", and bob's entityId will differentiate it from the host "john.acme.com", even for the same class of data. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId. And lastly, to differentiate components such as CPUs and disks, etc. multiple fields may be concatenated together to arrive at the entityId.
Default rollup: lastvalue
Length: 128
Sample data: "VMCCR:seattle.nworks.org:domain-c7:resgroup-74"
memoryExpandableReservation boolean 3.0 Indicates whether the pool is expandable or not. In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
Default rollup: lastvalue
Sample data: "True"
memoryLimit number 3.0 The maximum allowed memory (in MB) that will be consumed by the VMs in this resource pool. The utilization of a resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines / resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares).
Default rollup: lastvalue
Sample data: "3310"
memoryReservation number 3.0 The specified reservations for this resource pool (in MB). Reservations are guaranteed, minimal allotments of resources (memory in this case). VMs can consume more than this amount, but are guaranteed that the reservation will always be available to VMs in the pool. This field corresponds to the "Memory Reservation" field in the "Resource Allocation" tab of the VI Client.
Default rollup: lastvalue
Sample data: "3310"
memoryReservationCapacity number 3.0 The total of memory reservations (in MB) that can be supplied by this pool (i.e., the sum of memoryReservation and the unused reservations). If the pool is expandable, memoryUsage can exceed this value. This value corresponds to the sum of the VI Client fields "Memory Reservation" and "Memory Unreserved" in the "Resource Allocation" tab.
Default rollup: lastvalue
Sample data: "6425"
memoryShares number 3.0 Specified shares for this resource pool.
Default rollup: lastvalue
Sample data: "163840"
memoryUsed gauge 3.0 The current memory usage for the pool (in MB).
Default rollup: average
Sample data: "194"
memoryUsedPct percent 3.0 Memory used by the resource pool, as a percentage of the available Limit. If the Pool is set "Unlimited" then this will be a percentage of total memory available in the Cluster.
Default rollup: average
Sample data: "3"
poolId text 3.0 The VMware assigned resource pool identifier. The topmost, root Resource pool is not visible in the VI Client application, but is visible via the SDK API and the Managed Object Browser (MOB). This ID is only unique within each vCenter instance (i.e., two vCenters may assign the same ID).
Default rollup: lastvalue
Length: 128
Sample data: "VMPOOL:seattle.nworks.org:resgroup-7"
poolName text 3.0 The friendly name of the Resource pool. VMware automatically creates a "root" Resource pool for each cluster and assigns the name "Resources", even though this pool is not visible from the VI Client application. If this pool was created by the customer, then this is the name that the customer has assigned.
Default rollup: lastvalue
Length: 60
Sample data: "Windows VMs"
timestamp time 3.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 3.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
vcName text 5.6 The vCenter name.
Default rollup: lastvalue
Length: 128
vmActive gauge 3.0 Number of active (i.e., powered up) virtual machines belonging to this resource pool.
Default rollup: average
vmShutdown gauge 3.0 Number of virtual machines in a shutdown (i.e., powered off) state belonging to this resource pool.
Default rollup: average
vmSuspended gauge 3.0 Number of virtual machines in a suspended state belonging to this resource pool.
Default rollup: average
vmTotal gauge 3.0 Total number of virtual machines in all states belonging to this resource pool.
Default rollup: average

[top]   Class HostProperties (28 entries)
Name Type Since
nworks
Description
apiType text 3.0 Indicates whether or not the service instance represents a standalone host. If the service instance represents a standalone host, then the physical inventory for that service instance is fixed to that single host. vCenter server provides additional features over single hosts.

Examples of values are:
* "VirtualCenter" - For a vCenter instance.
* "HostAgent" - For host agent on an ESX Server
Default rollup: lastvalue
Length: 13
Sample data: "HostAgent"
apiVersion text 3.0 The version of the API as a dot-separated string.
Default rollup: lastvalue
Length: 5
Sample data: "2.0.0"
build number 1.0 The VMware Build number.
Default rollup: lastvalue
Sample data: "30353"
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 100
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
connectionState text 3.0 The host connection state.
"not responding" - vCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again. This state is typically used to trigger an alarm on the host.
"connected" - Connected to the server. For ESX Server, this is always the setting.
"disconnected" - The user has explicitly taken the host down. vCenter does not expect to receive heartbeats from the host. The next time a heartbeat is received, the host is moved to the connected state again and an event is logged.
Default rollup: lastvalue
Length: 15
Sample data: "connected"
cpuCores number 2.1 Number of physical CPU cores on the host. Physical CPU cores are the processors contained by a CPU package.
Default rollup: lastvalue
Sample data: "2"
cpuMhz number 3.0 CPU speed per core. This might be an averaged value if the speed is not uniform across all cores. The total CPU speed of the box is defined as hz * numCpuCores
Default rollup: lastvalue
Sample data: "3400"
cpuModel text 3.0 String summary description of CPU (for display purposes).
Default rollup: lastvalue
Length: 60
Sample data: "Intel(R) Xeon(TM) CPU 3.40GHz"
cpuPkgs number 2.1 Number of CPU's (on hyperthreading systems, this is the logical CPU count). Number of physical CPU packages on the host. Physical CPU packages are chips that contain one or more processors. Processors contained by a package are also known as CPU cores. For example, one dual-core package is comprised of one chip that contains two CPU cores.
Default rollup: lastvalue
Sample data: "2"
cpuThreads number 3.0 Number of physical CPU threads on the host.
Default rollup: lastvalue
Sample data: "4"
customTag0 text 4.0 This is a grouping label assigned by the customer to this host which allows it to be arbitrarily grouped with other hosts.
Default rollup: lastvalue
Length: 128
customTag1 text 4.0 This is a grouping label assigned by the customer to this host which allows it to be arbitrarily grouped with other hosts.
Default rollup: lastvalue
Length: 128
customTag2 text 4.0 This is a grouping label assigned by the customer to this host which allows it to be arbitrarily grouped with other hosts.
Default rollup: lastvalue
Length: 20
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", and bob's entityId will differentiate it from the host "john.acme.com", even for the same class of data. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId. And lastly, to differentiate components such as CPUs and disks, etc. multiple fields may be concatenated together to arrive at the entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com"
fullName text 3.0 The complete product name, including the version and build information. For 3.5, certain builds have been given names:
3.5.0: Up to build 82660
3.5.0 U1: Build 82663 - 103907
3.5.0 U2: Build 103908 onwards
Default rollup: lastvalue
Length: 60
Sample data: "VMware ESX Server 3.5.0 build-103908"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
inMaintenanceMode boolean 3.0 The flag to indicate whether or not the host is in maintenance mode. This flag is set when the host has entered the maintenance mode. It is not set during the entering phase of maintenance mode.
Default rollup: lastvalue
Sample data: "False"
numHBAs number 3.0 The number of host bus adapters (HBAs)
Default rollup: lastvalue
Sample data: "2"
numNICs number 3.0 The number of network adapters
Default rollup: lastvalue
Sample data: "4"
platform number 1.0 A VMware Platform ID, such as "3" for the COM API version, or "esx-server" for the VC 1.2 version.
Default rollup: lastvalue
Sample data: "3"
product number 1.0 A VMware Product ID, such as "3" for the COM API version, or "VMware ESX Server" for the VC 1.2 version.
Default rollup: lastvalue
Sample data: "3"
systemModel text 3.0 The hardware model identification.
Default rollup: lastvalue
Length: 30
Sample data: "ProLiant DL360 G4"
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
uuId text 3.0 The hardware BIOS identification
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vcName text 5.6 The vCenter name.
Default rollup: lastvalue
Length: 128
vendor text 3.0 The hardware vendor identification
Default rollup: lastvalue
Length: 25
Sample data: "HP"
vmwareVersion text 3.0 A short form of the VMware Version string consisting of the major, minor, and revision strings. See also fullName.
Default rollup: lastvalue
Length: 8
Sample data: "3.0.1"

[top]   Class HostStats (57 entries)
Name Type Since
nworks
Description
bootTime time 3.0 The time when the host was booted.
Default rollup: lastvalue
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 100
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
cpuFairness gauge 3.0 The fairness of distributed CPU resource allocation on the host. Fairness scores are represented in units with relative values, meaning they are evaluated relative to the scores of other hosts. They should not be thought of as having any particular absolute value. The further the fairness score diverges from 1000, the less fair the allocation. Therefore, a fairness score of 990, is more fair than a fairness score of 1015. This is because 1015 is further from 1000 than 990.
Default rollup: average
cpuGuestUsedPct percent 1.0 Percentage (for the last interval) of real host CPU cycles used by all guests (in MHz) / Host's cpu capability (in Mhz). The guest's usage is the sum of all VMStats.cpuUsageMhz for the guests running on this host. The Host's cpu capability is calculated as the HostProperties.cpuCores * cpuMhz. The value of this metric is lower than cpuUsedPct because it does not include non-VM ESX cpu overhead.
Default rollup: average
Sample data: "54"
cpuLatency percent 5.7 Percent of time the VM is unable to run because it is contending for access to the physical CPU(s)
Default rollup: average
cpuMhz number 3.0 The speed of the CPU cores. This is an average value if there are multiple speeds. The product of cpuMhz and numCpuCores is approximately equal to the sum of the MHz for all the individual cores on the host.
Default rollup: lastvalue
Sample data: "3400"
cpuReadyPct percent 5.5 Rolled up total for all VMStats.cpuReadyPct for all virtual machine vCPUs on the host.
Default rollup: summation
cpuReservedCapacity gauge 3.0 CPU reserved capacity in Mhz.
Default rollup: average
cpuUsageMhz gauge 3.0 Aggregated CPU usage across all cores on the host in MHz.
Default rollup: average
cpuUsedPct percent 1.0 The percentage of the last interval (0-100%) that the physical server's CPU was busy.
Default rollup: average
Sample data: "58"
diskMaxTotalLatency millisecond 5.7 Highest latency value across all disks used by the host
Default rollup: latest
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", and bob's entityId will differentiate it from the host "john.acme.com", even for the same class of data. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId. And lastly, to differentiate components such as CPUs and disks, etc. multiple fields may be concatenated together to arrive at the entityId.
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
hbrNetRx kbps 5.7 Average amount of data received per second
Default rollup: average
hbrNetTx kbps 5.7 Average amount of data transmitted per second
Default rollup: average
hbrNumVms number 5.7 Current Number of Replicated VMs
Default rollup: average
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
memoryActive gauge 1.0 The amount of memory, in KB, that the host has recently used.
Default rollup: average
memoryAvail gauge 1.0 Total amount of memory (in KB) still available. This is the difference between the system's total memory (memoryTotalMem) and memory currently being used.

Both of these values can also be seen in the VI Client on a host's Summary Tab under Resources / Memory Usage. MemoryAvail is the value between Memory usage and total memory. Refer to VMware's Resource Management Guide for more information on VMware's memory usage.
Default rollup: average
Sample data: "3953132"
memoryAvailPct percent 4.0 This is a convenience calculation taking memoryAvail divided by memoryTotalMem as a percentage.
Default rollup: average
Sample data: "90"
memoryCompressed number 5.6 Amount of memory compressed by ESX
Default rollup: average
memoryCompressionRate number 5.6 Rate of memory compression for the VM
Default rollup: average
memoryCtl number 5.6 Amount of memory allocated by the virtual machine memory control driver (vmmemctl), which is installed with VMware Tools
Default rollup: average
memoryDecompressionRate number 5.6 Rate of memory decompression for the VM
Default rollup: average
memoryFairness gauge 3.0 The fairness of distributed memory resource allocation on the host. Fairness scores are represented in units with relative values, meaning they are evaluated relative to the scores of other hosts. They should not be thought of as having any particular absolute value. Each fairness unit represents an increment of 0.001 in a fairness score. The further the fairness score diverges from 1, the less fair the allocation. Therefore, a fairness score of 990, representing 0.990, is more fair than a fairness score of 1015, which represents 1.015. This is because 1.015 is further from 1 than 0.990.
Default rollup: average
memoryFree gauge 4.0 The average amount of memory, in KB, that has been available during the last interval.
Default rollup: average
memoryLatency percent 5.7 Percentage of time the VM is waiting to access swapped or compressed memory
Default rollup: average
memoryllSwapInRate kbps 5.7 Rate at which memory is being swapped from host cache into active memory
Default rollup: average
memoryllSwapOutRate kbps 5.7 Rate at which memory is being swapped from active memory to host cache
Default rollup: average
memoryOverhd gauge 1.0 Sum of the current memory overhead, in KB, for all running virtual machines. This is the extra memory required by the ESX host to maintain each VM.
Default rollup: average
memoryPressure percent 3.6 This metric is expressed as a percentage, which can go above 100%. It shows potential memory over-commitment issues on the ESX Host. This value is calculated internally in the nworks Collector, so is not visible in vCenter. Factors used in the calculation include - Total allocated memory for powered-on VMs, Memory overhead , the effects of TPS (Transparent Page Sharing), and total available physical memory in the Host.
Default rollup: average
Sample data: "80"
memoryReservedMem gauge 1.0 Total reserved memory, in KB, for all running virtual machines (Amount of memory that is reserved capacity). This number is the total of user set minimum memory sizes and the default minimum memory sizes (50% of the specified maximum) on all virtual machines.
Default rollup: average
memoryShared gauge 1.0 The average amount of shared memory. Shared memory represents the entire pool of memory from which sharing savings are possible.
Default rollup: average
memorySharedCommon gauge 1.0 The average amount of shared common memory. Shared memory represents the entire pool of memory from which sharing savings are possible. The amount of memory that this has been condensed to is reported in shared common memory.
Default rollup: average
memorySharedVM percent 1.0 Note: Deprecated since 5.5.
Default rollup: average
memorySwapin counter 1.0 Cumulative memory, in KB, swapped into memory since the last time the physical server was booted.
Default rollup: lastvalue
memorySwapout counter 1.0 Cumulative memory, in KB, swapped out to disk since the last time the physical server was booted.
Default rollup: lastvalue
memorySwapped gauge 1.0 The difference (in KB) between memorySwapout and memorySwapin.

See VMStats.memorySwapped.
Default rollup: average
memorySwapRate gauge 4.0 The rate of bytes swapped (in plus out) per second during the interval.
Default rollup: average
memorySysHeapSize gauge 1.0 Amount of memory allocated, in KB, to the VMKernel heap file.
Default rollup: average
memoryTotalMem number 1.0 The total memory, in KB, on the physical server.
Default rollup: lastvalue
memoryUsageMb gauge 3.0 Physical memory usage on the host in MB.
Default rollup: average
memoryUsedPct percent 4.0 Memory used divided by total physical memory, as a percentage.
Default rollup: average
overallStatus text 3.0 The overall alarm status of the host - red, yellow, green or gray.
Default rollup: lastvalue
Length: 7
Sample data: "green"
sample time 3.0 The date/time of the end of the last interval. For ESX 3.0 or VC 2.0 targets, this is the target's local date/time.
Default rollup: lastvalue
Sample data: "632936028235115000"
serverDelta timeDelta 3.0 For collection from ESX 3.0 or VC 2.0 systems,the "sample" time in the collection is the end of the 5-minute sample expressed in the vmware server's local time. The vmware server's local time may differ from the VEM collector because of clock differences or time zones. Therefore, this data item shows the difference in seconds of the server's clock vs. the VEM's clock.
Default rollup: summation
Sample data: "-19"
serverTime time 3.0 For collection from ESX 3.0 or VC 2.0 systems,the "sample" time in the collection is the end of the 5-minute sample expressed in the vmware server's local time. The vmware server's local time may differ from the VEM collector because of clock differences or time zones. Therefore, this data item exposes what the server's current clock indicates.
Default rollup: lastvalue
Sample data: "632936028235115000"
sysCpuUsed timeDelta 1.0 The total number of seconds that all CPUs were in use (non-idle) during the last interval.
Default rollup: average
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
totalDiskIOPS number 5.5 Rolled up total for all disk IOPS (reads + writes divided by the interval) through all vmhba on the host.
Default rollup: summation
totalDiskKb number 5.5 Rolled up total in KB for all disk traffic through all vmhba on the host.
Default rollup: lastvalue
totalNetKb number 5.5 Rolled up total in KB for all network traffic through all vmnic on the host.
Default rollup: lastvalue
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
uuId text 3.0 This is the hardware BIOS identification.
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vmActive gauge 1.0 Number of active (i.e., powered up) virtual machines running on this host.
Default rollup: average
vmShutdown gauge 1.0 Number of virtual machines in a shutdown (i.e., powered off) state on this host.
Default rollup: average
vmSuspended gauge 1.0 Number of virtual machines in a suspended state on this host.
Default rollup: average
vmTotal gauge 1.0 Total number of all virtual machines on this host.
Default rollup: average

[top]   Class HostCPUStats (9 entries)
Name Type Since
nworks
Description
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 100
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
cpuName text 1.0 A name given to the individual physical server CPU, beginning with "CPU" followed by the instance number, such as "CPU0".
Default rollup: lastvalue
Length: 5
Sample data: "CPU0"
cpuUsedPct percent 1.0 Percentage of time during which the host CPU was busy during the last interval.
Default rollup: average
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", but this host may have multiple CPU packages. The entityId will differentiate this CPU being reported from other CPUs even on other systems. EntityIds do not differentiate over time. That is, different intervals for CPU2 will have the same entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com:CPU2"
hostName text 1.0 The hostname of the physical server (ESX host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
idle timeDelta 1.0 The number of seconds the host CPU was idle in the last interval.
Default rollup: summation
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
used timeDelta 1.0 The number of seconds that this host CPU was busy in the last interval. Deprecated since 5.5.
Default rollup: summation

[top]   Class HostDiskStats (20 entries)
Name Type Since
nworks
Description
aborts delta 1.0 SCSI commands aborted for this disk on this host in the last interval.
Default rollup: summation
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 100
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
datastoreName text 3.0 The name of the datastore that this lun is connected with. VMware refers to this as the datastore "Identification" in the VI Client. Luns (aka, "disks") can be created but not assigned to any datastore. When this occurs, the datastore name is "(No datastore assigned)".
Default rollup: lastvalue
Length: 40
Sample data: "san2"
deviceReadLatency timeDelta 4.0 The average amount of time taken to complete a read from the physical device. This is the time from the device to the HBA in milliseconds.
Default rollup: average
deviceWriteLatency timeDelta 4.0 The average amount of time taken to complete a write to the physical device. This is the time from the HBA to the device in milliseconds.
Default rollup: average
diskIOPS number 5.5 Disk IOPS is input/output operations per second, and is calculated as total of (reads + writes) divided by the collection interval..
Default rollup: summation
diskName text 1.0 The name of the lun (vmhba) on the host.
Default rollup: lastvalue
Length: 20
Sample data: "vmhba1:0:0"
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one disk (lun) vmhba0:0:0 on host "bob.acme.com", and this disk's entityId will differentiate it from all other disks, even those on different systems. EntityIds do not differentiate over time. That is, different intervals for disk vmhba0:0:0 on host "bob.acme.com" will have the same entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com:vmhba0:0:0"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
kbRead deltaKB 1.0 Kilobytes read from this disk for this host in the last interval.
Default rollup: average
kbWritten deltaKB 1.0 Kilobytes written to this disk for this host in the last interval.
Default rollup: average
maxQueueDepth number 5.7 Maximum queue depth
Default rollup: average
queueLatency number 5.6 Average amount of time spent in the VMkernel queue, per SCSI command, during the collection interval
Default rollup: average
reads delta 1.0 Disk read operations for this disk on this host in the last interval.
Default rollup: summation
resets delta 1.0 SCSI bus resets detected for this disk on this host in the last interval.
Default rollup: summation
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
totalReadLatency timeDelta 4.0 The average amount of time (in milliseconds) taken to complete a read from the perspective of a Guest OS. This is the average time from the the physical disk device (including the time through the HBA) to the vmkernel.
Default rollup: average
totalWriteLatency timeDelta 4.0 The average amount of time (in milliseconds) taken to complete a disk write from the perspective of a Guest OS. This is the average time from the the kernel (including the time through the HBA) to the physical disk. This number is always greater than deviceWriteLatency.
Default rollup: average
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
writes delta 1.0 Disk write operations for this disk on this host in the last interval.
Default rollup: summation

[top]   Class HostNetStats (13 entries)
Name Type Since
nworks
Description
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 100
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
droppedRx delta 4.0 Number of receive packets dropped in the last interval.
Default rollup: summation
droppedTx delta 4.0 Number of transmit packets dropped in the last interval.
Default rollup: summation
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one NIC vmnic0 on host "bob.acme.com", and vmnic0's entityId will differentiate it from all other NICs even those on different hosts. EntityIds do not differentiate over time. That is, different intervals for NIC vmnic0 on host "bob.acme.com" will have the same entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com:vmnic0"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
kbRx deltaKB 1.0 Kilobytes received by this host interface in the last interval.
Default rollup: average
kbTx deltaKB 1.0 Kilobytes transmitted by this host interface in the last interval.
Default rollup: average
linkSpeed number 3.0 The speed of the physical NIC in megabits per second.
Default rollup: lastvalue
Sample data: "1000"
netName text 1.0 The Network Interface Name.
Default rollup: lastvalue
Length: 25
Sample data: "vmnic0"
packetsRx delta 1.0 Packets received by this host interface in the last interval.
Default rollup: summation
packetsTx delta 1.0 Packets transmitted by this host interface in the last interval.
Default rollup: summation
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"

[top]   Class DatastoreStats (19 entries)
Name Type Since
nworks
Description
clusterId text 3.0 ID of the cluster that this host is a member of.
Default rollup: lastvalue
Length: 100
Sample data: "VMCCR:seattle.nworks.org:domain-c7"
customTag0 text 5.7 This is a grouping label assigned by the customer to this host which allows it to be arbitrarily grouped with other hosts.
Default rollup: lastvalue
Length: 128
customTag1 text 5.7 This is a grouping label assigned by the customer to this host which allows it to be arbitrarily grouped with other hosts.
Default rollup: lastvalue
Length: 128
datastoreName text 3.0 The name of the host datastore. VMware refers to this as the datastore "Identification" in the VI Client. For local datastores (i.e., disks that are locally mounted to the esx server), this is the file system.
Default rollup: lastvalue
Length: 40
Sample data: "san2"
diskFree gauge 1.0 Number of KBs (GBs for nworks SPI) free on the VMFS.
Default rollup: average
Sample data: "1170928"
diskPercUsed percent 1.0 Percentage of space in use on the VMFS. That is, diskUse vs diskSize.
Default rollup: average
Sample data: "52"
diskPressure percent 5.7 The ratio of allocated storage to storage capacity, expressed as a percentage. This percentage can be greater than 100 if thin-provisioning (storage overcommit) is used extensively. See related metric diskProvisioned.
Default rollup: average
Sample data: "41"
diskProvisioned gauge 5.7 The space in GB that is provisioned (allocated) in the datastore. This can exceed the actual capacity of the datastore if thin-provisioning is used extensively (storage overcommit). See related metric diskProvisioned.
Default rollup: average
Sample data: "140"
diskSize gauge 1.0 Size in KB (GB for nworks SPI) of the VMFS. VMware refers to this as "Capacity" in the VI Client.
Default rollup: average
Sample data: "2517952"
diskUse gauge 1.0 Number of KBs (GBs for nworks SPI) used on the VMFS. That is, capacity minus freespace.
Default rollup: average
Sample data: "1219116"
entityId text 2.0 The entityId differentiates one datastore from another. Performance data for the same datastore will have the same entityId even though reported in different intervals.
Default rollup: lastvalue
Length: 128
Sample data: "sanfs://vmfs_uuid:48f9be30-82eedea3-e4e3-001ec9fdfcc9/"
fsType text 1.0 Either "vmfs2", "vmfs3", "NFS", "CIFS", if one of the file systems supported by VMware, or "native" if the data was retrieved via ssh using plink.
Default rollup: lastvalue
Length: 6
Sample data: "vmfs3"
hostName text 1.0 The hostname of the first esx server (host) connected to this datastore. Multiple hosts may refer to this same datastore if its external and shared, but only the first one is listed here.
Default rollup: lastvalue
Length: 60
Sample data: "esx01.nworks.com"
mountPoint text 1.0 For locally mounted datastores, this is the mount point of the disk or partition. For external NAS datastores, this is the remote path. For all other external datastores, it is "/vmfs/volumes/" + the datastore name.
Default rollup: lastvalue
Length: 128
Sample data: "/vmfs/volumes/san2"
StoragePod text 5.7 The name of datastore cluster.
Default rollup: lastvalue
Length: 128
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
url text 4.0 The name of the file system for locally mounted datastores. For external datastores, this is the URL of the datastore.
Default rollup: lastvalue
Length: 128
Sample data: "/dev/cciss/c0d0p2 or sanfs://vmfs_uuid:47aa47fc-32ebeb3a-3ac5-00114336192f/ or netfs://15.1.2.9//mnt/md1/vmfs3/"
vcName text 5.7 The vCenter name.
Default rollup: lastvalue
Length: 128

[top]   Class SensorStats (10 entries)
Name Type Since
nworks
Description
actualValue number 4.0 The current reading of the element indicated by the sensor current reading multiplied by the scale factor.
Default rollup: lastvalue
Sample data: "5250"
baseUnits text 4.0 The base units in which the sensor reading is specified. If rateUnits is set, the units of the current reading is further qualified by the rateUnits.
Default rollup: lastvalue
Length: 20
Sample data: "RPM"
entityId text 4.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", and bob's entityId will differentiate it from the host "john.acme.com", even for the same class of data. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId. And lastly, to differentiate components such as CPUs and disks, etc. multiple fields may be concatenated together to arrive at the entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com"
healthState text 4.0 The health state of the of the element indicated by the sensor. This property is populated only for sensors that support threshold settings. Possible values are "green", "yellow", "red", and "unknown".
Default rollup: lastvalue
Length: 7
Sample data: "green"
hostName text 4.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
rateUnits text 4.0 The rate units in which the sensor reading is specified. For example if the baseUnits is Volts and the rateUnits is per second the value returned by the sensor are in Volts/second.
Default rollup: lastvalue
Length: 15
Sample data: "per second"
sensorName text 4.0 The name of the physical element associated with the sensor.
Default rollup: lastvalue
Length: 60
Sample data: "FAN 4B RPM for System Board 1"
sensorType text 4.0 The type of the sensor. If the sensor type is set to "Other" the sensor name can be used to further identify the type of sensor. The sensor units can also be used to further implicitly determine the type of the sensor.

Possible values are "fan", "power", "temperature", "voltage"
Default rollup: lastvalue
Length: 15
Sample data: "fan"

timestamp time 4.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 4.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"

[top]   Class HardwareStatus (9 entries)
Name Type Since
nworks
Description
entityId text 4.0 The entityId differentiates one entity being reported from another. For example, there is only one host "bob.acme.com", and bob's entityId will differentiate it from the host "john.acme.com", even for the same class of data. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId. And lastly, to differentiate components such as CPUs and disks, etc. multiple fields may be concatenated together to arrive at the entityId.
Default rollup: lastvalue
Length: 128
Sample data: "seattle.nworks.com:Port 1 on Controller 0"
hostName text 4.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
hwName text 4.0 The name of the hardware component. If there are multiple components on a system, then this field becomes a short description identifying which one (see sample).
Default rollup: lastvalue
Length: 60
Sample data: "Port 1 on Controller 0"
properties text 4.0 A list of property elements presented as a comma seperated list of name/value pairs (joined with a colon).
Default rollup: lastvalue
Length: 100
Sample data: "Firmware: 00.20.48.00.06.14.10.00 (Package); 00.20.48.00(Fw)"
status text 4.0 The status of the hardware component.
"green" - The hardware is behaving normally.
"yellow" - The hardware might have a problem.
"red" - The hardware definitely has a problem
"gray" - The status is unknown
If status is yellow or red, look to statusText for more information.
Default rollup: lastvalue
Length: 7
Sample data: "green"
statusCode number 4.0 This code is a numeric representation of VMware's status text.
0 - "green" - The hardware is behaving normally.
1 - "yellow" - The hardware might have a problem.
2 - "red" - The hardware definitely has a problem
3 - "gray" - The status is unknown
Default rollup: lastvalue
Sample data: "0"
statusText text 4.0 A more lengthy explanation of the status of the hardware. This is expecially helpful if the hardware status is "yellow" or "red".
Default rollup: lastvalue
Length: 150
Sample data: "Physical element is functioning as expected"
timestamp time 4.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 4.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"

[top]   Class VMProperties (23 entries)
Name Type Since
nworks
Description
configPath text 1.0 The configuration file path and name for this virtual machine.
Default rollup: lastvalue
Length: 128
Sample data: "/home/vmware/gw2k13-OVOW/gw2k13-OVOW.vmx"
customTag0 text 4.0 This is a grouping label assigned by the customer to this virtual machine which allows it to be arbitrarily grouped with other VMs.
Default rollup: lastvalue
Length: 128
customTag1 text 4.0 This is a grouping label assigned by the customer to this virtual machine which allows it to be arbitrarily grouped with other VMs.
Default rollup: lastvalue
Length: 128
customTag2 text 4.0 This is a grouping label assigned by the customer to this virtual machine which allows it to be arbitrarily grouped with other VMs.
Default rollup: lastvalue
Length: 20
datacenterName text 5.7 The Datacenter name.
Default rollup: lastvalue
Length: 128
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, the entityId will uniquely identify each virtual machine system on "bob.acme.com". EntityIds do not differentiate over time. That is, different intervals for a particular virtual machine will have the same entityId.
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
guestFamily text 3.0 Virtual machine operating system family, if known.
Default rollup: lastvalue
Length: 20
Sample data: "windowsGuest"
guestHostName text 3.0 This is the name of the guest OS installed inside the VM. Generally, this is the name that is returned from the command line "hostname" when invoked from within the Guest OS. This is only available if VMware Tools are installed and running in the guest OS.
Default rollup: lastvalue
Length: 60
Sample data: "gExchange.test.nworks.local"
guestOSFullName text 3.0 This is the full name of the guest operating system on the virtual machine.
Default rollup: lastvalue
Length: 70
Sample data: "Microsoft Windows Server 2003, Standard Edition"
guestOSId text 3.0 Guest operating system configured on a virtual machine. This is a virtual machine identifier that can be used to access the GuestOsDescriptor list for information about default configuration. For more information on possible values, see VirtualMachineGuestOsIdentifier.
Default rollup: lastvalue
Length: 60
Sample data: "winNetStandardGuest"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
ipAddress text 3.0 Primary IP address assigned to the virtual machine operating system. This is only available if VMware Tools are installed and running on the virtual machine system.
Default rollup: lastvalue
Length: 128
Sample data: "15.1.1.18"
objectId text 3.0 This is VMware's managed object ID of the Virtual Machine.
Default rollup: lastvalue
Length: 16
Sample data: "vm-1251"
poolId text 3.0 The VMware assigned resource pool Id that this virtual machine is currently assigned to.
Default rollup: lastvalue
Length: 128
Sample data: "resgroup-74"
poolName text 3.0 The friendly name of the Resource pool that this virtual machine is assigned to.
Default rollup: lastvalue
Length: 40
Sample data: "Windows VMs"
template boolean 3.0 Flag indicating whether or not a virtual machine is a template.
Default rollup: lastvalue
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
toolsVersion text 3.0 Version of VMware Tools installed on the VM's guest O/S.
Default rollup: lastvalue
Length: 7
Sample data: "30353"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
uuId text 1.0 The Universal Unique ID of the virtual machine system. 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vcName text 5.6 The vCenter name.
Default rollup: lastvalue
Length: 128
version text 3.0 The version string for this virtual machine.
Default rollup: lastvalue
Length: 12
Sample data: "vmx-03"
vmName text 1.0 This is the name that VMware uses for the virtual machine, and is the name that shows up in the VI Client.
Default rollup: lastvalue
Length: 60
Sample data: "gw2k13-OVOW"

[top]   Class VMStats (60 entries)
Name Type Since
nworks
Description
cpuAllocLimit number 3.0 The utilization of a virtual machine will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, MHz for CPU.
Default rollup: lastvalue
cpuAllocReservation number 3.0 Amount of resource that is guaranteed available to the virtual machine or resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB for memory, MHz for CPU.
Default rollup: lastvalue
cpuCount number 1.0 Number of virtual CPUs present in this virtual machine.
Default rollup: lastvalue
Sample data: "1"
cpuGuaranteedPct percent 3.0 Percentage of time in the last sample that is guaranteed for the virtual machine.
Default rollup: average
cpuLatency percent 5.7 Percent of time the VM is unable to run because it is contending for access to the physical
Default rollup: average
cpuReadyPct percent 2.2 Percentage of time during the last sample that the virtual machine CPU resources were in the ready state.
Default rollup: average
cpuShares number 1.0 The current number of CPU shares assigned to this virtual machine. The default allocation is "normal", which by default is 1000 shares per virtual CPU, i.e., 1000 shares for a uniprocessor VM, or 2000 shares for an SMP VM with 2 virtual CPUS.
Default rollup: lastvalue
Sample data: "2000"
cpuSwapWaitPct number 5.6 Percentage of the time during the last sample spent waiting for swap-in
Default rollup: summation
cpuSystemPct percent 3.0 Percentage of the time during the last sample spent on system processes.
Default rollup: summation
cpuUsageMhz gauge 3.0 CPU usage in MHz over the interval of collection.
Default rollup: average
cpuUsedPct percent 1.0 Percentage of the potential physical server's CPU time that this virtual machine was busy during the last interval. For example, consider an 8-core esx server w/ a single 2-core VM. If each core is rated at 3,000 Mhz and the VM consumes an average of 5,400 Mhz over the interval, then the cpuUsedPct would be 90% (since 6,000 is the maximum that a 2-core VM could consume).

Correspondly, 5,400 Mhz represents 23% of the ESX server's total capability of 24,000 Mhz. Refer to HostStats.cpuUsedPct for this server percentage.
Default rollup: average
cpuWaitPct percent 3.0 Percentage of time during the last sample that the virtual machine CPU resources were in the "wait" state. For example, on a physical server with 2 CPU threads, during a 300 second interval 600 seconds of CPU resources are available. If the VM was in a "wait" state for 60 seconds the cpuWaitPct would be 10%.
Default rollup: summation
diskMaxTotalLatency millisecond 5.7 Highest latency value across all disks used by the host
Default rollup: latest
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, the entityId will uniquely identify each virtual machine system on "bob.acme.com". EntityIds do not differentiate over time. That is, different intervals for a particular virtual machine will have the same entityId.
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
guestHeartbeat boolean 3.0 A boolean value indicating if a guest O/S heartbeat has been seen. If the guestHeartBeatStatus value is "green" or "yellow" then this metric will be "True". Red or gray status will cause a False value.
Default rollup: lastvalue
Sample data: "True"
guestHeartbeatStatus text 3.0 Monitoring for this status was deprecated in 5.5, as the value retrieved from the VI-API was shown to be unstable.
Default rollup: lastvalue
Length: 7
Sample data: "green"
guestHostName text 3.0 This is the name that the Guest OS knows the VM as. Generally, this is the name that is returned from the command line "hostname" when invoked from the Guest OS. This is only available if VMware Tools are installed and running on the virtual machine system.
Default rollup: lastvalue
Length: 60
Sample data: "gExchange.test.nworks.local"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
htSharing text 3.0 Specifies how the VCPUs of a virtual machine are allowed to share physical cores on a hyperthreaded system.
Default rollup: lastvalue
Length: 8
Sample data: "any"
idleSec timeDelta 1.0 The number of seconds that the CPU was idle for this virtual machine during the last interval. For esx 3.x systems, this value is in milliseconds.
Default rollup: summation
memoryActive gauge 1.0 Current amount of memory that is being "actively used" by this virtual machine (in KB).
Default rollup: average
memoryActivePct gauge 2.1 The current percentage of memoryActive vs. memoryMaximum for this virtual machine.
Default rollup: average
Sample data: "88"
memoryAllocLimit number 3.0 The utilization of a virtual machine pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, MHz for CPU.
Default rollup: lastvalue
memoryAllocReservation number 3.0 Amount of resource that is guaranteed available to the virtual machine or resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB for memory, MHz for CPU.
Default rollup: lastvalue
memoryCompressed number 5.6 Amount of memory (KB) stored in virtual machine's compression cache
Default rollup: average
memoryCompressionRate number 5.6 Rate of memory compression for the VM
Default rollup: average
memoryConfigMaximum number 3.0 The maximum amount of memory configured for this virtual machine (in KB).
Default rollup: lastvalue
memoryCtl gauge 1.0 The current memory in KB assigned to the balloon driver (also known as memory controller / mem_ctl).
Default rollup: average
memoryDecompressionRate number 5.6 Rate of memory decompression for the VM
Default rollup: average
memoryLatency percent 5.7 Percentage of time the VM is waitng to access swapped or compressed memory
Default rollup: average
memoryllSwapInRate kbps 5.7 Rate at which memory is being swapped from host cache into active memory
Default rollup: average
memoryllSwapOutRate kbps 5.7 Rate at which memory is being swapped from active memory to host cache
Default rollup: average
memoryMaximum gauge 1.0 The current maximum amount of memory assigned to this virtual machine (in KB). VMware refers to this as the "memory consumed" Currently, this is the same size as MemoryInfo.sizeMb. The amount of memory configured for use by the virtual machine OS running in the VM.
Default rollup: maximum
memoryMinimum gauge 1.0 The current minimum amount of memory assigned to this virtual machine (in KB). It is a guaranteed lower bound on the amount of memory that will be allocated to the VM, even when memory is overcommitted.
Default rollup: minimum
memoryOverhd gauge 1.0 The current memory overhead for this virtual machine (in KB). Overhead memory size is determined automatically; it is typically 54MB for a uniprocessor VM (with 1 virtual cpu) and 64MB for a multiprocessor VM (with 2 virtual cpus). This is the memory required by ESX Host to manage this VM, additional to the memory allocated for use by the VM/guestOS.
Default rollup: average
memoryShared gauge 1.0 The average amount of shared memory in KB for this virtual machine.
Default rollup: average
memoryShares number 1.0 The current number of memory shares assigned to this virtual machine.
Default rollup: lastvalue
Sample data: "0"
memorySwapin counter 5.5 Cumulative memory, in KB, swapped into memory for this VM since the last time the physical server was booted.
Default rollup: average
memorySwapout counter 5.5 Cumulative memory, in KB, swapped out to disk for this VM since the last time the physical server was booted.
Default rollup: average
memorySwapped gauge 1.0 The current memory swapped to disk for this virtual machine (in KB).
Default rollup: average
memorySwapRate gauge 5.5 The rate of bytes swapped in or out per second for this VM during the interval.
Default rollup: average
memoryZipped number 5.6 Total compressed physical memory (KB)
Default rollup: average
memoryZipSaved number 5.6 Memory (KB) saved due to memory zipping
Default rollup: average
overallStatus text 3.0 The overall alarm status of the virtual machine.
"green" - The entity is OK.
"red" - The entity definitely has a problem
"yellow" - The entity might have a problem.
"gray" - The status is unknown
Default rollup: lastvalue
Length: 7
Sample data: "green"
powerState text 3.0 The power state of the virtual machine.
"poweredOff" - The virtual machine is currently powered off.
"poweredOn" - The virtual machine is currently powered on.
"suspended" - The virtual machine is currently suspended.
If vmware tools are installed you might also look at guestState for more information.
Default rollup: lastvalue
Length: 10
Sample data: "poweredOn"
procAffinity text 1.0 The processors on the host that this virtual machine runs on such as "0,1,2,3". These numbers correspond to "CPU0", CPU1", etc. on the host. Specifies the initial processor affinity set for a VM. If set to all or the empty string (""), then the affinity set contains all available processors. The set may alternatively be a comma-separated list of CPU numbers such as "0,2,3". For an SMP VM, this affinity set will apply to all virtual CPUs.

Refer to VMware's Resource Management Guide for more information.
Default rollup: lastvalue
Length: 20
Sample data: "0,1,2,3"
sample time 1.0 The date/time of the end of the last interval. For ESX 3.0 or VC 2.0 targets, this is the target's local date/time.
Default rollup: lastvalue
Sample data: "632936028235115000"
sampleSecs timeDelta 1.0 The number of seconds in the last interval (should be ~300).
Default rollup: summation
Sample data: "300"
snapshotAge number 5.6 The age of the oldest snapshot
Default rollup: average
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
toolsActive boolean 1.0 The status of the virtual machine tools; "True" indicates active virtual machine tools.
Default rollup: lastvalue
Sample data: "True"
totalDiskIOPS number 5.5 Rolled up total IOPS (reads+ writes per second) for all vmhba storage connections in this Virtual Machine.
Default rollup: lastvalue
totalDiskKb number 5.5 Rolled up total traffic (in KB) for all vmhba storage connections in this Virtual Machine.
Default rollup: lastvalue
totalNetKb number 5.5 Rolled up total traffic (in KB) for all vNIC network connections in this Virtual Machine.
Default rollup: lastvalue
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
upTime timeElapsed 1.0 Amount of elapsed time, in seconds, since the virtual machine was booted.
Default rollup: lastvalue
usedSec timeDelta 1.0 The number of seconds, in the last interval, that the processor was in use for this virtual machine. For esx 3.x systems, this value is in milliseconds.
Default rollup: summation
uuId text 1.0 The Universal Unique ID of the virtual machine system. 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vmName text 1.0 This is the name that VMware uses for the virtual machine, and is the name that shows up in the VI Client.
Default rollup: lastvalue
Length: 60
Sample data: "gw2k13-OVOW"
vmState text 1.0 Operation mode of virtual machine operating system. One of:

"running" - Virtual machine is running normally.
"shuttingdown" - Virtual machine has a pending shutdown command.
"resetting" - Virtual machine has a pending reset command.
"standby" - Virtual machine has a pending standby command.
"notrunning" - Virtual machine is not running.
"unknown" - Virtual machine information is not available.

Default rollup: lastvalue
Length: 20
Sample data: "running"

[top]   Class VMDiskProperties (12 entries)
Name Type Since
nworks
Description
capacity gauge 3.0 The capacity in GB of this virtual disk.
Default rollup: average
Sample data: "4.17"
diskPath text 3.0 The name of the virtual disk in the guest operating system.
Default rollup: lastvalue
Length: 40
Sample data: "C:\"
entityId text 3.0 The entityId differentiates one entity being reported from another. For example, there is only one virtual machine disk vmhba1:0:3 on host "bob.acme.com", and the entityId will differentiate it from the virtual machine disks on other hosts. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId.
Default rollup: lastvalue
Length: 128
Sample data: "33363730-3037-4541-4a58-4d53475a3435:C:\"
freePct percent 3.0 The percentage of disk spaced still available on this virtual disk.
Default rollup: average
Sample data: "51"
freeSpace gauge 3.0 The amount of free space in KB (GB for nworks SPI) on this virtual disk.
Default rollup: average
Sample data: "2133794816"
guestHostName text 3.0 This is the name that the Guest OS knows the VM as. Generally, this is the name that is returned from the command line "hostname" when invoked from the Guest OS. This is only available if VMware Tools are installed and running on the virtual machine system.
Default rollup: lastvalue
Length: 60
Sample data: "gExchange.test.nworks.local"
hostName text 3.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
timestamp time 3.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 3.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
usedPct percent 3.0 The percentage of disk spaced consumed on this virtual disk.
Default rollup: average
Sample data: "49"
uuId text 3.0 The Universal Unique ID of the virtual machine system, such as "50247b82d67c1c31-4aebefb07192a5ed".
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vmName text 3.0 This is the name that VMware uses for the virtual machine, and is the name that shows up in the VI Client.
Default rollup: lastvalue
Length: 60
Sample data: "gCVS-48"

[top]   Class VMDiskStats (16 entries)
Name Type Since
nworks
Description
aborts delta 1.0 The number of aborted SCSI commands through this host vmhba storage connection for this Virtual Machine
Default rollup: summation
diskIOPS number 5.5 Disk IOPS (reads+ writes per second) through this host vmhba storage connection for this Virtual Machine..
Default rollup: summation
diskName text 1.0 A calculated name for the physical lun, like "gDisk0".
Default rollup: lastvalue
Length: 40
Sample data: "vmhba1:0:4"
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one virtual machine disk vmhba1:0:3 on host "bob.acme.com", and the entityId will differentiate it from the virtual machine disks on other hosts. EntityIds do not differentiate over time. That is, different intervals for host "bob.acme.com" will have the same entityId.
Default rollup: lastvalue
Length: 128
Sample data: "33363730-3037-4541-4a58-4d53475a3435:vmhba1:0:3"
guestHostName text 3.0 This is the name that the Guest OS knows the VM as. Generally, this is the name that is returned from the command line "hostname" when invoked from the Guest OS. This is only available if VMware Tools are installed and running on the virtual machine system.
Default rollup: lastvalue
Length: 60
Sample data: "gExchange.test.nworks.local"
hostDiskName text 1.0 The name of the host lun where the virtual disk resides. Multiple virtual disks may share this lun.
Default rollup: lastvalue
Length: 40
Sample data: "vmhba1:0:3"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
kbRead deltaKB 1.0 Kilobytes read through this host vmhba storage connection for this Virtual Machine.
Default rollup: average
kbWritten deltaKB 1.0 Kilobytes written through this host vmhba storage connection for this Virtual Machine
Default rollup: average
reads delta 1.0 The number of disk reads through this host vmhba storage connection for this Virtual Machine
Default rollup: summation
resets delta 1.0 The number of SCSI bus resets through this host vmhba storage connection for this Virtual Machine.
Default rollup: summation
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
uuId text 1.0 The Universal Unique ID of the virtual machine system, such as "50247b82d67c1c31-4aebefb07192a5ed".
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vmName text 1.0 This is the name that VMware uses for the virtual machine, and is the name that shows up in the VI Client.
Default rollup: lastvalue
Length: 60
Sample data: "gCVS-48"
writes delta 1.0 The number of disk writes through this host vmhba storage connection for this Virtual Machine
Default rollup: summation

[top]   Class VMNetStats (14 entries)
Name Type Since
nworks
Description
entityId text 2.0 The entityId differentiates one entity being reported from another. EntityIds do not differentiate over time. That is, different intervals for this NIC will have the same entityId.
Default rollup: lastvalue
Length: 60
Sample data: "33363730-3037-4541-4a58-4d53475a3435:00:50:56:a4:6f:5d"
guestHostName text 3.0 This is the name that the Guest OS knows the VM as. Generally, this is the name that is returned from the command line "hostname" when invoked from the Guest OS. This is only available if VMware Tools are installed and running on the virtual machine system.
Default rollup: lastvalue
Length: 60
Sample data: "gExchange.test.nworks.local"
hostName text 1.0 The hostname of the physical server (host).
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
ipAddress text 3.0 IP address assigned to this virtual machine NIC. This may be different than the guest's primary IP address if the virtual machine has multiple NICs. This field is only available if VMware Tools are installed and running on the virtual machine system.
Default rollup: lastvalue
Length: 128
Sample data: "15.1.1.18"
kbRx deltaKB 1.0 Kilobytes of traffic received by this network interface on this virtual machine in the last interval.
Default rollup: average
kbTx deltaKB 1.0 Kilobytes of traffic sent for this network interface on this virtual machine in the last sample period.
Default rollup: average
macAddress text 1.0 The MAC address of the vNIC for this virtual machine.
Default rollup: lastvalue
Length: 17
Sample data: "00:50:56:a4:6f:5d"
netName text 1.0 An assigned name to the virtual NIC ("NIC." + instance). This is ONLY available if VMware Tools are running in the virtual machine.
Default rollup: lastvalue
Length: 25
Sample data: "NIC.4000"
packetsRx delta 1.0 Network packets received by this network interface on this virtual machine in the last sample period.
Default rollup: summation
packetsTx delta 1.0 Network packets transmitted for this network interface on this virtual machine in the last sample period.
Default rollup: summation
timestamp time 2.0 This is the date/time in Ticks of the interval in which this class of data was collected. All metrics collected in this interval will have this same timestamp.
Default rollup: lastvalue
Sample data: "632936028235115000"
uniqueId number 2.0 Every class of data generated will have a unique ID. This ID is unique, even among the same or different classes of data.
Default rollup: lastvalue
Sample data: "53"
uuId text 1.0 The Universal Unique ID (uuId) of the virtual machine system.
Default rollup: lastvalue
Length: 40
Sample data: "33363730-3037-4541-4a58-4d53475a3435"
vmName text 1.0 This is the name that VMware uses for the virtual machine, and is the name that shows up in the VI Client.
Default rollup: lastvalue
Length: 60
Sample data: "gCVS-48"

[top]