nworks Metric Definitions July 22, 2008

(See also OpenView, and Types)
249 entries

[top]   Class VMHostCluster (21 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 VMHostStats.cpuUsedPct values were 50% and 60%, then this value would show 55%
Please note, this definition changed in 3.6.0. Prior to this release, the definition was the same as for ResourcePools.
Default rollup: average
Sample data: "58"
effectiveCpu gauge 3.0 Effective CPU resources (in MHz) 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: "6800"
effectiveMemory gauge 3.0 Effective memory resources (in KB) 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: "4929536"
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 value is the ratio of total VM memory for the cluster vs. total memory for all esx systems in the cluster and is expressed as a percentage. For example, if the sum of all the VMs memory requirements totaled 16GB and all esx servers had 20 GB installed, this value would be 80%. Any value below 100% means that the esx can find all the memory it needs and it has no overhead being used to find more memory.

However, if this value goes over 100%, then the esx server does not have enough memory to satisfy all VMs. This situation is referred to as "overcommitment". When this occurs the esx server must work to make memory available using swapping, balloon memory, shared pages, etc. The larger this number is, the more work the esx server must perform with non-productive tasks.

Another excellent reference about ESX memory is The Role of Memory in VMware ESX Server 3.
Default rollup: average
Sample data: "80"
memoryUsedPct percent 3.0 Percentage of the memory used vs. the memoryReservationCapacity of the root resource pool (i.e., the topmost resource pool representing the entire cluster). This value cannot exceed 100%.
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.
"gray" - The status is unknown
"green" - The Cluster is OK.
"red" - The Cluster definitely has a problem
"yellow" - The Cluster might have a problem.
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 MHz.
Default rollup: average
Sample data: "12896"
totalMemory gauge 3.0 Aggregated memory resources of all hosts, in bytes. Note, on some systems this value appears negative. VMware has corrected this in later versions of ESX 3.1 (PR #152948).
Default rollup: average
Sample data: "6375260160"
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"
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 VMResourcePool (24 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 reservation usage for the pool (in Mhz). This value corresponds to the "CPU Reservation Used" field in the "Resource Allocation" tab of the VI Client.
Default rollup: average
Sample data: "0"
cpuUsedPct percent 3.0 Percentage of the cpu consumed (i.e., cpuUsageMhz) vs. the cpuReservationCapacity of the pool. For the root pool (e.g., at the cluster level) this value cannot exceed 100%. But for expandable sub-pools this value may be greater than 100%.
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 memory (in MB) currently reserved out this resource pool. This value corresponds to "Memory Allocation Used" in the "Resource Allocation" tab of the VI Client.
Default rollup: average
Sample data: "194"
memoryUsedPct percent 3.0 Percentage of the memoryUsed used vs. the memoryReservationCapacity of the pool. For the root pool (e.g., at the cluster level) this value cannot exceed 100%. But for expandable sub-pools this value may be greater than 100%.
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 Virtual Center instance (i.e., two Virtual Centers 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"
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 VMHostProperties (24 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. VirtualCenter server provides additional features over single hosts.

Examples of values are:
* "VirtualCenter" - For a VirtualCenter instance.
* "HostAgent" - For host agent on an ESX Server or GSX Server host.
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" - VirtualCenter 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. VirtualCenter 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 cores on the host. Physical CPU cores are the processors contained by a CPU package.
Default rollup: lastvalue
Sample data: "4"
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 information.
Default rollup: lastvalue
Length: 60
Sample data: "VMware ESX Server 3.0.1 build-30353"
hostName text 1.0 The hostname of the physical server (host) as specified in the collector configuration.
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"
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.
Default rollup: lastvalue
Length: 8
Sample data: "3.0.1"

[top]   Class VMHostStats (37 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. 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
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 VMGuestStats.cpuUsageMhz for the guests running on this host. The Host's cpu capability is calculated as the VMHostProperties.cpuThreads * 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"
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"
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. This is only available if the host is connected.
Default rollup: average
cpuUsedPct percent 1.0 The percentage of the last interval (0-100%) that the physical server's CPU was busy. This value takes into account the total work (in Mhz) and the number of CPU cores.
See also VMGuestStats.cpuUsedPct.
Default rollup: average
Sample data: "58"
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"
hostName text 1.0 The hostname of the physical server (host) as specified in the collector configuration.
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"
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
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. This is memory used for the Virtual Machine frame buffer and other virtalization data structures maintained by the VMKernel.

Refer to VMware's Resource Management Guide on page 41 for more information.
Default rollup: average
memoryPressure percent 3.6 This value is the ratio of total VM memory vs. total esx memory and is expressed as a percentage. For example, if the sum of all the VMs memory requirements totaled 8GB and the esx server had 10GB installed, this value would be 80%. Any value below 100% means that the esx can find all the memory it needs and it has no overhead being used to find more memory.

However, if this value goes over 100%, then the esx server does not have enough memory to satisfy all VMs. This situation is referred to as "overcommitment". When this occurs the esx server must work to make memory available using swapping, balloon memory, shared pages, etc. The larger this number is, the more work the esx server must perform with non-productive tasks.

Another excellent reference about ESX memory is The Role of Memory in VMware ESX Server 3.
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 amount of memory, in KB, that has been allocated to virtual machines that is securely shared with other virtual machines. Many VMware ESX Server workloads present opportunities for sharing memory across virtual machines. VMware ESX can share common memory pages across VMs. This includes pages from VMs running the same virtual machine OS and applications. In such cases, VMware ESX Server uses a proprietary transparent page sharing technique to securely eliminate redundant copies of memory pages. With memory sharing a workload running as VMs often consumes less memory than when it was running on physical machines.

Refer to VMware's Resource Management Guide for more information.
Default rollup: average
memorySharedCommon gauge 1.0 The total amount of memory, in MB, that is required for a single copy of shared pages in running virtual machines.
Default rollup: average
memorySharedVM percent 1.0 The total amount of memory, in MB, for running virtual machines. This is the same value as the sum of memoryShared and memorySharedCommon.
Default rollup: average
memorySwapin gauge 1.0 Cumulative memory, in KB, swapped into memory since the last time the physical server was booted.
Default rollup: average
memorySwapout gauge 1.0 Cumulative memory, in KB, swapped out to disk since the last time the physical server was booted.
Default rollup: average
memorySwapped gauge 1.0 The sum of all swapped memory (in KB) for all virtual machines running on this host.

See VMGuestStats.memorySwapped.
Default rollup: average
memorySysHeapSize gauge 1.0 Amount of memory allocated, in KB, to the VMKernel heap file.
Default rollup: average
memoryTotalMem gauge 1.0 The total memory, in KB, on the physical server.
Default rollup: average
memoryUsageMb gauge 3.0 Physical memory usage on the host in MB. This is only available if the host is connected.
Default rollup: average
overallStatus text 3.0 The overall alarm status of the host.
"gray" - The status is unknown
"green" - The host is OK.
"red" - The entity definitely has a problem
"yellow" - The entity might have a problem.
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. That is, the sum of all the VMHostCPUStats.used values for this host.
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"
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 VMHostCPUStats (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 (host) as specified in the collector configuration.
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.
Default rollup: summation

[top]   Class VMHostDiskStats (13 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: average
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 by not assigned to any datastore. When this occurs, the datastore name is "(No datastore assigned)".
Default rollup: lastvalue
Length: 40
Sample data: "san2"
diskName text 1.0 The name of the lun 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) as specified in the collector configuration.
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
reads delta 1.0 Disk read operations for this disk on this host in the last interval.
Default rollup: average
resets delta 1.0 SCSI bus resets detected for this disk on this host in the last interval.
The guest systems use the SCSI protocol to communicate to disks, even over Fibre Channel to SAN Luns. SCSI Bus Resets are issued to release resources. These SCSI Bus Resets are in effect the SCSI subsystem timing out, commands being canceled, and retrying. This happens when the HBA device is overloaded, or its q-depth is exhausted. The first thing to know is which vmhba controller (C), target/path (T), and LUN (L) experienced these problems. The more VMs sharing a single Lun the more likely that resets will occur. Rule of thumb is no more than 10 VMs sharing a Lun.
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"
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: average

[top]   Class VMHostNetStats (11 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"
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) as specified in the collector configuration.
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: average
packetsTx delta 1.0 Packets transmitted by this host interface in 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"
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 VMHostDatastoreStats (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"
datastoreName text 3.0 The name of the host datastore. VMware refers to this as the datastore "Identification" in the VI Client.
Default rollup: lastvalue
Length: 40
Sample data: "san2"
diskFree gauge 1.0 Number of KBs 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"
diskSize gauge 1.0 Size in KB 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 used on the VMFS. That is, capacity minus freespace.
Default rollup: average
Sample data: "1219116"
entityId text 2.0 The entityId differentiates one entity being reported from another. For example, there is only one file sytem on host "bob.acme.com", and the entityId will differentiate it from all other virtual file systems, even those on different 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: "seattle.nworks.com:/dev/cciss/c0d0p2"
fileSystem text 1.0 The name of the file system for ESX 2 (COM API). URL of the Datastore for ESX 3/VC 2 (SDK).
Default rollup: lastvalue
Length: 128
Sample data: "/dev/cciss/c0d0p2 or /vmfs/volumes/44ad2837-46795afd-7496-0012799485e6"
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 physical server (host) as specified in the collector configuration.
Default rollup: lastvalue
Length: 60
Sample data: "seattle.nworks.com"
mountPoint text 1.0 The mount point on the Host of the VMFS.
Default rollup: lastvalue
Length: 128
Sample data: ""/vmfs/volumes/" & san1"
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 VMGuestStats (54 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"
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
cpuReadyPct percent 2.2 Percentage of time during the last sample that the virtual machine CPU resources were in the ready state. For example, on a physical server with 2 CPU threads and a 300 second interval, 600 seconds of CPU resources are available. If the VM was in a "ready" state for 60 seconds the cpuReadyPct would be 10%.
Default rollup: average
cpuShares number 1.0 The current number of CPU shares assigned to this virtual machine. Specifies the initial CPU share allocation for a VM to be n shares. The valid range of numeric values for nshares is 1 to 100000, enabling a large range of allocation ratios. The special named values low, normal, and high may also be used. These named values are converted into numbers automatically, using the configurable ESX Server options CpuSharesPerVcpuLow, CpuSharesPerVcpuNormal, and CpuSharesPerVcpuHigh, described below. 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.

Refer to VMware's Resource Management Guide for more information.
Default rollup: lastvalue
Sample data: "2000"
cpuSystemPct percent 3.0 Percentage of the time during the last sample spent on system processes.
Default rollup: average
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 VMHostStats.cpuUsedPct for this server percentage.
Default rollup: average
cpuVUsedPct percent 2.1 This value has been deprecated and should not be used. See VMGuestStats.cpuUsedPct instead.
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: average
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"
guestHeartbeat boolean 3.0 A boolean value indicating if a virtual machine 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 The virtual machine heartbeat. The heartbeat status is classified as:
* gray - VMware Tools are not installed or not running.
* red - No heartbeat. Virtual machine operating system may have stopped responding.
* yellow - Intermittent heartbeat. May be due to virtual machine load.
* green - virtual machine operating system is responding normally.
The virtual machine heartbeat is a statistics metric. Alarms can be configured on this metric to trigger emails or other actions.
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"
guestName 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"
guestOSFullName text 3.0 This is the full name of the virtual machine operating system for the virtual machine.
Default rollup: lastvalue
Length: 70
Sample data: "Microsoft Windows Server 2003, Standard Edition"
guestOSId text 3.0 Virtual machine 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"
guestState 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"
hostName text 1.0 The hostname of the physical server (host) as specified in the collector configuration.
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. Two VCPUs are "sharing" a core if they are both running on logical CPUs of the core at the same time. This value can be "any", "internal" or "none".

ANY - VCPUs may freely share cores at any time with any other VCPUs (default for all virtual machines on a hyperthreaded system).

INTERNAL - Similar to "none", in that VCPUs from this virtual machine will not be allowed to share cores with VCPUs from other virtual machines. However, other VCPUs from the same virtual machine will be allowed to share cores together. This configuration option is only permitted for SMP virtual machines. If applied to a uniprocessor virtual machine, it will be converted to the "none" sharing option.

NONE - VCPUs should not share cores with each other or with VCPUs from other virtual machines. That is, each VCPU from this virtual machine should always get a whole core to itself, with the other logical CPU on that core being placed into the "halted" state.
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
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: 15
Sample data: "15.1.1.18"
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. MemoryMaximum (aka, "consumed") takes into account the sharing of memory that is done between Virtual Machines, whereas memoryActive does not. Consequently, this percentage may rise above 100% if a lot of memory sharing is occuring.

Also, the VM can be using more memory than has been allocated to it. For example, consider a VM whose memory size is 1 GB and ESX has allocated it 256 MB. The VM, however, might be using 512 MB of the virtual machine memory actively. In this case, the percentage could be above 100% and the ESX will be swapping some of the VM's memory.

Another excellent reference about ESX memory is The Role of Memory in VMware ESX Server 3.
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
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 assigned to the balloon driver (in KB). VMware ESX Server employs two distinct techniques for dynamically expanding or contracting the amount of memory allocated to VMs - a VMware supplied balloon memory or vmmemctl module that is loaded into the virtual machine OS as part of the VMware Tools and swapping pages from a VM to a server swap file without any involvement by the virtual machine OS.

The preferred mechansim is the balloon memory driver, which cooperates with the server to reclaim those pages that are considered least valuable by the virtual machine operating system. This proprietary technique provides predictable performance that closely matches the behavior of a native system under similar memory constraints. It effectively increases or decreases memory pressure on the virtual machine OS, causing the virtual machine to invoke its own native memory management algorithms. When memory is tight, the virtual machine OS decides which particular pages to reclaim, and if neccessary, swaps them to its own virtual disk. The virtual machine OS must be configured with sufficient swap space. If necessary, the amount of memory reclaimed using the balloon memory driver can be limited via the sched.mem.maxmemctl configuration file option.
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. This maximum size must be specified in the configuration file for the VM.

See also memoryConfigMaximum.

Refer to VMware's Re