Search

Class VcVirtualMachineConfigSpec

Extends VcDynamicData
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
alternateGuestName String Full name for guest, if guestId is specified as <tt>other</tt> or <tt>other-64</tt>. <p> Reconfigure privilege: VirtualMachine.Config.Settings
annotation 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 <a href="VcVirtualMachineConfigInfo.html">VcVirtualMachineConfigInfo</a> for a virtual machine. <p> Reconfigure privilege: VirtualMachine.Config.Rename
bootOptions VcVirtualMachineBootOptions Settings that control the boot behavior of the virtual machine. These settings take effect during the next power-on of the virtual machine. <p> Reconfigure privilege: VirtualMachine.Config.Settings
changeTrackingEnabled boolean Setting to control enabling/disabling changed block tracking for the virtual disks of this VM. This may only be set if the <a href="VcVirtualMachineCapability.html#changeTrackingSupported">VcVirtualMachineCapability</a> 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. <p> Reconfigure privilege: VirtualMachine.Config.ChangeTracking (also required when setting this property while creating a virtual machine)
changeVersion 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. <p> For more information about how configurations are uniquely identified, see <a href="VcVirtualMachineConfigInfo.html#changeVersion">VcVirtualMachineConfigInfo</a>.
consolePreferences VcVirtualMachineConsolePreferences Legacy console viewer preferences that are used with power operations. For example, power on. <p> Reconfigure privilege: VirtualMachine.Config.Settings
cpuAffinity VcVirtualMachineAffinityInfo Affinity settings for CPU. <p> Reconfigure privilege: VirtualMachine.Config.Resource
cpuAllocation VcResourceAllocationInfo Resource limits for CPU. <p> Reconfigure privilege: VirtualMachine.Config.Resource
cpuFeatureMask VcVirtualMachineCpuIdInfoSpec[] Specifies the CPU feature compatibility masks. <p> Reconfigure privilege: VirtualMachine.Config.Settings
cpuHotAddEnabled 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. <p> Reconfigure privilege: VirtualMachine.Config.CpuCount
cpuHotRemoveEnabled 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. <p> Reconfigure privilege: VirtualMachine.Config.CpuCount
deviceChange VcVirtualDeviceConfigSpec[] Set of virtual devices being modified by the configuration operation. <p> Reconfigure privileges: <ul> <li>VirtualMachine.Config.Resource if setting the "shares" property of a new or existing VirtualDisk device <li>VirtualMachine.Config.RawDevice if adding, removing, or modifying a raw device (also required when creating a virtual machine) <li>VirtualMachine.Config.HostUSBDevice if adding, removing, or modifying a VirtualUSB device backed by a host USB device (also required when creating a virtual machine). <li>VirtualMachine.Interact.DeviceConnection if setting the "connectable" property of a connectable device <li>VirtualMachine.Interact.SetCDMedia if setting the "backing" property of a VirtualCdrom device <li>VirtualMachine.Interact.SetFloppyMedia if setting the "backing" property of a VirtualFloppy device <li>VirtualMachine.Config.EditDevice if setting any property of a non-CDROM non-Floppy device <li>VirtualMachine.Config.AddExistingDisk if adding a VirtualDisk, and the fileOperation is unset (also required when creating a virtual machine) <li>VirtualMachine.Config.AddNewDisk if adding a VirtualDisk and the fileOperation is set (also required when creating a virtual machine) <li>VirtualMachine.Config.RemoveDisk if removing a VirtualDisk device <li>VirtualMachine.Config.AddRemoveDevice if adding or removing any device other than disk, raw, or USB device. <li>Network.Assign if if setting the "backing" property of a VirtualEthernetCard device. </ul>
extraConfig VcOptionValue[] 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. <p> Configuration keys that would conflict with parameters that are explicitly configurable through other fields in the ConfigSpec object are silently ignored. <p> Reconfigure privilege: VirtualMachine.Config.AdvancedConfig (also required when setting this property while creating a virtual machine)
files VcVirtualMachineFileInfo Information about virtual machine files. <p> Reconfigure privilege: VirtualMachine.Config.Settings
firmware String Set the desired firmware type for this Virtual Machine. Possible values are described in <a href="VcGuestOsDescriptorFirmwareType.html">VcGuestOsDescriptorFirmwareType</a>
flags VcVirtualMachineFlagInfo Additional flags for a virtual machine. <p> Reconfigure privilege: VirtualMachine.Config.Settings
ftInfo VcFaultToleranceConfigInfo Fault Tolerance settings for this virtual machine.
guestAutoLockEnabled 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. <p> Reconfigure privilege: VirtualMachine.Config.MksControl
guestId String Short guest operating system identifier. <p> Reconfigure privilege: VirtualMachine.Config.Settings
instanceUuid 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. <p> 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. <p> Reconfigure privilege: VirtualMachine.Config.Settings
latencySensitivity VcLatencySensitivity The latency-sensitivity setting of the virtual machine. <p> Reconfigure privilege: VirtualMachine.Config.Resource
locationId 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. <p> 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. <p> Reconfigure privilege: VirtualMachine.Config.Settings
managedBy VcManagedByInfo Specifies that this VM is managed by a VC Extension. <p> 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 <a href="VcManagedByInfo.html">VcManagedByInfo</a> object, or the type is not found in the <a href="VcExtension.html#managedEntityInfo">VcExtension</a> list of the extension, the default virtual machine icon is used, and no description is shown. <p> Reconfigure privilege: VirtualMachine.Config.ManagedBy
maxMksConnections Number If set, this setting limits the maximum number of active remote display connections that the virtual machine will support to the specified value. <p> Reconfigure privilege: VirtualMachine.Config.MksControl
memoryAffinity VcVirtualMachineAffinityInfo Affinity settings for memory. <p> Reconfigure privilege: VirtualMachine.Config.Resource
memoryAllocation VcResourceAllocationInfo Resource limits for memory. <p> Reconfigure privilege: VirtualMachine.Config.Resource
memoryHotAddEnabled 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. <p> Reconfigure privilege: VirtualMachine.Config.Memory
memoryMB Number Size of a virtual machine's memory, in MB. <p> Reconfigure privilege: VirtualMachine.Config.Memory
memoryReservationLockedToMax 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. <p> Reconfigure privilege: VirtualMachine.Config.Resource
name String Display name of the virtual machine. <p> 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. <p> Reconfigure privilege: VirtualMachine.Config.Rename
nestedHVEnabled boolean Specifies that this VM will use nested hardware-assisted virtualization. <p> Reconfigure privilege: VirtualMachine.Config.Settings
networkShaper VcVirtualMachineNetworkShaperInfo Resource limits for network. <p> Reconfigure privilege: VirtualMachine.Config.Resource <br/><i>from vSphere 5.5, shaping policy on VM is not supported.</i>
npivDesiredNodeWwns Number 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
npivDesiredPortWwns Number 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
npivNodeWorldWideName Number[] The NPIV node WWN to be assigned to a virtual machine. This property should only be used or set when the value of <a href="VcVirtualMachineConfigSpec.html#npivWorldWideNameOp">VcVirtualMachineConfigSpec</a> property is "set". Otherwise, an <a href="VcInvalidVmConfig.html">VcInvalidVmConfig</a> fault will be thrown. If the specified node WWN is currently being used by another virtual machine, a <a href="VcVmWwnConflict.html">VcVmWwnConflict</a> fault will be thrown. <p> For detail description on WWN, see <a href="VcVirtualMachineConfigInfo.html#npivNodeWorldWideName">VcVirtualMachineConfigInfo</a>. <p> Reconfigure privilege: VirtualMachine.Config.Settings.
npivOnNonRdmDisks 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.
npivPortWorldWideName Number[] The NPIV port WWN to be assigned to a virtual machine. This property should only be used or set when the value of <a href="VcVirtualMachineConfigSpec.html#npivWorldWideNameOp">VcVirtualMachineConfigSpec</a> property is "set". Otherwise, an <a href="VcInvalidVmConfig.html">VcInvalidVmConfig</a> fault will be thrown. If the specified port WWN is currently being used by another virtual machine, a <a href="VcVmWwnConflict.html">VcVmWwnConflict</a> fault will be thrown. <p> For detail description on WWN, see <a href="VcVirtualMachineConfigInfo.html#npivPortWorldWideName">VcVirtualMachineConfigInfo</a>. <p> Reconfigure privilege: VirtualMachine.Config.Settings.
npivTemporaryDisabled 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. <p> Reconfigure privilege: VirtualMachine.Config.Settings.
npivWorldWideNameOp 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. <p> Reconfigure privilege: VirtualMachine.Config.Settings.<br>See NpivWwnOp
npivWorldWideNameType String This property is used internally in the communication between the VirtualCenter server and ESX Server to indicate the source for <a href="VcVirtualMachineConfigSpec.html#npivNodeWorldWideName">VcVirtualMachineConfigSpec</a> and <a href="VcVirtualMachineConfigSpec.html#npivPortWorldWideName">VcVirtualMachineConfigSpec</a> when <a href="VcVirtualMachineConfigSpec.html#npivWorldWideNameOp">VcVirtualMachineConfigSpec</a> is "set". This property should only be set by the VirtualCenter server. <p> If this property is set in a call to a VirtualCenter server, an <a href="VcInvalidVmConfig.html">VcInvalidVmConfig</a> fault will always be thrown. In a call to an ESX Server host, an <a href="VcInvalidVmConfig.html">VcInvalidVmConfig</a> fault will be thrown if the value of <a href="VcVirtualMachineConfigSpec.html#npivWorldWideNameOp">VcVirtualMachineConfigSpec</a> is not set to "set". <p> Reconfigure privilege: VirtualMachine.Config.Settings.
numCoresPerSocket Number Number of cores among which to distribute CPUs in this virtual machine.
numCPUs Number Number of virtual processors in a virtual machine. <p> Reconfigure privilege: VirtualMachine.Config.CpuCount
powerOpInfo VcVirtualMachineDefaultPowerOpInfo Configuration for default power operations. <p> Reconfigure privilege: VirtualMachine.Config.Settings
scheduledHardwareUpgradeInfo VcScheduledHardwareUpgradeInfo Configuration of scheduled hardware upgrades.<br>See <a href="VcScheduledHardwareUpgradeInfo.html">VcScheduledHardwareUpgradeInfo</a><br>
swapPlacement String Virtual machine swapfile placement policy. This may only be set if the <a href="VcVirtualMachineCapability.html#swapPlacementSupported">VcVirtualMachineCapability</a> 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. <p> Reconfigure privilege: VirtualMachine.Config.SwapPlacement (also required when setting this property while creating a virtual machine) <p><br>See <a href="VcVirtualMachineConfigInfoSwapPlacementType.html">VcVirtualMachineConfigInfoSwapPlacementType</a><br>
tools VcToolsConfigInfo Configuration of VMware Tools running in the guest operating system. <p> Reconfigure privilege: VirtualMachine.Config.Settings
uuid String 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format. <p> 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. <p> Reconfigure privilege: VirtualMachine.Config.Settings
vAppConfig VcVmConfigSpec Configuration of vApp meta-data for a virtual machine
vAppConfigRemoved boolean Set to true, if the vApp configuration should be removed <p> Reconfigure privilege: VApp.ApplicationConfig
vAssertsEnabled 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. <p> Enabling this functionality can potentially cause some performance overhead during virtual machine execution.
version String The version string for this virtual machine. This is used only while creating a new virtual machine, and can be updated by invoking <a href="VcVirtualMachine.html#upgradeVirtualHardware">VcVirtualMachine</a> for this virtual machine.
virtualICH7MPresent boolean Does this virtual machine have Virtual Intel I/O Controller Hub 7
virtualSMCPresent boolean Does this virtual machine have System Management Controller
vmProfile VcVirtualMachineProfileSpec[] 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.
vPMCEnabled boolean Specifies that this VM will have vurtual CPU performance counters enabled. <p> Reconfigure privilege: VirtualMachine.Config.Settings

Methods

Name Returns
VcVirtualMachineConfigSpec() constructor
equals(Object ) boolean
getDeserializer(String , java.lang.Class , javax.xml.namespace.QName ) org.apache.axis.encoding.Deserializer
getSerializer(String , java.lang.Class , javax.xml.namespace.QName ) org.apache.axis.encoding.Serializer
getTypeDesc() org.apache.axis.description.TypeDesc
hashCode() Number

Returned by

None

Referenced in

Method Returns
VcFolder.createVM_Task(VcVirtualMachineConfigSpec config, VcResourcePool pool, VcHostSystem host) VcTask
VcResourcePool.createChildVM_Task(VcVirtualMachineConfigSpec config, VcHostSystem host) VcTask
VcStoragePod.createVM_Task(VcVirtualMachineConfigSpec config, VcResourcePool pool, VcHostSystem host) VcTask
VcVirtualApp.createChildVM_Task(VcVirtualMachineConfigSpec config, VcHostSystem host) VcTask
VcVirtualMachine.reconfigVM_Task(VcVirtualMachineConfigSpec spec) VcTask