Data Object Description

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.
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
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.
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
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.
supportedMinMemMB	xsd:int	Minimum memory requirements supported for this guest, in MB.
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.
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
vRAMSizeInKB	IntOption	Video RAM size limits supported by this guest, in KB. *Since* vSphere API 5.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

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

xsd:string

Identifier (short name) for the guest operating system.

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

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.

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

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.

supportedMinMemMB

xsd:int

Minimum memory requirements supported for this guest, in MB.

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.

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

vRAMSizeInKB

IntOption

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

Since vSphere API 5.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:vim25="urn:vim25" name="GuestOsDescriptor">
            <complexContent>
               <extension base="vim25: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" minOccurs="0"/>
                     <element name="numSupportedCoresPerSocket" type="xsd:int" minOccurs="0"/>
                     <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" minOccurs="0"/>
                     <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="vim25:HostCpuIdInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="smcRequired" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportsWakeOnLan" type="xsd:boolean"/>
                     <element name="supportsVMI" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportsMemoryHotAdd" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportsCpuHotAdd" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportsCpuHotRemove" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportedFirmware" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="recommendedFirmware" type="xsd:string" minOccurs="0"/>
                     <element name="supportedUSBControllerList" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="recommendedUSBController" type="xsd:string" minOccurs="0"/>
                     <element name="supports3D" type="xsd:boolean" minOccurs="0"/>
                     <element name="recommended3D" type="xsd:boolean" minOccurs="0"/>
                     <element name="smcRecommended" type="xsd:boolean" minOccurs="0"/>
                     <element name="ich7mRecommended" type="xsd:boolean" minOccurs="0"/>
                     <element name="usbRecommended" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportLevel" type="xsd:string" minOccurs="0"/>
                     <element name="supportedForCreate" type="xsd:boolean" minOccurs="0"/>
                     <element name="vRAMSizeInKB" type="vim25:IntOption" minOccurs="0"/>
                     <element name="numSupportedFloppyDevices" type="xsd:int" minOccurs="0"/>
                     <element name="wakeOnLanEthernetCard" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="supportsPvscsiControllerForBoot" type="xsd:boolean" minOccurs="0"/>
                     <element name="diskUuidEnabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportsHotPlugPCI" type="xsd:boolean" minOccurs="0"/>
                     <element name="supportsSecureBoot" type="xsd:boolean" minOccurs="0"/>
                     <element name="defaultSecureBoot" type="xsd:boolean" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - GuestOsDescriptor(vim.vm.GuestOsDescriptor)

Data Object Description