summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-08-17 22:01:18 +0200
committerChristian Breunig <christian@breunig.cc>2023-08-17 22:01:54 +0200
commitabd405b91e20786409fc5d9e2163940b9bcdfc90 (patch)
treecdd11258a9b9d2ca9760fc6f665be3aa947be1bf /docs
parentf6a30534bd173bcdc0667627e52498c2800d454c (diff)
downloadvyos-documentation-abd405b91e20786409fc5d9e2163940b9bcdfc90.tar.gz
vyos-documentation-abd405b91e20786409fc5d9e2163940b9bcdfc90.zip
T5409: add per-client-thread CLI option for wireguard and wireless interfaces
Diffstat (limited to 'docs')
-rw-r--r--docs/_include/interface-per-client-thread.txt14
-rw-r--r--docs/configuration/interfaces/wireguard.rst4
-rw-r--r--docs/configuration/interfaces/wireless.rst4
3 files changed, 22 insertions, 0 deletions
diff --git a/docs/_include/interface-per-client-thread.txt b/docs/_include/interface-per-client-thread.txt
new file mode 100644
index 00000000..877be591
--- /dev/null
+++ b/docs/_include/interface-per-client-thread.txt
@@ -0,0 +1,14 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ {{ var5 }} {{ var6 }} per-client-thread
+
+ Provides a per-device control to enable/disable the threaded mode for
+ all the NAPI instances of the given network device, without the need for
+ a device up/down.
+
+ If CLI option is not specified, this feature is disabled.
+
+ Example:
+
+ .. code-block:: none
+
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} per-client-thread
diff --git a/docs/configuration/interfaces/wireguard.rst b/docs/configuration/interfaces/wireguard.rst
index 5eb10fe8..d2916d9f 100644
--- a/docs/configuration/interfaces/wireguard.rst
+++ b/docs/configuration/interfaces/wireguard.rst
@@ -183,6 +183,10 @@ traffic.
The command :opcmd:`show interfaces wireguard wg01 public-key` will then show the
public key, which needs to be shared with the peer.
+.. cmdinclude:: /_include/interface-per-client-thread.txt
+ :var0: wireguard
+ :var1: wg01
+
**remote side - commands**
.. code-block:: none
diff --git a/docs/configuration/interfaces/wireless.rst b/docs/configuration/interfaces/wireless.rst
index f45101b5..c321f208 100644
--- a/docs/configuration/interfaces/wireless.rst
+++ b/docs/configuration/interfaces/wireless.rst
@@ -122,6 +122,10 @@ Wireless options
* ``station`` - Connects to another access point
* ``monitor`` - Passively monitor all packets on the frequency/channel
+.. cmdinclude:: /_include/interface-per-client-thread.txt
+ :var0: wireless
+ :var1: wlan0
+
PPDU
----