From: Hannes Laimer <h.laimer@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [pdm-devel] [PATCH proxmox v2 1/4] pve-api-types: update pve-api.json
Date: Wed, 5 Nov 2025 17:35:35 +0100 [thread overview]
Message-ID: <20251105163546.450094-2-h.laimer@proxmox.com> (raw)
In-Reply-To: <20251105163546.450094-1-h.laimer@proxmox.com>
This reflects the latest changes in pve-storage and pve-firewall.
Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>
---
pve-api-types/pve-api.json | 362 +++----------------------------------
1 file changed, 27 insertions(+), 335 deletions(-)
diff --git a/pve-api-types/pve-api.json b/pve-api-types/pve-api.json
index 7bde484e..d1e77fdb 100644
--- a/pve-api-types/pve-api.json
+++ b/pve-api-types/pve-api.json
@@ -4724,33 +4724,41 @@
"returns": {
"properties": {
"action": {
+ "description": "Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name",
"type": "string"
},
"comment": {
+ "description": "Descriptive comment",
"optional": 1,
"type": "string"
},
"dest": {
+ "description": "Restrict packet destination address",
"optional": 1,
"type": "string"
},
"dport": {
+ "description": "Restrict TCP/UDP destination port",
"optional": 1,
"type": "string"
},
"enable": {
+ "description": "Flag to enable/disable a rule",
"optional": 1,
"type": "integer"
},
"icmp-type": {
+ "description": "Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'",
"optional": 1,
"type": "string"
},
"iface": {
+ "description": "Network interface name. You have to use network configuration key names for VMs and containers",
"optional": 1,
"type": "string"
},
"ipversion": {
+ "description": "IP version (4 or 6) - automatically determined from source/dest addresses",
"optional": 1,
"type": "integer"
},
@@ -4771,25 +4779,31 @@
"type": "string"
},
"macro": {
+ "description": "Use predefined standard macro",
"optional": 1,
"type": "string"
},
"pos": {
+ "description": "Rule position in the ruleset",
"type": "integer"
},
"proto": {
+ "description": "IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'",
"optional": 1,
"type": "string"
},
"source": {
+ "description": "Restrict packet source address",
"optional": 1,
"type": "string"
},
"sport": {
+ "description": "Restrict TCP/UDP source port",
"optional": 1,
"type": "string"
},
"type": {
+ "description": "Rule type",
"type": "string"
}
},
@@ -4990,11 +5004,7 @@
"proxyto": null,
"returns": {
"items": {
- "properties": {
- "pos": {
- "type": "integer"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
},
"links": [
@@ -5290,67 +5300,7 @@
},
"proxyto": null,
"returns": {
- "properties": {
- "action": {
- "type": "string"
- },
- "comment": {
- "optional": 1,
- "type": "string"
- },
- "dest": {
- "optional": 1,
- "type": "string"
- },
- "dport": {
- "optional": 1,
- "type": "string"
- },
- "enable": {
- "optional": 1,
- "type": "integer"
- },
- "icmp-type": {
- "optional": 1,
- "type": "string"
- },
- "iface": {
- "optional": 1,
- "type": "string"
- },
- "ipversion": {
- "optional": 1,
- "type": "integer"
- },
- "log": {
- "description": "Log level for firewall rule",
- "enum": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties/log/enum"],
- "optional": 1,
- "type": "string"
- },
- "macro": {
- "optional": 1,
- "type": "string"
- },
- "pos": {
- "type": "integer"
- },
- "proto": {
- "optional": 1,
- "type": "string"
- },
- "source": {
- "optional": 1,
- "type": "string"
- },
- "sport": {
- "optional": 1,
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
}
},
@@ -5509,11 +5459,7 @@
"proxyto": null,
"returns": {
"items": {
- "properties": {
- "pos": {
- "type": "integer"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
},
"links": [
@@ -6227,6 +6173,7 @@
"type": "boolean"
},
"enable": {
+ "default": 0,
"description": "Enable or disable the firewall cluster wide.",
"minimum": 0,
"optional": 1,
@@ -11029,67 +10976,7 @@
},
"proxyto": null,
"returns": {
- "properties": {
- "action": {
- "type": "string"
- },
- "comment": {
- "optional": 1,
- "type": "string"
- },
- "dest": {
- "optional": 1,
- "type": "string"
- },
- "dport": {
- "optional": 1,
- "type": "string"
- },
- "enable": {
- "optional": 1,
- "type": "integer"
- },
- "icmp-type": {
- "optional": 1,
- "type": "string"
- },
- "iface": {
- "optional": 1,
- "type": "string"
- },
- "ipversion": {
- "optional": 1,
- "type": "integer"
- },
- "log": {
- "description": "Log level for firewall rule",
- "enum": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties/log/enum"],
- "optional": 1,
- "type": "string"
- },
- "macro": {
- "optional": 1,
- "type": "string"
- },
- "pos": {
- "type": "integer"
- },
- "proto": {
- "optional": 1,
- "type": "string"
- },
- "source": {
- "optional": 1,
- "type": "string"
- },
- "sport": {
- "optional": 1,
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
}
},
@@ -11241,11 +11128,7 @@
"proxyto": null,
"returns": {
"items": {
- "properties": {
- "pos": {
- "type": "integer"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
},
"links": [
@@ -16634,67 +16517,7 @@
},
"proxyto": null,
"returns": {
- "properties": {
- "action": {
- "type": "string"
- },
- "comment": {
- "optional": 1,
- "type": "string"
- },
- "dest": {
- "optional": 1,
- "type": "string"
- },
- "dport": {
- "optional": 1,
- "type": "string"
- },
- "enable": {
- "optional": 1,
- "type": "integer"
- },
- "icmp-type": {
- "optional": 1,
- "type": "string"
- },
- "iface": {
- "optional": 1,
- "type": "string"
- },
- "ipversion": {
- "optional": 1,
- "type": "integer"
- },
- "log": {
- "description": "Log level for firewall rule",
- "enum": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties/log/enum"],
- "optional": 1,
- "type": "string"
- },
- "macro": {
- "optional": 1,
- "type": "string"
- },
- "pos": {
- "type": "integer"
- },
- "proto": {
- "optional": 1,
- "type": "string"
- },
- "source": {
- "optional": 1,
- "type": "string"
- },
- "sport": {
- "optional": 1,
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
}
},
@@ -16858,11 +16681,7 @@
"proxyto": null,
"returns": {
"items": {
- "properties": {
- "pos": {
- "type": "integer"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
},
"links": [
@@ -35315,67 +35134,7 @@
},
"proxyto": null,
"returns": {
- "properties": {
- "action": {
- "type": "string"
- },
- "comment": {
- "optional": 1,
- "type": "string"
- },
- "dest": {
- "optional": 1,
- "type": "string"
- },
- "dport": {
- "optional": 1,
- "type": "string"
- },
- "enable": {
- "optional": 1,
- "type": "integer"
- },
- "icmp-type": {
- "optional": 1,
- "type": "string"
- },
- "iface": {
- "optional": 1,
- "type": "string"
- },
- "ipversion": {
- "optional": 1,
- "type": "integer"
- },
- "log": {
- "description": "Log level for firewall rule",
- "enum": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties/log/enum"],
- "optional": 1,
- "type": "string"
- },
- "macro": {
- "optional": 1,
- "type": "string"
- },
- "pos": {
- "type": "integer"
- },
- "proto": {
- "optional": 1,
- "type": "string"
- },
- "source": {
- "optional": 1,
- "type": "string"
- },
- "sport": {
- "optional": 1,
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
}
},
@@ -35539,11 +35298,7 @@
"proxyto": null,
"returns": {
"items": {
- "properties": {
- "pos": {
- "type": "integer"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
},
"links": [
@@ -49109,67 +48864,7 @@
},
"proxyto": "node",
"returns": {
- "properties": {
- "action": {
- "type": "string"
- },
- "comment": {
- "optional": 1,
- "type": "string"
- },
- "dest": {
- "optional": 1,
- "type": "string"
- },
- "dport": {
- "optional": 1,
- "type": "string"
- },
- "enable": {
- "optional": 1,
- "type": "integer"
- },
- "icmp-type": {
- "optional": 1,
- "type": "string"
- },
- "iface": {
- "optional": 1,
- "type": "string"
- },
- "ipversion": {
- "optional": 1,
- "type": "integer"
- },
- "log": {
- "description": "Log level for firewall rule",
- "enum": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties/log/enum"],
- "optional": 1,
- "type": "string"
- },
- "macro": {
- "optional": 1,
- "type": "string"
- },
- "pos": {
- "type": "integer"
- },
- "proto": {
- "optional": 1,
- "type": "string"
- },
- "source": {
- "optional": 1,
- "type": "string"
- },
- "sport": {
- "optional": 1,
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
}
},
@@ -49331,11 +49026,7 @@
"proxyto": "node",
"returns": {
"items": {
- "properties": {
- "pos": {
- "type": "integer"
- }
- },
+ "properties": ("Ref")["/root/0/children/4/children/0/children/0/children/0/info/GET/returns/properties"],
"type": "object"
},
"links": [
@@ -49503,6 +49194,7 @@
"returns": {
"properties": {
"enable": {
+ "default": 1,
"description": "Enable host firewall rules.",
"optional": 1,
"type": "boolean"
--
2.47.3
_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel
next prev parent reply other threads:[~2025-11-05 16:35 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-05 16:35 [pdm-devel] [PATCH proxmox{, -yew-comp, -datacenter-manager} v2 00/12] add basic integration of PVE firewall Hannes Laimer
2025-11-05 16:35 ` Hannes Laimer [this message]
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox v2 2/4] pve-api-types: add get/update firewall options endpoints Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox v2 3/4] pve-api-types: add list firewall rules endpoints Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox v2 4/4] pve-api-types: regenerate Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-yew-comp v2 1/4] form: add helpers for extractig data out of schemas Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-yew-comp v2 2/4] firewall: add FirewallContext Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-yew-comp v2 3/4] firewall: add options edit form Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-yew-comp v2 4/4] firewall: add rules table Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 1/4] pdm-api-types: add firewall status types Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 2/4] api: firewall: add option, rules and status endpoints Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 3/4] pdm-client: add api methods for firewall options, " Hannes Laimer
2025-11-05 16:35 ` [pdm-devel] [PATCH proxmox-datacenter-manager v2 4/4] ui: add firewall status tree Hannes Laimer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251105163546.450094-2-h.laimer@proxmox.com \
--to=h.laimer@proxmox.com \
--cc=pdm-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.