Changeset 41842 in vbox for trunk/doc/manual/en_US

Timestamp:

Jun 20, 2012 11:46:31 AM (13 years ago)

Author:

vboxsync

Message:

Main,VBoxManage,docs: bandwidth units changed to bytes (#5582)

File:

• trunk/doc/manual/en_US/user_Networking.xml (modified) (1 diff)

trunk/doc/manual/en_US/user_Networking.xml

@@ -770 +770 @@
       </footnote></para>
   </sect1>
+
+  <sect1 id="network_bandwidth_limit">
+    <title>Limiting bandwidth for network I/O</title>
+
+    <para>Starting with version 4.2, VirtualBox allows for limiting the
+    maximum bandwidth used for network transmission. Several network adapters
+    of one VM may share limits through bandwidth groups. It is possible
+    to have more than one such limit.</para>
+
+    <para>Limits are configured through
+    <computeroutput>VBoxManage</computeroutput>. The example below creates a
+    bandwidth group named "Limit", sets the limit to 20 Mbit/s and assigns the
+    group to the first and second adapters of the VM:<screen>VBoxManage bandwidthctl "VM name" add Limit --type network --limit 20m
+VBoxManage modifyvm "VM name" --nicbandwidthgroup1 Limit
+VBoxManage modifyvm "VM name" --nicbandwidthgroup2 Limit</screen></para>
+
+    <para>All adapters in a group share the bandwidth limit, meaning that in the
+    example above the bandwidth of both adapters combined can never exceed 20
+    Mbit/s. However, if one disk doesn't require bandwidth the other can use the
+    remaining bandwidth of its group.</para>
+
+    <para>The limits for each group can be changed while the VM is running,
+    with changes being picked up immediately. The example below changes the
+    limit for the group created in the example above to 100 Kbit/s:<screen>VBoxManage bandwidthctl "VM name" set Limit --limit 100k</screen></para>
+  </sect1>
 </chapter>