Scripting Object - VcVirtualMachineConfigSpec

Attribute of
VcPlacementSpec, VcStoragePlacementSpec, VcVirtualMachineCloneSpec, VcVirtualMachineImportSpec, VcVmBeingCreatedEvent, VcVmReconfiguredEvent
Parameter to
createChildVM_Task, createChildVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, createVM_Task, lLPMReconfigVM_Task, lowLevelCreateVm_Task, reconfigVM_Task

Scripting Object Description

This data object type encapsulates configuration settings when creating or reconfiguring a virtual machine. To support incremental changes, these properties are all optional. If an optional property is unset, or any nested optional property is unset, the property will not be changed unless 'unset' is a valid value for the property. To determine whether 'unset' is a valid value for a particular property, refer to the documentation for that property.

Attributes

Name Type Description
alternateGuestNameString

Full name for guest, if guestId is specified as other or other-64.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

annotationString

User-provided description of the virtual machine. Because this property is optional in the virtual machine configuration, it is necessary to pass an explicit empty string in a ConfigSpec object to remove an annotation that is already present in the {@link vim.vm.ConfigInfo} for a virtual machine.

Reconfigure privilege: VirtualMachine.Config.Rename @since VI API 2.5

bootOptionsVcVirtualMachineBootOptions

Settings that control the boot behavior of the virtual machine. These settings take effect during the next power-on of the virtual machine.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

changeTrackingEnabledBoolean

