pve_firewall_ipset_create
Create an empty IP set referenced as '+name' in firewall rules. Dry-run by default; use confirm=True to execute.
Instructions
MUTATION: create an empty IP set. Dry-run by default — the PLAN shows the name and scope. Passive until a rule references it as '+name' and entries are added via pve_firewall_ipset_entry_add. Synchronous — confirm=True returns {"status": "ok", "result": None}; no task UPID to poll.
No UNDO: revert by deleting it with pve_firewall_ipset_delete.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Guest kind for scope='guest': 'qemu' or 'lxc'. | |
| name | Yes | Name for the new IP set, referenced by rules as '+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 ipsets in the PVE API). | cluster |
| comment | No | Free-text comment stored with the IP set. | |
| 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 |