pbs_realm_sync
Synchronize PBS authentication realm users from LDAP/AD. Uses dry-run by default; execute with confirm=True. Optionally removes users no longer present in the directory.
Instructions
MUTATION: sync PBS auth realm (LDAP/AD) users. Dry-run by default. confirm=True to execute. Async — returns UPID. Needs PROXIMO_PBS_* config. remove_vanished=True also removes PBS users no longer in the directory. (2026-07-10 audit: the old 'scope' param was dropped — PBS /sync has no such field.)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| realm | Yes | ||
| confirm | No | ||
| dry_run | No | ||
| 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 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |