VirtualMachineQuickStats

VirtualMachineQuickStats
VirtualMachineQuickStats

A set of statistics that are typically updated with near real-time regularity.

This data object type does not support notification, for scalability reasons. Therefore, changes in QuickStats do not generate property collector updates. To monitor statistics values, use the statistics and alarms modules instead.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "overallCpuUsage": 0,
    "overallCpuDemand": 0,
    "overallCpuReadiness": 0,
    "guestMemoryUsage": 0,
    "hostMemoryUsage": 0,
    "guestHeartbeatStatus": "string",
    "distributedCpuEntitlement": 0,
    "distributedMemoryEntitlement": 0,
    "staticCpuEntitlement": 0,
    "staticMemoryEntitlement": 0,
    "grantedMemory": 0,
    "privateMemory": 0,
    "sharedMemory": 0,
    "swappedMemory": 0,
    "balloonedMemory": 0,
    "consumedOverheadMemory": 0,
    "ftLogBandwidth": 0,
    "ftSecondaryLatency": 0,
    "ftLatencyStatus": "string",
    "compressedMemory": 0,
    "uptimeSeconds": 0,
    "ssdSwappedMemory": 0,
    "activeMemory": 0,
    "memoryTierStats": [
        {
            "_typeName": "string",
            "memoryTierType": "string",
            "readBandwidth": 0
        }
    ]
}
integer As int32 As int32
overallCpuUsage
Optional

Basic CPU performance statistics, in MHz.

Valid while the virtual machine is running.

integer As int32 As int32
overallCpuDemand
Optional

Basic CPU performance statistics, in MHz.

Valid while the virtual machine is running.

integer As int32 As int32
overallCpuReadiness
Optional

Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.

Valid while the virtual machine is running.

integer As int32 As int32
guestMemoryUsage
Optional

Guest memory utilization statistics, in MB.

This is also known as active guest memory. The number can be between 0 and the configured memory size of the virtual machine. Valid while the virtual machine is running.

integer As int32 As int32
hostMemoryUsage
Optional

Host memory utilization statistics, in MB.

This is also known as consumed host memory. This is between 0 and the configured resource limit. Valid while the virtual machine is running. This includes the overhead memory of the VM.

guestHeartbeatStatus
Required

The Status enumeration defines a general "health" value for a managed entity.

Possible values:

  • gray: The status is unknown.
  • green: The entity is OK.
  • yellow: The entity might have a problem.
  • red: The entity definitely has a problem.
Possible values are : gray, green, yellow, red,
integer As int32 As int32
distributedCpuEntitlement
Optional

This is the amount of CPU resource, in MHz, that this VM is entitled to, as calculated by DRS.

Valid only for a VM managed by DRS.

integer As int32 As int32
distributedMemoryEntitlement
Optional

This is the amount of memory, in MB, that this VM is entitled to, as calculated by DRS.

Valid only for a VM managed by DRS.

integer As int32 As int32
staticCpuEntitlement
Optional

The static CPU resource entitlement for a virtual machine.

This value is calculated based on this virtual machine's resource reservations, shares and limit, and doesn't take into account current usage. This is the worst case CPU allocation for this virtual machine, that is, the amount of CPU resource this virtual machine would receive if all virtual machines running in the cluster went to maximum consumption. Units are MHz.

integer As int32 As int32
staticMemoryEntitlement
Optional

The static memory resource entitlement for a virtual machine.

This value is calculated based on this virtual machine's resource reservations, shares and limit, and doesn't take into account current usage. This is the worst case memory allocation for this virtual machine, that is, the amount of memory this virtual machine would receive if all virtual machines running in the cluster went to maximum consumption. Units are MB.

integer As int32 As int32
grantedMemory
Optional

Amount of host physical memory that is mapped for a virtual machine, in MB.

The number can be between 0 and the configured memory size of the virtual machine. Valid while the virtual machine is running.

integer As int32 As int32
privateMemory
Optional

The portion of memory, in MB, that is granted to this VM from non-shared host memory.

integer As int32 As int32
sharedMemory
Optional

The portion of memory, in MB, that is granted to this VM from host memory that is shared between VMs.

integer As int32 As int32
swappedMemory
Optional

The portion of memory, in MB, that is granted to this VM from the host's swap space.

This is a sign that there is memory pressure on the host.

integer As int32 As int32
balloonedMemory
Optional

The size of the balloon driver in the VM, in MB.

The host will inflate the balloon driver to reclaim physical memory from the VM. This is a sign that there is memory pressure on the host.

integer As int32 As int32
consumedOverheadMemory
Optional

The amount of consumed overhead memory, in MB, for this VM.

integer As int32 As int32
ftLogBandwidth
Optional

The network bandwidth used for logging between the primary and secondary fault tolerance VMs.

The unit is kilobytes per second.

integer As int32 As int32
ftSecondaryLatency
Optional

The amount of time in wallclock that the VCPU of the secondary fault tolerance VM is behind the VCPU of the primary VM.

The unit is millisecond.

ftLatencyStatus
Optional

The Status enumeration defines a general "health" value for a managed entity.

Possible values:

  • gray: The status is unknown.
  • green: The entity is OK.
  • yellow: The entity might have a problem.
  • red: The entity definitely has a problem.
Possible values are : gray, green, yellow, red,
integer As int64 As int64
compressedMemory
Optional

The amount of compressed memory currently consumed by VM, in Kb.

integer As int32 As int32
uptimeSeconds
Optional

The system uptime of the VM in seconds.

integer As int64 As int64
ssdSwappedMemory
Optional

The amount of memory swapped to fast disk device such as SSD, in KB.

integer As int32 As int32
activeMemory
Optional

The amount of memory that was recently touched by the VM, in MB.

Since: vSphere API Release 7.0.3.0

memoryTierStats
Optional

Stats for each physical memory tier.

A physical memory tier consists of one or more logical memory tiers of the same HostMemoryTierTypeEnum. For example, the logical tiers can be tier0 (DRAM), tier1 (DRAM), and tier2 (PMEM), while the physical tiers are just DRAM and PMEM.

Since: vSphere API Release 7.0.3.0