| Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
The VirtualUSB object represents either a configuration to be applied to the virtual machine or the current device configuration on the virtual machine.
To configure a USB device for a virtual machine, the virtual machine must have a USB controller. To add a controller, include a VirtualUSBController object in the virtual device specification for your virtual machine configuration. You can add only one USB controller to a 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.
Properties
Name | Type | Description |
---|---|---|
connected | xsd:boolean |
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 |
family* | xsd:string[] |
Device class families.
For possible values see
VirtualMachineUsbInfoFamily.
Since vSphere API 4.1 |
product* | xsd:int |
Product ID of the USB device.
Since vSphere API 4.1 |
speed* | xsd:string[] |
Device speeds detected by server.
For possible values see
VirtualMachineUsbInfoSpeed.
Since vSphere API 4.1 |
vendor* | xsd:int |
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 | ||
None |
Top of page | Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |