GuestOsDescriptor

GuestOsDescriptor
GuestOsDescriptor

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

AllOf
This class requires all of the following:
JSON Example
{
    "_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
}
string
id
Required

Identifier (short name) for the guest operating system.

string
family
Required

Family to which this guest operating system belongs.

string
fullName
Required

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

integer As int32 As int32
supportedMaxCPUs
Required

Maximum number of processors supported for this guest.

integer As int32 As int32
numSupportedPhysicalSockets
Required

Maximum number of sockets supported for this guest.

integer As int32 As int32
numSupportedCoresPerSocket
Required

Maximum number of cores per socket for this guest.

integer As int32 As int32
supportedMinMemMB
Required

Minimum memory requirements supported for this guest, in MB.

integer As int32 As int32
supportedMaxMemMB
Required

Maximum memory requirements supported for this guest, in MB.

integer As int32 As int32
recommendedMemMB
Required

Recommended default memory size for this guest, in MB.

integer As int32 As int32
recommendedColorDepth
Required

Recommended default color depth for this guest.

array of string
supportedDiskControllerList
Required

List of supported disk controller types for this guest.

string
recommendedSCSIController
Optional

Recommended default SCSI controller type for this guest.

string
recommendedDiskController
Required

Recommended default disk controller type for this guest.

integer As int32 As int32
supportedNumDisks
Required

Number of disks supported for this guest.

integer As int32 As int32
recommendedDiskSizeMB
Required

Recommended default disk size for this guest, in MB.

string
recommendedCdromController
Required

Recommended default CD-ROM type for this guest.

array of string
supportedEthernetCard
Required

List of supported ethernet cards for this guest.

string
recommendedEthernetCard
Optional

Recommended default ethernet controller type for this guest.

boolean
supportsSlaveDisk
Optional

Flag to indicate whether or not this guest can support a disk configured as a slave.

cpuFeatureMask
Optional

Specifies the CPU feature compatibility masks.

boolean
smcRequired
Required

Flag that indicates wether the guest requires an SMC (Apple hardware).

This is logically equivalent to GuestOS = Mac OS

boolean
supportsWakeOnLan
Required

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

boolean
supportsVMI
Required

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

boolean
supportsMemoryHotAdd
Required

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

boolean
supportsCpuHotAdd
Required

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

boolean
supportsCpuHotRemove
Required

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

array of string
supportedFirmware
Required

Supported firmware types for this guest.

Possible values are described in GuestOsDescriptorFirmwareTypeEnum

string
recommendedFirmware
Required

Recommended firmware type for this guest.

Possible values are described in GuestOsDescriptorFirmwareTypeEnum

array of string
supportedUSBControllerList
Optional

List of supported USB controllers for this guest.

string
recommendedUSBController
Optional

Recommended default USB controller type for this guest.

boolean
supports3D
Required

Whether this guest supports 3D graphics.

boolean
recommended3D
Required

Recommended 3D graphics for this guest.

boolean
smcRecommended
Required

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

boolean
ich7mRecommended
Required

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

boolean
usbRecommended
Required

Whether USB controller is recommended for this guest.

string
supportLevel
Required

Support level of this Guest Possible values are described in GuestOsDescriptorSupportLevelEnum

boolean
supportedForCreate
Required

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

vRAMSizeInKB
Required

The IntOption data object type is used to define the minimum, maximum, and default values for an integer option.

integer As int32 As int32
numSupportedFloppyDevices
Required

Maximum number of floppies supported by this guest.

array of string
wakeOnLanEthernetCard
Optional

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

boolean
supportsPvscsiControllerForBoot
Required

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

boolean
diskUuidEnabled
Required

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

boolean
supportsHotPlugPCI
Required

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

boolean
supportsSecureBoot
Optional

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.

boolean
defaultSecureBoot
Optional

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.

boolean
persistentMemorySupported
Optional

Support of persistent memory (virtual NVDIMM device).

See also VirtualNVDIMM.

integer As int64 As int64
supportedMinPersistentMemoryMB
Optional

Minimum persistent memory supported for this guest, in MB.

integer As int64 As int64
supportedMaxPersistentMemoryMB
Optional

Maximum persistent memory supported for this guest, in MB.

Total size of all the virtual NVDIMM devices should be less than this value.

integer As int64 As int64
recommendedPersistentMemoryMB
Optional

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

boolean
persistentMemoryHotAddSupported
Optional

Support of persistent memory hot-add operation.

boolean
persistentMemoryHotRemoveSupported
Optional

Support of persistent memory hot-remove operation.

boolean
persistentMemoryColdGrowthSupported
Optional

Support of virtual NVDIMM cold-growth operation.

integer As int64 As int64
persistentMemoryColdGrowthGranularityMB
Optional

Virtual NVDIMM cold-growth granularity in MB.

boolean
persistentMemoryHotGrowthSupported
Optional

Support of virtual NVDIMM hot-growth operation.

integer As int64 As int64
persistentMemoryHotGrowthGranularityMB
Optional

Virtual NVDIMM hot-growth granularity in MB.

integer As int32 As int32
numRecommendedPhysicalSockets
Optional

Recommended number of sockets for this guest.

integer As int32 As int32
numRecommendedCoresPerSocket
Optional

Recommended number of cores per socket for this guest.

vvtdSupported
Optional

The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.

vbsSupported
Optional

The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.

vsgxSupported
Optional

The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.

boolean
vsgxRemoteAttestationSupported
Optional

Support for Intel Software Guard Extensions remote attestation.

Since: vSphere API Release 8.0.0.1

boolean
supportsTPM20
Optional

Support for TPM 2.0.

boolean
recommendedTPM20
Optional

Support for default vTPM

Since: vSphere API Release 8.0.0.1

boolean
vwdtSupported
Optional

Support for Virtual Watchdog Timer.