[82044] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | manpage, user manual, usage: VBoxManage usbdevsource
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
[82044] | 7 |
|
---|
[96407] | 8 | This file is part of VirtualBox base platform packages, as
|
---|
| 9 | available from https://www.virtualbox.org.
|
---|
| 10 |
|
---|
| 11 | This program is free software; you can redistribute it and/or
|
---|
| 12 | modify it under the terms of the GNU General Public License
|
---|
| 13 | as published by the Free Software Foundation, in version 3 of the
|
---|
| 14 | License.
|
---|
| 15 |
|
---|
| 16 | This program is distributed in the hope that it will be useful, but
|
---|
| 17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 19 | General Public License for more details.
|
---|
| 20 |
|
---|
| 21 | You should have received a copy of the GNU General Public License
|
---|
| 22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
| 23 |
|
---|
| 24 | SPDX-License-Identifier: GPL-3.0-only
|
---|
[96300] | 25 | -->
|
---|
[82044] | 26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
---|
| 28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
---|
| 29 | %all.entities;
|
---|
| 30 | ]>
|
---|
| 31 | <refentry id="vboxmanage-usbdevsource" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
[94213] | 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
[82044] | 34 | <title>VBoxManage usbdevsource</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
[94213] | 38 | <refentrytitle>vboxmanage-usbdevsource</refentrytitle>
|
---|
[82044] | 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>vboxmanage-usbdevsource</refname>
|
---|
| 44 | <refpurpose>add and remove USB device sources</refpurpose>
|
---|
[94213] | 45 | <refclass>&product-name;</refclass>
|
---|
[82044] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-usbdevsource-add">
|
---|
[82057] | 50 | <command>VBoxManage usbdevsource add</command>
|
---|
[82044] | 51 | <arg choice="req"><replaceable>source-name</replaceable></arg>
|
---|
| 52 | <arg choice="req">--backend=<replaceable>backend</replaceable></arg>
|
---|
| 53 | <arg choice="req">--address=<replaceable>address</replaceable></arg>
|
---|
| 54 | </cmdsynopsis>
|
---|
[82057] | 55 |
|
---|
[82044] | 56 | <cmdsynopsis id="synopsis-vboxmanage-usbdevsource-remove">
|
---|
[82057] | 57 | <command>VBoxManage usbdevsource remove</command>
|
---|
[82044] | 58 | <arg choice="req"><replaceable>source-name</replaceable></arg>
|
---|
| 59 | </cmdsynopsis>
|
---|
| 60 | </refsynopsisdiv>
|
---|
| 61 |
|
---|
[99513] | 62 | <refsect1 id="vboxmanage-usbdevsource-description">
|
---|
[82044] | 63 | <title>Description</title>
|
---|
| 64 | <para>
|
---|
| 65 | The <command>VBoxManage usbdevsource</command> command adds a USB
|
---|
| 66 | device source and makes it available to the guests on the host
|
---|
| 67 | system. You can also use this command to remove the USB device
|
---|
| 68 | source.
|
---|
| 69 | </para>
|
---|
| 70 | <refsect2 id="vboxmanage-usbdevsource-add">
|
---|
| 71 | <title>Add a USB Device Source</title>
|
---|
| 72 | <remark role="help-copy-synopsis"/>
|
---|
| 73 | <para>
|
---|
| 74 | The <command>VBoxManage usbdevsource add</command> command adds
|
---|
| 75 | a USB device source, which is available to all guests on the
|
---|
| 76 | host system.
|
---|
| 77 | </para>
|
---|
| 78 | <variablelist>
|
---|
| 79 | <varlistentry>
|
---|
| 80 | <term><replaceable>source-name</replaceable></term>
|
---|
| 81 | <listitem><para>
|
---|
| 82 | Specifies a unique name for the USB device source.
|
---|
| 83 | </para></listitem>
|
---|
| 84 | </varlistentry>
|
---|
| 85 | <varlistentry>
|
---|
| 86 | <term>--address=<replaceable>address</replaceable></term>
|
---|
| 87 | <listitem><para>
|
---|
| 88 | Specifies the address of the USB backend.
|
---|
| 89 | </para></listitem>
|
---|
| 90 | </varlistentry>
|
---|
| 91 | <varlistentry>
|
---|
| 92 | <term>--backend=<replaceable>backend</replaceable></term>
|
---|
| 93 | <listitem><para>
|
---|
| 94 | Specifies the USB proxy service backend to use.
|
---|
[94213] | 95 | </para><para>
|
---|
| 96 | For now only USBIP is supported to specify a remote
|
---|
| 97 | server using the USB/IP protocol.
|
---|
| 98 | </para></listitem>
|
---|
[82044] | 99 | </varlistentry>
|
---|
| 100 | </variablelist>
|
---|
| 101 | </refsect2>
|
---|
| 102 | <refsect2 id="vboxmanage-usbdevsource-remove">
|
---|
| 103 | <title>Remove a USB Device</title>
|
---|
| 104 | <remark role="help-copy-synopsis"/>
|
---|
| 105 | <para>
|
---|
| 106 | The <command>VBoxManage usbdevsource remove</command> command
|
---|
| 107 | removes a USB device.
|
---|
| 108 | </para>
|
---|
| 109 | <variablelist>
|
---|
| 110 | <varlistentry>
|
---|
| 111 | <term><replaceable>source-name</replaceable></term>
|
---|
| 112 | <listitem><para>
|
---|
| 113 | Specifies the name of the USB device source to remove.
|
---|
| 114 | </para></listitem>
|
---|
| 115 | </varlistentry>
|
---|
| 116 | </variablelist>
|
---|
| 117 | </refsect2>
|
---|
| 118 | </refsect1>
|
---|
| 119 |
|
---|
[99513] | 120 | <refsect1 id="vboxmanage-usbdevsource-examples">
|
---|
[82044] | 121 | <title>Examples</title>
|
---|
| 122 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 123 | <para>
|
---|
| 124 | The following command adds a USB device server called
|
---|
| 125 | <filename>hostusb01</filename>.
|
---|
| 126 | </para>
|
---|
| 127 | <screen>$ VBoxManage usbdevsource add hostusb01 --backend USBIP --address 10.0.1.16</screen>
|
---|
| 128 | </refsect1>
|
---|
| 129 | </refentry>
|
---|