VirtualMachineFlagInfo
The FlagInfo data object type encapsulates the flag settings for a virtual machine.
These properties are optional since the same structure is used to change the values during an edit or create operation.
{
"_typeName": "string",
"disableAcceleration": false,
"enableLogging": false,
"useToe": false,
"runWithDebugInfo": false,
"monitorType": "string",
"htSharing": "string",
"snapshotDisabled": false,
"snapshotLocked": false,
"diskUuidEnabled": false,
"virtualMmuUsage": "string",
"virtualExecUsage": "string",
"snapshotPowerOffBehavior": "string",
"recordReplayEnabled": false,
"faultToleranceType": "string",
"cbrcCacheEnabled": false,
"vvtdEnabled": false,
"vbsEnabled": false
}Flag to turn off video acceleration for a virtual machine console window.
Flag to enable logging for a virtual machine.
Flag to specify whether or not to use TOE (TCP/IP Offloading).
Deprecated as of VI API 2.5, use monitorType.
Flag to specify whether or not to run in debug mode.
vmx process type.
See VirtualMachineFlagInfoMonitorTypeEnum for possible values for this property.
Deprecated as of vSphere API 6.7.
Specifies how the VCPUs of a virtual machine are allowed to share physical cores on a hyperthreaded system.
Two VCPUs are "sharing" a core if they are both running on logical CPUs of the core at the same time.
See also VirtualMachineHtSharingEnum.
Deprecated as of vSphere API 4.0. The flag is ignored by the server.
Flag to specify whether snapshots are disabled for this virtual machine.
Flag to specify whether the snapshot tree is locked for this virtual machine.
Indicates whether disk UUIDs are being used by this virtual machine.
If this flag is set to false, disk UUIDs are not exposed to the guest.
Since products before ESX 3.1 do not support disk UUIDs, moving virtual machines from a platform that supports UUID to a platform that does not support UUIDs could result in unspecified guest behavior. For virtual machines where the ability to move to older platforms is important, this flag should be set to false. If the value is unset, the behavior 'false' will be used.
Indicates whether or not the system will try to use nested page table hardware support, if available.
By default, VMware software will determine whether or not to use nested page table hardware support based on various factors such as the guest operating system type and the physical hardware. Certain workloads can benefit from explicitly turning nested page table hardware support on or off; this can be set using nptUsage flag. If the value is unset, the value will default to automatic.
VirtualMachineFlagInfoVirtualMmuUsageEnum represents the set of possible values.
Indicates whether or not the system will try to use Hardware Virtualization (HV) support for instruction virtualization, if available.
By default, VMware software will determine whether or not to use hardware virtualization support based on various factors such as the guest operating system type and the physical hardware. Certain workloads can benefit from explicitly turning hardware virtualization support on or off. If the value is unset, the value will default to hvAuto.
VirtualMachineFlagInfoVirtualExecUsageEnum represents the set of possible values.
New processors can enable two hardware acceleration technologies for virtualization, one for instruction virtualization and the other for MMU virtualization. Intel names its hardware-assisted instruction virtualization as VT, and its hardware-assisted MMU virtualization as EPT. AMD calls them as AMD-V and RVI, respectively. For details on these technologies, please refer to documents from the processor vendors.
virtualExecUsage controls instruction virtualization; while virtualMmuUsage controls MMU virtualization. "On" allows hardware acceleration, while "off" only allows software solution.
There are four meaningful combinations.
(hvAuto, automatic) - The host chooses which feature to use. (hvOn, on) - Use both VT/AMD-V and EPT/RVI. (hvOn, off) - Use VT/AMD-V but do not use EPT/RVI. (hvOff, off) - Do not use any of these hardware acceleration technologies.
Specifies the power-off behavior for a virtual machine that has a snapshot.
If the value is unset, the behavior 'powerOff' will be used.
See also VirtualMachinePowerOffBehaviorEnum.
Deprecated as of vSphere API 6.0.
Flag to specify whether record and replay operations are allowed for this virtual machine.
If this flag is set to 'true', instruction virtualization will use hardware virtualization (HV) support. I.e., virtualExecUsage will be set to 'hvOn'. If this flag is set to 'false' for a virtual machine that already has a recording, replay will be disallowed, though the recording will be preserved. If the value is unset, the behavior 'false' will be used.
Indicates the type of fault tolerance type the virtual machine is configured to use.
VirtualMachineFaultToleranceTypeEnum represents the set of possible values.
Flag to specify whether common CBRC digest cache is enabled for this virtual machine.
The common CBRC cache is shared between the hot added disks in the VM. If this flag is set to 'true' the VM will allocate a commont digest cache on power on.
Flag to specify if Intel Virtualization Technology for Directed I/O is enabled for this virtual machine.
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.
Flag to specify if Virtualization-based security is enabled for this virtual machine.
If set to true when creating a new VM, the following VM properties might be modified automatically: - If vim.vm.FlagInfo.vvtdEnabled is not set to false, it is set to true. Else error is returned. - If vim.vm.ConfigSpec.nestedHVEnabled is not set to false, it is set to true. Else error is returned. - If vim.vm.BootOptions.efiSecureBootEnabled is not set to false, it is set to true. Else error is returned. - If vim.vm.firmware is not set to bios, it is set to efi. Else error is returned.