VirtualDeviceOption

VirtualDeviceOption
VirtualDeviceOption

The VirtualDeviceOption data object type contains information about a virtual device type, the options for configuring the virtual device, and the relationship between this virtual device and other devices.

The vSphere API groups device configurations that are mutually exclusive into different configuration objects; each of these configuration objects may define subtypes for virtual device backing options that are independent of the virtual device. Backing-dependent options should appear in a subtype of VirtualDeviceBackingOption.

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

The name of the run-time class the client should instantiate to create a run-time instance of this device.

VirtualDeviceConnectOption
connectOption
Optional

The ConnectOption data object type contains information about options for connectable virtual devices.

VirtualDeviceBusSlotOption
busSlotOption
Optional

The VirtualDeviceBusSlotOption data class defines options for device-specific bus slot objects.

string
controllerType
Optional

Data object type that denotes the controller option object that is valid for controlling this device.

BoolOption
autoAssignController
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.

array of VirtualDeviceBackingOption
backingOption
Optional

A list of backing options that can be used to map the virtual device to the host.

The list is optional, since some devices exist only within the virtual machine; for example, a VirtualController.

integer As int32 As int32
defaultBackingOptionIndex
Optional

Index into the backingOption list, indicating the default backing.

array of string
licensingLimit
Optional

List of property names enforced by a licensing restriction of the underlying product.

For example, a limit that is not derived based on the product or hardware features; the property name "numCPU".

boolean
deprecated
Required

Indicates whether this device is deprecated.

Hence, if set the device cannot be used when creating a new virtual machine or be added to an existing virtual machine. However, the device is still supported by the platform.

boolean
plugAndPlay
Required

Indicates if this type of device can be hot-added to the virtual machine via a reconfigure operation when the virtual machine is powered on.

boolean
hotRemoveSupported
Required

Indicates if this type of device can be hot-removed from the virtual machine via a reconfigure operation when the virtual machine is powered on.

boolean
numaSupported
Optional

Since: vSphere API Release 8.0.0.1

Property Of
Used By