pbs_traffic_control_upsert
Create or update a Proxmox Backup Server traffic control rule. Set rate limits for inbound and outbound bandwidth. Dry-run by default; set confirm=true to apply.
Instructions
MUTATION: create or update a PBS traffic-control (bandwidth-limit) rule. Dry-run by default.
Detects create-vs-update by reading the existing rule config (CAPTURE on update path): create → LOW: additive, no existing rule changed. update → MEDIUM: changing rate limits can throttle backups or saturate the network.
A too-low rate-in or rate-out throttles PBS backups to a crawl. No rollback primitive. confirm=True to execute.
POST (create) or PUT (update) /config/traffic-control[/{name}] Smoke-confirm: create-vs-update dispatch; rate-in/rate-out/burst-in/burst-out/timeframe param names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| comment | No | ||
| confirm | No | ||
| network | No | ||
| rate_in | No | ||
| burst_in | No | ||
| rate_out | No | ||
| burst_out | No | ||
| timeframe | No | ||
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |