pve_firewall_ipset_entry_add
Add an IP or CIDR network entry to a Proximo firewall IP set. Dry-run shows planned changes; use confirm=True to execute.
Instructions
MUTATION: add an IP/Network entry to an IP set. Dry-run by default — the PLAN shows the entry and warns it changes every referencing rule's match set. nomatch=True = exclusion. Synchronous — confirm=True returns {"status": "ok", "result": None}; no task UPID to poll.
No UNDO: revert by removing the entry with pve_firewall_ipset_entry_remove.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cidr | Yes | IP address or CIDR network to add as a member entry. | |
| kind | No | Guest kind for scope='guest': 'qemu' or 'lxc'. | |
| name | Yes | Name of the IP set to add the entry to. | |
| 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 entry. | |
| confirm | No | Set True to execute the mutation; False (default) only returns a dry-run PLAN. | |
| nomatch | No | If True, this entry is an exclusion (negative match) rather than an inclusion. | |
| 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 |