pve_sdn_apply
Apply pending SDN configuration changes cluster-wide. Dry-run by default; set confirm=True to execute, disrupting virtual networking for all guests if misconfigured.
Instructions
MUTATION (HIGH RISK): apply pending SDN config changes (cluster-scoped).
Stage zones/vnets/subnets first with pve_sdn_zone_create / pve_sdn_vnet_create / pve_sdn_subnet_create — this applies whatever is pending; for interface/bridge changes use pve_network_apply instead. Dry-run by default — the PLAN surfaces pending zones/vnets AND cites pve_sdn_dry_run's rendered diff (fail-open — an unreachable dry-run degrades to an honest note, never blocks this plan). confirm=True executes with no automatic undo (short of pve_sdn_rollback, which discards PENDING changes only — it cannot revert an already-applied, now-LIVE config), disrupting virtual networking for ALL guests cluster-wide if misconfigured. May return a UPID (async) or None (sync) — outcome='submitted' in either case.
Wave 7a extension: pass lock_token/release_lock if you already hold a lock from pve_sdn_lock_acquire. Both omitted: byte-for-byte the same call as before this extension. lock_token is never written to the audit ledger (see network.py module docstring).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | False (default) returns a dry-run PLAN only; True applies pending SDN config cluster-wide. | |
| lock_token | No | SDN cluster lock token to use for this write, if one is held (from pve_sdn_lock_acquire). | |
| release_lock | No | Whether PVE releases the lock automatically after a successful commit (only relevant when lock_token is given; PVE's own default is True — omit to use it). | |
| 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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |