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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage bandwidthctl
-->
<!--
Copyright (C) 2006-2024 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-bandwidthctl" lang="en">
<refentryinfo>
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
<title>VBoxManage bandwidthctl</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-bandwidthctl</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-bandwidthctl</refname>
<refpurpose>manage bandwidth groups</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-add">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage bandwidthctl</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">add</arg>
<arg choice="req"><replaceable>bandwidth-group-name</replaceable></arg>
<arg choice="req">--limit=<replaceable>bandwidth-limit</replaceable>[k|m|g|K|M|G]</arg>
<arg choice="req">--type=<group choice="plain">
<arg choice="plain">disk</arg>
<arg choice="plain">network</arg>
</group></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-list">
<command>VBoxManage bandwidthctl</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">list</arg>
<arg>--machinereadable</arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-remove">
<command>VBoxManage bandwidthctl</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">remove</arg>
<arg choice="req"><replaceable>bandwidth-group-name</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis id="synopsis-vboxmanage-bandwidthctl-set">
<command>VBoxManage bandwidthctl</command>
<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
<arg choice="plain">set</arg>
<arg choice="req"><replaceable>bandwidth-group-name</replaceable></arg>
<arg choice="req">--limit=<replaceable>bandwidth-limit</replaceable>[k|m|g|K|M|G]</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-bandwidthctl-description">
<title>Description</title>
<para>
The <command>VBoxManage bandwidthctl</command> command enables you
to manage bandwidth groups for virtual machines (VMs). A bandwidth
group specifies the bandwidth limit for the disks or for the
network adapters of a VM.
</para>
<para>
Note that a network bandwidth limit applies only to the outbound
traffic from the VM. The inbound traffic is unlimited.
</para>
<refsect2 id="vboxmanage-bandwidthctl-add">
<title>Create a Bandwidth Group</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage bandwidthctl add</command> command
creates a bandwidth group for the specified VM. You must specify
whether the bandwidth group is for disks or for networks and
specify the bandwidth limit.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the Universally Unique Identifier (UUID) or the
name of the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option><replaceable>bandwidth-group-name</replaceable></option></term>
<listitem><para>
Specifies the name of the bandwidth group.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--type=disk|network</option></term>
<listitem><para>
Specifies the type of the bandwidth group:
<literal>disk</literal> or <literal>network</literal>.
For more information, see
<xref linkend="storage-bandwidth-limit" /> or
<xref linkend="network_bandwidth_limit" />.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--limit=<replaceable>bandwidth-limit[k|m|g|K|M|G]</replaceable></option></term>
<listitem><para>
Specifies the bandwidth limit for a bandwidth group. The
default unit is megabytes per second. You can modify this
value while the VM is running.
</para><para>
You can change the unit by appending one of the following
unit specifiers to the bandwidth limit:
</para><itemizedlist>
<listitem><para>
<literal>k</literal> – kilobits per second
</para></listitem>
<listitem><para>
<literal>m</literal> – megabits per second
</para></listitem>
<listitem><para>
<literal>g</literal> – gigabits per second
</para></listitem>
<listitem><para>
<literal>K</literal> – kilobytes per second
</para></listitem>
<listitem><para>
<literal>M</literal> – megabytes per second
</para></listitem>
<listitem><para>
<literal>G</literal> – gigabytes per second
</para></listitem>
</itemizedlist></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-bandwidthctl-list">
<title>List Bandwidth Groups</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage bandwidthctl list</command> command
lists the all the bandwidth groups that have been defined for
the specified VM. Use the <option>--machinereadable</option>
option to produce the output in a machine-readable format, which
uses name-value pairs.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the UUID or the name of the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--machinereadable</option></term>
<listitem><para>
Outputs the information about the bandwidth groups in
name-value pairs.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-bandwidthctl-remove">
<title>Remove a Bandwidth Group</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage bandwidthctl remove</command> command
removes a bandwidth group.
</para>
<note>
<para>
To successfully remove a bandwidth group, ensure that it is
not referenced by any disk or adapter in the running VM.
</para>
</note>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the UUID or the name of the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option><replaceable>bandwidth-group-name</replaceable></option></term>
<listitem><para>
Specifies the name of the bandwidth group.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="vboxmanage-bandwidthctl-set">
<title>Modify the Bandwidth Limit of a Bandwidth Group</title>
<remark role="help-copy-synopsis"/>
<para>
The <command>VBoxManage bandwidthctl set</command> command
modifies the bandwidth limit for a bandwidth group.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the UUID or the name of the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option><replaceable>bandwidth-group-name</replaceable></option></term>
<listitem><para>
Specifies the name of the bandwidth group.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--limit=<replaceable>bandwidth-limit[k|m|g|K|M|G]</replaceable></option></term>
<listitem><para>
Specifies the bandwidth limit for a bandwidth group. The
default unit is megabytes per second. You can modify this
value while the VM is running.
</para><para>
You can change the unit by appending one of the following
unit specifiers to the bandwidth limit:
</para><itemizedlist>
<listitem><para>
<literal>k</literal> – kilobits per second
</para></listitem>
<listitem><para>
<literal>m</literal> – megabits per second
</para></listitem>
<listitem><para>
<literal>g</literal> – gigabits per second
</para></listitem>
<listitem><para>
<literal>K</literal> – kilobytes per second
</para></listitem>
<listitem><para>
<literal>M</literal> – megabytes per second
</para></listitem>
<listitem><para>
<literal>G</literal> – gigabytes per second
</para></listitem>
</itemizedlist></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id="vboxmanage-bandwidthctl-examples">
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL"/>
<para>
The following example shows how to use the <command>VBoxManage
bandwidthctl</command> command to create the
<literal>Limit</literal> bandwidth group and set the limit to 20
Mbps. Then use the <command>VBoxManage modifyvm</command> command
to assign this bandwidth group to the first and second adapters of
the <literal>vm1</literal> VM.
</para>
<screen>$ VBoxManage bandwidthctl "vm1" add Limit --type network --limit 20m
$ VBoxManage modifyvm "vm1" --nicbandwidthgroup1 Limit
$ VBoxManage modifyvm "vm1" --nicbandwidthgroup2 Limit</screen>
<para>
You can dynamically modify the limit of a bandwidth group while
the VM is running. The following example shows how to modify the
limit for the <literal>Limit</literal> bandwidth group from 20
Mbps to 100 kbps:
</para>
<screen>$ VBoxManage bandwidthctl "vm1" set Limit --limit 100k</screen>
<para>
The following command disables shaping for all adapters in the
<literal>Limit</literal> bandwidth group by specifying a limit of
zero (<literal>0</literal>):
</para>
<screen>$ VBoxManage bandwidthctl "vm1" set Limit --limit 0</screen>
</refsect1>
</refentry>
|
