|
| Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| alternateGuestName | xsd:string |
Used as display name for the operating system if guestId is other
or other-64.
|
| annotation* | xsd:string |
Description for the virtual machine.
|
| bootOptions* | VirtualMachineBootOptions |
Configuration options for the boot behavior of the virtual machine.
Since VI API 2.5 |
| changeTrackingEnabled* | xsd:boolean |
Indicates whether changed block tracking for this VM's disks
is active.
Since vSphere API 4.0 |
| changeVersion | xsd:string |
The changeVersion is a unique identifier for a given version
of the configuration. Each change to the configuration
updates this value. This is typically implemented as an ever
increasing count or a time-stamp. However, a client should
always treat this as an opaque string.
|
| consolePreferences* | VirtualMachineConsolePreferences |
Legacy console viewer preferences when doing power operations.
|
| contentLibItemInfo* | VirtualMachineContentLibraryItemInfo |
Content Library Item info.
Since vSphere API 7.0 |
| cpuAffinity* | VirtualMachineAffinityInfo |
Affinity settings for CPU.
|
| cpuAllocation* | ResourceAllocationInfo |
Resource limits for CPU.
|
| cpuFeatureMask* | HostCpuIdInfo[] |
Specifies CPU feature compatibility masks that override the
defaults from the GuestOsDescriptor
of the virtual machine's guest OS.
As of vSphere API 6.5 FeatureMask
is the recommended method for masking virtual machines with
hardware version 9 and above (newer). They can be viewed via
featureMask.
|
| cpuHotAddEnabled* | xsd:boolean |
Whether virtual processors can be added while this
virtual machine is running.
Since vSphere API 4.0 |
| cpuHotRemoveEnabled* | xsd:boolean |
Whether virtual processors can be removed while this
virtual machine is running.
Since vSphere API 4.0 |
| createDate* | xsd:dateTime |
Time the virtual machine's configuration was created.
Since vSphere API 6.7 |
| datastoreUrl* | VirtualMachineConfigInfoDatastoreUrlPair[] |
Enumerates the set of datastores that this virtual machine is
stored on, as well as the URL identification for each of these.
Changes to datastores do not generate property updates on this
property. However, when this property is retrieved it returns the
current datastore information.
|
| defaultPowerOps | VirtualMachineDefaultPowerOpInfo |
Configuration of default power operations.
|
| deviceGroups* | VirtualMachineVirtualDeviceGroups |
Assignable hardware device groups.
Since 8.0.0.1 |
| deviceSwap* | VirtualMachineVirtualDeviceSwap |
Status of the device swap operation.
Since 8.0.0.1 |
| extraConfig* | OptionValue[] |
Additional configuration information for the virtual machine.
|
| files | VirtualMachineFileInfo |
Information about the files associated with a virtual machine.
This information does not include files for specific virtual disks or
snapshots.
|
| firmware* | xsd:string |
Information about firmware type for this Virtual Machine.
Possible values are described in
GuestOsDescriptorFirmwareType
When creating a new VM:
- If vim.vm.FlagInfo.vbsEnabled is set to true and
this property is set to bios, error is returned.
- If this property is unset and vim.vm.FlagInfo.vbsEnabled is set
to true, this property is set to efi.
Since vSphere API 5.0 |
| fixedPassthruHotPlugEnabled* | xsd:boolean |
Indicates whether support to add and remove fixed passthrough
devices when the VM is running is enabled.
When the virtual machine is powered on, this indicates if support for hot adding and removing fixed passthrough devices was enabled prior to power on. Otherwise, it indicates whether it will be enabled when the VM is powered on. NOTE: When setting this to true, the memory reservation should be equal to the guest memory size or the option to reserve all guest memory should be selected. If unset, the current value is left unchanged. Since 8.0.1.0 |
| flags | VirtualMachineFlagInfo |
Additional flags for a virtual machine.
|
| forkConfigInfo* | VirtualMachineForkConfigInfo |
Fork configuration of this virtual machines. If unset, this virtual machine
is not configured for fork. See VirtualMachineForkConfigInfo Since vSphere API 6.0 |
| ftEncryptionMode* | xsd:string |
An enum describing whether encrypted Fault Tolerance is required for this
VM. See VirtualMachineConfigSpecEncryptedFtModes for allowed values.
- This defaults to opportunistic for a regular VM, and will be set to
required for an encrypted VM.
- If this property is unset, the mode of encrypted Fault Tolerance
will be set to opportunistic.
Since vSphere API 7.0.2.0 |
| ftInfo* | FaultToleranceConfigInfo |
Fault Tolerance settings for this virtual machine.
Since vSphere API 4.0 |
| guestAutoLockEnabled* | xsd:boolean |
Indicates whether the guest operating system will logout any active
sessions whenever there are no remote display connections open to
the virtual machine.
Since vSphere API 5.0 |
| guestFullName | xsd:string | This is the full name of the guest operating system for the virtual machine. For example: Windows 2000 Professional. |
| guestId | xsd:string |
Guest operating system configured on a virtual machine.
This is a guest identifier that can be used to access the
GuestOsDescriptor
list for information about default configuration.
For more information on possible values, see
VirtualMachineGuestOsIdentifier.
|
| guestIntegrityInfo* | VirtualMachineGuestIntegrityInfo |
Guest integrity platform configuration
Since vSphere API 6.5 |
| guestMonitoringModeInfo* | VirtualMachineGuestMonitoringModeInfo |
GMM configuration
Since vSphere API 7.0 |
| hardware | VirtualHardware |
Processor, memory, and virtual devices for a virtual machine.
|
| hotPlugMemoryIncrementSize* | xsd:long |
Memory, in MB that can be added to a running virtual machine
must be in increments of this value and needs be a
multiple of this value.
This value is determined by the virtual machine and is specified
only if memoryHotAddEnabled
has been set to true.
Since vSphere API 4.0 |
| hotPlugMemoryLimit* | xsd:long |
The maximum amount of memory, in MB, than can be added to a
running virtual machine. This value is determined by the
virtual machine and is specified only if
memoryHotAddEnabled
is set to true.
Since vSphere API 4.0 |
| initialOverhead* | VirtualMachineConfigInfoOverheadInfo |
Set of values to be used only to perform admission control when
determining if a host has sufficient resources for the virtual
machine to power on.
Since vSphere API 5.0 |
| instanceUuid* | xsd:string |
VirtualCenter-specific 128-bit UUID of a virtual machine, represented
as a hexademical string. This identifier is used by VirtualCenter to
uniquely identify all virtual machine instances, including those that
may share the same SMBIOS UUID.
Since vSphere API 4.0 |
| keyId* | CryptoKeyId |
Virtual Machine cryptographic options.
Since vSphere API 6.5 |
| latencySensitivity* | LatencySensitivity |
The latency-sensitivity of the virtual machine.
Since vSphere API 5.1 |
| locationId* | xsd:string |
Hash incorporating the virtual machine's config file location
and the UUID of the host assigned to run the virtual machine.
|
| managedBy* | ManagedByInfo |
Specifies that this VM is managed by a VC Extension. See the
managedBy property in the ConfigSpec
for more details.
Since vSphere API 5.0 |
| maxMksConnections* | xsd:int |
Indicates the maximum number of active remote display connections
that the virtual machine will support.
Since vSphere API 5.0 |
| memoryAffinity* | VirtualMachineAffinityInfo |
Deprecated.
since vSphere 6.0.
Affinity settings for memory.
|
| memoryAllocation* | ResourceAllocationInfo |
Resource limits for memory.
|
| memoryHotAddEnabled* | xsd:boolean |
Whether memory can be added while this virtual machine is running.
Since vSphere API 4.0 |
| memoryReservationLockedToMax* | xsd:boolean |
If set true, memory resource reservation for this virtual machine will always be
equal to the virtual machine's memory size; increases in memory size will be
rejected when a corresponding reservation increase is not possible.
Since vSphere API 5.0 |
| messageBusTunnelEnabled* | xsd:boolean |
Whether to allow tunneling of clients from the guest VM into the
common message bus on the host network.
Since vSphere API 6.0 |
| migrateEncryption* | xsd:string |
An enum describing whether encrypted vMotion is required for this VM.
See VirtualMachineConfigSpecEncryptedVMotionModes for allowed values.
This defaults to opportunistic for a regular VM, and will be set to
required for an encrypted VM.
Since vSphere API 6.5 |
| modified | xsd:dateTime |
Last time a virtual machine's configuration was modified.
|
| name | xsd:string |
Display name of the virtual machine.
Any / (slash), \ (backslash), character used in this
name element is escaped. Similarly, any % (percent) character used in
this name element is escaped, unless it is used to start an escape
sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or
%5c, and a percent is escaped as %25.
|
| nestedHVEnabled* | xsd:boolean |
Indicates whether this VM is configured to use nested
hardware-assisted virtualization.
Since vSphere API 5.1 |
| networkShaper* | VirtualMachineNetworkShaperInfo |
Deprecated.
from vSphere 5.5, shaping policy on VM is not supported.
Resource limits for network.
|
| npivDesiredNodeWwns* | xsd:short |
The NPIV node WWNs to be extended from the original list of WWN nummbers. This
property should be set to desired number which is an aggregate of existing
plus new numbers. Desired Node WWNs should always be greater than the existing
number of node WWNs
Since vSphere API 4.0 |
| npivDesiredPortWwns* | xsd:short |
The NPIV port WWNs to be extended from the original list of WWN nummbers. This
property should be set to desired number which is an aggregate of existing
plus new numbers. Desired Node WWNs should always be greater than the existing
number of port WWNs
Since vSphere API 4.0 |
| npivNodeWorldWideName* | xsd:long[] |
A 64-bit node WWN (World Wide Name). These WWNs are paired with the
npivPortWorldWideName to be used by the NPIV VPORTs instantiated for the
virtual machine on the physical HBAs of the host. A pair of node and port WWNs
serves as a unique identifier in accessing a LUN, so that it can be monitored or
controlled by the storage administrator.
If this property contains a single node WWN, the same node WWN is used to pair with all port WWNs listed in npivPortWorldWideName. If this property or npivPortWorldWideName is empty or unset, NPIV WWN is disabled for the virtual machine. Since VI API 2.5 |
| npivOnNonRdmDisks* | xsd:boolean |
This property is used to check whether the NPIV can be enabled on the Virtual
machine with non-rdm disks in the configuration, so this is potentially not
enabling npiv on vmfs disks. Also this property is used to check whether RDM
is required to generate WWNs for a virtual machine.
Since vSphere API 4.0 |
| npivPortWorldWideName* | xsd:long[] |
A 64-bit port WWN (World Wide Name). For detail description on WWN, see
npivNodeWorldWideName.
Since VI API 2.5 |
| npivTemporaryDisabled* | xsd:boolean |
This property is used to enable or disable the NPIV capability on a desired
virtual machine on a temporary basis. When this property is set NPIV Vport
will not be instantiated by the VMX process of the Virtual Machine. When this
property is set port WWNs and node WWNs in the VM configuration are preserved.
Since vSphere API 4.0 |
| npivWorldWideNameType* | xsd:string |
The source that provides/generates the assigned WWNs.
|
| numaInfo* | VirtualMachineVirtualNumaInfo |
vNUMA info.
Since 8.0.0.1 |
| pmem* | VirtualMachineVirtualPMem |
Virtual persistent memory info.
Since vSphere API 7.0.3.0 |
| pmemFailoverEnabled* | xsd:boolean |
Property to indicate PMem HA failover configuration.
- When set to TRUE, VMs configured to use PMem
will be failed over to other hosts by HA, but the data
in NVDIMM is not persistent.
- When set to FALSE, VMs configured to use PMem will not
be failed over to other hosts by HA.
Property is currently only applicable to VMs with NVDimms and
will fail to set True if vPMem disks are present.
Since vSphere API 7.0.2.0 |
| rebootPowerOff* | xsd:boolean |
Whether the next reboot will result in a power off.
Since 8.0.0.1 |
| repConfig* | ReplicationConfigSpec |
vSphere Replication settings for this virtual machine.
Note this may become deprecated in the future releases. We discourage
any unnecessary dependency on this field.
Since vSphere API 6.0 |
| scheduledHardwareUpgradeInfo* | ScheduledHardwareUpgradeInfo |
Configuration of scheduled hardware upgrades and result from last
attempt to run scheduled hardware upgrade. See ScheduledHardwareUpgradeInfo Since vSphere API 5.1 |
| sevEnabled* | xsd:boolean |
SEV (Secure Encrypted Virtualization) enabled or not. SEV is enabled
when set to true, and disabled otherwise.
Since vSphere API 7.0.1.0 |
| sgxInfo* | VirtualMachineSgxInfo |
Configuration of SGX, Software Guard Extensions for the VM.
Since vSphere API 7.0 |
| swapPlacement* | xsd:string |
Virtual machine swapfile placement policy. This will be unset if the
virtual machine's
swapPlacementSupported
capability is false. If swapPlacementSupported is true, the default
policy is "inherit".
|
| swapStorageObjectId* | xsd:string |
Virtual Machine Swap Object Identifier.
With Object-based Storage systems, VM's Swap is backed by an object.
This identifier will be set only if VM swap resided on
object-based storage systems.
Since vSphere API 6.0 |
| template | xsd:boolean |
Flag indicating whether or not a virtual machine is a template.
|
| tools* | ToolsConfigInfo |
Configuration of VMware Tools running in the guest operating system.
|
| uuid | xsd:string |
128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string
in "12345678-abcd-1234-cdef-123456789abc" format.
|
| vAppConfig* | VmConfigInfo |
vApp meta-data for the virtual machine
Since vSphere API 4.0 |
| vAssertsEnabled* | xsd:boolean |
Indicates whether user-configured virtual asserts will be
triggered during virtual machine replay.
Since vSphere API 4.0 |
| vcpuConfig* | VirtualMachineVcpuConfig[] |
Vcpu configuration. The vcpuConfig array is indexed
by vcpu number.
Since vSphere API 7.0 |
| version | xsd:string |
The version string for this virtual machine.
|
| vFlashCacheReservation* | xsd:long |
Deprecated.
since vSphere 7.0 because vFlash Read Cache
end of availability.
Specifies the total vFlash resource reservation for the vFlash caches associated
with this VM's virtual disks, in bytes. This reservation must be allocated to power on the VM.
See vFlashCacheAllocation for allocated
reservation when VM is powered on.
Since vSphere API 5.5 |
| vmOpNotificationTimeout* | xsd:long |
Operation notification timeout in seconds.
- Specifies the maximum time the application can take to
prepare for the operation after its been notified. This value is used
only if vmOpNotificationToAppEnabled is set to TRUE.
- If vmOpNotificationTimeout is unset, then it defaults to
cluster/host timeout.
Since 8.0.0.1 |
| vmOpNotificationToAppEnabled* | xsd:boolean |
Indicates whether operation notification to applications is
enabled/disabled.
- When set to TRUE, application running inside the VM will be
notified of operations for which they have registered.
- If unset or FALSE, new applications are not allowed to register
for notifications and RPCs will no longer be supported from
already registered applications.
Since vSphere API 7.0.3.0 |
| vmStorageObjectId* | xsd:string |
Virtual Machine Object Identifier.
With Object-based Storage systems, Virtual Machine home directory
is backed by an object.
This identifier will be set only if VM directory resided on
object-based storage systems.
Since vSphere API 6.0 |
| vmxConfigChecksum* | xsd:base64Binary |
A checksum of vmx config file.
Since vSphere API 6.0 |
| vmxStatsCollectionEnabled* | xsd:boolean |
Indicates whether VMXStats Collection is enabled/disabled.
- If TRUE, VMXStats is enabled for the VM and a scoreboard
file is created to store stats for various VMX components.
- If FALSE, VMXStats is disabled for the VM and there is
no scoreboard file created.
Since 7.0.3.1 |
| vPMCEnabled* | xsd:boolean |
Indicates whether this VM have vurtual CPU performance counters
enabled.
Since vSphere API 5.1 |
| Properties inherited from DynamicData | ||
| None | ||
| Top of page | Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |