APIs vSAN Management API

vSAN Management API 8.0U3(Latest)

Search for vSAN Management API

Local Properties
Managed Object Types Data Object Types All Properties All Methods

Data Object - VirtualMachineConfigInfo(vim.vm.ConfigInfo)

Property of
VirtualMachine, VirtualMachineSnapshot

Parameter to
QueryMemoryOverheadEx

Extends
DynamicData

See also
CryptoKeyId, FaultToleranceConfigInfo, HostCpuIdInfo, LatencySensitivity, ManagedByInfo, OptionValue, ReplicationConfigSpec, ResourceAllocationInfo,
ScheduledHardwareUpgradeInfo, ToolsConfigInfo, VirtualHardware, VirtualMachineAffinityInfo, VirtualMachineBootOptions, VirtualMachineConfigInfoDatastoreUrlPair,
VirtualMachineConfigInfoOverheadInfo, VirtualMachineConsolePreferences, VirtualMachineContentLibraryItemInfo, VirtualMachineDefaultPowerOpInfo,
VirtualMachineFileInfo, VirtualMachineFlagInfo, VirtualMachineForkConfigInfo, VirtualMachineGuestIntegrityInfo, VirtualMachineGuestMonitoringModeInfo,
VirtualMachineNetworkShaperInfo, VirtualMachineSgxInfo, VirtualMachineVcpuConfig, VirtualMachineVirtualDeviceGroups, VirtualMachineVirtualDeviceSwap,
VirtualMachineVirtualNumaInfo, VirtualMachineVirtualPMem, VmConfigInfo

Since
2.0

Data Object Description

The ConfigInfo data object type encapsulates the configuration settings and virtual hardware for a virtual machine. This type holds all the information that is present in
the .vmx configuration file for the virtual machine.

Properties
Name Type Description

Used as display name for the operating system if guestId is {@code

other} or {@code other-64}.
alternateGuestName xsd:string
See guestFullName

Since VI API 2.5

annotation* xsd:string
Description for the virtual machine.

Configuration options for the boot behavior of the virtual machine.

bootOptions* VirtualMachineBootOptions
Since VI API 2.5

Indicates whether changed block tracking for this VM's disks is

changeTrackingEnabled* xsd:boolean active.

Since vSphere API Release 4.0

The changeVersion is a unique identifier for a given version of the

configuration. Each change to the configuration updates this value.
changeVersion xsd:string
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.

Content Library Item info.

contentLibItemInfo* VirtualMachineContentLibraryItemInfo
Since vSphere API Release 7.0

cpuAffinity* VirtualMachineAffinityInfo
Affinity settings for CPU.

cpuAllocation* ResourceAllocationInfo
Resource limits for CPU.
 Specifies CPU feature compatibility masks that override the defaults
from the GuestOsDescriptor of the virtual machine's guest OS. As of
cpuFeatureMask* HostCpuIdInfo[]
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.

Whether virtual processors can be added while this virtual machine is

cpuHotAddEnabled* xsd:boolean running.

Since VI API 2.5 U2

Whether virtual processors can be removed while this virtual

cpuHotRemoveEnabled* xsd:boolean machine is running.

Since VI API 2.5 U2

Time the virtual machine's configuration was created.

createDate* xsd:dateTime
Since vSphere API Release 6.7

Enumerates the set of datastores that this virtual machine is stored

on, as well as the URL identification for each of these.
datastoreUrl* VirtualMachineConfigInfoDatastoreUrlPair[] 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.

Assignable hardware device groups.

deviceGroups* VirtualMachineVirtualDeviceGroups
Since vSphere API Release 8.0.0.1

Status of the device swap operation.

deviceSwap* VirtualMachineVirtualDeviceSwap
Since vSphere API Release 8.0.0.1

extraConfig* OptionValue[]
Additional configuration information for the virtual machine.

Information about the files associated with a virtual machine. This

files VirtualMachineFileInfo
information does not include files for specific virtual disks or
snapshots.

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
firmware* xsd:string 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 Release 5.0

flags VirtualMachineFlagInfo
Additional flags for a virtual machine.

Fork configuration of this virtual machines. If unset, this virtual

machine is not configured for fork.
forkConfigInfo* VirtualMachineForkConfigInfo
See VirtualMachineForkConfigInfo

Since vSphere API Release 6.0

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
ftEncryptionMode* xsd:string
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 Release 7.0.2.0

Fault Tolerance settings for this virtual machine.

ftInfo* FaultToleranceConfigInfo
Since vSphere API Release 4.0

Indicates whether the guest operating system will logout any active
sessions whenever there are no remote display connections open to
guestAutoLockEnabled* xsd:boolean
the virtual machine.

Since vSphere API Release 5.0

 This is the full name of the guest operating system for the virtual
machine. For example: Windows 2000 Professional.
guestFullName xsd:string
See alternateGuestName

Guest operating system configured on a virtual machine. This is a

guestId xsd:string guest identifier that can be used to access the GuestOsDescriptor list
for information about default configuration. For more information on
possible values, see VirtualMachineGuestOsIdentifier.

Guest integrity platform configuration

guestIntegrityInfo* VirtualMachineGuestIntegrityInfo
Since vSphere API Release 6.5

GMM configuration
guestMonitoringModeInfo* VirtualMachineGuestMonitoringModeInfo
Since vSphere API Release 7.0

hardware VirtualHardware
Processor, memory, and virtual devices for a virtual machine.

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.
hotPlugMemoryIncrementSize* xsd:long This value is determined by the virtual machine and is specified only
if memoryHotAddEnabled has been set to true.

Since VI API 2.5 U2

The maximum amount of memory, in MB, than can be added to a

running virtual machine. This value is determined by the virtual
hotPlugMemoryLimit* xsd:long machine and is specified only if memoryHotAddEnabled is set to
true.

Since VI API 2.5 U2

Set of values to be used only to perform admission control when

determining if a host has sufficient resources for the virtual machine
initialOverhead* VirtualMachineConfigInfoOverheadInfo
to power on.

Since vSphere API Release 5.0

VirtualCenter-specific 128-bit UUID of a virtual machine, represented

as a hexademical string. This identifier is used by VirtualCenter to
instanceUuid* xsd:string uniquely identify all virtual machine instances, including those that
may share the same SMBIOS UUID.

Since vSphere API Release 4.0

Virtual Machine cryptographic options.

keyId* CryptoKeyId
Since vSphere API Release 6.5

The latency-sensitivity of the virtual machine.

latencySensitivity* LatencySensitivity
Since vSphere API Release 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.

Specifies that this VM is managed by a VC Extension. See the

managedBy* ManagedByInfo managedBy property in the ConfigSpec for more details.

Since vSphere API Release 5.0

Indicates the maximum number of active remote display connections

maxMksConnections* xsd:int that the virtual machine will support.

Since vSphere API Release 5.0

Deprecated. since vSphere 6.0.

memoryAffinity* VirtualMachineAffinityInfo
Affinity settings for memory.

memoryAllocation* ResourceAllocationInfo
Resource limits for memory.

Whether memory can be added while this virtual machine is running.

memoryHotAddEnabled* xsd:boolean
Since VI API 2.5 U2
 If set true, memory resource reservation for this virtual machine will
always be equal to the virtual machine's memory size; increases in
memoryReservationLockedToMax* xsd:boolean memory size will be rejected when a corresponding reservation
increase is not possible.

Since vSphere API Release 5.0

Whether to allow tunneling of clients from the guest VM into the

messageBusTunnelEnabled* xsd:boolean common message bus on the host network.

Since vSphere API Release 6.0

An enum describing whether encrypted vMotion is required for this

VM. See VirtualMachineConfigSpecEncryptedVMotionModes for
migrateEncryption* xsd:string allowed values. This defaults to opportunistic for a regular VM, and
will be set to required for an encrypted VM.

Since vSphere API Release 6.5

modified xsd:dateTime
Last time a virtual machine's configuration was modified.

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
name xsd:string
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.

Indicates whether this VM is configured to use nested hardware-

nestedHVEnabled* xsd:boolean assisted virtualization.

Since vSphere API Release 5.1

Deprecated. from vSphere 5.5, shaping policy on VM is not

networkShaper* VirtualMachineNetworkShaperInfo supported.

Resource limits for network.

The NPIV node WWNs to be extended from the original list of WWN
nummbers. This property should be set to desired number which is
npivDesiredNodeWwns* xsd:short an aggregate of existing plus new numbers. Desired Node WWNs
should always be greater than the existing number of node WWNs

Since vSphere API Release 4.0

The NPIV port WWNs to be extended from the original list of WWN
nummbers. This property should be set to desired number which is
npivDesiredPortWwns* xsd:short an aggregate of existing plus new numbers. Desired Node WWNs
should always be greater than the existing number of port WWNs

Since vSphere API Release 4.0

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
npivNodeWorldWideName* xsd:long[] 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

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
npivOnNonRdmDisks* xsd:boolean
to check whether RDM is required to generate WWNs for a virtual
machine.

Since vSphere API Release 4.0

A 64-bit port WWN (World Wide Name). For detail description on

npivPortWorldWideName* xsd:long[] WWN, see npivNodeWorldWideName.

Since VI API 2.5

 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