Setting to control enabling/disabling changed block tracking for the virtual disks of this VM. This may only be set if the {@link vim.vm.Capability#changeTrackingSupported changeTrackingSupported} capability is true for this virtual machine. Any change to this property will take effect the next time the virtual machine powers on, resumes from a suspended state, performs a snapshot create/delete/revert operation or migrates while powered on.

Reconfigure privilege: VirtualMachine.Config.ChangeTracking (also required when setting this property while creating a virtual machine) @since vSphere API 4.0

changeVersionString

If specified, the changes are only applied if the current changeVersion matches the specified changeVersion. This field can be used to guard against updates that have happened between when configInfo is read and when it is applied.

For more information about how configurations are uniquely identified, see {@link vim.vm.ConfigInfo#changeVersion}. @since VI API 2.5

consolePreferencesVcVirtualMachineConsolePreferences

Legacy console viewer preferences that are used with power operations. For example, power on.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

cpuAffinityVcVirtualMachineAffinityInfo

Affinity settings for CPU.

Reconfigure privilege: VirtualMachine.Config.Resource @since VI API 2.5

cpuAllocationVcResourceAllocationInfo

Resource limits for CPU.

Reconfigure privilege: VirtualMachine.Config.Resource @since VI API 2.5

cpuFeatureMaskVcVirtualMachineCpuIdInfoSpec []

Specifies the CPU feature compatibility masks.

Reconfigure privilege: VirtualMachine.Config.Settings As of vSphere API 6.5 {@link vim.host.FeatureMask FeatureMask} is the recommended method for masking virtual machines with hardware version 9 and above (newer). @since VI API 2.5

cpuHotAddEnabledBoolean

Indicates whether or not virtual processors can be added to the virtual machine while it is running. This attribute can only be set when the virtual machine is powered-off.

Reconfigure privilege: VirtualMachine.Config.CpuCount @since vSphere API 4.0

cpuHotRemoveEnabledBoolean

Indicates whether or not virtual processors can be removed from the virtual machine while it is running. This attribute can only be set when the virtual machine is powered-off.

Reconfigure privilege: VirtualMachine.Config.CpuCount @since vSphere API 4.0

cryptoVcCryptoSpec

Virtual Machine cryptographic options. The cryptographic options are inherited to all disks of the VM. The cryptographic options for a disk can be different by setting its CryptoSpec. @since vSphere API 6.5
deviceChangeVcVirtualDeviceConfigSpec []

Set of virtual devices being modified by the configuration operation.

Reconfigure privileges:

  • VirtualMachine.Config.Resource if setting the "shares" property of a new or existing VirtualDisk device
  • VirtualMachine.Config.RawDevice if adding, removing, or modifying a raw device (also required when creating a virtual machine)
  • VirtualMachine.Config.HostUSBDevice if adding, removing, or modifying a VirtualUSB device backed by a host USB device (also required when creating a virtual machine).
  • VirtualMachine.Interact.DeviceConnection if setting the "connectable" property of a connectable device
  • VirtualMachine.Interact.SetCDMedia if setting the "backing" property of a VirtualCdrom device
  • VirtualMachine.Interact.SetFloppyMedia if setting the "backing" property of a VirtualFloppy device
  • VirtualMachine.Config.EditDevice if setting any property of a non-CDROM non-Floppy device
  • VirtualMachine.Config.AddExistingDisk if adding a VirtualDisk, and the fileOperation is unset (also required when creating a virtual machine)
  • VirtualMachine.Config.AddNewDisk if adding a VirtualDisk and the fileOperation is set (also required when creating a virtual machine)
  • VirtualMachine.Config.RemoveDisk if removing a VirtualDisk device
  • VirtualMachine.Config.AddRemoveDevice if adding or removing any device other than disk, raw, or USB device.
  • Network.Assign if if setting the "backing" property of a VirtualEthernetCard device.
@since VI API 2.5
dynamicPropertyVcDynamicProperty []

@since Unknown
dynamicTypeString

@since Unknown
extraConfigVcOptionValue []

Additional configuration information for the virtual machine. This describes a set of modifications to the additional options. If the key is already present, it will be reset with the new value provided. Otherwise, a new option is added. Keys with empty values will be removed.

Configuration keys that would conflict with parameters that are explicitly configurable through other fields in the ConfigSpec object are silently ignored.

Reconfigure privilege: VirtualMachine.Config.AdvancedConfig (also required when setting this property while creating a virtual machine) @since VI API 2.5

filesVcVirtualMachineFileInfo

Information about virtual machine files.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

firmwareString

Set the desired firmware type for this Virtual Machine. Possible values are described in {@link vim.vm.GuestOsDescriptor.FirmwareType} @since vSphere API 5.0
flagsVcVirtualMachineFlagInfo

Additional flags for a virtual machine.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

ftInfoVcFaultToleranceConfigInfo

Fault Tolerance settings for this virtual machine. @since vSphere API 4.0
guestAutoLockEnabledBoolean

If set to True, this causes the guest operating system to automatically logout any active sessions whenever there are no remote display connections open to the virtual machine.

Reconfigure privilege: VirtualMachine.Config.MksControl @since vSphere API 5.0

guestIdString

Short guest operating system identifier.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

instanceUuidString

VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexadecimal string. This identifier is used by VirtalCenter to uniquely identify all virtual machine instances in the Virtual Infrastructure environment, including those that may share the same SMBIOS UUID.

Normally, this property is not set by a client, allowing the Virtual Infrastructure environment to assign or change it when VirtualCenter detects an identifier conflict between virtual machines. This identifier can be modified even when a virtual machine is powered on. Clients can specify that vCenter Server reassign a new identifier by a providing an empty string. Reassigning the identifer is not allowed for Fault Tolerance virtual machines.

Reconfigure privilege: VirtualMachine.Config.Settings @since vSphere API 4.0

latencySensitivityVcLatencySensitivity

The latency-sensitivity setting of the virtual machine.

Reconfigure privilege: VirtualMachine.Config.Resource @since vSphere API 5.1

locationIdString

128-bit hash based on the virtual machine's configuration file location and the UUID of the host assigned to run the virtual machine.

Normally, this property is not set by a client, allowing the Virtual Infrastructure environment to assign a location ID when the virtual machine is created. However, if the virtual machine's configuration file has been manually moved, it may be desirable to clear this property, setting it to an empty string, so the property is regenerated.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

managedByVcManagedByInfo

Specifies that this VM is managed by a VC Extension.

This information is primarily used in the Client to show a custom icon for managed virtual machines, and a description of the function of the virtual machine. If no extension can be found with the extension key in the {@link vim.ext.ManagedByInfo managedBy} object, or the type is not found in the {@link vim.Extension#managedEntityInfo managedEntityInfo} list of the extension, the default virtual machine icon is used, and no description is shown. To unset this field pass a {@link vim.ext.ManagedByInfo} object with an empty {@link vim.ext.ManagedByInfo#extensionKey extensionKey}.

Reconfigure privilege: VirtualMachine.Config.ManagedBy @since vSphere API 5.0

maxMksConnectionsNumber

If set, this setting limits the maximum number of active remote display connections that the virtual machine will support to the specified value.

Reconfigure privilege: VirtualMachine.Config.MksControl @since vSphere API 5.0

memoryAffinityVcVirtualMachineAffinityInfoDeprecated.

Affinity settings for memory.

Reconfigure privilege: VirtualMachine.Config.Resource @since VI API 2.5

memoryAllocationVcResourceAllocationInfo

Resource limits for memory.

Reconfigure privilege: VirtualMachine.Config.Resource @since VI API 2.5

memoryHotAddEnabledBoolean

Indicates whether or not memory can be added to the virtual machine while it is running. This attribute can only be set when the virtual machine is powered-off.

Reconfigure privilege: VirtualMachine.Config.Memory @since vSphere API 4.0

memoryMBNumber

Size of a virtual machine's memory, in MB.

Reconfigure privilege: VirtualMachine.Config.Memory @since VI API 2.5

memoryReservationLockedToMaxBoolean

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. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.

Reconfigure privilege: VirtualMachine.Config.Resource @since vSphere API 5.0

messageBusTunnelEnabledBoolean

Whether to allow tunneling of clients from the guest VM into the common message bus on the host network. @since vSphere API 6.0
migrateEncryptionString

An enum describing whether encrypted vMotion is required for this VM. @since vSphere API 6.5
nameString

Display name of the virtual machine.

Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter. Snapshots of virtual machines that have spaces in their names and are associated with ESX 2.x servers are not supported. Therefore, if you want the option to take snapshots of this virtual machine and you are associating it with an ESX 2.x server, do not use spaces in the name.

Reconfigure privilege: VirtualMachine.Config.Rename @since VI API 2.5

nestedHVEnabledBoolean

Specifies that this VM will use nested hardware-assisted virtualization.

Reconfigure privilege: VirtualMachine.Config.Settings @since vSphere API 5.1

networkShaperVcVirtualMachineNetworkShaperInfoDeprecated.

Resource limits for network.

Reconfigure privilege: VirtualMachine.Config.Resource @since VI API 2.5

npivDesiredNodeWwnsNumber

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
npivDesiredPortWwnsNumber

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
npivNodeWorldWideNameNumber []

The NPIV node WWN to be assigned to a virtual machine. This property should only be used or set when the value of {@link #npivWorldWideNameOp} property is "set". Otherwise, an {@link vim.fault.InvalidVmConfig} fault will be thrown. If the specified node WWN is currently being used by another virtual machine, a {@link vim.fault.VmWwnConflict} fault will be thrown.

For detail description on WWN, see {@link vim.vm.ConfigInfo#npivNodeWorldWideName}.

Reconfigure privilege: VirtualMachine.Config.Settings. @since VI API 2.5

npivOnNonRdmDisksBoolean

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
npivPortWorldWideNameNumber []

The NPIV port WWN to be assigned to a virtual machine. This property should only be used or set when the value of {@link #npivWorldWideNameOp} property is "set". Otherwise, an {@link vim.fault.InvalidVmConfig} fault will be thrown. If the specified port WWN is currently being used by another virtual machine, a {@link vim.fault.VmWwnConflict} fault will be thrown.

For detail description on WWN, see {@link vim.vm.ConfigInfo#npivPortWorldWideName}.

Reconfigure privilege: VirtualMachine.Config.Settings. @since VI API 2.5

npivTemporaryDisabledBoolean

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.

Reconfigure privilege: VirtualMachine.Config.Settings. @since vSphere API 4.0

npivWorldWideNameOpString

The flag to indicate what type of NPIV WWN operation is going to be performed on the virtual machine. If unset, it indicates no change to existing NPIV WWN assignment (or not assigned) in the virtual machine.

Reconfigure privilege: VirtualMachine.Config.Settings. @since VI API 2.5

npivWorldWideNameTypeString

This property is used internally in the communication between the VirtualCenter server and ESX Server to indicate the source for {@link #npivNodeWorldWideName} and {@link #npivPortWorldWideName} when {@link #npivWorldWideNameOp} is "set". This property should only be set by the VirtualCenter server.

If this property is set in a call to a VirtualCenter server, an {@link vim.fault.InvalidVmConfig} fault will always be thrown. In a call to an ESX Server host, an {@link vim.fault.InvalidVmConfig} fault will be thrown if the value of {@link #npivWorldWideNameOp} is not set to "set".

Reconfigure privilege: VirtualMachine.Config.Settings. @since VI API 2.5

numCoresPerSocketNumber

Number of cores among which to distribute CPUs in this virtual machine. @since vSphere API 5.0
numCPUsNumber

Number of virtual processors in a virtual machine.

Reconfigure privilege: VirtualMachine.Config.CpuCount @since VI API 2.5

powerOpInfoVcVirtualMachineDefaultPowerOpInfo

Configuration for default power operations.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

repConfigVcReplicationConfigSpec

vSphere Replication settings. Note this may become deprecated in the future releases. We discourage any unnecessary dependency on this field. @since vSphere API 6.0
scheduledHardwareUpgradeInfoVcScheduledHardwareUpgradeInfo

Configuration of scheduled hardware upgrades. @since vSphere API 5.1
swapPlacementString

Virtual machine swapfile placement policy. This may only be set if the {@link vim.vm.Capability#swapPlacementSupported swapPlacementSupported} capability is true for this virtual machine. Any change to this policy will take effect the next time the virtual machine powers on, resumes from a suspended state, or migrates while powered on.

Reconfigure privilege: VirtualMachine.Config.SwapPlacement (also required when setting this property while creating a virtual machine)

@since VI API 2.5

toolsVcToolsConfigInfo

Configuration of VMware Tools running in the guest operating system.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

uuidString

128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.

Normally, this property is not set by a client, allowing the Virtual Infrastructure environment to assign a UUID when the virtual machine is created. However, in some rare cases, such as a manual copy of a virtual machine, it may be necessary to set this property.

Reconfigure privilege: VirtualMachine.Config.Settings @since VI API 2.5

vAppConfigVcVmConfigSpec

Configuration of vApp meta-data for a virtual machine @since vSphere API 4.0
vAppConfigRemovedBoolean

Set to true, if the vApp configuration should be removed

Reconfigure privilege: VApp.ApplicationConfig @since vSphere API 4.0

vAssertsEnabledBoolean

Indicates whether user-configured virtual asserts will be triggered during virtual machine replay. This setting takes effect during the next replay of the virtual machine.

Enabling this functionality can potentially cause some performance overhead during virtual machine execution. @since vSphere API 4.0

versionString

The version string for this virtual machine. This is used only while creating a new virtual machine, and can be updated by invoking {@link vim.VirtualMachine#upgradeVirtualHardware} for this virtual machine. @since VI API 2.5
virtualICH7MPresentBoolean

Does this virtual machine have Virtual Intel I/O Controller Hub 7 @since vSphere API 5.0
virtualSMCPresentBoolean

Does this virtual machine have System Management Controller @since vSphere API 5.0
vmProfileVcVirtualMachineProfileSpec []

Virtual Machine Profile requirement. Profiles are solution specific. Profile Based Storage Management is a vSphere server extension. API users who want to provision VMs using Storage Profiles, need to interact with it. This is an optional parameter and if user doesn't specify profile, the default behavior will apply. @since vSphere API 5.5
vPMCEnabledBoolean

Specifies that this VM will have vurtual CPU performance counters enabled.

Reconfigure privilege: VirtualMachine.Config.Settings @since vSphere API 5.1


Methods

Methods defined in this Scripting Object
isChangeTrackingEnabled, isCpuHotAddEnabled, isCpuHotRemoveEnabled, isGuestAutoLockEnabled, isMemoryHotAddEnabled, isMemoryReservationLockedToMax, isMessageBusTunnelEnabled, isNestedHVEnabled, isNpivOnNonRdmDisks, isNpivTemporaryDisabled, isVAppConfigRemoved, isVAssertsEnabled, isVirtualICH7MPresent, isVirtualSMCPresent, isVPMCEnabled

isVAppConfigRemoved

Set to true, if the vApp configuration should be removed

Reconfigure privilege: VApp.ApplicationConfig @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isNestedHVEnabled

Specifies that this VM will use nested hardware-assisted virtualization.

Reconfigure privilege: VirtualMachine.Config.Settings @since vSphere API 5.1

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isCpuHotRemoveEnabled

Indicates whether or not virtual processors can be removed from the virtual machine while it is running. This attribute can only be set when the virtual machine is powered-off.

Reconfigure privilege: VirtualMachine.Config.CpuCount @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isVirtualICH7MPresent

Does this virtual machine have Virtual Intel I/O Controller Hub 7 @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isGuestAutoLockEnabled

If set to True, this causes the guest operating system to automatically logout any active sessions whenever there are no remote display connections open to the virtual machine.

Reconfigure privilege: VirtualMachine.Config.MksControl @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isVAssertsEnabled

Indicates whether user-configured virtual asserts will be triggered during virtual machine replay. This setting takes effect during the next replay of the virtual machine.

Enabling this functionality can potentially cause some performance overhead during virtual machine execution. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isChangeTrackingEnabled

Setting to control enabling/disabling changed block tracking for the virtual disks of this VM. This may only be set if the {@link vim.vm.Capability#changeTrackingSupported changeTrackingSupported} capability is true for this virtual machine. Any change to this property will take effect the next time the virtual machine powers on, resumes from a suspended state, performs a snapshot create/delete/revert operation or migrates while powered on.

Reconfigure privilege: VirtualMachine.Config.ChangeTracking (also required when setting this property while creating a virtual machine) @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isCpuHotAddEnabled

Indicates whether or not virtual processors can be added to the virtual machine while it is running. This attribute can only be set when the virtual machine is powered-off.

Reconfigure privilege: VirtualMachine.Config.CpuCount @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isMemoryReservationLockedToMax

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. This feature may only be enabled if it is currently possible to reserve all of the virtual machine's memory.

Reconfigure privilege: VirtualMachine.Config.Resource @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isMemoryHotAddEnabled

Indicates whether or not memory can be added to the virtual machine while it is running. This attribute can only be set when the virtual machine is powered-off.

Reconfigure privilege: VirtualMachine.Config.Memory @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isNpivTemporaryDisabled

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.

Reconfigure privilege: VirtualMachine.Config.Settings. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isVPMCEnabled

Specifies that this VM will have vurtual CPU performance counters enabled.

Reconfigure privilege: VirtualMachine.Config.Settings @since vSphere API 5.1

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isVirtualSMCPresent

Does this virtual machine have System Management Controller @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isNpivOnNonRdmDisks

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

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isMessageBusTunnelEnabled

Whether to allow tunneling of clients from the guest VM into the common message bus on the host network. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean