Data Object - VirtualUSB(vim.vm.device.VirtualUSB)


Data Object Description

The VirtualUSB data object describes the USB device configuration for a virtual machine. You can attach a USB device to an ESX host. The device is available to only one virtual machine at a time. When you remove the device from the virtual machine, it becomes available to other virtual machines located on the host. You can add up to 20 USB devices to a virtual machine. Virtual USB support requires virtual machine hardware version 7 or later.

The VirtualUSB object represents either a configuration to be applied to the virtual machine or the current device configuration on the virtual machine.

To determine the USB options available on the host, use the QueryConfigOption method to retrieve the virtual machine configuration. The presence of the VirtualUSBOption object in the retrieved configuration (VirtualMachineConfigOption.hardwareOptions.virtualDeviceOption) indicates that the host supports USB connections.

The following operations will disconnect a USB device, losing data if data transfer is in progress over the USB connection.

The following services do not support USB connections.


Name Type Description

Flag indicating whether the device is currently connected. The virtual machine is not connected to the device if the autoconnect pattern specified in the USB device backing (VirtualDeviceDeviceBackingInfo.deviceName) can not be satisfied, either because there is no such device, or the matching device is not available. Valid only while the virtual machine is running.

Since VI API 2.5

Device class families. For possible values see VirtualMachineUsbInfoFamily.

Since vSphere API 4.1

Product ID of the USB device.

Since vSphere API 4.1

Device speeds detected by server. For possible values see VirtualMachineUsbInfoSpeed.

Since vSphere API 4.1

Vendor ID of the USB device.

Since vSphere API 4.1
Properties inherited from VirtualDevice
backing, connectable, controllerKey, deviceInfo, key, slotInfo, unitNumber
Properties inherited from DynamicData
*Need not be set
Show WSDL type definition