pbs_realm_ad_update
Update an Active Directory realm configuration with a dry-run preview to verify changes before applying.
Instructions
MUTATION (MEDIUM): update an AD realm's config. Dry-run by default — the PLAN reads the
realm's current config first. password, if supplied, is redacted identically to
pbs_realm_ad_create's. confirm=True executes and returns a dict; synchronous, no UPID. Needs
PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | LDAP connection type; omit to leave unchanged. | |
| port | No | AD server port; omit to leave unchanged. | |
| realm | Yes | AD realm name to update. | |
| capath | No | CA certificate path; omit to leave unchanged. | |
| digest | No | Optional SHA256 config digest to prevent concurrent modifications. | |
| filter | No | Custom LDAP search filter; omit to leave unchanged. | |
| verify | No | TLS verification flag; omit to leave unchanged. | |
| base_dn | No | LDAP base DN; omit to leave unchanged. | |
| bind_dn | No | LDAP bind DN; omit to leave unchanged. | |
| comment | No | Optional free-text comment; omit to leave unchanged. | |
| confirm | No | False (default) returns a dry-run PLAN preview; True executes the mutation. | |
| default | No | Default-realm-on-login flag; omit to leave unchanged. | |
| server1 | No | Primary AD server address; omit to leave unchanged. | |
| server2 | No | Fallback AD server address; omit to leave unchanged. | |
| password | No | New AD bind password; redacted from all plans/logs/ledger. | |
| delete_props | No | Property names to clear. | |
| user_classes | No | Allowed objectClass values; omit to leave unchanged. | |
| 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. | |
| sync_attributes | No | Sync-attribute map string; omit to leave unchanged. | |
| sync_defaults_options | No | Sync-defaults options string; omit to leave unchanged. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |