Data Object Description

Properties

Name	Type	Description
cbrcCacheEnabled*	xsd:boolean	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. *Since* vSphere API 6.5
disableAcceleration*	xsd:boolean	Flag to turn off video acceleration for a virtual machine console window.
diskUuidEnabled*	xsd:boolean	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. *Since* VI API 2.5
enableLogging*	xsd:boolean	Flag to enable logging for a virtual machine.
faultToleranceType*	xsd:string	Indicates the type of fault tolerance type the virtual machine is configured to use. VirtualMachineFaultToleranceType represents the set of possible values. *Since* vSphere API 6.0
htSharing*	xsd:string	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 VirtualMachineHtSharing
monitorType*	xsd:string	vmx process type. See VirtualMachineFlagInfoMonitorType for possible values for this property. *Since* VI API 2.5
recordReplayEnabled*	xsd:boolean	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. *Since* vSphere API 4.0
runWithDebugInfo*	xsd:boolean	Deprecated. As of VI API 2.5, use monitorType. Flag to specify whether or not to run in debug mode.
snapshotDisabled*	xsd:boolean	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. *Since* VI API 2.5
snapshotLocked*	xsd:boolean	Flag to specify whether the snapshot tree is locked for this virtual machine. *Since* VI API 2.5
snapshotPowerOffBehavior*	xsd:string	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 VirtualMachinePowerOffBehavior *Since* VI API 2.5
useToe*	xsd:boolean	Flag to specify whether or not to use TOE (TCP/IP Offloading).
vbsEnabled*	xsd:boolean	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. *Since* vSphere API 6.7
virtualExecUsage*	xsd:string	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. VirtualMachineFlagInfoVirtualExecUsage 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. *Since* vSphere API 4.0
virtualMmuUsage*	xsd:string	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. VirtualMachineFlagInfoVirtualMmuUsage represents the set of possible values. *Since* VI API 2.5
vvtdEnabled*	xsd:boolean	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`. *Since* vSphere API 6.7
Properties inherited from DynamicData
None

Name

Type

Description

cbrcCacheEnabled*

xsd:boolean

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.

Since vSphere API 6.5

disableAcceleration*

xsd:boolean

Flag to turn off video acceleration for a virtual machine console window.

diskUuidEnabled*

xsd:boolean

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.

Since VI API 2.5

enableLogging*

xsd:boolean

Flag to enable logging for a virtual machine.

faultToleranceType*

xsd:string

Indicates the type of fault tolerance type the virtual machine is configured to use.

VirtualMachineFaultToleranceType represents the set of possible values.

Since vSphere API 6.0

htSharing*

xsd:string

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 VirtualMachineHtSharing

monitorType*

xsd:string

vmx process type. See VirtualMachineFlagInfoMonitorType for possible values for this property.

Since VI API 2.5

recordReplayEnabled*

xsd:boolean

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.

Since vSphere API 4.0

runWithDebugInfo*

xsd:boolean

Deprecated. As of VI API 2.5, use monitorType.

Flag to specify whether or not to run in debug mode.

snapshotDisabled*

xsd:boolean

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.

Since VI API 2.5

snapshotLocked*

xsd:boolean

Flag to specify whether the snapshot tree is locked for this virtual machine.

Since VI API 2.5

snapshotPowerOffBehavior*

xsd:string

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 VirtualMachinePowerOffBehavior

Since VI API 2.5

useToe*

xsd:boolean

Flag to specify whether or not to use TOE (TCP/IP Offloading).

vbsEnabled*

xsd:boolean

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.

Since vSphere API 6.7

virtualExecUsage*

xsd:string

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.

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

Since vSphere API 4.0

virtualMmuUsage*

xsd:string

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.

VirtualMachineFlagInfoVirtualMmuUsage represents the set of possible values.

Since VI API 2.5

vvtdEnabled*

xsd:boolean

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.

Since vSphere API 6.7

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VirtualMachineFlagInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="disableAcceleration" type="xsd:boolean" minOccurs="0"/>
                     <element name="enableLogging" type="xsd:boolean" minOccurs="0"/>
                     <element name="useToe" type="xsd:boolean" minOccurs="0"/>
                     <element name="runWithDebugInfo" type="xsd:boolean" minOccurs="0"/>
                     <element name="monitorType" type="xsd:string" minOccurs="0"/>
                     <element name="htSharing" type="xsd:string" minOccurs="0"/>
                     <element name="snapshotDisabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="snapshotLocked" type="xsd:boolean" minOccurs="0"/>
                     <element name="diskUuidEnabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="virtualMmuUsage" type="xsd:string" minOccurs="0"/>
                     <element name="virtualExecUsage" type="xsd:string" minOccurs="0"/>
                     <element name="snapshotPowerOffBehavior" type="xsd:string" minOccurs="0"/>
                     <element name="recordReplayEnabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="faultToleranceType" type="xsd:string" minOccurs="0"/>
                     <element name="cbrcCacheEnabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="vvtdEnabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="vbsEnabled" type="xsd:boolean" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - VirtualMachineFlagInfo(vim.vm.FlagInfo)

Data Object Description