pbs_realm_sync
Sync users from a PBS LDAP/AD realm into PBS. Run a dry-run preview by default; set confirm=true to apply changes and optionally remove users no longer in the directory.
Instructions
MUTATION: sync PBS auth realm (LDAP/AD) users into PBS. Dry-run by default; confirm=True to execute. Async — returns a UPID; check progress with pbs_tasks_list. remove_vanished=True additionally DELETES PBS users no longer present in the directory (recoverable only by re-sync, not a true undo). Needs PROXIMO_PBS_* config. (2026-07-10 audit: the old 'scope' param was dropped — PBS /sync has no such field.)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| realm | Yes | PBS LDAP/AD auth realm ID to sync users from. | |
| confirm | No | Gate: false returns a dry-run PLAN, true executes the sync. | |
| dry_run | No | If true, ask PBS itself to preview the sync without applying it (separate from the tool's own confirm gate). | |
| 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. | |
| remove_vanished | No | If true, also delete PBS users no longer present in the directory. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |