pbs_realm_ad_create
Set up an Active Directory realm for Proxmox Backup Server authentication. Define server, LDAP options, and sync attributes.
Instructions
MUTATION (MEDIUM): create an AD authentication realm. Dry-run by default.
PASSWORD REDACTION: password (the AD bind password), when supplied, is UNCONDITIONALLY
redacted from the plan, detail, and audit ledger (only {"password": "[redacted]"} is
recorded). confirm=True executes and returns a dict; synchronous, no UPID. Use
pbs_realm_ad_update to change it afterward, or pbs_realm_ad_delete to remove it. Needs
PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | LDAP connection type: 'ldap', 'ldap+starttls', or 'ldaps'. | |
| port | No | AD server port. | |
| realm | Yes | New AD realm name. | |
| capath | No | Path to a CA certificate file or directory to trust for TLS. | |
| filter | No | Custom LDAP search filter for user sync. | |
| verify | No | Whether to verify the AD server's TLS certificate. | |
| base_dn | No | LDAP base DN to search under; optional for AD. | |
| bind_dn | No | LDAP bind DN for the service account. | |
| comment | No | Optional free-text comment. | |
| confirm | No | False (default) returns a dry-run PLAN preview; True executes the mutation. | |
| default | No | True to make this the default realm preselected on login. | |
| server1 | Yes | Primary AD server address. | |
| server2 | No | Fallback AD server address. | |
| password | No | AD bind password for the service account; redacted from all plans/logs/ledger. | |
| user_classes | No | Comma-separated allowed objectClass values for user sync. | |
| 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 | Comma-separated key=value LDAP-attribute-to-PBS-field sync map, forwarded verbatim. | |
| sync_defaults_options | No | Default sync-run options string, forwarded verbatim (exact syntax not live-verified). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |