Data Object - GuestOsDescriptor(vim.vm.GuestOsDescriptor)

Property of
VirtualMachineConfigOption
Extends
DynamicData
See also
BoolOption, HostCpuIdInfo, IntOption

Data Object Description

This data object type contains information to describe a particular guest operating system.

Properties

Name Type Description
cpuFeatureMask*HostCpuIdInfo[]

Specifies the CPU feature compatibility masks.
defaultSecureBoot*xsd:boolean

Whether or not Secure Boot should be enabled by default for this guest OS. If all OS releases that fall under this guest OS descriptor support Secure Boot and are known to operate correctly with Secure Boot enabled, it is reasonable to enable it by default. Only meaningful when virtual EFI firmware is in use.

Since vSphere API 6.5
diskUuidEnabledxsd:boolean

Whether or not this guest should have disk uuid enabled by default.

Since vSphere API 6.0
familyxsd:string

Family to which this guest operating system belongs.
fullNamexsd:string

Full name of the guest operating system. For example, if the value of "id" is "win2000Pro", then the value of "fullName" is "Windows 2000 Professional".
ich7mRecommendedxsd:boolean

Whether I/O Controller Hub is recommended for this guest.

Since vSphere API 5.0
idxsd:string

Identifier (short name) for the guest operating system.
numRecommendedCoresPerSocket*xsd:int

Recommended number of cores per socket for this guest.

Since vSphere API 6.7
numRecommendedPhysicalSockets*xsd:int

Recommended number of sockets for this guest.

Since vSphere API 6.7
numSupportedCoresPerSocketxsd:int

Maximum number of cores per socket for this guest.

Since vSphere API 5.0
numSupportedFloppyDevicesxsd:int

Maximum number of floppies supported by this guest.

Since vSphere API 6.0
numSupportedPhysicalSocketsxsd:int

Maximum number of sockets supported for this guest.

Since vSphere API 5.0
persistentMemoryColdGrowthGranularityMB*xsd:long

Virtual NVDIMM cold-growth granularity in MB.

Since vSphere API 6.7
persistentMemoryColdGrowthSupported*xsd:boolean

Support of virtual NVDIMM cold-growth operation.

Since vSphere API 6.7
persistentMemoryHotAddSupported*xsd:boolean

Support of persistent memory hot-add operation.

Since vSphere API 6.7
persistentMemoryHotGrowthGranularityMB*xsd:long

Virtual NVDIMM hot-growth granularity in MB.

Since vSphere API 6.7
persistentMemoryHotGrowthSupported*xsd:boolean

Support of virtual NVDIMM hot-growth operation.

Since vSphere API 6.7
persistentMemoryHotRemoveSupported*xsd:boolean

Support of persistent memory hot-remove operation.

Since vSphere API 6.7
persistentMemorySupported*xsd:boolean

Support of persistent memory (virtual NVDIMM device).
See VirtualNVDIMM

Since vSphere API 6.7
recommended3Dxsd:boolean

Recommended 3D graphics for this guest.

Since vSphere API 5.1
recommendedCdromControllerxsd:string

Recommended default CD-ROM type for this guest.

Since vSphere API 5.5
recommendedColorDepthxsd:int

Recommended default color depth for this guest.
recommendedDiskControllerxsd:string

Recommended default disk controller type for this guest.
recommendedDiskSizeMBxsd:int

Recommended default disk size for this guest, in MB.
recommendedEthernetCard*xsd:string

Recommended default ethernet controller type for this guest.
recommendedFirmwarexsd:string

Recommended firmware type for this guest. Possible values are described in GuestOsDescriptorFirmwareType

Since vSphere API 5.0
recommendedMemMBxsd:int

Recommended default memory size for this guest, in MB.
recommendedPersistentMemoryMB*xsd:long

Recommended default persistent memory size for this guest, in MB.

Since vSphere API 6.7
recommendedSCSIController*xsd:string

Recommended default SCSI controller type for this guest.
recommendedUSBController*xsd:string

