projects / proxmox-backup.git / blame
| Commit | Line | Data |
|---|---|---|
| 96ec3801 DM |
1 | .. _sysadmin_traffic_control: |
| 2 | ||
| 3 | Traffic Control | |
| 4 | --------------- | |
| 5 | ||
| 6 | Proxmox Backup Server allows to limit network traffic for clients | |
| 7 | within specified source networks. The following command adds a traffic | |
| 8 | control rule to limit all clients (network ``0.0.0.0/0``) to 100 MB/s: | |
| 9 | ||
| 10 | ||
| 11 | .. code-block:: console | |
| 12 | ||
| 13 | # proxmox-backup-manager traffic-control create rule0 --network 0.0.0.0/0 \ | |
| 14 | --rate-in 100000000 --rate-out 100000000 \ | |
| 15 | --comment "Default rate limit (100MB/s) for all clients" | |
| 16 | ||
| 17 | It is possible to restrict rules to certain time frames, for example | |
| 18 | the company office hours: | |
| 19 | ||
| 20 | .. code-block:: console | |
| 21 | ||
| 22 | # proxmox-backup-manager traffic-control update rule0 \ | |
| 23 | --timeframe "mon..fri 8-12" \ | |
| 24 | --timeframe "mon..fri 14:30-18" | |
| 25 | ||
| 26 | If there are more rules, the server uses the rule with the smaller | |
| 27 | network. For example, we can overwrite the setting for our private | |
| 28 | network (and the server itself) with: | |
| 29 | ||
| 30 | .. code-block:: console | |
| 31 | ||
| 32 | # proxmox-backup-manager traffic-control create rule1 \ | |
| 33 | --network 192.168.2.0/24 \ | |
| 34 | --network 127.0.0.0/8 \ | |
| 35 | --rate-in 20000000000 --rate-out 20000000000 \ | |
| 36 | --comment "Use 20GB/s for the local network" | |
| 37 | ||
| 38 | .. note:: The behavior is undefined if there are several rules for the same network. | |
| 39 | ||
| 40 | To list the current rules use: | |
| 41 | ||
| 42 | .. code-block:: console | |
| 43 | ||
| 44 | # proxmox-backup-manager traffic-control list | |
| 45 | ┌───────┬─────────────┬─────────────┬─────────────────────────┬────────────...─┐ | |
| 46 | │ name │ rate-in │ rate-out │ network │ timeframe ... │ | |
| 47 | ╞═══════╪═════════════╪═════════════╪═════════════════════════╪════════════...═╡ | |
| 48 | │ rule0 │ 100000000 │ 100000000 │ ["0.0.0.0/0"] │ ["mon..fri ... │ | |
| 49 | ├───────┼─────────────┼─────────────┼─────────────────────────┼────────────...─┤ | |
| 50 | │ rule1 │ 20000000000 │ 20000000000 │ ["192.168.2.0/24", ...] │ ... │ | |
| 51 | └───────┴─────────────┴─────────────┴─────────────────────────┴────────────...─┘ | |
| 52 | ||
| 53 | Rules can also be removed: | |
| 54 | ||
| 55 | .. code-block:: console | |
| 56 | ||
| 57 | # proxmox-backup-manager traffic-control remove rule1 | |
| 58 | ||
| 59 | ||
| 60 | To show the state (current data rate) of all configured rules use: | |
| 61 | ||
| 62 | .. code-block:: console | |
| 63 | ||
| 64 | # proxmox-backup-manager traffic-control traffic | |
| 65 | ┌───────┬─────────┬──────────┐ | |
| 66 | │ name │ rate-in │ rate-out │ | |
| 67 | ╞═══════╪═════════╪══════════╡ | |
| 68 | │ rule0 │ 0 │ 0 │ | |
| 69 | ├───────┼─────────┼──────────┤ | |
| 70 | │ rule1 │ 10344 │ 237 │ | |
| 71 | └───────┴─────────┴──────────┘ |