pbs_datastore_create
Create a new PBS datastore on a Proxmox Backup Server by specifying a name and filesystem path. Supports dry-run mode to preview changes before confirming execution.
Instructions
MUTATION (MEDIUM): create a new PBS datastore at the given path.
Dry-run by default — additive, but a misconfigured path can conflict with existing storage. PBS datastore creation is an async worker task (UPID) → outcome='submitted' (not 'ok'). No rollback primitive. confirm=True to execute. Use pbs_datastores_list to check for name/path collisions first, or pbs_datastore_update to modify it afterward.
POST /config/datastore Smoke-confirm: gc-schedule / prune-schedule / notification-mode param names; sync-vs-async.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name for the new PBS datastore. | |
| path | Yes | Filesystem path on the PBS node where the datastore will be created. | |
| comment | No | Free-text comment/description for the datastore. | |
| confirm | No | Set True to execute; False (default) only returns the dry-run plan. | |
| gc_schedule | No | Garbage-collection schedule as a PBS calendar-event string (e.g. 'daily'). | |
| 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. | |
| prune_schedule | No | Prune-job schedule as a PBS calendar-event string (e.g. 'daily'). | |
| notification_mode | No | Notification delivery mode for this datastore (PBS notification-mode value). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |