# Data Object - GuestOsDescriptor(vim.vm.GuestOsDescriptor)

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

## 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
diskUuidEnabled | xsd:boolean | Whether or not this guest should have disk uuid enabled by default. Since vSphere API 6.0
family | xsd:string | Family to which this guest operating system belongs.
fullName | xsd: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".
ich7mRecommended | xsd:boolean | Whether I/O Controller Hub is recommended for this guest. Since vSphere API 5.0
id | xsd: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
numSupportedCoresPerSocket | xsd:int | Maximum number of cores per socket for this guest. Since vSphere API 5.0
numSupportedFloppyDevices | xsd:int | Maximum number of floppies supported by this guest. Since vSphere API 6.0
numSupportedPhysicalSockets | xsd: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
recommended3D | xsd:boolean | Recommended 3D graphics for this guest. Since vSphere API 5.1
recommendedCdromController | xsd:string | Recommended default CD-ROM type for this guest. Since vSphere API 5.5
recommendedColorDepth | xsd:int | Recommended default color depth for this guest.
recommendedDiskController | xsd:string | Recommended default disk controller type for this guest.
recommendedDiskSizeMB | xsd:int | Recommended default disk size for this guest, in MB.
recommendedEthernetCard* | xsd:string | Recommended default ethernet controller type for this guest.
recommendedFirmware | xsd:string | Recommended firmware type for this guest. Possible values are described in GuestOsDescriptorFirmwareType Since vSphere API 5.0
recommendedMemMB | xsd: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.
recommendedTPM20* | xsd:boolean | Support for default vTPM Since 8.0.0.1
recommendedUSBController* | xsd:string | Recommended default USB controller type for this guest. Since vSphere API 5.0
smcRecommended | xsd:boolean | Whether SMC (Apple hardware) is recommended for this guest. Since vSphere API 5.0
smcRequired | xsd: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
supportedDiskControllerList | xsd:string[] | List of supported disk controller types for this guest.
supportedEthernetCard | xsd:string[] | List of supported ethernet cards for this guest.
supportedFirmware | xsd:string[] | Supported firmware types for this guest. Possible values are described in GuestOsDescriptorFirmwareType Since vSphere API 5.0
supportedForCreate | xsd:boolean | Whether or not this guest should be allowed for selection during virtual machine creation. Since vSphere API 5.0
supportedMaxCPUs | xsd:int | Maximum number of processors supported for this guest.
supportedMaxMemMB | xsd: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
supportedMinMemMB | xsd: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
supportedNumDisks | xsd:int | Number of disks supported for this guest.
supportedUSBControllerList* | xsd:string[] | List of supported USB controllers for this guest. Since vSphere API 5.0
supportLevel | xsd:string | Support level of this Guest Possible values are described in GuestOsDescriptorSupportLevel Since vSphere API 5.0
supports3D | xsd:boolean | Whether this guest supports 3D graphics. Since vSphere API 5.0
supportsCpuHotAdd | xsd:boolean | Whether virtual CPUs can be added to this guest while the virtual machine is running. Since vSphere API 4.0
supportsCpuHotRemove | xsd:boolean | Whether virtual CPUs can be removed from this guest while the virtual machine is running. Since vSphere API 4.0
supportsHotPlugPCI | xsd:boolean | Whether or not this guest supports hot plug of PCI devices. Since vSphere API 6.0
supportsMemoryHotAdd | xsd:boolean | Whether the memory size for this guest can be changed while the virtual machine is running. Since vSphere API 4.0
supportsPvscsiControllerForBoot | xsd: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
supportsVMI | xsd:boolean | Flag indicating whether or not this guest supports the virtual machine interface. Since vSphere API 4.0
supportsWakeOnLan | xsd:boolean | Flag to indicate whether or not this guest can support Wake-on-LAN.
usbRecommended | xsd: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
vRAMSizeInKB | IntOption | Video RAM size limits supported by this guest, in KB. Since vSphere API 5.0
vsgxRemoteAttestationSupported* | xsd:boolean | Support for Intel Software Guard Extensions remote attestation. Since 8.0.0.1
vsgxSupported* | BoolOption | Support for Intel Software Guard Extensions Since vSphere API 7.0
vvtdSupported* | BoolOption | Support of Intel Virtualization Technology for Directed I/O. Since vSphere API 6.7
vwdtSupported* | xsd:boolean | Support for Virtual Watchdog Timer. Since vSphere API 7.0
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
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GuestOsDescriptor"> <complexContent> <extension base="vsan:DynamicData"> <sequence> <element name="id" type="xsd:string"/> <element name="family" type="xsd:string"/> <element name="fullName" type="xsd:string"/> <element name="supportedMaxCPUs" type="xsd:int"/> <element name="numSupportedPhysicalSockets" type="xsd:int"/> <element name="numSupportedCoresPerSocket" type="xsd:int"/> <element name="supportedMinMemMB" type="xsd:int"/> <element name="supportedMaxMemMB" type="xsd:int"/> <element name="recommendedMemMB" type="xsd:int"/> <element name="recommendedColorDepth" type="xsd:int"/> <element name="supportedDiskControllerList" type="xsd:string" maxOccurs="unbounded"/> <element name="recommendedSCSIController" type="xsd:string" minOccurs="0"/> <element name="recommendedDiskController" type="xsd:string"/> <element name="supportedNumDisks" type="xsd:int"/> <element name="recommendedDiskSizeMB" type="xsd:int"/> <element name="recommendedCdromController" type="xsd:string"/> <element name="supportedEthernetCard" type="xsd:string" maxOccurs="unbounded"/> <element name="recommendedEthernetCard" type="xsd:string" minOccurs="0"/> <element name="supportsSlaveDisk" type="xsd:boolean" minOccurs="0"/> <element name="cpuFeatureMask" type="vsan:HostCpuIdInfo" minOccurs="0" maxOccurs="unbounded"/> <element name="smcRequired" type="xsd:boolean"/> <element name="supportsWakeOnLan" type="xsd:boolean"/> <element name="supportsVMI" type="xsd:boolean"/> <element name="supportsMemoryHotAdd" type="xsd:boolean"/> <element name="supportsCpuHotAdd" type="xsd:boolean"/> <element name="supportsCpuHotRemove" type="xsd:boolean"/> <element name="supportedFirmware" type="xsd:string" maxOccurs="unbounded"/> <element name="recommendedFirmware" type="xsd:string"/> <element name="supportedUSBControllerList" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="recommendedUSBController" type="xsd:string" minOccurs="0"/> <element name="supports3D" type="xsd:boolean"/> <element name="recommended3D" type="xsd:boolean"/> <element name="smcRecommended" type="xsd:boolean"/> <element name="ich7mRecommended" type="xsd:boolean"/> <element name="usbRecommended" type="xsd:boolean"/> <element name="supportLevel" type="xsd:string"/> <element name="supportedForCreate" type="xsd:boolean"/> <element name="vRAMSizeInKB" type="vsan:IntOption"/> <element name="numSupportedFloppyDevices" type="xsd:int"/> <element name="wakeOnLanEthernetCard" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="supportsPvscsiControllerForBoot" type="xsd:boolean"/> <element name="diskUuidEnabled" type="xsd:boolean"/> <element name="supportsHotPlugPCI" type="xsd:boolean"/> <element name="supportsSecureBoot" type="xsd:boolean" minOccurs="0"/> <element name="defaultSecureBoot" type="xsd:boolean" minOccurs="0"/> <element name="persistentMemorySupported" type="xsd:boolean" minOccurs="0"/> <element name="supportedMinPersistentMemoryMB" type="xsd:long" minOccurs="0"/> <element name="supportedMaxPersistentMemoryMB" type="xsd:long" minOccurs="0"/> <element name="recommendedPersistentMemoryMB" type="xsd:long" minOccurs="0"/> <element name="persistentMemoryHotAddSupported" type="xsd:boolean" minOccurs="0"/> <element name="persistentMemoryHotRemoveSupported" type="xsd:boolean" minOccurs="0"/> <element name="persistentMemoryColdGrowthSupported" type="xsd:boolean" minOccurs="0"/> <element name="persistentMemoryColdGrowthGranularityMB" type="xsd:long" minOccurs="0"/> <element name="persistentMemoryHotGrowthSupported" type="xsd:boolean" minOccurs="0"/> <element name="persistentMemoryHotGrowthGranularityMB" type="xsd:long" minOccurs="0"/> <element name="numRecommendedPhysicalSockets" type="xsd:int" minOccurs="0"/> <element name="numRecommendedCoresPerSocket" type="xsd:int" minOccurs="0"/> <element name="vvtdSupported" type="vsan:BoolOption" minOccurs="0"/> <element name="vbsSupported" type="vsan:BoolOption" minOccurs="0"/> <element name="vsgxSupported" type="vsan:BoolOption" minOccurs="0"/> <element name="vsgxRemoteAttestationSupported" type="xsd:boolean" minOccurs="0"/> <element name="supportsTPM20" type="xsd:boolean" minOccurs="0"/> <element name="recommendedTPM20" type="xsd:boolean" minOccurs="0"/> <element name="vwdtSupported" type="xsd:boolean" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>