GuestOsDescriptor
This data object type contains information to describe a particular guest operating system.
{
"_typeName": "string",
"id": "string",
"family": "string",
"fullName": "string",
"supportedMaxCPUs": 0,
"numSupportedPhysicalSockets": 0,
"numSupportedCoresPerSocket": 0,
"supportedMinMemMB": 0,
"supportedMaxMemMB": 0,
"recommendedMemMB": 0,
"recommendedColorDepth": 0,
"supportedDiskControllerList": [
"string"
],
"recommendedSCSIController": "string",
"recommendedDiskController": "string",
"supportedNumDisks": 0,
"recommendedDiskSizeMB": 0,
"recommendedCdromController": "string",
"supportedEthernetCard": [
"string"
],
"recommendedEthernetCard": "string",
"supportsSlaveDisk": false,
"cpuFeatureMask": [
{
"_typeName": "string",
"level": 0,
"vendor": "string",
"eax": "string",
"ebx": "string",
"ecx": "string",
"edx": "string"
}
],
"smcRequired": false,
"supportsWakeOnLan": false,
"supportsVMI": false,
"supportsMemoryHotAdd": false,
"supportsCpuHotAdd": false,
"supportsCpuHotRemove": false,
"supportedFirmware": [
"string"
],
"recommendedFirmware": "string",
"supportedUSBControllerList": [
"string"
],
"recommendedUSBController": "string",
"supports3D": false,
"recommended3D": false,
"smcRecommended": false,
"ich7mRecommended": false,
"usbRecommended": false,
"supportLevel": "string",
"supportedForCreate": false,
"vRAMSizeInKB": {
"_typeName": "string",
"valueIsReadonly": false,
"min": 0,
"max": 0,
"defaultValue": 0
},
"numSupportedFloppyDevices": 0,
"wakeOnLanEthernetCard": [
"string"
],
"supportsPvscsiControllerForBoot": false,
"diskUuidEnabled": false,
"supportsHotPlugPCI": false,
"supportsSecureBoot": false,
"defaultSecureBoot": false,
"persistentMemorySupported": false,
"supportedMinPersistentMemoryMB": 0,
"supportedMaxPersistentMemoryMB": 0,
"recommendedPersistentMemoryMB": 0,
"persistentMemoryHotAddSupported": false,
"persistentMemoryHotRemoveSupported": false,
"persistentMemoryColdGrowthSupported": false,
"persistentMemoryColdGrowthGranularityMB": 0,
"persistentMemoryHotGrowthSupported": false,
"persistentMemoryHotGrowthGranularityMB": 0,
"numRecommendedPhysicalSockets": 0,
"numRecommendedCoresPerSocket": 0,
"vvtdSupported": {
"_typeName": "string",
"valueIsReadonly": false,
"supported": false,
"defaultValue": false
},
"vbsSupported": {
"_typeName": "string",
"valueIsReadonly": false,
"supported": false,
"defaultValue": false
},
"vsgxSupported": {
"_typeName": "string",
"valueIsReadonly": false,
"supported": false,
"defaultValue": false
},
"vsgxRemoteAttestationSupported": false,
"supportsTPM20": false,
"recommendedTPM20": false,
"vwdtSupported": false
}Identifier (short name) for the guest operating system.
Family to which this guest operating system belongs.
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".
Maximum number of processors supported for this guest.
Maximum number of sockets supported for this guest.
Maximum number of cores per socket for this guest.
Minimum memory requirements supported for this guest, in MB.
Maximum memory requirements supported for this guest, in MB.
Recommended default memory size for this guest, in MB.
Recommended default color depth for this guest.
List of supported disk controller types for this guest.
Recommended default SCSI controller type for this guest.
Recommended default disk controller type for this guest.
Number of disks supported for this guest.
Recommended default disk size for this guest, in MB.
Recommended default CD-ROM type for this guest.
List of supported ethernet cards for this guest.
Recommended default ethernet controller type for this guest.
Flag to indicate whether or not this guest can support a disk configured as a slave.
Flag that indicates wether the guest requires an SMC (Apple hardware).
This is logically equivalent to GuestOS = Mac OS
Flag to indicate whether or not this guest can support Wake-on-LAN.
Flag indicating whether or not this guest supports the virtual machine interface.
Whether the memory size for this guest can be changed while the virtual machine is running.
Whether virtual CPUs can be added to this guest while the virtual machine is running.
Whether virtual CPUs can be removed from this guest while the virtual machine is running.
Supported firmware types for this guest.
Possible values are described in GuestOsDescriptorFirmwareTypeEnum
Recommended firmware type for this guest.
Possible values are described in GuestOsDescriptorFirmwareTypeEnum
List of supported USB controllers for this guest.
Recommended default USB controller type for this guest.
Whether this guest supports 3D graphics.
Recommended 3D graphics for this guest.
Whether SMC (Apple hardware) is recommended for this guest.
Whether I/O Controller Hub is recommended for this guest.
Whether USB controller is recommended for this guest.
Support level of this Guest Possible values are described in GuestOsDescriptorSupportLevelEnum
Whether or not this guest should be allowed for selection during virtual machine creation.
The IntOption data object type is used to define the minimum, maximum, and default values for an integer option.
Maximum number of floppies supported by this guest.
List of NICs supported by this guest that support Wake-On-Lan.
Whether or not this guest can use pvscsi as boot adapter.
Whether or not this guest should have disk uuid enabled by default.
Whether or not this guest supports hot plug of PCI devices.
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.
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.
Support of persistent memory (virtual NVDIMM device).
See also VirtualNVDIMM.
Minimum persistent memory supported for this guest, in MB.
Maximum persistent memory supported for this guest, in MB.
Total size of all the virtual NVDIMM devices should be less than this value.
Recommended default persistent memory size for this guest, in MB.
Support of persistent memory hot-add operation.
Support of persistent memory hot-remove operation.
Support of virtual NVDIMM cold-growth operation.
Virtual NVDIMM cold-growth granularity in MB.
Support of virtual NVDIMM hot-growth operation.
Virtual NVDIMM hot-growth granularity in MB.
Recommended number of sockets for this guest.
Recommended number of cores per socket for this guest.
The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.
The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.
The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.
Support for Intel Software Guard Extensions remote attestation.
Since: vSphere API Release 8.0.0.1
Support for TPM 2.0.
Support for default vTPM
Since: vSphere API Release 8.0.0.1
Support for Virtual Watchdog Timer.