summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/interfaces')
-rw-r--r--docs/configuration/interfaces/ethernet.rst10
-rw-r--r--docs/configuration/interfaces/geneve.rst30
-rw-r--r--docs/configuration/interfaces/openvpn.rst12
-rw-r--r--docs/configuration/interfaces/wireless.rst19
4 files changed, 55 insertions, 16 deletions
diff --git a/docs/configuration/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst
index dd524035..30a13b5b 100644
--- a/docs/configuration/interfaces/ethernet.rst
+++ b/docs/configuration/interfaces/ethernet.rst
@@ -52,6 +52,14 @@ Ethernet options
VyOS default will be `auto`.
+.. cfgcmd:: set interface ethernet <interface> ring-buffer rx <value>
+.. cfgcmd:: set interface ethernet <interface> ring-buffer tx <value>
+
+ Configures the ring buffer size of the interface.
+
+ The supported values for a specific interface can be obtained
+ with: `ethtool -g <interface>`
+
Offloading
----------
@@ -295,5 +303,3 @@ Operation
BR margin, min : 0%
Vendor SN : FNS092xxxxx
Date code : 0506xx
-
-.. stop_vyoslinter
diff --git a/docs/configuration/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst
index bf8b0920..1e8b8096 100644
--- a/docs/configuration/interfaces/geneve.rst
+++ b/docs/configuration/interfaces/geneve.rst
@@ -41,9 +41,33 @@ Configuration
Common interface configuration
==============================
-.. cmdinclude:: /_include/interface-common-without-dhcp.txt
- :var0: geneve
- :var1: gnv0
+.. cmdinclude:: /_include/interface-address.txt
+ :var0: geneve
+ :var1: gnv0
+
+.. cmdinclude:: /_include/interface-description.txt
+ :var0: geneve
+ :var1: gnv0
+
+.. cmdinclude:: /_include/interface-disable.txt
+ :var0: geneve
+ :var1: gnv0
+
+.. cmdinclude:: /_include/interface-mac.txt
+ :var0: geneve
+ :var1: gnv0
+
+.. cmdinclude:: /_include/interface-mtu.txt
+ :var0: geneve
+ :var1: gnv0
+
+.. cmdinclude:: /_include/interface-ip.txt
+ :var0: geneve
+ :var1: gnv0
+
+.. cmdinclude:: /_include/interface-ipv6.txt
+ :var0: geneve
+ :var1: gnv0
GENEVE options
==============
diff --git a/docs/configuration/interfaces/openvpn.rst b/docs/configuration/interfaces/openvpn.rst
index f51dfa94..fb85f4bf 100644
--- a/docs/configuration/interfaces/openvpn.rst
+++ b/docs/configuration/interfaces/openvpn.rst
@@ -637,17 +637,23 @@ benefit from it (see :ref:`issues_features`).
If you are a hacker or want to try on your own we support passing raw OpenVPN
options to OpenVPN.
-.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'persistent-key'
+.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'persist-key'
-Will add ``persistent-key`` at the end of the generated OpenVPN configuration.
+Will add ``persist-key`` to the generated OpenVPN configuration.
Please use this only as last resort - things might break and OpenVPN won't start
if you pass invalid options/syntax.
.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option
- 'push &quot;keepalive 1 10&quot;'
+ 'push keepalive 10 60'
Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file.
+.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option
+ 'route-up &quot;/config/auth/tun_up.sh arg1&quot;'
+
+Will add ``route-up "/config/auth/tun_up.sh arg1"`` to the generated OpenVPN
+config file. The path and arguments need to be single- or double-quoted.
+
.. note:: Sometimes option lines in the generated OpenVPN configuration require
quotes. This is done through a hack on our config generator. You can pass
quotes using the ``&quot;`` statement.
diff --git a/docs/configuration/interfaces/wireless.rst b/docs/configuration/interfaces/wireless.rst
index df153763..8a45111e 100644
--- a/docs/configuration/interfaces/wireless.rst
+++ b/docs/configuration/interfaces/wireless.rst
@@ -36,15 +36,10 @@ Common interface configuration
:var0: wireless
:var1: wlan0
-Wireless options
-================
-
-.. cfgcmd:: set interfaces wireless <interface> channel <number>
+System Wide configuration
+=========================
- Channel number (IEEE 802.11), for 2.4Ghz (802.11 b/g/n) channels range from
- 1-14. On 5Ghz (802.11 a/h/j/n/ac) channels available are 0, 34 to 173
-
-.. cfgcmd:: set interfaces wireless <interface> country-code <cc>
+.. cfgcmd:: set system wireless country-code <cc>
Country code (ISO/IEC 3166-1). Used to set regulatory domain. Set as needed
to indicate country in which device is operating. This can limit available
@@ -52,6 +47,14 @@ Wireless options
.. note:: This option is mandatory in Access-Point mode.
+Wireless options
+================
+
+.. cfgcmd:: set interfaces wireless <interface> channel <number>
+
+ Channel number (IEEE 802.11), for 2.4Ghz (802.11 b/g/n) channels range from
+ 1-14. On 5Ghz (802.11 a/h/j/n/ac) channels available are 0, 34 to 173
+
.. cfgcmd:: set interfaces wireless <interface> disable-broadcast-ssid
Send empty SSID in beacons and ignore probe request frames that do not specify