| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage usbfilter
|
|---|
| 4 | -->
|
|---|
| 5 | <!--
|
|---|
| 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 7 |
|
|---|
| 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
|
|---|
| 25 | -->
|
|---|
| 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-usbfilter" lang="en">
|
|---|
| 32 | <refentryinfo>
|
|---|
| 33 | <pubdate>$Date: 2023-01-17 14:15:46 +0000 (Tue, 17 Jan 2023) $</pubdate>
|
|---|
| 34 | <title>VBoxManage usbfilter</title>
|
|---|
| 35 | </refentryinfo>
|
|---|
| 36 |
|
|---|
| 37 | <refmeta>
|
|---|
| 38 | <refentrytitle>VBoxManage-usbfilter</refentrytitle>
|
|---|
| 39 | <manvolnum>1</manvolnum>
|
|---|
| 40 | </refmeta>
|
|---|
| 41 |
|
|---|
| 42 | <refnamediv>
|
|---|
| 43 | <refname>VBoxManage-usbfilter</refname>
|
|---|
| 44 | <refpurpose>управление USB фильтрами</refpurpose>
|
|---|
| 45 | <refclass>&product-name;</refclass>
|
|---|
| 46 | </refnamediv>
|
|---|
| 47 |
|
|---|
| 48 | <refsynopsisdiv>
|
|---|
| 49 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 50 | <cmdsynopsis id="synopsis-vboxmanage-usbfilter-add">
|
|---|
| 51 | <command>VBoxManage usbfilter add</command>
|
|---|
| 52 | <arg choice="req"><replaceable>индекс</replaceable>,0-<replaceable>N</replaceable></arg>
|
|---|
| 53 | <arg choice="req">--target=<group choice="req">
|
|---|
| 54 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 55 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 56 | <arg choice="plain">global</arg>
|
|---|
| 57 | </group></arg>
|
|---|
| 58 | <arg choice="req">--name=<replaceable>строка</replaceable></arg>
|
|---|
| 59 | <arg choice="req">--action=ignore | hold</arg>
|
|---|
| 60 | <arg>--active=yes | no</arg>
|
|---|
| 61 | <arg>--vendorid=<replaceable>XXXX</replaceable></arg>
|
|---|
| 62 | <arg>--productid=<replaceable>XXXX</replaceable></arg>
|
|---|
| 63 | <arg>--revision=<replaceable>IIFF</replaceable></arg>
|
|---|
| 64 | <arg>--manufacturer=<replaceable>строка</replaceable></arg>
|
|---|
| 65 | <arg>--product=<replaceable>строка</replaceable></arg>
|
|---|
| 66 | <arg>--port=<replaceable>hex</replaceable></arg>
|
|---|
| 67 | <arg>--remote=yes | no</arg>
|
|---|
| 68 | <arg>--serialnumber=<replaceable>строка</replaceable></arg>
|
|---|
| 69 | <arg>--maskedinterfaces=<replaceable>XXXXXXXX</replaceable></arg>
|
|---|
| 70 | </cmdsynopsis>
|
|---|
| 71 |
|
|---|
| 72 | <cmdsynopsis id="synopsis-vboxmanage-usbfilter-modify">
|
|---|
| 73 | <command>VBoxManage usbfilter modify</command>
|
|---|
| 74 | <arg choice="req"><replaceable>индекс</replaceable>,0-<replaceable>N</replaceable></arg>
|
|---|
| 75 | <arg choice="req">--target=<group choice="req">
|
|---|
| 76 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 77 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 78 | <arg choice="plain">global</arg>
|
|---|
| 79 | </group></arg>
|
|---|
| 80 | <arg>--name=<replaceable>строка</replaceable></arg>
|
|---|
| 81 | <arg>--action=ignore | hold</arg>
|
|---|
| 82 | <arg>--active=yes | no</arg>
|
|---|
| 83 | <arg>--vendorid=<replaceable>XXXX</replaceable> | ""</arg>
|
|---|
| 84 | <arg>--productid=<replaceable>XXXX</replaceable> | ""</arg>
|
|---|
| 85 | <arg>--revision=<replaceable>IIFF</replaceable> | ""</arg>
|
|---|
| 86 | <arg>--manufacturer=<replaceable>строка</replaceable> | ""</arg>
|
|---|
| 87 | <arg>--product=<replaceable>строка</replaceable> | ""</arg>
|
|---|
| 88 | <arg>--port=<replaceable>hex</replaceable></arg>
|
|---|
| 89 | <arg>--remote=yes | no</arg>
|
|---|
| 90 | <arg>--serialnumber=<replaceable>строка</replaceable> | ""</arg>
|
|---|
| 91 | <arg>--maskedinterfaces=<replaceable>XXXXXXXX</replaceable></arg>
|
|---|
| 92 | </cmdsynopsis>
|
|---|
| 93 |
|
|---|
| 94 | <cmdsynopsis id="synopsis-vboxmanage-usbfilter-remove">
|
|---|
| 95 | <command>VBoxManage usbfilter remove</command>
|
|---|
| 96 | <arg choice="req"><replaceable>индекс</replaceable>,0-<replaceable>N</replaceable></arg>
|
|---|
| 97 | <arg choice="req">--target=<group choice="req">
|
|---|
| 98 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 99 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 100 | <arg choice="plain">global</arg>
|
|---|
| 101 | </group></arg>
|
|---|
| 102 | </cmdsynopsis>
|
|---|
| 103 | </refsynopsisdiv>
|
|---|
| 104 |
|
|---|
| 105 | <refsect1>
|
|---|
| 106 | <title>Описание</title>
|
|---|
| 107 | <para>
|
|---|
| 108 | Команда <command>VBoxManage usbfilter</command> позволяет управлять
|
|---|
| 109 | USB фильтрами для указанной виртуальной машиной (ВМ) или глобальными
|
|---|
| 110 | USB фильтрами, влияющими на всю конфигурацию &product-name;.
|
|---|
| 111 | </para>
|
|---|
| 112 | <para>
|
|---|
| 113 | Глобальные фильтры применяются перед фильтрами определенной ВМ.
|
|---|
| 114 | Это означает, что можно использовать глобальный фильтр для
|
|---|
| 115 | предотвращения захвата устройств какой-либо ВМ.
|
|---|
| 116 | </para>
|
|---|
| 117 | <para>
|
|---|
| 118 | Глобальные фильтры применяются в определенном порядке. Применяется
|
|---|
| 119 | только первый походящий данному устройству фильтр. Например,
|
|---|
| 120 | первый глобальный фильтр делает доступным определенный
|
|---|
| 121 | флеш-накопитель Kingston, тогда как второй фильтр игнорирует все
|
|---|
| 122 | устройства Kingston. В результате применения этих фильтров,
|
|---|
| 123 | определенный флеш-накопитель Kingston будет доступен любой машине,
|
|---|
| 124 | имеющей соответствующий фильтр, но остальные устройства Kingston
|
|---|
| 125 | доступны не будут.
|
|---|
| 126 | </para>
|
|---|
| 127 | <refsect2>
|
|---|
| 128 | <title>Общие операнды и опции</title>
|
|---|
| 129 | <variablelist>
|
|---|
| 130 | <varlistentry>
|
|---|
| 131 | <term>index,0-<replaceable>N</replaceable></term>
|
|---|
| 132 | <listitem><para>
|
|---|
| 133 | Задает единственное число, указывающее позицию фильтра
|
|---|
| 134 | в списке. Ноль (<literal>0</literal>) представляет
|
|---|
| 135 | первую позицию в списке. Если в данной позиции уже
|
|---|
| 136 | существует фильтр, то этот фильтр, а также
|
|---|
| 137 | следующие за ним передвигаются ниже по списку.
|
|---|
| 138 | В противном случае, новый фильтр добавляется в
|
|---|
| 139 | список.
|
|---|
| 140 | </para></listitem>
|
|---|
| 141 | </varlistentry>
|
|---|
| 142 | <varlistentry>
|
|---|
| 143 | <term><option>--action=ignore | hold</option></term>
|
|---|
| 144 | <listitem><para>
|
|---|
| 145 | Указывает, разрешать ли доступ ВМ к устройствам,
|
|---|
| 146 | подходящим к описанию фильтра (<literal>hold</literal>)
|
|---|
| 147 | или запрещать (<literal>ignore</literal>). Эта опция
|
|---|
| 148 | применяется только к глобальным фильтрам.
|
|---|
| 149 | </para></listitem>
|
|---|
| 150 | </varlistentry>
|
|---|
| 151 | <varlistentry>
|
|---|
| 152 | <term><option>--active=yes | no</option></term>
|
|---|
| 153 | <listitem><para>
|
|---|
| 154 | Указывает, активен ли USB фильтр или временно отключен.
|
|---|
| 155 | Допустимые значения <literal>yes</literal>, активирующая
|
|---|
| 156 | фильтр и <literal>no</literal>, отключающая его. Значение
|
|---|
| 157 | по умолчанию <literal>yes</literal>.
|
|---|
| 158 | </para></listitem>
|
|---|
| 159 | </varlistentry>
|
|---|
| 160 | <varlistentry>
|
|---|
| 161 | <term><option>--manufacturer=<replaceable>строка</replaceable></option></term>
|
|---|
| 162 | <listitem><para>
|
|---|
| 163 | Задает фильтр по ID производителя как строку. Значение
|
|---|
| 164 | по умолчанию пустое (<literal>""</literal>).
|
|---|
| 165 | </para></listitem>
|
|---|
| 166 | </varlistentry>
|
|---|
| 167 | <varlistentry>
|
|---|
| 168 | <term><option>--maskedinterfaces=<replaceable>XXXXXXXX</replaceable></option></term>
|
|---|
| 169 | <listitem><para>
|
|---|
| 170 | Указывает фильтр маскированного интерфейса, который
|
|---|
| 171 | используется для скрытия одного или нескольких USB
|
|---|
| 172 | интерфейсов от гостевой системы. Значение - это битовая
|
|---|
| 173 | маска, где набор битов соответствует скрываемому USB
|
|---|
| 174 | интерфейсу или снятие маски. Эта функция поддерживается
|
|---|
| 175 | только только в хост-системах Linux.
|
|---|
| 176 | </para></listitem>
|
|---|
| 177 | </varlistentry>
|
|---|
| 178 | <varlistentry>
|
|---|
| 179 | <term><option>--name=<replaceable>имя-фильтра</replaceable></option></term>
|
|---|
| 180 | <listitem><para>
|
|---|
| 181 | Задает имя фильтра.
|
|---|
| 182 | </para></listitem>
|
|---|
| 183 | </varlistentry>
|
|---|
| 184 | <varlistentry>
|
|---|
| 185 | <term><option>--port=<replaceable>hex</replaceable></option></term>
|
|---|
| 186 | <listitem><para>
|
|---|
| 187 | Задает фильтр по номеру USB порта (hub port number). Значение по
|
|---|
| 188 | умолчанию - пустая строка (<literal>""</literal>).
|
|---|
| 189 | </para></listitem>
|
|---|
| 190 | </varlistentry>
|
|---|
| 191 | <varlistentry>
|
|---|
| 192 | <term><option>--product=<replaceable>строка</replaceable></option></term>
|
|---|
| 193 | <listitem><para>
|
|---|
| 194 | Задает фильтр по ID продукта как строку. Значение по
|
|---|
| 195 | умолчанию пустое (<literal>""</literal>).
|
|---|
| 196 | </para></listitem>
|
|---|
| 197 | </varlistentry>
|
|---|
| 198 | <varlistentry>
|
|---|
| 199 | <term><option>--productid=<replaceable>XXXX</replaceable></option></term>
|
|---|
| 200 | <listitem><para>
|
|---|
| 201 | Задает фильтр по ID продукта. Строковое представление
|
|---|
| 202 | для точного соответствия имеет вид
|
|---|
| 203 | <replaceable>XXXX</replaceable>, где
|
|---|
| 204 | <replaceable>X</replaceable> - это шестнадцатеричная
|
|---|
| 205 | цифра включающая лидирующие нули. Значение по умолчанию
|
|---|
| 206 | пустое (<literal>""</literal>).
|
|---|
| 207 | </para></listitem>
|
|---|
| 208 | </varlistentry>
|
|---|
| 209 | <varlistentry>
|
|---|
| 210 | <term><option>--remote=yes | no</option></term>
|
|---|
| 211 | <listitem><para>
|
|---|
| 212 | Задает удаленный фильтр, показывающий подключено ли
|
|---|
| 213 | физически устройство к удаленному клиенту VRDE или
|
|---|
| 214 | или к локальной системе. Эта опцию применяется только
|
|---|
| 215 | к фильтрам ВМ. Значение по умолчанию пустое
|
|---|
| 216 | (<literal>""</literal>).
|
|---|
| 217 | </para><remark>
|
|---|
| 218 | Почему значение по умолчанию пустое когда допустимые
|
|---|
| 219 | значения <literal>yes</literal> или <literal>no</literal>?
|
|---|
| 220 | </remark></listitem>
|
|---|
| 221 | </varlistentry>
|
|---|
| 222 | <varlistentry>
|
|---|
| 223 | <term><option>--revision=<replaceable>IIFF</replaceable></option></term>
|
|---|
| 224 | <listitem><para>
|
|---|
| 225 | Задает фильтр по ID ревизии. Строковое представление
|
|---|
| 226 | для точного соответствия имеет вид <replaceable>IIFF</replaceable>.
|
|---|
| 227 | <replaceable>I</replaceable> - это десятичная цифра
|
|---|
| 228 | целой части ревизии. <replaceable>F</replaceable> -
|
|---|
| 229 | это десятичная цифра ее дробной части включающая
|
|---|
| 230 | лидирующие и замыкающие нули. Значение по умолчанию
|
|---|
| 231 | пустое (<literal>""</literal>).
|
|---|
| 232 | </para><para>
|
|---|
| 233 | Для того, чтобы указать диапазон ревизий ID, убедитесь
|
|---|
| 234 | что используется шестнадцатеричная форма, то есть в виде
|
|---|
| 235 | 16 битного упакованного двоично-десятичного значения.
|
|---|
| 236 | Например, выражение <literal>int:0x0100-0x0199</literal>
|
|---|
| 237 | соответствует любой ревизии с 1.0 по 1.99 включительно.
|
|---|
| 238 | </para></listitem>
|
|---|
| 239 | </varlistentry>
|
|---|
| 240 | <varlistentry>
|
|---|
| 241 | <term><option>--serialnumber=<replaceable>строка</replaceable></option></term>
|
|---|
| 242 | <listitem><para>
|
|---|
| 243 | Задает фильтр серийного номера как строку. Значение по
|
|---|
| 244 | умолчанию пустое(<literal>""</literal>).
|
|---|
| 245 | </para></listitem>
|
|---|
| 246 | </varlistentry>
|
|---|
| 247 | <varlistentry>
|
|---|
| 248 | <term><option>--target=<replaceable>uuid</replaceable> | <replaceable>имя-ВМ</replaceable> | global</option></term>
|
|---|
| 249 | <listitem><para>
|
|---|
| 250 | Указывает ВМ, к которой подключается фильтр. Можно
|
|---|
| 251 | указать Универсальный Уникальный Идентификатор (UUID)
|
|---|
| 252 | или имя ВМ. Для применения описания фильтра ко всем ВМ,
|
|---|
| 253 | укажите <literal>global</literal>.
|
|---|
| 254 | </para></listitem>
|
|---|
| 255 | </varlistentry>
|
|---|
| 256 | <varlistentry>
|
|---|
| 257 | <term><option>--vendorid=<replaceable>XXXX</replaceable></option></term>
|
|---|
| 258 | <listitem><para>
|
|---|
| 259 | Задает фильтр по ID поставщика, который представляется
|
|---|
| 260 | строкой шестнадцатеричного номера, состоящего из
|
|---|
| 261 | четырех цифр включая лидирующие нули. Значение по
|
|---|
| 262 | умолчанию пустое (<literal>""</literal>).
|
|---|
| 263 | </para></listitem>
|
|---|
| 264 | </varlistentry>
|
|---|
| 265 | </variablelist>
|
|---|
| 266 | </refsect2>
|
|---|
| 267 | <refsect2 id="vboxmanage-usbfilter-add">
|
|---|
| 268 | <title>Добавить USB фильтр или глобальный фильтр</title>
|
|---|
| 269 | <remark role="help-copy-synopsis"/>
|
|---|
| 270 | <para>
|
|---|
| 271 | Используйте команду <command>VBoxManage usbfilter add</command>
|
|---|
| 272 | для создания нового USB фильтра.
|
|---|
| 273 | </para>
|
|---|
| 274 | <para>
|
|---|
| 275 | Дополнительно укажите параметры для фильтрации. Можно использовать
|
|---|
| 276 | команду <command>VBoxManage list usbhost</command> для просмотра
|
|---|
| 277 | параметров устройств, подключенных к вашей системе.
|
|---|
| 278 | </para>
|
|---|
| 279 | </refsect2>
|
|---|
| 280 | <refsect2 id="vboxmanage-usbfilter-modify">
|
|---|
| 281 | <title>Изменить USB фильтр или глобальный фильтр</title>
|
|---|
| 282 | <remark role="help-copy-synopsis"/>
|
|---|
| 283 | <para>
|
|---|
| 284 | Используйте команду <command>VBoxManage usbfilter modify</command>
|
|---|
| 285 | для изменения USB фильтра. Можно использовать команду
|
|---|
| 286 | <command>VBoxManage list usbfilters</command> для отображения
|
|---|
| 287 | индексов глобальных фильтров и команду
|
|---|
| 288 | <command>VBoxManage showvminfo</command> для отображения
|
|---|
| 289 | индексов по определенной машине.
|
|---|
| 290 | </para>
|
|---|
| 291 | </refsect2>
|
|---|
| 292 | <refsect2 id="vboxmanage-usbfilter-remove">
|
|---|
| 293 | <title>Удалить USB фильтр или глобальный фильтр</title>
|
|---|
| 294 | <remark role="help-copy-synopsis"/>
|
|---|
| 295 | <para>
|
|---|
| 296 | Используйте команду <command>VBoxManage usbfilter remove</command>
|
|---|
| 297 | для удаления USB фильтра.
|
|---|
| 298 | </para>
|
|---|
| 299 | </refsect2>
|
|---|
| 300 | </refsect1>
|
|---|
| 301 |
|
|---|
| 302 | <refsect1>
|
|---|
| 303 | <title>Примеры</title>
|
|---|
| 304 | <remark role="help-scope" condition="GLOBAL" />
|
|---|
| 305 | <para>
|
|---|
| 306 | Следующая команда отображает доступные USB устройства в хост-системе.
|
|---|
| 307 | </para>
|
|---|
| 308 | <screen>$ VBoxManage list usbhost</screen>
|
|---|
| 309 | <para>
|
|---|
| 310 | Следующая команда добавляет USB фильтр, называемый
|
|---|
| 311 | <filename>filter01</filename> к ВМ <filename>ol7</filename>.
|
|---|
| 312 | Фильтр определяет флеш-накопитель Kingston DataTraveler и
|
|---|
| 313 | помещается первым в списке USB фильтров ВМ.
|
|---|
| 314 | </para>
|
|---|
| 315 | <screen>$ VBoxManage usbfilter add 0 --target ol7 --name filter01 --vendorid 0x0930 --productid 0x6545</screen>
|
|---|
| 316 | <para>
|
|---|
| 317 | Следующая команда удаляет USB фильтр, который второй в списке
|
|---|
| 318 | ВМ <filename>ol7</filename> VM.
|
|---|
| 319 | </para>
|
|---|
| 320 | <screen>$ VBoxManage usbfilter remove 1 --target ol7</screen>
|
|---|
| 321 | </refsect1>
|
|---|
| 322 | </refentry>
|
|---|