npivTemporaryDisabled* xsd:boolean
Virtual Machine. When this property is set port WWNs and node
WWNs in the VM configuration are preserved.

Since vSphere API Release 4.0

The source that provides/generates the assigned WWNs.

npivWorldWideNameType* xsd:string
See VirtualMachineConfigInfoNpivWwnType

Since VI API 2.5

vNUMA info.
numaInfo* VirtualMachineVirtualNumaInfo
Since vSphere API Release 8.0.0.1

Virtual persistent memory info.

pmem* VirtualMachineVirtualPMem
Since vSphere API Release 7.0.3.0

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
pmemFailoverEnabled* xsd:boolean 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 Release 7.0.2.0

Whether the next reboot will result in a power off.

rebootPowerOff* xsd:boolean
Since vSphere API Release 8.0.0.1

vSphere Replication settings for this virtual machine. Note this may
become deprecated in the future releases. We discourage any
repConfig* ReplicationConfigSpec
unnecessary dependency on this field.

Since vSphere API Release 6.0

Configuration of scheduled hardware upgrades and result from last

attempt to run scheduled hardware upgrade.
scheduledHardwareUpgradeInfo* ScheduledHardwareUpgradeInfo
See ScheduledHardwareUpgradeInfo

Since vSphere API Release 5.1

SEV (Secure Encrypted Virtualization) enabled or not. SEV is

sevEnabled* xsd:boolean enabled when set to true, and disabled otherwise.

Since vSphere API Release 7.0.1.0

Configuration of SGX, Software Guard Extensions for the VM.

sgxInfo* VirtualMachineSgxInfo
Since vSphere API Release 7.0

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".
swapPlacement* xsd:string

See VirtualMachineConfigInfoSwapPlacementType

Since VI API 2.5

Virtual Machine Swap Object Identifier. With Object-based Storage

systems, VM's Swap is backed by an object. This identifier will be set
swapStorageObjectId* xsd:string
only if VM swap resided on object-based storage systems.

Since vSphere API Release 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.

128-bit SMBIOS UUID of a virtual machine represented as a

uuid xsd:string
hexadecimal string in "12345678-abcd-1234-cdef-123456789abc"
format.
 vApp meta-data for the virtual machine
vAppConfig* VmConfigInfo
Since vSphere API Release 4.0

Indicates whether user-configured virtual asserts will be triggered

vAssertsEnabled* xsd:boolean during virtual machine replay.

Since vSphere API Release 4.0

Vcpu configuration. The vcpuConfig array is indexed by vcpu number.

vcpuConfig* VirtualMachineVcpuConfig[]
Since vSphere API Release 7.0

version xsd:string
The version string for this virtual machine.

Deprecated. since vSphere 7.0 because vFlash Read Cache end

of availability.

Specifies the total vFlash resource reservation for the vFlash caches
vFlashCacheReservation* xsd:long
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 Release 5.5

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
vmOpNotificationTimeout* xsd:long vmOpNotificationToAppEnabled is set to TRUE. - If
vmOpNotificationTimeout is unset, then it defaults to cluster/host
timeout.

Since vSphere API Release 8.0.0.1

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
vmOpNotificationToAppEnabled* xsd:boolean FALSE, new applications are not allowed to register for notifications
and RPCs will no longer be supported from already registered
applications.

Since vSphere API Release 7.0.3.0

Virtual Machine Object Identifier. With Object-based Storage

systems, Virtual Machine home directory is backed by an object. This
vmStorageObjectId* xsd:string identifier will be set only if VM directory resided on object-based
storage systems.

Since vSphere API Release 6.0

A checksum of vmx config file.

vmxConfigChecksum* xsd:base64Binary
Since vSphere API Release 6.0

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,
vmxStatsCollectionEnabled* xsd:boolean
VMXStats is disabled for the VM and there is no scoreboard file
created.

Since vSphere API Release 7.0.3.1

Indicates whether this VM have vurtual CPU performance counters

vPMCEnabled* xsd:boolean enabled.

Since vSphere API Release 5.1

Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition
 <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VirtualMachineConfigInfo">
<complexContent>
<extension base="vsan:DynamicData">
<sequence>
<element name="changeVersion" type="xsd:string"/>
<element name="modified" type="xsd:dateTime"/>
<element name="name" type="xsd:string"/>
<element name="guestFullName" type="xsd:string"/>
<element name="version" type="xsd:string"/>
<element name="uuid" type="xsd:string"/>

Top of page Local Properties

Managed Object Types Data Object Types All Properties All Methods

Products

Solutions

Support and Services

Company

How To Buy

Copyright © 2005-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

Accessibility Privacy Site Map Supplier Responsibility Terms of Use