1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage bandwidthctl
|
---|
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-bandwidthctl" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2024-02-29 20:47:25 +0000 (Thu, 29 Feb 2024) $</pubdate>
|
---|
34 | <title>VBoxManage bandwidthctl</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-bandwidthctl</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-bandwidthctl</refname>
|
---|
44 | <refpurpose>управление группами полосы пропускания</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-add">
|
---|
50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
51 | <command>VBoxManage bandwidthctl</command>
|
---|
52 | <group choice="req">
|
---|
53 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
54 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
---|
55 | </group>
|
---|
56 | <arg choice="plain">add</arg>
|
---|
57 | <arg choice="req"><replaceable>имя-группы-полосы-пропускания</replaceable></arg>
|
---|
58 | <arg choice="req">--limit=<replaceable>лимит-полосы-пропускания</replaceable>[k|m|g|K|M|G]</arg>
|
---|
59 | <arg choice="req">--type=disk|network</arg>
|
---|
60 | </cmdsynopsis>
|
---|
61 |
|
---|
62 | <cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-list">
|
---|
63 | <command>VBoxManage bandwidthctl</command>
|
---|
64 | <group choice="req">
|
---|
65 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
66 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
---|
67 | </group>
|
---|
68 | <arg choice="plain">list</arg>
|
---|
69 | <arg>--machinereadable</arg>
|
---|
70 | </cmdsynopsis>
|
---|
71 |
|
---|
72 | <cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-remove">
|
---|
73 | <command>VBoxManage bandwidthctl</command>
|
---|
74 | <group choice="req">
|
---|
75 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
76 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
---|
77 | </group>
|
---|
78 | <arg choice="plain">remove</arg>
|
---|
79 | <arg choice="req"><replaceable>имя-группы-полосы-пропускания</replaceable></arg>
|
---|
80 | </cmdsynopsis>
|
---|
81 |
|
---|
82 | <cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-set">
|
---|
83 | <command>VBoxManage bandwidthctl</command>
|
---|
84 | <group choice="req">
|
---|
85 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
86 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
---|
87 | </group>
|
---|
88 | <arg choice="plain">set</arg>
|
---|
89 | <arg choice="req"><replaceable>имя-группы-полосы-пропускания</replaceable></arg>
|
---|
90 | <arg choice="req">--limit=<replaceable>лимит-полосы-пропускания</replaceable>[k|m|g|K|M|G]</arg>
|
---|
91 | </cmdsynopsis>
|
---|
92 | </refsynopsisdiv>
|
---|
93 |
|
---|
94 | <refsect1 id="vboxmanage-bandwidthctl-description">
|
---|
95 | <title>Описание</title>
|
---|
96 | <para>
|
---|
97 | Команда <command>VBoxManage bandwidthctl</command> позволяет управлять
|
---|
98 | группами полосы пропускания для виртуальных машин (ВМ). Группа полосы
|
---|
99 | пропускания указывает лимит полосы пропускания для дисков или сетевых
|
---|
100 | адаптеров ВМ.
|
---|
101 | </para>
|
---|
102 | <para>
|
---|
103 | Обратите внимание, что лимит полосы пропускания сети применяется только
|
---|
104 | к исходящему траффику ВМ. Входящий траффик не ограничивается.
|
---|
105 | </para>
|
---|
106 | <refsect2 id="vboxmanage-bandwidthctl-add">
|
---|
107 | <title>Создание группы полосы пропускания</title>
|
---|
108 | <remark role="help-copy-synopsis"/>
|
---|
109 | <para>
|
---|
110 | Команда <command>VBoxManage bandwidthctl add</command> создает группу
|
---|
111 | полосы пропускания для указанной ВМ. Вы должны указать назначение
|
---|
112 | группы полосы пропускания: для дисков или сетей, а также указать
|
---|
113 | лимит полосы пропускания.
|
---|
114 | </para>
|
---|
115 | <variablelist>
|
---|
116 | <varlistentry>
|
---|
117 | <term><replaceable>uuid</replaceable> | <replaceable>имя-ВМ</replaceable></term>
|
---|
118 | <listitem><para>
|
---|
119 | Указывает Универсальный Уникальный Идентификатор (UUID) или
|
---|
120 | имя ВМ.
|
---|
121 | </para></listitem>
|
---|
122 | </varlistentry>
|
---|
123 | <varlistentry>
|
---|
124 | <term><option><replaceable>имя-группы-полосы-пропускания</replaceable></option></term>
|
---|
125 | <listitem><para>
|
---|
126 | Указывает имя группы полосы пропускания.
|
---|
127 | </para></listitem>
|
---|
128 | </varlistentry>
|
---|
129 | <varlistentry>
|
---|
130 | <term><option>--type=disk|network</option></term>
|
---|
131 | <listitem><para>
|
---|
132 | Указывает тип группы полосы пропускания:
|
---|
133 | <literal>disk</literal> и <literal>network</literal>.
|
---|
134 | Для дополнительной информации смотрите
|
---|
135 | <xref linkend="storage-bandwidth-limit" /> или <xref linkend="network_bandwidth_limit" />.
|
---|
136 | </para></listitem>
|
---|
137 | </varlistentry>
|
---|
138 | <varlistentry>
|
---|
139 | <term><option>--limit=<replaceable>лимит-полосы-пропускания</replaceable>[k|m|g|K|M|G]</option></term>
|
---|
140 | <listitem><para>
|
---|
141 | Указывает лимит для группы полосы пропускания. По умолчанию,
|
---|
142 | указывается в мегабайтах в секунду. Можно изменить это значение
|
---|
143 | пока ВМ работает.
|
---|
144 | </para><para>
|
---|
145 | Можно изменить единицы измерения, добавляя следующие спецификаторы
|
---|
146 | к лимиту полосы пропускания:
|
---|
147 | </para><itemizedlist>
|
---|
148 | <listitem><para>
|
---|
149 | <literal>k</literal> – килобит в секунду
|
---|
150 | </para></listitem>
|
---|
151 | <listitem><para>
|
---|
152 | <literal>m</literal> – мегабит в секунду
|
---|
153 | </para></listitem>
|
---|
154 | <listitem><para>
|
---|
155 | <literal>g</literal> – гигабит в секунду
|
---|
156 | </para></listitem>
|
---|
157 | <listitem><para>
|
---|
158 | <literal>K</literal> – килобайт в секунду
|
---|
159 | </para></listitem>
|
---|
160 | <listitem><para>
|
---|
161 | <literal>M</literal> – мегабайт в секунду
|
---|
162 | </para></listitem>
|
---|
163 | <listitem><para>
|
---|
164 | <literal>G</literal> – гигабайт в секунду
|
---|
165 | </para></listitem>
|
---|
166 | </itemizedlist></listitem>
|
---|
167 | </varlistentry>
|
---|
168 | </variablelist>
|
---|
169 | </refsect2>
|
---|
170 | <refsect2 id="vboxmanage-bandwidthctl-list">
|
---|
171 | <title>Отображение групп полосы пропускания</title>
|
---|
172 | <remark role="help-copy-synopsis"/>
|
---|
173 | <para>
|
---|
174 | Команда <command>VBoxManage bandwidthctl list</command> показывает
|
---|
175 | все группы полосы пропускания, определенные для указанной ВМ.
|
---|
176 | Используйте опцию <option>--machinereadable</option> для вывода
|
---|
177 | в машино-читаемом формате, который использует пары имя-значение.
|
---|
178 | </para>
|
---|
179 | <variablelist>
|
---|
180 | <varlistentry>
|
---|
181 | <term><replaceable>uuid</replaceable> | <replaceable>имя-ВМ</replaceable></term>
|
---|
182 | <listitem><para>
|
---|
183 | Указывает UUID или имя ВМ.
|
---|
184 | </para></listitem>
|
---|
185 | </varlistentry>
|
---|
186 | <varlistentry>
|
---|
187 | <term><option>--machinereadable</option></term>
|
---|
188 | <listitem><para>
|
---|
189 | Выводит информацию о группах полосы пропускания в виде
|
---|
190 | пар имя-значение.
|
---|
191 | </para></listitem>
|
---|
192 | </varlistentry>
|
---|
193 | </variablelist>
|
---|
194 | </refsect2>
|
---|
195 | <refsect2 id="vboxmanage-bandwidthctl-remove">
|
---|
196 | <title>Удаление группы полосы пропускания</title>
|
---|
197 | <remark role="help-copy-synopsis"/>
|
---|
198 | <para>
|
---|
199 | Команда <command>VBoxManage bandwidthctl remove</command> удаляет
|
---|
200 | группу полосы пропускания.
|
---|
201 | </para>
|
---|
202 | <note>
|
---|
203 | <para>
|
---|
204 | Для успешного удаления группы полосы пропускания, убедитесь
|
---|
205 | что она не ссылается на диск или адаптер работающей ВМ.
|
---|
206 | </para>
|
---|
207 | </note>
|
---|
208 | <variablelist>
|
---|
209 | <varlistentry>
|
---|
210 | <term><replaceable>uuid</replaceable> | <replaceable>имя-ВМ</replaceable></term>
|
---|
211 | <listitem><para>
|
---|
212 | Указывает UUID или имя ВМ.
|
---|
213 | </para></listitem>
|
---|
214 | </varlistentry>
|
---|
215 | <varlistentry>
|
---|
216 | <term><option><replaceable>имя-группы-полосы-пропускания</replaceable></option></term>
|
---|
217 | <listitem><para>
|
---|
218 | Указывает имя группы полосы пропускания.
|
---|
219 | </para></listitem>
|
---|
220 | </varlistentry>
|
---|
221 | </variablelist>
|
---|
222 | </refsect2>
|
---|
223 | <refsect2 id="vboxmanage-bandwidthctl-set">
|
---|
224 | <title>Изменение лимита группы полосы пропускания</title>
|
---|
225 | <remark role="help-copy-synopsis"/>
|
---|
226 | <para>
|
---|
227 | Команда <command>VBoxManage bandwidthctl set</command> изменяет
|
---|
228 | лимит группы полосы пропускания.
|
---|
229 | </para>
|
---|
230 | <variablelist>
|
---|
231 | <varlistentry>
|
---|
232 | <term><replaceable>uuid</replaceable> | <replaceable>имя-ВМ</replaceable></term>
|
---|
233 | <listitem><para>
|
---|
234 | Указывает UUID или имя ВМ.
|
---|
235 | </para></listitem>
|
---|
236 | </varlistentry>
|
---|
237 | <varlistentry>
|
---|
238 | <term><option><replaceable>bandwidth-group-name</replaceable></option></term>
|
---|
239 | <listitem><para>
|
---|
240 | Указывает имя группы полосы пропускания.
|
---|
241 | </para></listitem>
|
---|
242 | </varlistentry>
|
---|
243 | <varlistentry>
|
---|
244 | <term><option>--limit=<replaceable>лимит-полосы-пропускания</replaceable>[k|m|g|K|M|G]</option></term>
|
---|
245 | <listitem><para>
|
---|
246 | Указывает лимит для группы полосы пропускания. По умолчанию,
|
---|
247 | указывается в мегабайтах в секунду. Можно изменить это значение
|
---|
248 | пока ВМ работает.
|
---|
249 | </para><para>
|
---|
250 | Можно изменить единицы измерения, добавляя следующие спецификаторы
|
---|
251 | к лимиту полосы пропускания:
|
---|
252 | </para><itemizedlist>
|
---|
253 | <listitem><para>
|
---|
254 | <literal>k</literal> – килобит в секунду
|
---|
255 | </para></listitem>
|
---|
256 | <listitem><para>
|
---|
257 | <literal>m</literal> – мегабит в секунду
|
---|
258 | </para></listitem>
|
---|
259 | <listitem><para>
|
---|
260 | <literal>g</literal> – гигабит в секунду
|
---|
261 | </para></listitem>
|
---|
262 | <listitem><para>
|
---|
263 | <literal>K</literal> – килобайт в секунду
|
---|
264 | </para></listitem>
|
---|
265 | <listitem><para>
|
---|
266 | <literal>M</literal> – мегабайт в секунду
|
---|
267 | </para></listitem>
|
---|
268 | <listitem><para>
|
---|
269 | <literal>G</literal> – гигабайт в секунду
|
---|
270 | </para></listitem>
|
---|
271 | </itemizedlist></listitem>
|
---|
272 | </varlistentry>
|
---|
273 | </variablelist>
|
---|
274 | </refsect2>
|
---|
275 | </refsect1>
|
---|
276 |
|
---|
277 | <refsect1 id="vboxmanage-bandwidthctl-examples">
|
---|
278 | <title>Примеры</title>
|
---|
279 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
280 | <para>
|
---|
281 | Следующий пример показывает, как использовать команду
|
---|
282 | <command>VBoxManage bandwidthctl</command> для создания группы
|
---|
283 | полосы пропускания <literal>Limit</literal> с лимитом в 20 Мбит/с.
|
---|
284 | Затем используется команда <command>VBoxManage modifyvm</command>
|
---|
285 | для назначения этой группы первому и второму адаптерам ВМ
|
---|
286 | <literal>vm1</literal>.
|
---|
287 | </para>
|
---|
288 | <screen>$ VBoxManage bandwidthctl "vm1" add Limit --type network --limit 20m
|
---|
289 | $ VBoxManage modifyvm "vm1" --nicbandwidthgroup1 Limit
|
---|
290 | $ VBoxManage modifyvm "vm1" --nicbandwidthgroup2 Limit</screen>
|
---|
291 | <para>
|
---|
292 | Можно динамически менять лимит группы полосы пропускания пока
|
---|
293 | ВМ работает. Следующий пример показывает как изменить лимит
|
---|
294 | для группы полосы пропускания <literal>Limit</literal> с 20
|
---|
295 | Мбит/с в 100 кбит/с:
|
---|
296 | </para>
|
---|
297 | <screen>$ VBoxManage bandwidthctl "vm1" set Limit --limit 100k</screen>
|
---|
298 | <para>
|
---|
299 | Следующая команда отключает ограничения для всех адаптеров в
|
---|
300 | группе полосы пропускания <literal>Limit</literal> путем установки
|
---|
301 | лимита в ноль (<literal>0</literal>):
|
---|
302 | </para>
|
---|
303 | <screen>$ VBoxManage bandwidthctl "vm1" set Limit --limit 0</screen>
|
---|
304 | </refsect1>
|
---|
305 | </refentry>
|
---|