pve_replication_update
Update a PVE replication job with dry-run mode for planning, then execute with confirmation to apply changes.
Instructions
MUTATION: update a PVE replication job. Dry-run by default — the PLAN captures current config for manual revert; confirm=True to execute and returns synchronously (no task UPID). Config-only; in-flight replication is not immediately disrupted. To create a new job use pve_replication_create; to remove one use pve_replication_delete.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rate | No | New bandwidth limit in MB/s; omit to leave unchanged. | |
| rep_id | Yes | ID of the existing replication job to update. | |
| comment | No | New free-text note; omit to leave unchanged. | |
| confirm | No | Gate: false returns a dry-run PLAN, true executes the update. | |
| disable | No | Whether the job is disabled; omit to leave unchanged. | |
| schedule | No | New Proxmox calendar-event schedule string; omit to leave unchanged. | |
| 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 |