pmg_backup_create
Create a Proxmox Mail Gateway configuration backup. Dry-run returns a plan; confirm to execute and save a .tar.gz file to the default backup directory.
Instructions
MUTATION (LOW): create a PMG configuration backup. Dry-run by default. confirm=True to execute. Needs PROXIMO_PMG_* config.
Additive — writes a new backup .tar.gz to /var/lib/pmg/backup/ on the target node; does not touch existing backups or live config. Dry-run returns a PLAN; confirm=True executes and returns {"status": "ok", "result": ...}.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node | No | PMG node name; defaults to the configured node. | |
| notify | No | Notification mode: always|error|never (default never). | never |
| confirm | No | False (default) returns a dry-run PLAN; True executes the mutation. | |
| statistic | No | Whether to include mail statistics in the backup (default True). | |
| 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 |