VirtualBox

Changeset 64191 in vbox for trunk


Ignore:
Timestamp:
Oct 10, 2016 5:39:29 PM (8 years ago)
Author:
vboxsync
Message:

bugref:8604 Proof read/Minor changes - Manual/AdvancedTopics: Add a section about USB/IP

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/user_AdvancedTopics.xml

    r64187 r64191  
    42934293    <para>Starting with 5.1.0, VirtualBox supports passing through USB
    42944294    devices which are exposed over the network using the USB over IP protocol
    4295     without needing to configure the client side provided by the kernel and
    4296     usbip tools. Furthermore this also works with VirtualBox running on any
    4297     supported host instead of just on Linux like it is the case with the official
    4298     client. </para>
    4299 
    4300     <para>To enable support for passing through USB/IP devices the device server exporting
    4301     the devices must be added with the followig command:
    4302       <screen>VBoxManage usbdevsource add "Unique name" --backend "USBIP" --address "Device server"[:port]</screen>
    4303     USB devices exported on the device server are then accessile through the GUI
    4304     or VBoxManage just like any USB device attached locally. This can be used multiple times
     4295    without the need to configure the client side provided by the kernel and
     4296    usbip tools. Furthermore, this feature works with VirtualBox running on any
     4297    supported host, rather than just Linux alone - as is the case with the official
     4298    client.</para>
     4299
     4300    <para>To enable support for passing through USB/IP devices, the device server exporting
     4301    the devices must be added with the following command:
     4302    <screen>VBoxManage usbdevsource add "Unique name" --backend "USBIP" --address "Device server[:port]"</screen>
     4303    USB devices exported on the device server are then accessible through the GUI
     4304    or VBoxManage, like any USB devices attached locally. This can be used multiple times
    43054305    to access different device servers.</para>
    43064306
    4307     <para>To remove a device server the following command can be used:
     4307    <para>To remove a device server, the following command can be used:
    43084308      <screen>VBoxManage usbdevsource remove "Unique name"</screen>
    43094309    </para>
     
    43124312      <title>Setting up USB/IP support on a Linux system</title>
    43134313
    4314       <para>This secton gives a brief overview on how to set up a Linux based system
    4315       to act as a USB device server. The system on the server requires the
     4314      <para>This section gives a brief overview on how to set up a Linux based system
     4315      to act as a USB device server. The system on the server requires that the
    43164316      <computeroutput>usbip-core.ko</computeroutput> and
    43174317      <computeroutput>usbip-host.ko</computeroutput> kernel drivers
    4318       to be available and that the USB/IP tools package is installed.
    4319       How to install the necessary tools depends on the used distribution, for
    4320       Debian based systems the following command should install the required tools:
     4318      are available, and that the USB/IP tools package is installed.
     4319      The particular installation method for the necessary tools depends on which
     4320      distribution is used.
     4321      For example, for Debian based systems - the following command should be used to
     4322      install the required tools:
    43214323      <screen>apt-get install usbip-utils</screen></para>
    4322 
    4323       <para>Checking whether the necessary tools are installed can be done with
    4324       the following command which should produce a similar output like
    4325       in the example below:
     4324      <para>To check whether the necessary tools are already installed use
     4325      the following command:
    43264326      <screen>
    43274327$ usbip list -l
     4328      </screen></para>
     4329      <para>
     4330      which should produce output similar to that shown in the example below:
     4331      <screen>
    43284332 - busid 4-2 (0bda:0301)
    43294333   Realtek Semiconductor Corp. : multicard reader (0bda:0301)
     
    43334337      </screen></para>
    43344338
    4335       <para>If everything is installed the USB/IP server needs to be started as
    4336       <computeroutput>root</computeroutput> with the following command,
    4337       consult the documentation of the used distribution on how to start the
    4338       service when the system boots:
    4339       <screen>usbipd -D</screen></para>
    4340 
    4341       <para>By default no device on the server is exported which must be done manually
    4342       for each device. To export a device use: <screen>usbip bind -b "bus identifier"</screen>
    4343       To export the multicard reader from above for example use:
     4339      <para>If everything is installed, the USB/IP server needs to be started as
     4340      <computeroutput>root</computeroutput> using the following command:
     4341      <screen>usbipd -D</screen>
     4342      Refer to the documentation for the installed distribution to determine how to start the
     4343      service when the system boots.</para>
     4344
     4345      <para>By default, no device on the server is exported - and this must be done manually
     4346      for each device. To export a device use:
     4347      <screen>usbip bind -b "bus identifier"</screen>
     4348      To export the multicard reader from above, for example  - use:
    43444349      <screen>usbip bind -b 4-2</screen></para>
    43454350    </sect2>
     
    43484353      <title>Security considerations</title>
    43494354
    4350       <para>The communiction between the server and client is not encrypted and
     4355      <para>The communication between the server and client is unencrypted and
    43514356      there is no authorization required to access exported devices. An attacker
    43524357      might sniff sensitive data or gain control over a device. To mitigate this
    4353       risk the device should be exposed over a local network only trusted
    4354       clients have access to. To access the devie remotely over a public network
    4355       a VPN solution should be used to add the required protection.</para>
     4358      risk, the device should be exposed over a local network to which only trusted
     4359      clients have access. To access the device remotely over a public network,
     4360      a VPN solution should be used to provide the required level of security protection.</para>
    43564361    </sect2>
    43574362  </sect1>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette