Environment Browser Query Config Option
Query for a specific virtual machine configuration option (the ConfigOption).
If the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, the key or host, or both arguments can be used to return the required config options. If a key is specified, then the ConfigOption corresponding to that key value is returned. If a host is specified, then the default ConfigOption for that host is returned. If key and host both are specified, the ConfigOption corresponding to the given key for that host is returned. If neither is specified, then the default ConfigOption for this environment browser is returned. Typically, the default contains the options for the most recent virtual hardware supported.
If the EnvironmentBrowser is from a VirtualMachine neither a host nor a key should be specified.
Required privileges: System.View
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case EnvironmentBrowser/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"key": "string",
"host": {
"type": "string",
"value": "string"
}
}The key found in the VirtualMachineConfigOptionDescriptor, obtained by invoking the EnvironmentBrowser.QueryConfigOptionDescriptor operation.
Returns the ConfigOption object. If invoked on a cluster with no hosts, or if the ConfigOption with given key is not found for the given host, null is returned.
{
"_typeName": "string",
"version": "string",
"description": "string",
"guestOSDescriptor": [
{
"_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": {
"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": {
"supported": false,
"defaultValue": false
},
"vbsSupported": {
"supported": false,
"defaultValue": false
},
"vsgxSupported": {
"supported": false,
"defaultValue": false
},
"vsgxRemoteAttestationSupported": false,
"supportsTPM20": false,
"recommendedTPM20": false,
"vwdtSupported": false
}
],
"guestOSDefaultIndex": 0,
"hardwareOptions": {
"hwVersion": 0,
"virtualDeviceOption": [
{
"_typeName": "string",
"type": "string",
"connectOption": {
"startConnected": {
"supported": false,
"defaultValue": false
},
"allowGuestControl": {
"supported": false,
"defaultValue": false
}
},
"busSlotOption": {
"type": "string"
},
"controllerType": "string",
"autoAssignController": {
"supported": false,
"defaultValue": false
},
"backingOption": [
{
"_typeName": "string",
"type": "string"
}
],
"defaultBackingOptionIndex": 0,
"licensingLimit": [
"string"
],
"deprecated": false,
"plugAndPlay": false,
"hotRemoveSupported": false,
"numaSupported": false
}
],
"deviceListReadonly": false,
"numCPU": [
0
],
"numCoresPerSocket": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"autoCoresPerSocket": {
"supported": false,
"defaultValue": false
},
"numCpuReadonly": false,
"memoryMB": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numPCIControllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numIDEControllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numUSBControllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numUSBXHCIControllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numSIOControllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numPS2Controllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"licensingLimit": [
"string"
],
"numSupportedWwnPorts": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numSupportedWwnNodes": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"resourceConfigOption": {
"cpuAllocationOption": {
"sharesOption": {
"sharesOption": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"defaultLevel": "string"
}
},
"memoryAllocationOption": {
"sharesOption": {
"sharesOption": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"defaultLevel": "string"
}
}
},
"numNVDIMMControllers": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numTPMDevices": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numWDTDevices": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numPrecisionClockDevices": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"epcMemoryMB": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"acpiHostBridgesFirmware": [
"string"
],
"numCpuSimultaneousThreads": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numNumaNodes": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"numDeviceGroups": {
"min": 0,
"max": 0,
"defaultValue": 0
},
"deviceGroupTypes": [
"string"
]
},
"capabilities": {
"snapshotOperationsSupported": false,
"multipleSnapshotsSupported": false,
"snapshotConfigSupported": false,
"poweredOffSnapshotsSupported": false,
"memorySnapshotsSupported": false,
"revertToSnapshotSupported": false,
"quiescedSnapshotsSupported": false,
"disableSnapshotsSupported": false,
"lockSnapshotsSupported": false,
"consolePreferencesSupported": false,
"cpuFeatureMaskSupported": false,
"s1AcpiManagementSupported": false,
"settingScreenResolutionSupported": false,
"toolsAutoUpdateSupported": false,
"vmNpivWwnSupported": false,
"npivWwnOnNonRdmVmSupported": false,
"vmNpivWwnDisableSupported": false,
"vmNpivWwnUpdateSupported": false,
"swapPlacementSupported": false,
"toolsSyncTimeSupported": false,
"virtualMmuUsageSupported": false,
"diskSharesSupported": false,
"bootOptionsSupported": false,
"bootRetryOptionsSupported": false,
"settingVideoRamSizeSupported": false,
"settingDisplayTopologySupported": false,
"recordReplaySupported": false,
"changeTrackingSupported": false,
"multipleCoresPerSocketSupported": false,
"hostBasedReplicationSupported": false,
"guestAutoLockSupported": false,
"memoryReservationLockSupported": false,
"featureRequirementSupported": false,
"poweredOnMonitorTypeChangeSupported": false,
"seSparseDiskSupported": false,
"nestedHVSupported": false,
"vPMCSupported": false,
"secureBootSupported": false,
"perVmEvcSupported": false,
"virtualMmuUsageIgnored": false,
"virtualExecUsageIgnored": false,
"diskOnlySnapshotOnSuspendedVMSupported": false,
"suspendToMemorySupported": false,
"toolsSyncTimeAllowSupported": false,
"sevSupported": false,
"pmemFailoverSupported": false,
"requireSgxAttestationSupported": false,
"changeModeDisksSupported": false,
"vendorDeviceGroupSupported": false
},
"datastore": {
"unsupportedVolumes": [
{
"_typeName": "string",
"fileSystemType": "string",
"majorVersion": 0
}
]
},
"defaultDevice": [
{
"_typeName": "string",
"key": 0,
"deviceInfo": {
"label": "string",
"summary": "string"
},
"backing": {
"_typeName": "string"
},
"connectable": {
"migrateConnect": "string",
"startConnected": false,
"allowGuestControl": false,
"connected": false,
"status": "string"
},
"slotInfo": {
"_typeName": "string"
},
"controllerKey": 0,
"unitNumber": 0,
"numaNode": 0,
"deviceGroupInfo": {
"groupInstanceKey": 0,
"sequenceId": 0
}
}
],
"supportedMonitorType": [
"string"
],
"supportedOvfEnvironmentTransport": [
"string"
],
"supportedOvfInstallTransport": [
"string"
],
"propertyRelations": [
{
"_typeName": "string",
"key": {
"name": "string",
"val": {
"_typeName": "string"
}
},
"relations": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
]
}
]
}The version corresponding to this configOption.
A description string for this configOption.
List of supported guest operating systems.
The choice of guest operating system may limit the set of valid devices. For example, you cannot select Vmxnet with all guest operating systems.
Index into guestOsDescriptor array denoting the default guest operating system.
The VirtualHardwareOption data object contains the options available for all virtual devices.
This data object type contains information about the operation/capabilities of a virtual machine
The DatastoreOption data object describes datastore options for a virtual machine.
The list of virtual devices that are created on a virtual machine by default.
Clients should not create these devices.
The monitor types supported by a host.
The acceptable monitor types are enumerated by VirtualMachineFlagInfoMonitorTypeEnum.
Specifies the supported property transports that are available for the OVF environment
Specifies the supported transports for the OVF installation phase.
The relations between the properties of the virtual machine config spec.