Recommended default USB controller type for this guest.

Since vSphere API 5.0
smcRecommendedxsd:boolean

Whether SMC (Apple hardware) is recommended for this guest.

Since vSphere API 5.0
smcRequiredxsd:boolean

Flag that indicates wether the guest requires an SMC (Apple hardware). This is logically equivalent to GuestOS = Mac OS

Since vSphere API 5.0
supportedDiskControllerListxsd:string[]

List of supported disk controller types for this guest.
supportedEthernetCardxsd:string[]

List of supported ethernet cards for this guest.
supportedFirmwarexsd:string[]

Supported firmware types for this guest. Possible values are described in GuestOsDescriptorFirmwareType

Since vSphere API 5.0
supportedForCreatexsd:boolean

Whether or not this guest should be allowed for selection during virtual machine creation.

Since vSphere API 5.0
supportedMaxCPUsxsd:int

Maximum number of processors supported for this guest.
supportedMaxMemMBxsd:int

Maximum memory requirements supported for this guest, in MB.
supportedMaxPersistentMemoryMB*xsd:long

Maximum persistent memory supported for this guest, in MB. Total size of all the virtual NVDIMM devices should be less than this value.

Since vSphere API 6.7
supportedMinMemMBxsd:int

Minimum memory requirements supported for this guest, in MB.
supportedMinPersistentMemoryMB*xsd:long

Minimum persistent memory supported for this guest, in MB.

Since vSphere API 6.7
supportedNumDisksxsd:int

Number of disks supported for this guest.
supportedUSBControllerList*xsd:string[]

List of supported USB controllers for this guest.

Since vSphere API 5.0
supportLevelxsd:string

Support level of this Guest Possible values are described in GuestOsDescriptorSupportLevel

Since vSphere API 5.0
supports3Dxsd:boolean

Whether this guest supports 3D graphics.

Since vSphere API 5.0
supportsCpuHotAddxsd:boolean

Whether virtual CPUs can be added to this guest while the virtual machine is running.

Since vSphere API 4.0
supportsCpuHotRemovexsd:boolean

Whether virtual CPUs can be removed from this guest while the virtual machine is running.

Since vSphere API 4.0
supportsHotPlugPCIxsd:boolean

Whether or not this guest supports hot plug of PCI devices.

Since vSphere API 6.0
supportsMemoryHotAddxsd:boolean

Whether the memory size for this guest can be changed while the virtual machine is running.

Since vSphere API 4.0
supportsPvscsiControllerForBootxsd:boolean

Whether or not this guest can use pvscsi as boot adapter.

Since vSphere API 6.0
supportsSecureBoot*xsd:boolean

Whether or not this guest supports Secure Boot. If some of the OS releases that fall under this guest OS descriptor support Secure Boot, it is reasonable to offer the ability to enable Secure Boot. Only meaningful when virtual EFI firmware is in use.

Since vSphere API 6.5
supportsSlaveDisk*xsd:boolean

Flag to indicate whether or not this guest can support a disk configured as a slave.
supportsTPM20*xsd:boolean

Support for TPM 2.0.

Since vSphere API 6.7
supportsVMIxsd:boolean

Flag indicating whether or not this guest supports the virtual machine interface.

Since vSphere API 4.0
supportsWakeOnLanxsd:boolean

Flag to indicate whether or not this guest can support Wake-on-LAN.
usbRecommendedxsd:boolean

Whether USB controller is recommended for this guest.

Since vSphere API 5.0
vbsSupported*BoolOption

Support of Virtualization-based security.

Since vSphere API 6.7
vRAMSizeInKBIntOption

Video RAM size limits supported by this guest, in KB.

Since vSphere API 5.0
vvtdSupported*BoolOption

Support of Intel Virtualization Technology for Directed I/O.

Since vSphere API 6.7
wakeOnLanEthernetCard*xsd:string[]

List of NICs supported by this guest that support Wake-On-Lan.

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