pbs_node_config_set
Update Proxmox Backup Server node-wide configuration. Dry-run shows changes; confirm executes to set or delete properties like TLS ciphers, proxy, ACME domains, and more.
Instructions
MUTATION: update PBS node-wide config.
RISK_HIGH, uniform across the whole PUT: ciphers-tls-1.2/1.3 misconfiguration can make the API/web proxy refuse ALL TLS connections (lockout-class, mirrors network_reload/cert_upload); http-proxy misconfiguration can silently break outbound connectivity for notifications/ACME renewal/subscription-check; acme/acmedomain0-4 misconfiguration can break automatic certificate renewal — see proximo.pbs_admin module docstring's RISK RATING section. Dry-run by default (captures current config into the PLAN, http-proxy masked defensively); confirm=True executes (PUT /nodes/{node}/config, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. No snapshot primitive — revert by re-applying the captured current config. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| acme | No | ACME account assignment, pre-formatted per PBS's compound syntax, e.g. 'account=myaccount'. | |
| node | No | PBS node name (or 'localhost'). | localhost |
| delete | No | Property names to clear: any of acme/acmedomain0-4/http-proxy/email-from/ciphers-tls-1.3/ciphers-tls-1.2/default-lang/description/task-log-max-days/consent-text/location. | |
| digest | No | Optimistic-lock: 64-char lowercase hex SHA-256 of the config PBS last returned. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the update. | |
| location | No | Free-text location label for this PBS instance. | |
| email_from | No | From-address for node-generated e-mail (2-64 chars). | |
| http_proxy | No | HTTP proxy configuration '[http://]<host>[:port]'. May embed 'user:pass@' credentials per standard URL syntax — masked defensively in the returned Plan. | |
| acmedomain0 | No | ACME domain 0, pre-formatted e.g. 'domain=example.com,alias=other.com,plugin=cf'. | |
| acmedomain1 | No | ACME domain 1, same compound format as acmedomain0. | |
| acmedomain2 | No | ACME domain 2, same compound format as acmedomain0. | |
| acmedomain3 | No | ACME domain 3, same compound format as acmedomain0. | |
| acmedomain4 | No | ACME domain 4, same compound format as acmedomain0. | |
| description | No | Node comment (multiple lines allowed). | |
| consent_text | No | Consent banner text (<=65536 chars). | |
| default_lang | No | UI language code (closed enum, e.g. 'en', 'de', 'fr'). | |
| 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. | |
| ciphers_tls_1_2 | No | OpenSSL cipher list for TLS <= 1.2. Misconfiguration can break ALL TLS connections to the API/web proxy. | |
| ciphers_tls_1_3 | No | OpenSSL ciphersuite list for TLS 1.3. Misconfiguration can break ALL TLS connections to the API/web proxy. | |
| task_log_max_days | No | Maximum days to keep task logs (>=0). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |