source: vbox/trunk/doc/manual/en_US/man_VBoxManage-usbdevsource.xml@ 96300

<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage usbdevsource
-->
<!--
    Copyright (C) 2006-2020 Oracle Corporation

    This file is part of VirtualBox Open Source Edition (OSE), as
    available from http://www.virtualbox.org. This file is free software;
    you can redistribute it and/or modify it under the terms of the GNU
    General Public License (GPL) as published by the Free Software
    Foundation, in version 2 as it comes in the "COPYING" file of the
    VirtualBox OSE distribution. VirtualBox OSE is distributed in the
    hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
<refentry id="vboxmanage-usbdevsource" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2022-08-18 17:27:14 +0000 (Thu, 18 Aug 2022) $</pubdate>
    <title>VBoxManage usbdevsource</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>vboxmanage-usbdevsource</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>vboxmanage-usbdevsource</refname>
    <refpurpose>add and remove USB device sources</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-usbdevsource-add">
      <command>VBoxManage usbdevsource add</command>
      <arg choice="req"><replaceable>source-name</replaceable></arg>
      <arg choice="req">--backend=<replaceable>backend</replaceable></arg>
      <arg choice="req">--address=<replaceable>address</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-usbdevsource-remove">
      <command>VBoxManage usbdevsource remove</command>
      <arg choice="req"><replaceable>source-name</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      The <command>VBoxManage usbdevsource</command> command adds a USB
      device source and makes it available to the guests on the host
      system. You can also use this command to remove the USB device
      source.
    </para>
    <refsect2 id="vboxmanage-usbdevsource-add">
      <title>Add a USB Device Source</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage usbdevsource add</command> command adds
        a USB device source, which is available to all guests on the
        host system.
      </para>
      <variablelist>
        <varlistentry>
          <term><replaceable>source-name</replaceable></term>
          <listitem><para>
              Specifies a unique name for the USB device source.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term>--address=<replaceable>address</replaceable></term>
          <listitem><para>
              Specifies the address of the USB backend.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term>--backend=<replaceable>backend</replaceable></term>
          <listitem><para>
              Specifies the USB proxy service backend to use.
            </para><para>
              For now only USBIP is supported to specify a remote
              server using the USB/IP protocol.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-usbdevsource-remove">
      <title>Remove a USB Device</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage usbdevsource remove</command> command
        removes a USB device.
      </para>
      <variablelist>
        <varlistentry>
          <term><replaceable>source-name</replaceable></term>
          <listitem><para>
              Specifies the name of the USB device source to remove.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <remark role="help-scope" condition="GLOBAL" />
    <para>
      The following command adds a USB device server called
      <filename>hostusb01</filename>.
    </para>
<screen>$ VBoxManage usbdevsource add hostusb01 --backend USBIP --address 10.0.1.16</screen>
  </refsect1>
</refentry>