pve_replication_create
Define a Proxmox replication job for VM data synchronization across nodes. Dry-run plans changes; confirm executes.
Instructions
MUTATION: create a PVE replication job. Dry-run by default; confirm=True to execute and returns synchronously (no task UPID) — additive, no existing data affected. rep_type is typically 'local'. To modify an existing job use pve_replication_update; to remove one use pve_replication_delete.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rate | No | Bandwidth limit in MB/s; omit for unlimited. | |
| rep_id | Yes | Unique ID for the new replication job. | |
| target | Yes | Target node (or node/storage) to replicate to. | |
| comment | No | Free-text note stored on the job. | |
| confirm | No | Gate: false returns a dry-run PLAN, true executes the creation. | |
| disable | No | If true, create the job in a disabled state. | |
| rep_type | Yes | Replication job type, typically 'local'. | |
| schedule | No | Proxmox calendar-event schedule string; omit for the default cadence. | |
| 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |