From f215e02bf85f68d3a6106c2a1f4f7f063f819064 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 11 Apr 2024 10:17:27 +0200 Subject: Adding upstream version 7.0.14-dfsg. Signed-off-by: Daniel Baumann --- doc/manual/en_US/man_VBoxManage-bandwidthctl.xml | 307 +++++++++++++++++++++++ 1 file changed, 307 insertions(+) create mode 100644 doc/manual/en_US/man_VBoxManage-bandwidthctl.xml (limited to 'doc/manual/en_US/man_VBoxManage-bandwidthctl.xml') diff --git a/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml b/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml new file mode 100644 index 00000000..8a5b9b98 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml @@ -0,0 +1,307 @@ + + + + +%all.entities; +]> + + + $Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $ + VBoxManage bandwidthctl + + + + VBoxManage-bandwidthctl + 1 + + + + VBoxManage-bandwidthctl + manage bandwidth groups + &product-name; + + + + + + VBoxManage bandwidthctl + + uuid + vmname + + add + bandwidth-group-name + --limit=bandwidth-limit[k|m|g|K|M|G] + --type=disk|network + + + + VBoxManage bandwidthctl + + uuid + vmname + + list + --machinereadable + + + + VBoxManage bandwidthctl + + uuid + vmname + + remove + bandwidth-group-name + + + + VBoxManage bandwidthctl + + uuid + vmname + + set + bandwidth-group-name + --limit=bandwidth-limit[k|m|g|K|M|G] + + + + + Description + + The VBoxManage bandwidthctl 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. + + + Note that a network bandwidth limit applies only to the outbound + traffic from the VM. The inbound traffic is unlimited. + + + Create a Bandwidth Group + + + The VBoxManage bandwidthctl add 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. + + + + uuid | vmname + + Specifies the Universally Unique Identifier (UUID) or the + name of the VM. + + + + + + Specifies the name of the bandwidth group. + + + + + + Specifies the type of the bandwidth group: + disk and network. + For more information, see + or + . + + + + + + 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. + + You can change the unit by appending one of the following + unit specifiers to the bandwidth limit: + + + k – kilobits per second + + + m – megabits per second + + + g – gigabits per second + + + K – kilobytes per second + + + M – megabytes per second + + + G – gigabytes per second + + + + + + + List Bandwidth Groups + + + The VBoxManage bandwidthctl list command + lists the all the bandwidth groups that have been defined for + the specified VM. Use the + option to produce the output in a machine-readable format, which + uses name-value pairs. + + + + uuid | vmname + + Specifies the UUID or the name of the VM. + + + + + + Outputs the information about the bandwidth groups in + name-value pairs. + + + + + + Remove a Bandwidth Group + + + The VBoxManage bandwidthctl remove command + removes a bandwidth group. + + + + To successfully remove a bandwidth group, ensure that it is + not referenced by any disk or adapter in the running VM. + + + + + uuid | vmname + + Specifies the UUID or the name of the VM. + + + + + + Specifies the name of the bandwidth group. + + + + + + Modify the Bandwidth Limit of a Bandwidth Group + + + The VBoxManage bandwidthctl set command + modifies the bandwidth limit for a bandwidth group. + + + + uuid | vmname + + Specifies the UUID or the name of the VM. + + + + + + Specifies the name of the bandwidth group. + + + + + + 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. + + You can change the unit by appending one of the following + unit specifiers to the bandwidth limit: + + + k – kilobits per second + + + m – megabits per second + + + g – gigabits per second + + + K – kilobytes per second + + + M – megabytes per second + + + G – gigabytes per second + + + + + + + + + Examples + + + The following example shows how to use the VBoxManage + bandwidthctl command to create the + Limit bandwidth group and set the limit to 20 + Mbps. Then use the VBoxManage modifyvm command + to assign this bandwidth group to the first and second adapters of + the vm1 VM. + +$ VBoxManage bandwidthctl "vm1" add Limit --type network --limit 20m +$ VBoxManage modifyvm "vm1" --nicbandwidthgroup1 Limit +$ VBoxManage modifyvm "vm1" --nicbandwidthgroup2 Limit + + 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 Limit bandwidth group from 20 + Mbps to 100 kbps: + +$ VBoxManage bandwidthctl "vm1" set Limit --limit 100k + + The following command disables shaping for all adapters in the + Limit bandwidth group by specifying a limit of + zero (0): + +$ VBoxManage bandwidthctl "vm1" set Limit --limit 0 + + -- cgit v1.2.3