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

Timestamp:

Jun 22, 2012 9:32:15 AM (12 years ago)

Author:

vboxsync

Message:

doc/manual: examples for disabling the shaper + emphasize that only TX traffic is being shaped (#5582)

Location:

trunk/doc/manual/en_US

Files:

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

trunk/doc/manual/en_US/user_Networking.xml

@@ -778 +778 @@
     of one VM may share limits through bandwidth groups. It is possible
     to have more than one such limit.</para>
+    <note><para>VirtualBox shapes VM traffic only in ergress direction, delaying
+        the packets being sent by virtual machines. It does not limit the
+        traffic being received by virtual machines.</para>
+    </note>
 
     <para>Limits are configured through
@@ -794 +798 @@
     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>
+
+    <para>To completely disable shaping for the first adapter of VM use the
+      following command:
+      <screen>VBoxManage modifyvm "VM name" --nicbandwidthgroup1 none</screen></para>
+
+    <para>It is also possible to disable shaping for all adapters assigned to a
+      bandwidth group while VM is running, by specifying the zero limit for the
+      group. For example, for the bandwidth group named "Limit" use:
+      <screen>VBoxManage bandwidthctl "VM name" set Limit --limit 0</screen></para>
   </sect1>
 </chapter>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -2031 +2031 @@
               while the VM is running. The default unit is megabytes per
               second. The unit can be changed by specifying one of the
-              following suffixes: <computeroutput>k</computeroutput> for kilobits/s, <computeroutput>m</computeroutput> for megabits/s, <computeroutput>g</computeroutput> for gigabits/s, <computeroutput>K</computeroutput> for kilobytes/s, <computeroutput>M</computeroutput> for megabytes/s, <computeroutput>G</computeroutput> for gigabytes/s</para>
+              following suffixes: <computeroutput>k</computeroutput> for kilobits/s, <computeroutput>m</computeroutput> for megabits/s, <computeroutput>g</computeroutput> for gigabits/s, <computeroutput>K</computeroutput> for kilobytes/s, <computeroutput>M</computeroutput> for megabytes/s, <computeroutput>G</computeroutput> for gigabytes/s.</para>
           </glossdef>
         </glossentry>
       </glosslist>
+      <note>
+        <para>The network bandwidth limits apply only to the traffic being sent by
+          virtual machines. The traffic being received by VMs is unlimited.</para>
+      </note>
       <note>
         <para>To remove a bandwidth group it must not be referenced by any disks