pbs_push
Push backup snapshots from a local Proxmox Backup Server datastore to a remote PBS datastore. Supports dry-run planning and optional execution with confirmation.
Instructions
MUTATION: push backups from the LOCAL datastore store to a REMOTE PBS datastore.
RISK_MEDIUM by default, escalating to RISK_HIGH when remove_vanished=True (mirrors pbs_pull's
risk model, applied to the REMOTE side — see proximo.pbs_admin module docstring's RISK RATING
section). WRITES real backup data into the REMOTE remote_store; an over-broad or absent
group_filter transfers every group in scope. Dry-run by default (returns a PLAN disclosing
every param that changes where data lands or what gets deleted); confirm=True executes
(POST /push). The live schema declares this returns null — no UPID to poll; Smoke-confirm
whether this call blocks synchronously for the full transfer duration. No rollback primitive
— a remote push cannot be undone from this side. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | Namespace on the LOCAL datastore to push from. Defaults to root. | |
| store | Yes | LOCAL PBS datastore name to push backups FROM. REQUIRED. | |
| remote | Yes | Remote ID identifying the destination PBS. REQUIRED (unlike pbs_pull's optional remote). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the push. | |
| rate_in | No | Inbound rate limit as a byte size with unit. | |
| burst_in | No | Inbound burst limit as a byte size with unit. | |
| rate_out | No | Outbound rate limit as a byte size with unit. | |
| burst_out | No | Outbound burst limit as a byte size with unit. | |
| max_depth | No | Namespace recursion depth, 0-7. | |
| remote_ns | No | Namespace on the REMOTE datastore to push into. Defaults to root. | |
| group_filter | No | Group filters, e.g. '[exclude:]type:vm' or 'group:GROUP' or 'regex:RE'. Omit to push EVERY group in scope. | |
| remote_store | Yes | Datastore name on the remote PBS to push TO. REQUIRED. | |
| transfer_last | No | Limit transfer to the last N snapshots per group (>=1). | |
| verified_only | No | Only synchronize verified backup snapshots, exclude others. | |
| encrypted_only | No | Only synchronize encrypted backup snapshots, exclude others. | |
| encryption_key | No | ID of an already-registered client encryption key (pbs_encryption_key_*) to encrypt content toward the remote. NOT the raw key material. | |
| 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. | |
| worker_threads | No | Number of worker threads to process groups in parallel, 1-32. | |
| remove_vanished | No | DELETE remote snapshots that no longer exist locally. Escalates this call's risk to HIGH — no dry-run preview exists. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |