Changeset 34643 in vbox for trunk/doc

Timestamp:

Dec 2, 2010 6:16:20 PM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

68445

Message:

Manual: Add explanation of bandwidth groups

Location:

trunk/doc/manual/en_US

Files:

• user_Storage.xml (modified) (1 diff)
• user_VBoxManage.xml (modified) (2 diffs)

trunk/doc/manual/en_US/user_Storage.xml

@@ -946 +946 @@
     </sect2>
   </sect1>
+
+  <sect1 id="storage-bandwidth-limit">
+    <title>Limiting banwidth for disk images</title>
+    <para>VirtualBox allows limiting the maximum bandwidth used for asynchronous
+    I/O. Additionally it supports sharing limits through bandwidth groups for
+    several images. It is possible to have more than limit.
+    The limits can be configured through <computeroutput>VBoxManage</computeroutput>.
+    The example below creates a bandwidth group named "Limit" and sets the limit
+    to 20 MB/s and assigns the group to the attached disks of the VM:
+    <screen>VBoxManage bandwidthctl "VM name" --name Limit --add disk --limit 20
+VBoxManage storageattach "VM name" --controller "SATA" --port 0 --device 0 --type hdd
+                                   --medium disk1.vdi --bandwidthgroup Limit
+VBoxManage storageattach "VM name" --controller "SATA" --port 1 --device 0 --type hdd
+                                   --medium disk2.vdi --bandwidthgroup Limit</screen>
+
+    <para>Both disks will share the bandwidth limit meaning that the used bandwidth of
+    both can never exceed 20 MB/s. However if one disk doesn't require bandwidth
+    the other can use everything.</para>
+
+    <para>The limits for each group can be changed while the VM is running.
+    The VM will pick up the new limit immediately in that case.
+    The example below changes the limit for the group created in the example
+    above to 10 MB/s:
+    <screen>VBoxManage bandwidthctl "VM name" --name Limit --limit 10</screen></para>
+    </para>
+  </sect1>
 </chapter>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1520 +1520 @@
                              --medium none|emptydrive|uuid|filename|host:<drive>]
                             [--passthrough on|off]
-                            [--forceunmount]</screen>
+                            [--forceunmount]
+                            [--bandwidthgroup name|none]</screen>
 
       <para>where the parameters mean: <glosslist>
@@ -1631 +1632 @@
             </glossdef>
           </glossentry>
+
+          <glossentry>
+            <glossterm>bandwidthgroup</glossterm>
+
+            <glossdef>
+              <para>Sets the bandwidth group to use for the given device;
+              see see <xref linkend="storage-bandwdith-limit" /></para>
+            </glossdef>
+          </glossentry>
         </glosslist></para>
     </sect2>
+  </sect1>
+
+  <sect1>
+    <title>VBoxManage bandwidthctl</title>
+
+    <para>This command creates/deletes/modifies bandwidth groups of
+    the given virtual machine:</para>
+
+    <screen>VBoxManage bandwidhtctl    &lt;uuid|vmname&gt;
+                          --name &lt;name&gt;
+                          [--add disk
+                          [--delete]
+                          [--limit MB/s]</screen>
+
+    <para>where the parameters mean: <glosslist>
+        <glossentry>
+          <glossterm>uuid|vmname</glossterm>
+
+          <glossdef>
+            <para>The VM UUID or VM Name. Mandatory.</para>
+          </glossdef>
+        </glossentry>
+
+        <glossentry>
+          <glossterm>name</glossterm>
+
+          <glossdef>
+            <para>Name of the bandwidth group. Mandatory.</para>
+          </glossdef>
+        </glossentry>
+
+        <glossentry>
+          <glossterm>add</glossterm>
+
+          <glossdef>
+            <para>Creates a new bandwdith group with the given type.</para>
+          </glossdef>
+        </glossentry>
+
+        <glossentry>
+          <glossterm>delete</glossterm>
+
+          <glossdef>
+            <para>Deletes a bandwdith group if it isn't used anymore.</para>
+          </glossdef>
+        </glossentry>
+
+        <glossentry>
+          <glossterm>limit</glossterm>
+
+          <glossdef>
+            <para>Sets the limit for the given group to the specified amount.
+            Can be changed while the VM is running.</para>
+          </glossdef>
+        </glossentry>
+
+      </glosslist></para>
   </sect1>