pbs_tape_backup
Back up a datastore to a tape pool immediately without a schedule. Dry-run returns a plan; confirm=true executes the backup.
Instructions
MUTATION: one-off tape backup — back up a datastore to a tape pool right now, no schedule/job-id involved.
RISK_MEDIUM: writes datastore contents to tape, drive busy for the duration. Dry-run by default (returns a PLAN); confirm=True executes (POST /tape/backup) and returns {"status": "submitted", "result": ""}. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | Namespace to back up. | |
| pool | Yes | Media pool name (2-32 chars). | |
| drive | Yes | Drive identifier (3-32 chars). | |
| store | Yes | Datastore name to back up (3-32 chars, a single identifier — NOT the comma-separated mapping shape pbs_tape_restore's store uses). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the backup. | |
| max_depth | No | Namespace depth (0-7). | |
| eject_media | No | Eject media upon completion. | |
| latest_only | No | Back up latest snapshots only. | |
| notify_user | No | Notify-user (user@realm). | |
| group_filter | No | Group filters. | |
| 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 | Worker-thread count (1-32). | |
| force_media_set | No | Ignore the pool's allocation policy and start a new media-set. | |
| export_media_set | No | Export media set upon completion. | |
| notification_mode | No | 'legacy-sendmail' or 'notification-system'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |