VirtualDevice

VirtualDevice
VirtualDevice

VirtualDevice is the base data object type for devices in a virtual machine.

This type contains enough information about a virtual device to allow clients to display devices they do not recognize. For example, a client with an older version than the server to which it connects may see a device without knowing what it is.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": 0,
    "deviceInfo": {
        "_typeName": "string",
        "label": "string",
        "summary": "string"
    },
    "backing": {
        "_typeName": "string"
    },
    "connectable": {
        "_typeName": "string",
        "migrateConnect": "string",
        "startConnected": false,
        "allowGuestControl": false,
        "connected": false,
        "status": "string"
    },
    "slotInfo": {
        "_typeName": "string"
    },
    "controllerKey": 0,
    "unitNumber": 0,
    "numaNode": 0,
    "deviceGroupInfo": {
        "_typeName": "string",
        "groupInstanceKey": 0,
        "sequenceId": 0
    }
}
integer As int32 As int32
key
Required

A unique key that distinguishes this device from other devices in the same virtual machine.

Keys are immutable but may be recycled; that is, a key does not change as long as the device is associated with a particular virtual machine. However, once a device is removed, its key may be used when another device is added.

This property is not read-only, but the client cannot control its value. Persistent device keys are always assigned and managed by the server, which guarantees that all devices will have non-negative key values.

When adding new devices, it may be necessary for a client to assign keys temporarily in order to associate controllers with devices in configuring a virtual machine. However, the server does not allow a client to reassign a device key, and the server may assign a different value from the one passed during configuration. Clients should ensure that existing device keys are not reused as temporary key values for the new device to be added (for example, by using unique negative integers as temporary keys).

When editing or deleting a device, clients must use the server-provided key to refer to an existing device.

deviceInfo
Optional

Static strings used for describing an object or property.

backing
Optional

VirtualDeviceBackingInfo is a base data object type for information about the backing of a device in a virtual machine.

This base type does not define any properties. It is used as a namespace for general-purpose subtypes. Specific devices are represented by subtypes which define properties for device-specific backing information.

connectable
Optional

The VirtualDeviceConnectInfo data object type contains information about connectable virtual devices.

slotInfo
Optional

VirtualDeviceBusSlotInfo is a base data object type for information about device connection to its bus.

This base type does not define any properties. It is used as a namespace for general-purpose subtypes. Specific devices types are represented by subtypes which define properties for device-specific backing information.

integer As int32 As int32
controllerKey
Optional

Object key for the controller object for this device.

This property contains the key property value of the controller device object.

integer As int32 As int32
unitNumber
Optional

The unit number of this device on its controller.

This property is null if the controller property is null (for example, when the device is not attached to a specific controller object).

Normally, two devices on the same controller may not be assigned the same unit number. If multiple devices could exist on a controller, then unit number has to be specified to configure respective devices.

integer As int32 As int32
numaNode
Optional

The virtual NUMA node.

A negative number means there is no affinity for the device. A positive number is a vNUMA node. An unset value of numaNode is status-quo during Reconfigure time. If numaNode is unset during ConfigInfo, then it means there is no affinity for the device.

Since: vSphere API Release 8.0.0.1

deviceGroupInfo
Optional

VirtualDeviceDeviceGroupInfo contains information about the device group device is assigned to.

Since: vSphere API Release 8.0.0.1