| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!DOCTYPE topic
|
|---|
| 3 | PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 4 | <topic xml:lang="en-us" id="settings-usb">
|
|---|
| 5 | <title>USB Settings</title>
|
|---|
| 6 |
|
|---|
| 7 | <body>
|
|---|
| 8 | <p>
|
|---|
| 9 | The <b outputclass="bold">USB</b> section in a virtual
|
|---|
| 10 | machine's <b outputclass="bold">Settings</b> window
|
|---|
| 11 | enables you to configure <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s sophisticated USB
|
|---|
| 12 | support.
|
|---|
| 13 | </p>
|
|---|
| 14 | <p>
|
|---|
| 15 | <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can enable virtual machines to access the USB
|
|---|
| 16 | devices on your host directly. To achieve this, <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
|
|---|
| 17 | presents the guest OS with a virtual USB controller. As soon as
|
|---|
| 18 | the guest system starts using a USB device, it will appear as
|
|---|
| 19 | unavailable on the host.
|
|---|
| 20 | </p>
|
|---|
| 21 | <note>
|
|---|
| 22 | <ul>
|
|---|
| 23 | <li>
|
|---|
| 24 | <p>
|
|---|
| 25 | Be careful with USB devices that are currently in use on
|
|---|
| 26 | the host. For example, if you allow your guest to connect
|
|---|
| 27 | to your USB hard disk that is currently mounted on the
|
|---|
| 28 | host, when the guest is activated, it will be disconnected
|
|---|
| 29 | from the host without a proper shutdown. This may cause
|
|---|
| 30 | data loss.
|
|---|
| 31 | </p>
|
|---|
| 32 | </li>
|
|---|
| 33 | <li>
|
|---|
| 34 | <p>
|
|---|
| 35 | Oracle Solaris hosts have a few known limitations
|
|---|
| 36 | regarding USB support. See <xref href="KnownIssues.dita">Known Limitations</xref>.
|
|---|
| 37 | </p>
|
|---|
| 38 | </li>
|
|---|
| 39 | </ul>
|
|---|
| 40 | </note>
|
|---|
| 41 | <p>
|
|---|
| 42 | In addition to allowing a guest access to your local USB
|
|---|
| 43 | devices, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> even enables your guests to connect to
|
|---|
| 44 | remote USB devices by use of the VirtualBox Remote Desktop
|
|---|
| 45 | Extension (VRDE). See <xref href="usb-over-rdp.dita">Remote USB</xref>.
|
|---|
| 46 | </p>
|
|---|
| 47 | <p>
|
|---|
| 48 | To enable USB for a VM, select the <b outputclass="bold">Enable
|
|---|
| 49 | USB Controller</b> check box. The following settings are
|
|---|
| 50 | available:
|
|---|
| 51 | </p>
|
|---|
| 52 | <ul>
|
|---|
| 53 | <li>
|
|---|
| 54 | <p>
|
|---|
| 55 | <b outputclass="bold">USB Controller:</b> Selects a
|
|---|
| 56 | controller with the specified level of USB support, as
|
|---|
| 57 | follows:
|
|---|
| 58 | </p>
|
|---|
| 59 | <ul>
|
|---|
| 60 | <li>
|
|---|
| 61 | <p>
|
|---|
| 62 | OHCI for USB 1.1
|
|---|
| 63 | </p>
|
|---|
| 64 | </li>
|
|---|
| 65 | <li>
|
|---|
| 66 | <p>
|
|---|
| 67 | EHCI for USB 2.0. This also enables OHCI.
|
|---|
| 68 | </p>
|
|---|
| 69 | </li>
|
|---|
| 70 | <li>
|
|---|
| 71 | <p>
|
|---|
| 72 | xHCI for USB 3.0. This supports all USB speeds.
|
|---|
| 73 | </p>
|
|---|
| 74 | </li>
|
|---|
| 75 | </ul>
|
|---|
| 76 | </li>
|
|---|
| 77 | <li>
|
|---|
| 78 | <p>
|
|---|
| 79 | <b outputclass="bold">USB Device Filters:</b> When
|
|---|
| 80 | USB support is enabled for a VM, you can determine in detail
|
|---|
| 81 | which devices will be automatically attached to the guest.
|
|---|
| 82 | For this, you can create filters by specifying certain
|
|---|
| 83 | properties of the USB device. USB devices with a matching
|
|---|
| 84 | filter will be automatically passed to the guest once they
|
|---|
| 85 | are attached to the host. USB devices without a matching
|
|---|
| 86 | filter can be passed manually to the guest, for example by
|
|---|
| 87 | using the <b outputclass="bold">Devices</b>,
|
|---|
| 88 | <b outputclass="bold">USB</b> menu.
|
|---|
| 89 | </p>
|
|---|
| 90 | <p>
|
|---|
| 91 | Clicking on the <b outputclass="bold">+</b> button to
|
|---|
| 92 | the right of the <b outputclass="bold">USB Device
|
|---|
| 93 | Filters</b> window creates a new filter. You can give
|
|---|
| 94 | the filter a name, for later reference, and specify the
|
|---|
| 95 | filter criteria. The more criteria you specify, the more
|
|---|
| 96 | precisely devices will be selected. For instance, if you
|
|---|
| 97 | specify only a vendor ID of 046d, all devices produced by
|
|---|
| 98 | Logitech will be available to the guest. If you fill in all
|
|---|
| 99 | fields, on the other hand, the filter will only apply to a
|
|---|
| 100 | particular device model from a particular vendor, and not
|
|---|
| 101 | even to other devices of the same type with a different
|
|---|
| 102 | revision and serial number.
|
|---|
| 103 | </p>
|
|---|
| 104 | <p>
|
|---|
| 105 | In detail, the following criteria are available:
|
|---|
| 106 | </p>
|
|---|
| 107 | <ul>
|
|---|
| 108 | <li>
|
|---|
| 109 | <p>
|
|---|
| 110 | <b outputclass="bold">Vendor and Product ID.</b>
|
|---|
| 111 | With USB, each vendor of USB products carries an
|
|---|
| 112 | identification number that is unique world-wide, called
|
|---|
| 113 | the <i>vendor ID</i>. Similarly, each line
|
|---|
| 114 | of products is assigned a <i>product
|
|---|
| 115 | ID</i> number. Both numbers are commonly written
|
|---|
| 116 | in hexadecimal, and a colon separates the vendor from
|
|---|
| 117 | the product ID. For example,
|
|---|
| 118 | <codeph>046d:c016</codeph> stands for Logitech as a
|
|---|
| 119 | vendor, and the M-UV69a Optical Wheel Mouse product.
|
|---|
| 120 | </p>
|
|---|
| 121 | <p>
|
|---|
| 122 | Alternatively, you can also specify
|
|---|
| 123 | <b outputclass="bold">Manufacturer</b> and
|
|---|
| 124 | <b outputclass="bold">Product</b> by name.
|
|---|
| 125 | </p>
|
|---|
| 126 | <p>
|
|---|
| 127 | To list all the USB devices that are connected to your
|
|---|
| 128 | host machine with their respective vendor IDs and
|
|---|
| 129 | product IDs, use the following command:
|
|---|
| 130 | </p>
|
|---|
| 131 | <pre xml:space="preserve">VBoxManage list usbhost</pre>
|
|---|
| 132 | <p>
|
|---|
| 133 | On Windows, you can also see all USB devices that are
|
|---|
| 134 | attached to your system in the Device Manager. On Linux,
|
|---|
| 135 | you can use the <userinput>lsusb</userinput> command.
|
|---|
| 136 | </p>
|
|---|
| 137 | </li>
|
|---|
| 138 | <li>
|
|---|
| 139 | <p>
|
|---|
| 140 | <b outputclass="bold">Serial Number.</b> While
|
|---|
| 141 | vendor ID and product ID are quite specific to identify
|
|---|
| 142 | USB devices, if you have two identical devices of the
|
|---|
| 143 | same brand and product line, you will also need their
|
|---|
| 144 | serial numbers to filter them out correctly.
|
|---|
| 145 | </p>
|
|---|
| 146 | </li>
|
|---|
| 147 | <li>
|
|---|
| 148 | <p>
|
|---|
| 149 | <b outputclass="bold">Remote.</b> This setting
|
|---|
| 150 | specifies whether the device will be local only, remote
|
|---|
| 151 | only, such as over VRDP, or either.
|
|---|
| 152 | </p>
|
|---|
| 153 | </li>
|
|---|
| 154 | </ul>
|
|---|
| 155 | <p>
|
|---|
| 156 | On a Windows host, you will need to unplug and reconnect a
|
|---|
| 157 | USB device to use it after creating a filter for it.
|
|---|
| 158 | </p>
|
|---|
| 159 | <p>
|
|---|
| 160 | As an example, you could create a new USB filter and specify
|
|---|
| 161 | a vendor ID of 046d for Logitech, Inc, a manufacturer index
|
|---|
| 162 | of 1, and "not remote". Then any USB devices on the host
|
|---|
| 163 | system produced by Logitech, Inc with a manufacturer index
|
|---|
| 164 | of 1 will be visible to the guest system.
|
|---|
| 165 | </p>
|
|---|
| 166 | <p>
|
|---|
| 167 | Several filters can select a single device. For example, a
|
|---|
| 168 | filter which selects all Logitech devices, and one which
|
|---|
| 169 | selects a particular webcam.
|
|---|
| 170 | </p>
|
|---|
| 171 | <p>
|
|---|
| 172 | You can deactivate filters without deleting them by
|
|---|
| 173 | deselecting the check box next to the filter name.
|
|---|
| 174 | </p>
|
|---|
| 175 | </li>
|
|---|
| 176 | </ul>
|
|---|
| 177 | </body>
|
|---|
| 178 |
|
|---|
| 179 | </topic>
|
|---|
