| 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>The <b outputclass="bold">USB</b> section in a virtual machine's <b
|
|---|
| 9 | outputclass="bold">Settings</b> window enables you to configure <ph
|
|---|
| 10 | conkeyref="vbox-conkeyref-phrases/product-name"/>'s sophisticated USB support. </p>
|
|---|
| 11 | <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can enable virtual
|
|---|
| 12 | machines to access the USB devices on your host directly. To achieve this, <ph
|
|---|
| 13 | conkeyref="vbox-conkeyref-phrases/product-name"/> presents the guest OS with a virtual USB
|
|---|
| 14 | controller. </p>
|
|---|
| 15 | <p>
|
|---|
| 16 | <note id="note_bzl_prv_qbc" type="caution">
|
|---|
| 17 | <p>As soon as the guest system starts using a USB device, it will be disconnected from the
|
|---|
| 18 | host without a proper shutdown. This may cause data loss.</p>
|
|---|
| 19 | </note>
|
|---|
| 20 | </p>
|
|---|
| 21 | <note>
|
|---|
| 22 | <p>Oracle Solaris hosts have a few known limitations regarding USB support. See <xref
|
|---|
| 23 | href="KnownIssues.dita">Known Limitations</xref>. </p>
|
|---|
| 24 | </note>
|
|---|
| 25 | <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> also enables your guests
|
|---|
| 26 | to connect to remote USB devices by use of the VirtualBox Remote Desktop Extension (VRDE). See
|
|---|
| 27 | <xref href="usb-over-rdp.dita">Remote USB</xref>. </p>
|
|---|
| 28 | <section id="section_pfm_vsv_qbc">
|
|---|
| 29 | <title>Enable USB for a VM</title>
|
|---|
| 30 | </section>
|
|---|
| 31 |
|
|---|
| 32 | <ol id="ol_fpr_wsv_qbc">
|
|---|
| 33 | <li>Ensure the VM is not running.</li>
|
|---|
| 34 | <li>Select the VM in the machine list, and then click <b outputclass="bold"
|
|---|
| 35 | >Settings</b>.</li>
|
|---|
| 36 | <li>On the USB tab, select <b outputclass="bold">Enable USB Controller</b> and choose the
|
|---|
| 37 | USB Controller you need for your guest OS. In most cases this will be xHCI. Only use OHCI or
|
|---|
| 38 | EHCI if your guest OS does not support xHCI. For some legacy Windows guests you'll need to
|
|---|
| 39 | install third party drivers for xHCI support. <p>
|
|---|
| 40 | <ul id="ul_rzz_l5v_qbc">
|
|---|
| 41 | <li>OHCI supports USB 1.1 </li>
|
|---|
| 42 | <li>EHCI supports USB 2.0. This also enables OHCI.</li>
|
|---|
| 43 | <li>xHCI supports all USB speeds up to USB 3.0</li>
|
|---|
| 44 | </ul>
|
|---|
| 45 | </p></li>
|
|---|
| 46 |
|
|---|
| 47 |
|
|---|
| 48 |
|
|---|
| 49 | <li>Specify which devices can be attached to the guest by adding <b
|
|---|
| 50 | outputclass="bold">USB Device Filters</b>. USB devices with a matching filter will be
|
|---|
| 51 | automatically passed to the guest once they are attached to the host. USB devices without a
|
|---|
| 52 | matching filter can be passed manually to the guest, for example by using the <b
|
|---|
| 53 | outputclass="bold">Devices</b>, <b outputclass="bold">USB</b> menu. <ul
|
|---|
| 54 | id="ul_jjz_cxv_qbc">
|
|---|
| 55 | <li>Click the <b>USB filter</b> button to create a new filter with blank fields, and then
|
|---|
| 56 | complete the fields. </li>
|
|---|
| 57 | <li>Or, click the <b>Add USB filter</b> button to create a filter with the fields
|
|---|
| 58 | completed for the selected USB device. </li>
|
|---|
| 59 | </ul><p>Give the filter a name, for later reference, and specify the filter criteria. The
|
|---|
| 60 | more criteria you specify, the more precisely devices will be selected. For instance, if
|
|---|
| 61 | you specify only a vendor ID of 046d, all devices produced by Logitech will be available
|
|---|
| 62 | to the guest. If you fill in all fields, on the other hand, the filter will only apply to
|
|---|
| 63 | a particular device model from a particular vendor, and not even to other devices of the
|
|---|
| 64 | same type with a different revision and serial number. </p><p>The following criteria are
|
|---|
| 65 | available: </p><ul id="ul_av4_41w_qbc">
|
|---|
| 66 | <li>
|
|---|
| 67 | <p><b outputclass="bold">Vendor and Product ID.</b> With USB, each vendor of USB
|
|---|
| 68 | products carries an identification number that is unique world-wide, called the
|
|---|
| 69 | <i>vendor ID</i>. Similarly, each line of products is assigned a <i>product ID</i>
|
|---|
| 70 | number. Both numbers are commonly written in hexadecimal, and a colon separates the
|
|---|
| 71 | vendor from the product ID. For example, <codeph>046d:c016</codeph> stands for
|
|---|
| 72 | Logitech as a vendor, and the M-UV69a Optical Wheel Mouse product. </p>
|
|---|
| 73 | <p>Alternatively, you can also specify <b outputclass="bold">Manufacturer</b> and <b
|
|---|
| 74 | outputclass="bold">Product</b> by name. </p>
|
|---|
| 75 | <p>To list all the USB devices that are connected to your host machine with their
|
|---|
| 76 | respective vendor IDs and product IDs, use the following command: </p>
|
|---|
| 77 | <pre xml:space="preserve" id="pre_bv4_41w_qbc">VBoxManage list usbhost</pre>
|
|---|
| 78 | <p>On Windows, you can also see all USB devices that are attached to your system in the
|
|---|
| 79 | Device Manager. On Linux, you can use the <userinput>lsusb</userinput> command. </p>
|
|---|
| 80 | </li>
|
|---|
| 81 | <li>
|
|---|
| 82 | <p><b outputclass="bold">Serial Number.</b> While vendor ID and product ID are quite
|
|---|
| 83 | specific to identify USB devices, if you have two identical devices of the same brand
|
|---|
| 84 | and product line, you will also need their serial numbers to filter them out
|
|---|
| 85 | correctly. </p>
|
|---|
| 86 | </li>
|
|---|
| 87 | <li>
|
|---|
| 88 | <p><b outputclass="bold">Remote.</b> This setting specifies whether the device will be
|
|---|
| 89 | local only, remote only, such as over VRDP, or either. </p>
|
|---|
| 90 | </li>
|
|---|
| 91 | </ul><p>As an example, you could create a new USB filter and specify a vendor ID of 046d for
|
|---|
| 92 | Logitech, Inc, a manufacturer index of 1, and <i>not remote</i>. Then any USB devices on
|
|---|
| 93 | the host system produced by Logitech, Inc with a manufacturer index of 1 will be visible
|
|---|
| 94 | to the guest system. </p><p>Several filters can select a single device. For example, a
|
|---|
| 95 | filter which selects all Logitech devices, and one which selects a particular webcam.
|
|---|
| 96 | </p></li>
|
|---|
| 97 | <li>
|
|---|
| 98 | <p>On a Windows host, you will need to unplug and reconnect a USB device to use it after
|
|---|
| 99 | creating a filter for it. </p>
|
|---|
| 100 | </li>
|
|---|
| 101 | <li>
|
|---|
| 102 | <p>Ensure the filters you need immediately are selected in the list. Selected filters will
|
|---|
| 103 | be attached automatically when the VM starts.</p>
|
|---|
| 104 | </li></ol>
|
|---|
| 105 | </body>
|
|---|
| 106 |
|
|---|
| 107 | </topic>
|
|---|
