15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
4.9 KiB
vim.vm.Summary.QuickStats
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.
- extends
- Attributes:
-
overallCpuUsage (int, optional):
Basic CPU performance statistics, in MHz. Valid while the virtual machine is running.
overallCpuDemand (int, optional):
Basic CPU performance statistics, in MHz. Valid while the virtual machine is running.
guestMemoryUsage (int, 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.
hostMemoryUsage (int, 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 (vim.ManagedEntity.Status):
Guest operating system heartbeat metric. See guestHeartbeatStatus for a description.
distributedCpuEntitlement (int, 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.
distributedMemoryEntitlement (int, 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.
staticCpuEntitlement (int, 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.
staticMemoryEntitlement (int, 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.
privateMemory (int, optional):
The portion of memory, in MB, that is granted to this VM from non-shared host memory.
sharedMemory (int, optional):
The portion of memory, in MB, that is granted to this VM from host memory that is shared between VMs.
swappedMemory (int, 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.
balloonedMemory (int, 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.
consumedOverheadMemory (int, optional):
The amount of consumed overhead memory, in MB, for this VM.
ftLogBandwidth (int, optional):
The network bandwidth used for logging between the primary and secondary fault tolerance VMs. The unit is kilobytes per second.
ftSecondaryLatency (int, 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 (vim.ManagedEntity.Status, optional):
The latency status of the fault tolerance VM. ftLatencyStatus is determined by the value of ftSecondaryLatency. ftLatencyStatus is: green, if ftSecondaryLatency is less than or equal to 2 seconds; yellow, if ftSecondaryLatency is greater than 2 seconds, and less than or equal to 6 seconds; red, if ftSecondaryLatency is greater than 6 seconds; gray, if ftSecondaryLatency is unknown.
compressedMemory (long, optional):
The amount of compressed memory currently consumed by VM, in Kb.
uptimeSeconds (int, optional):
The system uptime of the VM in seconds.
ssdSwappedMemory (long, optional):
The amount of memory swapped to fast disk device such as SSD, in KB.