create_backup_job
Schedule automated backups for Proxmox VMs and containers. Define storage, retention, compression, and notification settings to protect your virtual infrastructure.
Instructions
Create a scheduled backup job.
Args: storage: Target storage ID for backups. schedule: Schedule in systemd calendar format (e.g. 'daily', 'weekly', '02:00'). all_guests: Backup all guests. vmid: Comma-separated VMIDs to back up (if not all_guests). node: Only back up guests on this node. mode: Backup mode: 'snapshot', 'suspend', 'stop'. compress: Compression: 'none', 'lzo', 'gzip', 'zstd'. mailnotification: 'always' or 'failure'. mailto: Comma-separated email addresses. maxfiles: Max backup files to keep (0 = unlimited, deprecated - use prune_backups). prune_backups: Retention schedule (e.g. 'keep-daily=7,keep-weekly=4'). notes_template: Template for backup notes. enabled: Enable the job. comment: Description.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| storage | Yes | ||
| schedule | No | daily | |
| all_guests | No | ||
| vmid | No | ||
| node | No | ||
| mode | No | snapshot | |
| compress | No | zstd | |
| mailnotification | No | ||
| mailto | No | ||
| maxfiles | No | ||
| prune_backups | No | ||
| notes_template | No | ||
| enabled | No | ||
| comment | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |