Data Object - VirtualDeviceOption

Property of
VirtualHardwareOption
Extended by
VirtualCdromOption, VirtualControllerOption, VirtualDiskOption, VirtualEthernetCardOption, VirtualFloppyOption, VirtualKeyboardOption, VirtualMachineVMCIDeviceOption, VirtualParallelPortOption, VirtualPCIPassthroughOption, VirtualPointingDeviceOption, VirtualSCSIPassthroughOption, VirtualSerialPortOption, VirtualSoundCardOption, VirtualUSBOption, VirtualVideoCardOption, VirtualVMIROMOption
Extends
DynamicData
See also
BoolOption, VirtualDeviceBackingOption, VirtualDeviceConnectOption

Data Object Description

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. We group 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 VirtualDeviceOption.BackingOption.

Properties

Name Type Description
autoAssignController*BoolOption

Flag to indicate whether or not this device will be auto-assigned a controller if one is required. If this is true, then a client need not explicitly create the controller that this device will plug into.
backingOption*VirtualDeviceBackingOption[]

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.
connectOption*VirtualDeviceConnectOption

If the device is connectable, then the connectOption describes the connect options and defaults.
controllerType*xsd:string

Data object type that denotes the controller option object that is valid for controlling this device.
defaultBackingOptionIndex*xsd:int

Index into the backingOption list, indicating the default backing.
deprecatedxsd:boolean

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.
hotRemoveSupportedxsd:boolean

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.

Since vSphere API 4.0
licensingLimit*xsd:string[]

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".
plugAndPlayxsd:boolean

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.
typexsd:string

The name of the run-time class the client should instantiate to create a run-time instance of this device.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition