VirtualHardwareOption

VirtualHardwareOption
VirtualHardwareOption

The VirtualHardwareOption data object contains the options available for all virtual devices.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "hwVersion": 0,
    "virtualDeviceOption": [
        {
            "_typeName": "string",
            "type": "string",
            "connectOption": {
                "_typeName": "string",
                "startConnected": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "supported": false,
                    "defaultValue": false
                },
                "allowGuestControl": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "supported": false,
                    "defaultValue": false
                }
            },
            "busSlotOption": {
                "_typeName": "string",
                "type": "string"
            },
            "controllerType": "string",
            "autoAssignController": {
                "_typeName": "string",
                "valueIsReadonly": false,
                "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": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "autoCoresPerSocket": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "supported": false,
        "defaultValue": false
    },
    "numCpuReadonly": false,
    "memoryMB": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numPCIControllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numIDEControllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numUSBControllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numUSBXHCIControllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numSIOControllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numPS2Controllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "licensingLimit": [
        "string"
    ],
    "numSupportedWwnPorts": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numSupportedWwnNodes": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "resourceConfigOption": {
        "_typeName": "string",
        "cpuAllocationOption": {
            "_typeName": "string",
            "sharesOption": {
                "_typeName": "string",
                "sharesOption": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "min": 0,
                    "max": 0,
                    "defaultValue": 0
                },
                "defaultLevel": "string"
            }
        },
        "memoryAllocationOption": {
            "_typeName": "string",
            "sharesOption": {
                "_typeName": "string",
                "sharesOption": {
                    "_typeName": "string",
                    "valueIsReadonly": false,
                    "min": 0,
                    "max": 0,
                    "defaultValue": 0
                },
                "defaultLevel": "string"
            }
        }
    },
    "numNVDIMMControllers": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numTPMDevices": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numWDTDevices": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numPrecisionClockDevices": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "epcMemoryMB": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "acpiHostBridgesFirmware": [
        "string"
    ],
    "numCpuSimultaneousThreads": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numNumaNodes": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "numDeviceGroups": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "min": 0,
        "max": 0,
        "defaultValue": 0
    },
    "deviceGroupTypes": [
        "string"
    ]
}
integer As int32 As int32
hwVersion
Required

The virtual hardware version.

virtualDeviceOption
Required

Array of virtual device options valid for this virtual machine configuration.

The list is unordered.

boolean
deviceListReadonly
Required

Whether the set of virtual devices can be changed, e.g., can devices be added or removed.

This does not preclude changing devices.

array of integer
numCPU
Required

List of acceptable values for the number of CPUs supported by this ConfigOption.

This is usually superceded by the information available in the guest operating system descriptors. The guest operating system descriptor describes a maximum CPU count, but the acceptable values are still constrained to the set specified here. The default value is stored at index 0 in the list.

numCoresPerSocket
Required

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

autoCoresPerSocket
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
numCpuReadonly
Required

Can the number of virtual CPUs be changed

memoryMB
Required

The LongOption data object type is used to define the minimum, maximum, and default values for a 64-bit long option.

numPCIControllers
Required

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

numIDEControllers
Required

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

numUSBControllers
Required

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

numUSBXHCIControllers
Required

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

numSIOControllers
Required

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

numPS2Controllers
Required

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

array of string
licensingLimit
Optional

List of propery names which limits are given be a licensing restriction of the underlying product, e.g., a limit that is not derived based on the product or hardware features.

For example, the property name "numCPU"

numSupportedWwnPorts
Optional

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

numSupportedWwnNodes
Optional

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

resourceConfigOption
Required

This data object type is a default value and value range specification for ResourceConfigSpec object.

numNVDIMMControllers
Optional

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

numTPMDevices
Optional

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

numWDTDevices
Optional

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

numPrecisionClockDevices
Optional

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

epcMemoryMB
Optional

The LongOption data object type is used to define the minimum, maximum, and default values for a 64-bit long option.

array of string
acpiHostBridgesFirmware
Optional

Empty for HWv17 & older, ["efi"] for HWv18.

Since: vSphere API Release 8.0.0.1

numCpuSimultaneousThreads
Optional

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

numNumaNodes
Optional

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

numDeviceGroups
Optional

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

array of string
deviceGroupTypes
Optional

Supported device group types.

Since: vSphere API Release 8.0.0.1