%all.entities; ]> $Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $ 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] 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. 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. bandwidth-group-name Specifies the name of the bandwidth group. --type=disk|network Specifies the type of the bandwidth group: disk and network. For more information, see or . --limit=bandwidth-limit[k|m|g|K|M|G] 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 The VBoxManage bandwidthctl list command lists the all the bandwidth groups that have been defined for the specified VM. Use the --machinereadable 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. --machinereadable Outputs the information about the bandwidth groups in name-value pairs. 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. bandwidth-group-name Specifies the name of the 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. bandwidth-group-name Specifies the name of the bandwidth group. --limit=bandwidth-limit[k|m|g|K|M|G] 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 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