pve_firewall_alias_create
Create a firewall alias (CIDR) that can be referenced by firewall rules. Use confirm=True to apply the change.
Instructions
MUTATION: create a firewall alias (named CIDR). Dry-run by default — the PLAN shows the name, CIDR, and scope. Re-call with confirm=True to execute. Passive until a rule references it. Synchronous — confirm=True returns {"status": "ok", "result": None}; no task UPID to poll.
No UNDO: revert by deleting the alias with pve_firewall_alias_delete. To change an existing alias instead, use pve_firewall_alias_update.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cidr | Yes | IP address or CIDR network the alias resolves to. | |
| kind | No | Guest kind for scope='guest': 'qemu' or 'lxc'. | |
| name | Yes | Name for the new alias, referenced by rules as this name. | |
| 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 |
| comment | No | Free-text comment stored with the alias. | |
| 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 |