vSphere Web Services API


Data Object - VirtualMachineConfigSpec(vim.vm.ConfigSpec)

Property of
ClusterClusterInitialPlacementAction, PlacementSpec, StoragePlacementSpec, VirtualMachineCloneSpec, VirtualMachineImportSpec, VmBeingCreatedEvent, VmReconfiguredEvent
Parameter to
CheckVmConfig_Task, CreateChildVM_Task, CreateVM_Task, ReconfigVM_Task
Extends
DynamicData
See also
CryptoSpec, FaultToleranceConfigInfo, LatencySensitivity, ManagedByInfo, OptionValue, ReplicationConfigSpec, ResourceAllocationInfo, ScheduledHardwareUpgradeInfo, ToolsConfigInfo, VirtualDeviceConfigSpec, VirtualMachineAffinityInfo, VirtualMachineBootOptions, VirtualMachineConsolePreferences, VirtualMachineCpuIdInfoSpec, VirtualMachineDefaultPowerOpInfo, VirtualMachineFileInfo, VirtualMachineFlagInfo, VirtualMachineGuestMonitoringModeInfo, VirtualMachineNetworkShaperInfo, VirtualMachineProfileSpec, VirtualMachineSgxInfo, VirtualMachineVcpuConfig, VirtualMachineVirtualDeviceGroups, VirtualMachineVirtualDeviceSwap, VirtualMachineVirtualNuma, VirtualMachineVirtualPMem, VmConfigSpec
Since
2.0

Data 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.

Properties

Name Type Description
alternateGuestName*xsd:string

Full name for guest, if guestId is specified as {@code other} or {@code other-64}.

Reconfigure privilege: VirtualMachine.Config.Settings

Since VI API 2.5
annotation*xsd:string

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 VirtualMachineConfigInfo for a virtual machine.

Reconfigure privilege: VirtualMachine.Config.Rename

bootOptions*VirtualMachineBootOptions

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
changeTrackingEnabled*xsd:boolean

Setting to control enabling/disabling changed block tracking for the virtual disks of this VM. This may only be set if the 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 Release 4.0
changeVersion*xsd:string

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 changeVersion.

consolePreferences*VirtualMachineConsolePreferences

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

Reconfigure privilege: VirtualMachine.Config.Settings

cpuAffinity*VirtualMachineAffinityInfo

Affinity settings for CPU.

Reconfigure privilege: VirtualMachine.Config.Resource

cpuAllocation*ResourceAllocationInfo

Resource limits for CPU.

Reconfigure privilege: VirtualMachine.Config.Resource

cpuFeatureMask*VirtualMachineCpuIdInfoSpec[]

Specifies the CPU feature compatibility masks.

Reconfigure privilege: VirtualMachine.Config.Settings As of vSphere API 6.5 FeatureMask is the recommended method for masking virtual machines with hardware version 9 and above (newer).

cpuHotAddEnabled*xsd:boolean

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 VI API 2.5 U2
cpuHotRemoveEnabled*xsd:boolean

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 VI API 2.5 U2
createDate*xsd:dateTime

Creation date of a virtual machine represented in DateTime format.

This property is populated by the vCenter Server with the date and time of creation of the virtual machine. Values provided by the client will be ignored.

Reconfigure privilege: VirtualMachine.Config.Settings

Since vSphere API Release 6.7
crypto*CryptoSpec

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 Release 6.5
deviceChange*VirtualDeviceConfigSpec[]

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.

deviceGroups*VirtualMachineVirtualDeviceGroups

Assignable hardware device groups.

Since vSphere API Release 8.0.0.1
deviceSwap*VirtualMachineVirtualDeviceSwap

Status of the device swap operation.

Since vSphere API Release 8.0.0.1
extraConfig*OptionValue[]

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)

files*VirtualMachineFileInfo

Information about virtual machine files.

Reconfigure privilege: VirtualMachine.Config.Settings

firmware*xsd:string

Set the desired firmware type for this Virtual Machine. Possible values are described in GuestOsDescriptorFirmwareType

Since vSphere API Release 5.0
fixedPassthruHotPlugEnabled*xsd:boolean

Indicates whether support to add and remove fixed passthrough devices when the VM is running should be enabled.

This property can only be set when the VM is powered off. If set, additional setup will be performed when the VM is powered on so that hot adding and removing fixed passthrough devices will be possible. 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 vSphere API Release 8.0.1.0
flags*VirtualMachineFlagInfo

Additional flags for a virtual machine.

Reconfigure privilege: VirtualMachine.Config.Settings

ftEncryptionMode*xsd:string

An enum describing whether encrypted Fault Tolerance is required for this VM. Supported values are listed in EncryptedFtModes. - 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 Release 7.0.2.0
ftInfo*FaultToleranceConfigInfo

Fault Tolerance settings for this virtual machine.

Since vSphere API Release 4.0
guestAutoLockEnabled*xsd:boolean

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

Short guest operating system identifier.

Reconfigure privilege: VirtualMachine.Config.Settings

guestMonitoringModeInfo*VirtualMachineGuestMonitoringModeInfo

Configuration of GMM, Guest Monitoring Mode for the VM.

Since vSphere API Release 7.0
instanceUuid*xsd:string

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 Release 4.0
latencySensitivity*LatencySensitivity

The latency-sensitivity setting of the virtual machine.

Reconfigure privilege: VirtualMachine.Config.Resource

Since vSphere API Release 5.1
locationId*xsd:string

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

managedBy*ManagedByInfo

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 managedBy object, or the type is not found in the managedEntityInfo list of the extension, the default virtual machine icon is used, and no description is shown. To unset this field pass a ManagedByInfo object with an empty extensionKey.

Reconfigure privilege: VirtualMachine.Config.ManagedBy

Since vSphere API Release 5.0
maxMksConnections*xsd:int

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 Release 5.0
memoryAffinity*VirtualMachineAffinityInfo

Deprecated. since vSphere 6.0.

Affinity settings for memory.

Reconfigure privilege: VirtualMachine.Config.Resource

memoryAllocation*ResourceAllocationInfo

Resource limits for memory.

Reconfigure privilege: VirtualMachine.Config.Resource

memoryHotAddEnabled*xsd:boolean

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 VI API 2.5 U2
memoryMB*xsd:long

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

Reconfigure privilege: VirtualMachine.Config.Memory

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. 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 Release 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 Release 6.0
metroFtEnabled*xsd:boolean

Indicates whether FT Metro Cluster is enabled/disabled.

- If TRUE, FT Metro Cluster is enabled for the VM. An implicit Anti-HostGroup will be generated from HostGroup defined for FT primary, then affine the primary with one HostGroup and affine the secondary with another HostGroup. - If FALSE or unset, FT Metro Cluster is disabled for the VM. Both FT primary and secondary will be put in the same HostGroup.

Since vSphere API Release 8.0.3.0
metroFtHostGroup*xsd:string

Indicate the Host Group (ClusterHostGroup) for FT Metro Cluster enabled Virtual Machine.

Based on the selected Host Group, FT can divide the hosts in the cluster into two groups and ensure to place FT primary and FT secondary in different groups.

Since vSphere API Release 8.0.3.0
migrateEncryption*xsd:string

An enum describing whether encrypted vMotion is required for this VM. Supported values are listed in EncryptedVMotionModes. This defaults to opportunistic for a regular VM, and will be set to required for an encrypted VM.

Since vSphere API Release 6.5
motherboardLayout*xsd:string

One of motherboardLayout choices. Default is i440bxHostBridge. See motherboardLayout

Since vSphere API Release 8.0.0.1
name*xsd:string

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

nestedHVEnabled*xsd:boolean

Specifies that this VM will use nested hardware-assisted virtualization. When creating a new VM: - If vim.vm.FlagInfo.vbsEnabled is set to true, and this flag is set to false error is returned. - If this flag is unset and vim.vm.FlagInfo.vbsEnabled is set to true, the value of this flag is set to true.

Reconfigure privilege: VirtualMachine.Config.Settings

Since vSphere API Release 5.1
networkShaper*VirtualMachineNetworkShaperInfo

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

Resource limits for network.

Reconfigure privilege: VirtualMachine.Config.Resource

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

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

For detail description on WWN, see npivNodeWorldWideName.

Reconfigure privilege: VirtualMachine.Config.Settings.

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 Release 4.0
npivPortWorldWideName*xsd:long[]

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

For detail description on WWN, see npivPortWorldWideName.

Reconfigure privilege: VirtualMachine.Config.Settings.

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.

Reconfigure privilege: VirtualMachine.Config.Settings.

Since vSphere API Release 4.0
npivWorldWideNameOp*xsd:string

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.
See NpivWwnOp

Since VI API 2.5
npivWorldWideNameType*xsd:string

This property is used internally in the communication between the VirtualCenter server and ESX Server to indicate the source for npivNodeWorldWideName and npivPortWorldWideName when 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 InvalidVmConfig fault will always be thrown. In a call to an ESX Server host, an InvalidVmConfig fault will be thrown if the value of npivWorldWideNameOp is not set to "set".

Reconfigure privilege: VirtualMachine.Config.Settings.

Since VI API 2.5
numCoresPerSocket*xsd:int

Number of cores among which to distribute CPUs in this virtual machine. Set "numCoresPerSocket" with a non-zero value to manually configure coresPerSocket size. Set "numCoresPerSocket" with zero to remove any manual size if present, and use default coresPerSocket behavior. Leave "numCoresPerSocket" unset to continue with existing configuration (either manual or default).

Since vSphere API Release 5.0
numCPUs*xsd:int

Number of virtual processors in a virtual machine.

Reconfigure privilege: VirtualMachine.Config.CpuCount

pmem*VirtualMachineVirtualPMem

Configuration for virtual persistent memory.

Since vSphere API Release 7.0.3.0
pmemFailoverEnabled*xsd:boolean

Property to enable/disable PMem HA failover. - 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 Release 7.0.2.0
powerOpInfo*VirtualMachineDefaultPowerOpInfo

Configuration for default power operations.

Reconfigure privilege: VirtualMachine.Config.Settings

rebootPowerOff*xsd:boolean

Whether the next reboot will result in a power off.

Reconfigure privilege: VirtualMachine.Config.Settings

Since vSphere API Release 8.0.0.1
repConfig*ReplicationConfigSpec

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

Since vSphere API Release 6.0
scheduledHardwareUpgradeInfo*ScheduledHardwareUpgradeInfo

Configuration of scheduled hardware upgrades.

Reconfigure privilege: VirtualMachine.Config.UpgradeVirtualHardware
See ScheduledHardwareUpgradeInfo

Since vSphere API Release 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 Release 7.0.1.0
sgxInfo*VirtualMachineSgxInfo

Configuration of SGX, Software Guard Extensions for the VM.

Since vSphere API Release 7.0
simultaneousThreads*xsd:int

Number of SMT (Simultaneous multithreading) threads. - Set "simultaneousThreads" with a non-zero value to configure threads. - If unset, then use system defaults.

Since vSphere API Release 8.0.0.1
swapPlacement*xsd:string

Virtual machine swapfile placement policy. This may only be set if the 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)


See VirtualMachineConfigInfoSwapPlacementType

Since VI API 2.5
tools*ToolsConfigInfo

Configuration of VMware Tools running in the guest operating system.

Reconfigure privilege: VirtualMachine.Config.Settings

uuid*xsd:string

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

vAppConfig*VmConfigSpec

Configuration of vApp meta-data for a virtual machine

Since vSphere API Release 4.0
vAppConfigRemoved*xsd:boolean

Set to true, if the vApp configuration should be removed

Reconfigure privilege: VApp.ApplicationConfig

Since vSphere API Release 4.0
vAssertsEnabled*xsd:boolean

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 Release 4.0
vcpuConfig*VirtualMachineVcpuConfig[]

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

Since vSphere API Release 7.0
version*xsd:string

The version string for this virtual machine. This is used only while creating a new virtual machine, and can be updated by invoking UpgradeVM_Task for this virtual machine.
virtualICH7MPresent*xsd:boolean

Does this virtual machine have Virtual Intel I/O Controller Hub 7

Since vSphere API Release 5.0
virtualNuma*VirtualMachineVirtualNuma

Virtual NUMA information for this VM.

Since vSphere API Release 8.0.0.1
virtualSMCPresent*xsd:boolean

Does this virtual machine have System Management Controller

Since vSphere API Release 5.0
vmOpNotificationTimeout*xsd:long

Operation notification timeout in seconds. - Specifies the maximum time duration the applications may take to prepare for the operation after its been notified. This value is used only if vmOpNotificationToAppEnabled is set to TRUE. - Timeout has to be a non-zero positive value for applications to be able to register and get notifications.

Since vSphere API Release 8.0.0.1
vmOpNotificationToAppEnabled*xsd:boolean

Property to enable/disable operation notification to applications. - When set to TRUE, application running inside the VM will be notified of operations for which they have registered. - If unset defaults to FALSE, no notifications are sent to the application.

Since vSphere API Release 7.0.3.0
vmProfile*VirtualMachineProfileSpec[]

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 Release 5.5
vmxStatsCollectionEnabled*xsd:boolean

Property to enable/disable VMXStats Collection. - Setting this property is only allowed when the VM is powered off and will fail otherwise. - When set to TRUE, VMs will be configured to create a scoreboard file to store certain stats for various VMX components.

Since vSphere API Release 7.0.3.1
vPMCEnabled*xsd:boolean

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

Reconfigure privilege: VirtualMachine.Config.Settings

Since vSphere API Release 5.1
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition