[pve-devel] [PATCH docs 1/1] Fix 3775: Added default values in doc

[pve-devel] [PATCH docs 1/1] Fix 3775: Added default values in doc

[Jana Hoch via pve-devel]

[-- Attachment #1: Type: message/rfc822, Size: 7778 bytes --]

From: Jana Hoch <janahoch91@mailo.com>
To: f.gruenbichler@proxmox.com, pve-devel@lists.proxmox.com
Cc: Jana Hoch <janahoch91@mailo.com>
Subject: [PATCH docs 1/1] Fix 3775: Added default values in doc
Date: Tue, 28 Oct 2025 15:14:46 +0530
Message-ID: <20251028094446.1412169-2-janahoch91@mailo.com>

Signed-off-by: Jana Hoch <janahoch91@mailo.com>
---
 pve-firewall-cluster-opts.adoc |  8 ++++----
 pve-firewall-host-opts.adoc    | 14 +++++++-------
 pve-firewall-vm-opts.adoc      | 16 ++++++++--------
 3 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/pve-firewall-cluster-opts.adoc b/pve-firewall-cluster-opts.adoc
index 7d72296..d3dfa91 100644
--- a/pve-firewall-cluster-opts.adoc
+++ b/pve-firewall-cluster-opts.adoc
@@ -2,7 +2,7 @@
 
 Enable ebtables rules cluster wide.
 
-`enable`: `<integer> (0 - N)` ::
+`enable`: `<integer> (0 - N)` ('default =' `0`)::
 
 Enable or disable the firewall cluster wide.
 
@@ -22,15 +22,15 @@ Enable or disable log rate limiting
 
 Frequency with which the burst bucket gets refilled
 
-`policy_forward`: `<ACCEPT | DROP>` ::
+`policy_forward`: `<ACCEPT | DROP>` ('default =' `ACCEPT`)::
 
 Forward policy.
 
-`policy_in`: `<ACCEPT | DROP | REJECT>` ::
+`policy_in`: `<ACCEPT | DROP | REJECT>` ('default =' `DROP`)::
 
 Input policy.
 
-`policy_out`: `<ACCEPT | DROP | REJECT>` ::
+`policy_out`: `<ACCEPT | DROP | REJECT>` ('default =' `ACCEPT`)::
 
 Output policy.
 
diff --git a/pve-firewall-host-opts.adoc b/pve-firewall-host-opts.adoc
index d561d0b..0a5168d 100644
--- a/pve-firewall-host-opts.adoc
+++ b/pve-firewall-host-opts.adoc
@@ -1,16 +1,16 @@
-`enable`: `<boolean>` ::
+`enable`: `<boolean>` ('default =' `1`)::
 
 Enable host firewall rules.
 
-`log_level_forward`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`log_level_forward`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for forwarded traffic.
 
-`log_level_in`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`log_level_in`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for incoming traffic.
 
-`log_level_out`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`log_level_out`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for outgoing traffic.
 
@@ -46,7 +46,7 @@ Conntrack syn recv timeout.
 
 Enable nftables based firewall (tech preview)
 
-`nosmurfs`: `<boolean>` ::
+`nosmurfs`: `<boolean>` ('default =' `1`)::
 
 Enable SMURFS filter.
 
@@ -62,11 +62,11 @@ Synflood protection rate burst by ip src.
 
 Synflood protection rate syn/sec by ip src.
 
-`smurf_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`smurf_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for SMURFS filter.
 
-`tcp_flags_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`tcp_flags_log_level`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for illegal tcp flags filter.
 
diff --git a/pve-firewall-vm-opts.adoc b/pve-firewall-vm-opts.adoc
index 9f191cf..5e5ca45 100644
--- a/pve-firewall-vm-opts.adoc
+++ b/pve-firewall-vm-opts.adoc
@@ -1,4 +1,4 @@
-`dhcp`: `<boolean>` ('default =' `0`)::
+`dhcp`: `<boolean>` ('default =' `1`)::
 
 Enable DHCP.
 
@@ -6,15 +6,15 @@ Enable DHCP.
 
 Enable/disable firewall rules.
 
-`ipfilter`: `<boolean>` ::
+`ipfilter`: `<boolean>` ('default =' `0`)::
 
 Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.
 
-`log_level_in`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`log_level_in`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for incoming traffic.
 
-`log_level_out`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ::
+`log_level_out`: `<alert | crit | debug | emerg | err | info | nolog | notice | warning>` ('default =' `nolog`)::
 
 Log level for outgoing traffic.
 
@@ -22,19 +22,19 @@ Log level for outgoing traffic.
 
 Enable/disable MAC address filter.
 
-`ndp`: `<boolean>` ('default =' `0`)::
+`ndp`: `<boolean>` ('default =' `1`)::
 
 Enable NDP (Neighbor Discovery Protocol).
 
-`policy_in`: `<ACCEPT | DROP | REJECT>` ::
+`policy_in`: `<ACCEPT | DROP | REJECT>` ('default =' `DROP`)::
 
 Input policy.
 
-`policy_out`: `<ACCEPT | DROP | REJECT>` ::
+`policy_out`: `<ACCEPT | DROP | REJECT>` ('default =' `ACCEPT`)::
 
 Output policy.
 
-`radv`: `<boolean>` ::
+`radv`: `<boolean>` ('default =' `0`)::
 
 Allow sending Router Advertisement.
 
-- 
2.39.5




[-- Attachment #2: Type: text/plain, Size: 160 bytes --]

_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel

Re: [pve-devel] [PATCH docs 1/1] Fix 3775: Added default values in doc

[Fiona Ebner]

Hi and sorry for the late response,

Am 28.10.25 um 8:34 PM schrieb Jana Hoch via pve-devel:
> Signed-off-by: Jana Hoch <janahoch91@mailo.com>
> ---
>  pve-firewall-cluster-opts.adoc |  8 ++++----
>  pve-firewall-host-opts.adoc    | 14 +++++++-------
>  pve-firewall-vm-opts.adoc      | 16 ++++++++--------
>  3 files changed, 19 insertions(+), 19 deletions(-)

please note that these are generated files. You would need to update the
default values in the API schema instead (in the pve-firewall
repository). The files in the docs will later be re-generated by a
maintainer, usually before a release. You could also run 'make update'
in the pve-docs repository to check the result yourself after installing
the modified pve-firewall package.

If you haven't done so already, we also need a singed Harmony CLA so
that we can accept your contributions, see:

https://pve.proxmox.com/wiki/Developer_Documentation#Software_License_and_Copyright

Best Regards,
Fiona


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel