|
| Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| bootTime* | xsd:dateTime |
The timestamp when the virtual machine was most recently powered on.
This property is updated when the virtual machine is powered on
from the poweredOff state, and is cleared when the virtual machine is
powered off. This property is not updated when a virtual machine is resumed
from a suspended state.
|
| cleanPowerOff* | xsd:boolean |
For a powered off virtual machine, indicates whether the virtual
machine's last shutdown was an orderly power off or not. Unset if
the virtual machine is running or suspended.
Since vSphere API 4.0 |
| connectionState | VirtualMachineConnectionState |
Indicates whether or not the virtual machine is available for management.
|
| consolidationNeeded | xsd:boolean |
Whether any disk of the virtual machine requires consolidation.
This can happen for example when a snapshot is deleted but its
associated disk is not committed back to the base disk.
Use ConsolidateVMDisks_Task to consolidate if
needed.
Since vSphere API 5.0 |
| cryptoState* | xsd:string |
Encryption state of the virtual machine. Valid values are enumerated by the
CryptoState type.
Since vSphere API 6.7 |
| dasVmProtection* | VirtualMachineRuntimeInfoDasProtectionState |
The vSphere HA protection state for a virtual machine. Property
is unset if vSphere HA is not enabled.
Since vSphere API 5.0 |
| device* | VirtualMachineDeviceRuntimeInfo[] |
Per-device runtime info. This array will be empty if the host
software does not provide runtime info for any of the device
types currently in use by the virtual machine.
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter.
Since this property is on a DataObject, an update returned by WaitForUpdatesEx may
contain values for this property when some other property on the DataObject changes.
If this update is a result of a call to WaitForUpdatesEx with a non-empty
version parameter, the value for this property may not be current.
Since vSphere API 4.1 |
| faultToleranceState | VirtualMachineFaultToleranceState |
The fault tolerance state of the virtual machine.
Since vSphere API 4.0 |
| featureMask* | HostFeatureMask[] |
The masks applied to an individual virtual machine as a result of its
configuration.
Since vSphere API 5.1 |
| featureRequirement* | VirtualMachineFeatureRequirement[] |
These requirements must have equivalent host capabilities
featureCapability in order to power on,
resume, or migrate to the host.
Since vSphere API 5.1 |
| host* | ManagedObjectReference
to a HostSystem |
The host that is responsible for running a virtual machine.
This property is null if the virtual machine is not running and is
not assigned to run on a particular host.
|
| instantCloneFrozen* | xsd:boolean |
Whether the virtual machine is frozen for instant clone, or not.
Since vSphere API 6.7 |
| maxCpuUsage* | xsd:int |
Current upper-bound on CPU usage. The upper-bound is based on the host
the virtual machine is current running on, as well as limits configured
on the virtual machine itself or any parent resource pool.
Valid while the virtual machine is running.
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter.
Since this property is on a DataObject, an update returned by WaitForUpdatesEx may
contain values for this property when some other property on the DataObject changes.
If this update is a result of a call to WaitForUpdatesEx with a non-empty
version parameter, the value for this property may not be current.
|
| maxMemoryUsage* | xsd:int |
Current upper-bound on memory usage. The upper-bound is based on memory
configuration of the virtual machine, as well as limits configured
on the virtual machine itself or any parent resource pool.
Valid while the virtual machine is running.
In releases after vSphere API 5.0, vSphere Servers might not
generate property collector update notifications for this property.
To obtain the latest value of the property, you can use
PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.
If you use the PropertyCollector.WaitForUpdatesEx method, specify
an empty string for the version parameter.
Since this property is on a DataObject, an update returned by WaitForUpdatesEx may
contain values for this property when some other property on the DataObject changes.
If this update is a result of a call to WaitForUpdatesEx with a non-empty
version parameter, the value for this property may not be current.
|
| memoryOverhead* | xsd:long | Deprecated.
As of vSphere API 4.1, use the PerformanceManager
memory overhead counter to get this value.
The amount of memory resource (in bytes) that will be used by
the virtual machine above its guest memory requirements.
This value is set if and only if the 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. |
| minRequiredEVCModeKey* | xsd:string |
For a powered-on or suspended virtual machine in a cluster with Enhanced
VMotion Compatibility (EVC) enabled, this identifies the least-featured
EVC mode (among those for the appropriate CPU vendor) that could admit
the virtual machine. See EVCMode. Until vSphere 6.5, this
property will be unset if the virtual machine is powered off or is not in
an EVC cluster.
This property may be used as a general indicator of the CPU feature baseline currently in use by the virtual machine. However, the virtual machine may be suppressing some of the features present in the CPU feature baseline of the indicated mode, either explicitly (in the virtual machine's configured cpuFeatureMask) or implicitly (in the default masks for the GuestOsDescriptor appropriate for the virtual machine's configured guest OS). Since vSphere API 4.1 |
| needSecondaryReason* | xsd:string |
If set, indicates the reason the virtual machine needs a secondary.
Since vSphere API 4.0 |
| numMksConnections | xsd:int |
Number of active MKS connections to this virtual machine.
|
| offlineFeatureRequirement* | VirtualMachineFeatureRequirement[] |
These requirements must have equivalent host capabilities
featureCapability in order to power on.
Since vSphere API 5.1 |
| onlineStandby | xsd:boolean |
This property indicates whether the guest has gone into one of the
s1, s2 or s3 standby modes, false indicates the guest is awake.
Since vSphere API 5.1 |
| paused* | xsd:boolean |
Whether the virtual machine is paused, or not.
Since vSphere API 6.0 |
| powerState | VirtualMachinePowerState |
The current power state of the virtual machine.
|
| question* | VirtualMachineQuestionInfo |
The current question, if any, that is blocking the virtual machine's execution.
|
| quiescedForkParent* | xsd:boolean |
This flag indicates whether a parent virtual machine is in a fork ready
state. A persistent instant clone child can be created only when this flag
is true. While a non-persistent instant clone child can be created
independent of this flag, it can only be powered on if this flag is true.
Since vSphere API 6.0 |
| recordReplayState | VirtualMachineRecordReplayState | Deprecated.
as of vSphere API 6.0
Record / replay state of this virtual machine.
Since vSphere API 4.0 |
| snapshotInBackground* | xsd:boolean |
Whether a snapshot operation is in progress in the background, or not.
Since vSphere API 6.0 |
| suspendedToMemory* | xsd:boolean |
Whether the virtual machine is suspended to memory, or not.
Since vSphere API 7.0.2.0 |
| suspendInterval* | xsd:long |
The total time the virtual machine has been suspended
since it was initially powered on. This time excludes the current period,
if the virtual machine is currently suspended. This property is updated
when the virtual machine resumes, and is reset to zero when the virtual machine
is powered off.
|
| suspendTime* | xsd:dateTime |
The timestamp when the virtual machine was most recently suspended.
This property is updated every time the virtual machine is suspended.
|
| toolsInstallerMounted | xsd:boolean |
Flag to indicate whether or not the VMware Tools installer
is mounted as a CD-ROM.
|
| vFlashCacheAllocation* | xsd:long | Deprecated.
since vSphere 7.0 because vFlash Read Cache
end of availability.
Specifies the total allocated vFlash resource for the vFlash caches associated with VM's
VMDKs when VM is powered on, in bytes.
Since vSphere API 5.5 |
| vmFailoverInProgress* | xsd:boolean |
Represents if the vm is currently being failed over by FDM
Since vSphere API 7.0.2.0 |
| Properties inherited from DynamicData | ||
| None | ||
| Top of page | Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |