pve_firewall_alias_update
Modify a Proxmox VE firewall alias by changing its CIDR, comment, or name. Dry-run previews changes; synchronous confirmation applies them.
Instructions
MUTATION: update a firewall alias. Dry-run by default — the PLAN shows the current alias and the fields being changed. Changing the CIDR silently alters every referencing rule's match set. Synchronous — confirm=True returns {"status": "ok", "result": None}; no task UPID to poll.
Requires at least one of cidr/comment/rename. No UNDO — revert by setting it back to its prior value; to create a new alias instead use pve_firewall_alias_create.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cidr | No | New IP address/CIDR the alias should resolve to; omit to leave unchanged. | |
| kind | No | Guest kind for scope='guest': 'qemu' or 'lxc'. | |
| name | Yes | Name of the existing alias to update. | |
| node | No | Node name, required for scope='guest'. | |
| vmid | No | Guest VMID/CTID, required for scope='guest'. | |
| scope | No | Firewall scope: 'cluster' or 'guest' (no node-scope aliases in the PVE API). | cluster |
| digest | No | Optimistic-lock digest forwarded to PVE to abort if the alias changed; this tool's PLAN does not surface a digest to copy (only the rule tools do). | |
| rename | No | New name to rename the alias to; omit to keep the current name. | |
| comment | No | New free-text comment; omit to leave unchanged. | |
| confirm | No | Set True to execute the mutation; False (default) only returns a dry-run PLAN. | |
| 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |