blob: 7a5dd9d184edead2683bc49c6a2c2356e743185c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage usbdevsource
-->
<!--
Copyright (C) 2006-2023 Oracle and/or its affiliates.
This file is part of VirtualBox base platform packages, as
available from https://www.virtualbox.org.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, in version 3 of the
License.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses>.
SPDX-License-Identifier: GPL-3.0-only
-->
<!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: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</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>
|
