ResourcePoolQuickStats

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

These statistics are aggregates of the corresponding statistics of all virtual machines in the given resource pool, and unless otherwise noted, only make sense when at least one virtual machine in the given resource pool is powered on. 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:

DataObject

JSON Example

{
    "_typeName": "string",
    "overallCpuUsage": 0,
    "overallCpuDemand": 0,
    "guestMemoryUsage": 0,
    "hostMemoryUsage": 0,
    "distributedCpuEntitlement": 0,
    "distributedMemoryEntitlement": 0,
    "staticCpuEntitlement": 0,
    "staticMemoryEntitlement": 0,
    "privateMemory": 0,
    "sharedMemory": 0,
    "swappedMemory": 0,
    "balloonedMemory": 0,
    "overheadMemory": 0,
    "consumedOverheadMemory": 0,
    "compressedMemory": 0
}

integer As int64 As int64

overallCpuUsage

Optional

Basic CPU performance statistics, in MHz.

integer As int64 As int64

overallCpuDemand

Optional

Basic CPU performance statistics, in MHz.

integer As int64 As int64

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 a virtual machine.

integer As int64 As int64

hostMemoryUsage

Optional

Host memory utilization statistics, in MB.

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

integer As int64 As int64

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 int64 As int64

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 int64 As int64

privateMemory

Optional

The portion of memory, in MB, that is granted to a virtual machine from non-shared host memory.

integer As int64 As int64

sharedMemory

Optional

The portion of memory, in MB, that is granted to a virtual machine from host memory that is shared between VMs.

integer As int64 As int64

swappedMemory

Optional

The portion of memory, in MB, that is granted to a virtual machine from the host's swap space.

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

integer As int64 As int64

balloonedMemory

Optional

The size of the balloon driver in a virtual machine, in MB.

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

integer As int64 As int64

overheadMemory

Optional

The amount of memory resource (in MB) that will be used by a virtual machine above its guest memory requirements.

This value is set if and only if a virtual machine is registered on a host that supports memory resource allocation features. For powered off VMs, this is the minimum overhead required to power on the VM on the registered host. For powered on VMs, this is the current overhead reservation, a value which is almost always larger than the minimum overhead, and which grows with time.