pbs_tape_backup_job_create
Create a tape backup job in Proxmox Backup Server with specified job ID, drive, media pool, and datastore. Plan first with dry-run mode, then confirm to execute.
Instructions
MUTATION: create a PBS tape backup job.
RISK_LOW: additive — no existing job/pool/drive config is affected. Dry-run by default (returns a PLAN); confirm=True executes (POST /config/tape-backup-job, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | Namespace to operate on. | |
| pool | Yes | Media pool name (2-32 chars). | |
| drive | Yes | Drive identifier (3-32 chars). | |
| store | Yes | Datastore name (3-32 chars). | |
| job_id | Yes | New tape backup job ID (3-32 chars). | |
| comment | No | Optional comment (<=128 chars). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the creation. | |
| schedule | No | Calendar-event schedule string for automatic runs. | |
| max_depth | No | How many namespace levels to operate on (0-7, default 7). | |
| eject_media | No | Eject media upon job completion. | |
| latest_only | No | Back up latest snapshots only. | |
| notify_user | No | User ID to notify (user@realm). | |
| group_filter | No | Group filters, e.g. 'type:vm', 'group:GROUP', 'regex:RE', optionally prefixed 'exclude:'/'include:'. | |
| 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 | Number of worker threads (1-32, default 1). | |
| export_media_set | No | Export media set upon job completion. | |
| notification_mode | No | 'legacy-sendmail' or 'notification-system' (default). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |