pbs_node_disk_zfs_create
Create a ZFS pool from disks and mount as a datastore on a Proxmox Backup Server node. Dry-run by default; confirm to execute, formatting disks irreversibly.
Instructions
MUTATION: create a zpool from disks and mount it as a zfs datastore on a PBS node.
RISK_HIGH: FORMATS the named device(s) immediately — any pre-existing data is destroyed, irreversibly. Unlike the directory backend, PBS's API has NO delete endpoint for a zfs backend at all (module docstring gap #3) — once created, this zpool cannot be destroyed through this API. Dry-run by default (returns a PLAN, which names this no-delete gap explicitly); confirm=True executes (POST /nodes/{node}/disks/zfs, Smoke-confirm) and returns {"status": "submitted", "result": <task UPID | None>}. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Datastore name to create (3-32 chars, alnum/underscore start). | |
| node | No | PBS node name (or 'localhost'). | localhost |
| ashift | No | Pool sector size exponent, 9-16 (PBS default 12 if omitted). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the creation. | |
| devices | Yes | Comma-separated bare disk names to consume (e.g. 'sda,sdb') — NOT /dev/ paths. | |
| raidlevel | Yes | ZFS RAID level: single, mirror, raid10, raidz, raidz2, or raidz3. (No dRAID — PBS's schema doesn't offer it, unlike PVE.) | |
| compression | No | ZFS compression algorithm: gzip, lz4, lzjb, zle, zstd, on, or off. | |
| add_datastore | No | If True, also register a PBS datastore using this zpool. | |
| 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
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |