Data Object - VirtualMachineConfigSpec

Property of
VirtualMachineCloneSpec, VmBeingCreatedEvent, VmReconfiguredEvent
Parameter to
CreateVM_Task, ReconfigVM_Task
Extends
DynamicData
See also
OptionValue, ResourceAllocationInfo, ToolsConfigInfo, VirtualDeviceConfigSpec, VirtualMachineAffinityInfo, VirtualMachineConsolePreferences, VirtualMachineCpuIdInfoSpec, VirtualMachineDefaultPowerOpInfo, VirtualMachineFileInfo, VirtualMachineFlagInfo, VirtualMachineNetworkShaperInfo

Data Object Description

The ConfigSpec data object type encapsulates configuration settings when creating or reconfiguring a virtual machine. To support incremental changes, these properties are all optional.

Properties

Name Type Description
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

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

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.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 a non-disk, non-raw device.
extraConfig*OptionValue[] Additional configuration information for the virtual machine. This describes a set of modifications to the additional options. An option is removed if the key is present but the value is not set or the value is an empty string. Otherwise, the key is set to the new value.

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

flags*VirtualMachineFlagInfo Additional flags for a virtual machine.

Reconfigure privilege: VirtualMachine.Config.Settings

guestId*xsd:string Short guest operating system identifier.

Reconfigure privilege: VirtualMachine.Config.Settings

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

memoryAffinity*VirtualMachineAffinityInfo Affinity settings for memory.

Reconfigure privilege: VirtualMachine.Config.Resource

memoryAllocation*ResourceAllocationInfo Resource limits for memory.

Reconfigure privilege: VirtualMachine.Config.Resource

memoryMB*xsd:long Size of a virtual machine's memory, in MB.

Reconfigure privilege: VirtualMachine.Config.Memory

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

networkShaper*VirtualMachineNetworkShaperInfo Resource limits for network.

Reconfigure privilege: VirtualMachine.Config.Resource

numCPUs*xsd:int Number of virtual processors in a virtual machine.

Reconfigure privilege: VirtualMachine.Config.CpuCount

powerOpInfo*VirtualMachineDefaultPowerOpInfo Configuration for default power operations.

Reconfigure privilege: VirtualMachine.Config.Settings

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

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.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition