summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNicolas Fort <nicolasfort1988@gmail.com>2023-03-17 08:00:58 -0300
committerNicolas Fort <nicolasfort1988@gmail.com>2023-03-17 08:00:58 -0300
commite56a7c86ecb83390a881ec7f4e0207bed2c75557 (patch)
tree7db32cd3cb8d06b48fc3f1f12916204949a9a284 /docs
parentcc9a5284d974aa372d9b49a618b8989870035d2b (diff)
downloadvyos-documentation-e56a7c86ecb83390a881ec7f4e0207bed2c75557.tar.gz
vyos-documentation-e56a7c86ecb83390a881ec7f4e0207bed2c75557.zip
T5050: firewall: add log-options in firewall docs
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/firewall/general.rst31
1 files changed, 27 insertions, 4 deletions
diff --git a/docs/configuration/firewall/general.rst b/docs/configuration/firewall/general.rst
index 9cd747b5..c217ba6c 100644
--- a/docs/configuration/firewall/general.rst
+++ b/docs/configuration/firewall/general.rst
@@ -335,13 +335,36 @@ the action of the rule will be executed.
Enable or disable logging for the matched packet.
-.. cfgcmd:: set firewall name <name> rule <1-999999> log-level [emerg |
- alert | crit | err | warn | notice | info | debug]
-.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> log-level [emerg |
- alert | crit | err | warn | notice | info | debug]
+.. cfgcmd:: set firewall name <name> rule <1-999999> log-options level
+ [emerg | alert | crit | err | warn | notice | info | debug]
+.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> log-options level
+ [emerg | alert | crit | err | warn | notice | info | debug]
Define log-level. Only applicable if rule log is enable.
+.. cfgcmd:: set firewall name <name> rule <1-999999> log-options group
+ <0-65535>
+.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> log-options group
+ <0-65535>
+
+ Define log group to send message to. Only applicable if rule log is enable.
+
+.. cfgcmd:: set firewall name <name> rule <1-999999> log-options snaplen
+ <0-9000>
+.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> log-options snaplen
+ <0-9000>
+
+ Define length of packet payload to include in netlink message. Only
+ applicable if rule log is enable and log group is defined.
+
+.. cfgcmd:: set firewall name <name> rule <1-999999> log-options
+ queue-threshold <0-65535>
+.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> log-options
+ queue-threshold <0-65535>
+
+ Define number of packets to queue inside the kernel before sending them to
+ userspace. Only applicable if rule log is enable and log group is defined.
+
.. cfgcmd:: set firewall name <name> rule <1-999999> disable
.. cfgcmd:: set firewall ipv6-name <name> rule <1-999999> disable