From e8256de2a6e8b7754545f3b23e279edb5b40265a Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Mon, 30 Mar 2026 12:25:38 +0200 Subject: DOC: Proofread wireless.rst (#1806) * DOC: Proofread wireless.rst * Apply suggestion from @dmbaturin --------- Co-authored-by: Daniil Baturin --- docs/configuration/interfaces/wireless.rst | 550 ++++++++++++++++------------- 1 file changed, 303 insertions(+), 247 deletions(-) (limited to 'docs/configuration') diff --git a/docs/configuration/interfaces/wireless.rst b/docs/configuration/interfaces/wireless.rst index e6a29f9a..5c003f15 100644 --- a/docs/configuration/interfaces/wireless.rst +++ b/docs/configuration/interfaces/wireless.rst @@ -1,29 +1,31 @@ -:lastproofread: 2024-07-04 +:lastproofread: 2026-03-23 .. _wireless-interface: ######################## -WLAN/WIFI - Wireless LAN +Wireless LAN / Wi-Fi ######################## -The :abbr:`WLAN (Wireless LAN)` interface provides 802.11 (a/b/g/n/ac) wireless -support (commonly referred to as Wi-Fi) by means of compatible hardware. If -your hardware supports it, VyOS supports multiple logical wireless interfaces -per physical device. +:abbr:`WLAN (Wireless LAN)` interfaces provide 802.11 (a/b/g/n/ac) wireless +connectivity, referred to as Wi-Fi, and operate in one of the following modes: -There are three modes of operation for a wireless interface: +* ``access-point``: Provide network access to connecting stations. -* :abbr:`WAP (Wireless Access-Point)` mode provides network access to connecting - stations if the physical hardware supports acting as a WAP +* ``station:`` Operate as Wi-Fi clients, connecting to the network via an + available :abbr:`AP (Access Point)`. -* Station mode acts as a Wi-Fi client accessing the network through an available - WAP +* ``monitor:`` Passively monitor wireless traffic. -* Monitor mode lets the system passively monitor wireless traffic +If the system detects an unconfigured wireless device, it automatically adds +the device to the configuration tree with the detected settings, such as the +MAC address, and sets it to ``monitor`` mode. -If the system detects an unconfigured wireless device, it will be automatically -added the configuration tree, specifying any detected settings (for example, -its MAC address) and configured to run in monitor mode. +.. note:: VyOS supports creating **multiple** WLAN interfaces on a single + physical device. + +.. note:: Wi-Fi connectivity, support for multiple WLAN interfaces on a single + physical device, and access point capabilities strictly depend on the + underlying hardware. ************* Configuration @@ -36,117 +38,122 @@ Common interface configuration :var0: wireless :var1: wlan0 -System Wide configuration +System-wide configuration ========================= .. cfgcmd:: set system wireless country-code - 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 - channels and transmit power. + **Configure the system's ISO/IEC 3166-1 country code.** + + The country code indicates the region in which the device operates. This may + restrict available channels and transmit power. - .. note:: This option is mandatory in Access-Point mode. + .. note:: This option is mandatory in ``access-point`` mode. Wireless options ================ -.. cfgcmd:: set system wireless country-code +.. cfgcmd:: set interfaces wireless channel - Country code (ISO/IEC 3166-1). Used to set regulatory domain. Set as needed - to indicate country in which the box is operating. This can limit available - channels and transmit power. + **Configure the IEEE 802.11 wireless radio channel for the interface.** - .. note:: This option is mandatory in Access-Point mode. + Channel allocation depends on the frequency band: -.. cfgcmd:: set interfaces wireless channel - - Channel number (IEEE 802.11), for 2.4Ghz (802.11 b/g/n/ax) channels range from - 1-14. On 5Ghz (802.11 a/h/j/n/ac) channels available are 0, 34 to 177. - On 6GHz (802.11 ax) channels range from 1 to 233. + * **2.4 GHz** (802.11b/g/n/ax): Channels range from 1 to 14. + * **5 GHz** (802.11a/h/j/n/ac/ax): Channels range from 34 to 177. + * **6 GHz** (802.11ax): Channels range from 1 to 233. + * **Automatic channel selection:** 0. .. cfgcmd:: set interfaces wireless disable-broadcast-ssid - Send empty SSID in beacons and ignore probe request frames that do not specify - full SSID, i.e., require stations to know the SSID. + **Configure the interface to broadcast an empty SSID in beacons and to ignore + probe requests that do not include the full SSID.** + + This requires client stations to be configured with the correct SSID to connect. .. cfgcmd:: set interfaces wireless expunge-failing-stations - Disassociate stations based on excessive transmission failures or other - indications of connection loss. + **Configure the interface to disconnect client stations upon excessive + transmission failures or connection loss.** - This depends on the driver capabilities and may not be available with all - drivers. + This feature depends on driver capabilities and may not work with some drivers. .. cfgcmd:: set interfaces wireless isolate-stations - Client isolation can be used to prevent low-level bridging of frames between - associated stations in the BSS. + **Enable client isolation on the interface.** + + This prevents low-level frame bridging between associated stations within the + BSS. By default, this bridging is allowed. -.. cfgcmd:: set interfaces wireless max-stations +.. cfgcmd:: set interfaces wireless max-stations + + **Configure the number of allowed connecting clients for the interface.** - Maximum number of stations allowed in station table. New stations will be - rejected after the station table is full. IEEE 802.11 has a limit of 2007 - different association IDs, so this number should not be larger than that. + When this limit is reached, new client association requests are rejected. The + IEEE 802.11 standard allows up to 2007 distinct association IDs. Therefore, + this value should not exceed 2007. - This defaults to 2007. + Default: 2007. .. cfgcmd:: set interfaces wireless mgmt-frame-protection - Management Frame Protection (MFP) according to IEEE 802.11w + Enable :abbr:`MFP (Management Frame Protection)` on the interface according to + IEEE 802.11w. .. note:: :abbr:`MFP (Management Frame Protection)` is required for WPA3. .. cfgcmd:: set interfaces wireless enable-bf-protection - Beacon Protection: management frame protection for Beacon frames. + Enable :abbr:`BF (Beacon Frame)` protection on the interface. .. note:: This option requires :abbr:`MFP (Management Frame Protection)` to be enabled. .. cfgcmd:: set interfaces wireless mode - Operation mode of wireless radio. + Configure wireless radio mode for the interface. - * ``a`` - 802.11a - 54 Mbits/sec - * ``b`` - 802.11b - 11 Mbits/sec - * ``g`` - 802.11g - 54 Mbits/sec (default) - * ``n`` - 802.11n - 600 Mbits/sec - * ``ac`` - 802.11ac - 1300 Mbits/sec - * ``ax`` - 802.11ax - exceeds 1GBit/sec + * ``a``: 802.11a (up to 54 Mbps). + * ``b``: 802.11b (up to 11 Mbps). + * ``g`` (default): 802.11g (up to 54 Mbps). + * ``n``: 802.11n (up to 600 Mbps). + * ``ac``: 802.11ac (up to 1300 Mbps). + * ``ax``: 802.11ax (exceeds 1 Gbps). - .. note:: In VyOS, 802.11ax is only implemented for 2.4GHz and 6GHz. + .. note:: In VyOS, 802.11ax is only implemented for 2.4 GHz and 6 GHz. .. cfgcmd:: set interfaces wireless physical-device - Wireless hardware device used as underlay radio. + **Configure the underlying wireless physical device for the interface.** - This defaults to phy0. + Default: ``phy0``. .. cfgcmd:: set interfaces wireless reduce-transmit-power - Adds the Power Constraint information element to Beacon and Probe Response - frames. + **Configure the interface to add the Power Constraint** :abbr:`IE (Information + Element)` **to Beacon and Probe Response frames.** - This option adds the Power Constraint information element when applicable - and the Country information element is configured. The Power Constraint - element is required by Transmit Power Control. + The Power Constraint :abbr:`IE (Information Element)` is required by :abbr:`TPC + (Transmit Power Control)`. - Valid values are 0..255. + Valid values: 0 to 255. + + .. note:: You must configure the country code to use this option. .. cfgcmd:: set interfaces wireless ssid - SSID to be used in IEEE 802.11 management frames + Configure the SSID to be used in IEEE 802.11 management frames. .. cfgcmd:: set interfaces wireless type - Wireless device type for this interface + **Configure the wireless device type for the interface.** - * ``access-point`` - Access-point forwards packets between other nodes - * ``station`` - Connects to another access point - * ``monitor`` - Passively monitor all packets on the frequency/channel + * ``access-point``: Forwards packets between other nodes. + * ``station``: Connects to another :abbr:`AP (Access Point)`. + * ``monitor``: Passively monitors all packets on the frequency/channel. .. cmdinclude:: /_include/interface-per-client-thread.txt :var0: wireless @@ -164,175 +171,215 @@ PPDU HT (High Throughput) capabilities (802.11n) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Configuring HT mode options is required when using 802.11n or 802.11ax at 2.4GHz. + Configure **HT mode options** if you use 802.11n or 802.11ax at 2.4 GHz. .. cfgcmd:: set interfaces wireless capabilities ht 40mhz-incapable - Device is incapable of 40 MHz, do not advertise. This sets ``[40-INTOLERANT]`` + **Configure the interface to operate at 20 MHz.** + + The command sets the ``[40-INTOLERANT]`` flag. .. cfgcmd:: set interfaces wireless capabilities ht auto-powersave - WMM-PS Unscheduled Automatic Power Save Delivery [U-APSD] + Enable :abbr:`WMM-PS (Wi-Fi Multimedia Power Save)` (:abbr:`U-APSD (Unscheduled + Automatic Power Save Delivery)`) for the interface. .. cfgcmd:: set interfaces wireless capabilities ht channel-set-width - Supported channel width set. - - * ``ht20`` - 20 MHz channel width - * ``ht40-`` - Both 20 MHz and 40 MHz with secondary channel below the primary - channel - * ``ht40+`` - Both 20 MHz and 40 MHz with secondary channel above the primary - channel + **Configure the supported channel width set for the interface.** - .. note:: There are limits on which channels can be used with HT40- and HT40+. - Following table shows the channels that may be available for HT40- and HT40+ - use per IEEE 802.11n Annex J: + * ``ht20``: Allows a 20 MHz channel width. + * ``ht40-``: Allows both 20 MHz and 40 MHz channel widths, with the secondary + channel **below** the primary channel. + * ``ht40+``: Allows both 20 MHz and 40 MHz channel widths, with the secondary + channel **above** the primary channel. + + .. note:: Channel availability for HT40- and HT40+ is limited. The following + table lists channels permitted for HT40- and HT40+ according to IEEE 802.11n + Annex J. Channel availability may vary by location. - Depending on the location, not all of these channels may be available for - use! + .. code-block:: none - .. code-block:: none + freq HT40- HT40+ + 2.4 GHz 5-13 1-7 (1-9 in Europe/Japan) + 5 GHz 40,48,56,64 36,44,52,60 - freq HT40- HT40+ - 2.4 GHz 5-13 1-7 (1-9 in Europe/Japan) - 5 GHz 40,48,56,64 36,44,52,60 - - .. note:: 40 MHz channels may switch their primary and secondary channels if - needed or creation of 40 MHz channel maybe rejected based on overlapping - BSSes. These changes are done automatically when hostapd is setting up the - 40 MHz channel. + .. note:: 40 MHz channels may automatically switch their primary and secondary + assignments, or the creation of a 40 MHz channel may be rejected due to + :abbr:`OBSSs (Overlapping Basic Service Sets)`. ``hostapd`` performs these + adjustments automatically when setting up the channel. .. cfgcmd:: set interfaces wireless capabilities ht delayed-block-ack - Enable HT-delayed Block Ack ``[DELAYED-BA]`` + **Enable HT-delayed** :abbr:`Block Ack (Block Acknowledgement)` **on the + interface.** + + This sets the ``[DELAYED-BA]`` flag. .. cfgcmd:: set interfaces wireless capabilities ht dsss-cck-40 - DSSS/CCK Mode in 40 MHz, this sets ``[DSSS_CCK-40]`` + **Enable** :abbr:`DSSS (Direct Sequence Spread Spectrum)`/:abbr:`CCK + (Complementary Code Keying)` **mode in 40 MHz channels.** + + This sets the ``[DSSS_CCK-40]`` flag. .. cfgcmd:: set interfaces wireless capabilities ht greenfield - This enables the greenfield option which sets the ``[GF]`` option + **Enable HT Greenfield mode on the interface.** + + This sets the ``[GF]`` flag. .. cfgcmd:: set interfaces wireless capabilities ht ldpc - Enable LDPC coding capability + Enable :abbr:`LDPC (Low-Density Parity-Check)` coding on the interface. .. cfgcmd:: set interfaces wireless capabilities ht lsig-protection - Enable L-SIG TXOP protection capability + Enable :abbr:`L-SIG TXOP (Legacy Signal Transmission Opportunity)` protection + on the interface. .. cfgcmd:: set interfaces wireless capabilities ht max-amsdu <3839 | 7935> - Maximum A-MSDU length 3839 (default) or 7935 octets + Configure the maximum :abbr:`A-MSDU (Aggregate MAC Service Data Unit)` length + to either 3839 octets (default) or 7935 octets. .. cfgcmd:: set interfaces wireless capabilities ht short-gi <20 | 40> - Short GI capabilities for 20 and 40 MHz + **Configure** :abbr:`Short GI (Short Guard Interval)` **capabilities for 20 MHz + or 40 MHz channels.** + + * ``20``: Enables Short GI for 20 MHz channels. + * ``40``: Enables Short GI for 40 MHz channels. .. cfgcmd:: set interfaces wireless capabilities ht smps - Spatial Multiplexing Power Save (SMPS) settings + **Configure** :abbr:`SMPS (Spatial Multiplexing Power Save)` **mode for the + interface.** + + * ``static``: Enables static SMPS mode. + * ``dynamic``: Enables dynamic SMPS mode. .. cfgcmd:: set interfaces wireless capabilities ht stbc rx - Enable receiving PPDU using STBC (Space Time Block Coding) + Enable receiving :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC + (Space-Time Block Coding)`. .. cfgcmd:: set interfaces wireless capabilities ht stbc tx - Enable sending PPDU using STBC (Space Time Block Coding) + Enable transmitting :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC + (Space-Time Block Coding)`. + VHT (Very High Throughput) capabilities (802.11ac) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. cfgcmd:: set interfaces wireless capabilities vht antenna-count +.. cfgcmd:: set interfaces wireless capabilities vht antenna-count + + **Configure the number of antennas for the interface.** - Number of antennas on this card + Valid values: 1 to 8. .. cfgcmd:: set interfaces wireless capabilities vht antenna-pattern-fixed - Set if antenna pattern does not change during the lifetime of an association + **Enable the fixed antenna pattern capability on the interface.** + + Use this option if the antenna pattern does not change during the lifetime of + an association. .. cfgcmd:: set interfaces wireless capabilities vht beamform - Beamforming capabilities: + Configure VHT beamforming capabilities for the interface. - * ``single-user-beamformer`` - Support for operation as - single user beamformer - * ``single-user-beamformee`` - Support for operation as - single user beamformee - * ``multi-user-beamformer`` - Support for operation as - multi user beamformer - * ``multi-user-beamformee`` - Support for operation as - multi user beamformee + * ``single-user-beamformer``: Supports operation as a Single-User (SU) + beamformer. + * ``single-user-beamformee``: Supports operation as a Single-User (SU) + beamformee. + * ``multi-user-beamformer``: Supports operation as a Multi-User (MU) beamformer. + * ``multi-user-beamformee``: Supports operation as a Multi-User (MU) beamformee. .. cfgcmd:: set interfaces wireless capabilities vht center-channel-freq - VHT operating channel center frequency - center freq 1 - (for use with 80, 80+80 and 160 modes) + **Configure the VHT operating channel center frequency for the interface.** - VHT operating channel center frequency - center freq 2 - (for use with the 80+80 mode) + * ``freq-1``: Specifies the center frequency for 80 MHz, 160 MHz, and 80+80 MHz + channels. - must be from 34 - 173. For 80 MHz channels it should be channel + 6. + * ``freq-2:`` Specifies the center frequency for 80+80 MHz channels. + + * ````: Ranges from 34 to 173. For 80 MHz channels, the center + frequency is typically the channel number plus 6. .. cfgcmd:: set interfaces wireless capabilities vht channel-set-width <0 | 1 | 2 | 3> - * ``0`` - 20 or 40 MHz channel width (default) - * ``1`` - 80 MHz channel width - * ``2`` - 160 MHz channel width - * ``3`` - 80+80 MHz channel width + **Configure the VHT operating channel width for the interface.** + + * ``0`` (default): 20 MHz or 40 MHz channel width. + * ``1``: 80 MHz channel width. + * ``2``: 160 MHz channel width. + * ``3``: 80+80 MHz channel width. .. cfgcmd:: set interfaces wireless capabilities vht ldpc - Enable LDPC (Low Density Parity Check) coding capability + Enable :abbr:`LDPC (Low-Density Parity Check)` coding for the interface. .. cfgcmd:: set interfaces wireless capabilities vht link-adaptation - VHT link adaptation capabilities + Enable VHT link adaptation on the interface. .. cfgcmd:: set interfaces wireless capabilities vht max-mpdu - Increase Maximum MPDU length to 7991 or 11454 octets (default 3895 octets) + **Increase the maximum** :abbr:`MPDU (MAC Protocol Data Unit)` **length to + 7991 or 11454 octets.** + + Default: 3895 octets. .. cfgcmd:: set interfaces wireless capabilities vht max-mpdu-exp - Set the maximum length of A-MPDU pre-EOF padding that the station can - receive + Configure the maximum length of :abbr:`A-MPDU (Aggregated MAC Protocol Data + Unit)` :abbr:`pre-EOF (pre-End of Frame)` padding that the interface can + receive. .. cfgcmd:: set interfaces wireless capabilities vht short-gi <80 | 160> - Short GI capabilities + **Configure** :abbr:`Short GI (Short Guard Interval)` **capabilities for 80 MHz + or 160 MHz channels.** + + * ``80``: Enables Short GI for 80 MHz channels. + * ``160``: Enables Short GI for 160 MHz channels. + .. cfgcmd:: set interfaces wireless capabilities vht stbc rx - Enable receiving PPDU using STBC (Space Time Block Coding) + Enable receiving :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC + (Space-Time Block Coding)`. .. cfgcmd:: set interfaces wireless capabilities vht stbc tx - Enable sending PPDU using STBC (Space Time Block Coding) + Enable transmitting :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC + (Space-Time Block Coding)`. .. cfgcmd:: set interfaces wireless capabilities vht tx-powersave - Enable VHT TXOP Power Save Mode + Enable VHT :abbr:`TXOP (Transmit Opportunity)` Power Save mode for the + interface. .. cfgcmd:: set interfaces wireless capabilities vht vht-cf - Station supports receiving VHT variant HT Control field + Enable receiving the VHT variant HT Control field on the interface. HE (High Efficiency) capabilities (802.11ax) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -340,77 +387,82 @@ HE (High Efficiency) capabilities (802.11ax) .. cfgcmd:: set interfaces wireless capabilities he antenna-pattern-fixed - Tell the AP that antenna positions are fixed and will not change - during the lifetime of an association. + Notify the :abbr:`AP (Access Point)` that antenna positions are fixed and do not change during the lifetime of an association. .. cfgcmd:: set interfaces wireless capabilities he beamform - Beamforming capabilities: + **Configure HE beamforming capabilities for the interface.** - * ``single-user-beamformer`` - Support for operation as - single user beamformer - * ``single-user-beamformee`` - Support for operation as - single user beamformee - * ``multi-user-beamformer`` - Support for operation as single - user beamformer + * ``single-user-beamformer``: Supports operation as a Single-User (SU) + beamformer. + * ``single-user-beamformee``: Supports operation as a Single-User (SU) + beamformee. + * ``multi-user-beamformer``: Supports operation as a Multi-User (MU) beamformer. .. cfgcmd:: set interfaces wireless capabilities he bss-color - BSS coloring helps to prevent channel jamming when multiple APs use - the same channels. + **Configure the** :abbr:`BSS (Basic Service Set)` **color for the interface.** + + BSS coloring helps prevent channel jamming when multiple :abbr:`APs (Access + Points)` use the same channels. Valid values are 1..63 .. cfgcmd:: set interfaces wireless capabilities he center-channel-freq - HE operating channel center frequency - center freq 1 - (for use with 80, 80+80 and 160 modes) + **Configure the HE operating channel center frequency for the interface.** + + * ``freq-1``: Specifies the center frequency for 80 MHz, 160 MHz, and 80+80 MHz + channels. - HE operating channel center frequency - center freq 2 - (for use with the 80+80 mode) + * ``freq-2``: Specifies the center frequency for 80+80 MHz channels. - must be within 1..233. For 80 MHz channels it should be - channel + 6 and for 160 MHz channels, it should be channel + 14. + * ````: Ranges from 34 to 173. For 80 MHz channels, the center + frequency is typically the primary channel number plus 6. .. cfgcmd:: set interfaces wireless capabilities he channel-set-width - must be one of: + **Configure the HE operating channel width for the interface.** - * ``81`` - 20 MHz channel width (2.4GHz) - * ``83`` - 40 MHz channel width, secondary 20MHz channel above primary - channel (2.4GHz) - * ``84`` - 40 MHz channel width, secondary 20MHz channel below primary - channel (2.4GHz) - * ``131`` - 20 MHz channel width (6GHz) - * ``132`` - 40 MHz channel width (6GHz) - * ``133`` - 80 MHz channel width (6GHz) - * ``134`` - 160 MHz channel width (6GHz) - * ``135`` - 80+80 MHz channel width (6GHz) + For the 2.4 GHz band: + + * ``81``: 20 MHz channel width. + * ``83``: 40 MHz channel width, secondary 20 MHz channel above primary. + * ``84``: 40 MHz channel width, secondary 20 MHz channel below primary. + + For the 6 GHz band: + + * ``131``: 20 MHz channel width. + * ``132``: 40 MHz channel width. + * ``133``: 80 MHz channel width. + * ``134``: 160 MHz channel width. + * ``135``: 80+80 MHz channel width. .. cfgcmd:: set interfaces wireless capabilities he coding-scheme + + **Configure** :abbr:`SS (Spatial Stream)` **and** :abbr:`HE-MCS (High + Efficiency Modulation and Coding Scheme)` **settings for the interface.** - This setting configures Spacial Stream and Modulation Coding Scheme - settings for HE mode (HE-MCS). It is usually not needed to set this - explicitly, but it might help with some WiFi adapters. + Explicit configuration of these settings is typically unnecessary. - must be one of: + The ```` defines the supported MCS range and must be one of the following: - * ``0`` - HE-MCS 0-7 - * ``1`` - HE-MCS 0-9 - * ``2`` - HE-MCS 0-11 - * ``3`` - HE-MCS is not supported + * ``0``: Allows HE-MCS 0-7. + * ``1``: Allows HE-MCS 0-9. + * ``2``: Allows HE-MCS 0-11. + * ``3``: Disables HE-MCS. -Wireless options (Station/Client) +Wireless options (station/client) ================================= -The example creates a wireless station (commonly referred to as Wi-Fi client) -that accesses the network through the WAP defined in the above example. The -default physical device (``phy0``) is used. +The following example configures a wireless station (Wi-Fi client) that +connects to the network through an :abbr:`AP (Access Point)`, using the default +physical interface ``phy0``. .. code-block:: none @@ -420,7 +472,7 @@ default physical device (``phy0``) is used. set interfaces wireless wlan0 ssid Test set interfaces wireless wlan0 security wpa passphrase '12345678' -Resulting in +Resulting configuration: .. code-block:: none @@ -441,28 +493,32 @@ Resulting in type station } -Security -======== +Wireless security +================= + +:abbr:`WPA (Wi-Fi Protected Access)`, WPA2, and WPA3 Enterprise, combined with +802.1X-based authentication, enable user or computer authentication within a +domain. -:abbr:`WPA (Wi-Fi Protected Access)`, WPA2 Enterprise and WPA3 Enterprise in -combination with 802.1x based authentication can be used to authenticate -users or computers in a domain. +The authentication process involves the following three participants: -The wireless client (supplicant) authenticates against the RADIUS server -(authentication server) using an :abbr:`EAP (Extensible Authentication -Protocol)` method configured on the RADIUS server. The WAP (also referred -to as authenticator) role is to send all authentication messages between the -supplicant and the configured authentication server, thus the RADIUS server -is responsible for authenticating the users. +* **Supplicant**: The wireless client authenticates against the RADIUS server + using an EAP method. +* **Authenticator**: The Access Point (AP) sends authentication messages + between the supplicant and the RADIUS server. +* **Authentication server**: The RADIUS server authenticates users. -The WAP in this example has the following characteristics: +The following example configures an :abbr:`AP (Access Point)` to use WPA2 +Enterprise security and authenticate connecting clients against an external +RADIUS server. -* IP address ``192.168.2.1/24`` -* Network ID (SSID) ``Enterprise-TEST`` -* WPA passphrase ``12345678`` -* Use 802.11n protocol -* Wireless channel ``1`` -* RADIUS server at ``192.168.3.10`` with shared-secret ``VyOSPassword`` +Configuration parameters: + +* **IP address:** ``192.168.2.1/24`` +* **Network ID (SSID):** ``Enterprise-TEST`` +* **Protocol:** 802.11n +* **Wireless channel:** ``1`` +* **RADIUS server:** ``192.168.3.10`` with shared-secret ``VyOSPassword`` .. stop_vyoslinter .. code-block:: none @@ -472,7 +528,7 @@ The WAP in this example has the following characteristics: set interfaces wireless wlan0 type access-point set interfaces wireless wlan0 channel 1 set interfaces wireless wlan0 mode n - set interfaces wireless wlan0 ssid 'TEST' + set interfaces wireless wlan0 ssid 'Enterprise-TEST' set interfaces wireless wlan0 security wpa mode wpa2 set interfaces wireless wlan0 security wpa cipher CCMP set interfaces wireless wlan0 security wpa radius server 192.168.3.10 key 'VyOSPassword' @@ -480,7 +536,7 @@ The WAP in this example has the following characteristics: .. start_vyoslinter -Resulting in +Resulting configuration: .. code-block:: none @@ -530,13 +586,13 @@ QinQ (802.1ad) :var1: wlan0 ********* -Operation +Operation ********* .. opcmd:: show interfaces wireless info -Use this command to view operational status and wireless-specific information -about all wireless interfaces. +Show the operational status and wireless-specific information about all +wireless interfaces. .. code-block:: none @@ -546,8 +602,8 @@ about all wireless interfaces. .. opcmd:: show interfaces wireless detail -Use this command to view operational status and details wireless-specific -information about all wireless interfaces. +Show the operational status and detailed wireless-specific information about +all wireless interfaces. .. stop_vyoslinter .. code-block:: none @@ -581,8 +637,8 @@ information about all wireless interfaces. .. opcmd:: show interfaces wireless -This command shows both status and statistics on the specified wireless -interface. The wireless interface identifier can range from wlan0 to wlan999. +Show the operational status and statistics for the specified wireless +interface. Interface identifiers range from ``wlan0`` to ``wlan999``. .. stop_vyoslinter .. code-block:: none @@ -605,8 +661,8 @@ interface. The wireless interface identifier can range from wlan0 to wlan999. .. opcmd:: show interfaces wireless brief -This command gives a brief status overview of a specified wireless interface. -The wireless interface identifier can range from wlan0 to wlan999. +Show a brief operational status summary for the specified wireless interface. +Interface identifiers range from ``wlan0`` to ``wlan999``. .. code-block:: none @@ -619,8 +675,8 @@ The wireless interface identifier can range from wlan0 to wlan999. .. opcmd:: show interfaces wireless queue -Use this command to view wireless interface queue information. -The wireless interface identifier can range from wlan0 to wlan999. +Show queue information for the specified wireless interface. Interface +identifiers range from ``wlan0`` to ``wlan999``. .. code-block:: none @@ -632,13 +688,12 @@ The wireless interface identifier can range from wlan0 to wlan999. .. opcmd:: show interfaces wireless scan -This command is used to retrieve information about WAP within the range of your -wireless interface. This command is useful on wireless interfaces configured -in station mode. +Show information about :abbr:`APs (Access Points)` within the range of the +specified wireless interface. You can use this data when configuring wireless +interfaces in ``station`` mode. -.. note:: Scanning is not supported on all wireless drivers and wireless - hardware. Refer to your driver and wireless hardware documentation for - further details. +.. note:: Some wireless drivers or hardware may not support such scanning. + Refer to your driver and hardware documentation for more information. .. code-block:: none @@ -664,17 +719,17 @@ in station mode. Examples ******** -The following example creates a WAP. When configuring multiple WAP interfaces, -you must specify unique IP addresses, channels, Network IDs commonly referred -to as :abbr:`SSID (Service Set Identifier)`, and MAC addresses. +The following example configures an :abbr:`AP (Access Point)` with the +following parameters: -The WAP in this example has the following characteristics: +* IP address: ``192.168.2.1/24`` +* Network ID (SSID): ``TEST`` +* WPA passphrase: ``12345678`` +* Protocol: 802.11n +* Wireless channel: ``1`` -* IP address ``192.168.2.1/24`` -* Network ID (SSID) ``TEST`` -* WPA passphrase ``12345678`` -* Use 802.11n protocol -* Wireless channel ``1`` +.. note:: When setting up multiple WAP interfaces, ensure each has a unique IP + address, channel, network ID (SSID), and MAC address. .. code-block:: none @@ -688,7 +743,7 @@ The WAP in this example has the following characteristics: set interfaces wireless wlan0 security wpa cipher CCMP set interfaces wireless wlan0 security wpa passphrase '12345678' -Resulting in +Resulting configuration: .. code-block:: none @@ -715,28 +770,27 @@ Resulting in } } -To get it to work as an access point with this configuration you will need -to set up a DHCP server to work with that network. You can - of course - also -bridge the Wireless interface with any configured bridge -(:ref:`bridge-interface`) on the system. +To enable access point functionality, configure a DHCP server for this +interface's network, or add the interface to an existing local bridge. +(see :ref:`bridge-interface` for details). -WiFi-6(e) - 802.11ax -==================== +Wi-Fi 6/6E (802.11ax) +===================== -The following examples will show valid configurations for WiFi-6 (2.4GHz) -and WiFi-6e (6GHz) Access-Points with the following characteristics: +The following examples configure Wi-Fi 6 (2.4 GHz) and Wi-Fi 6E (6 GHz) +:abbr:`APs (Access Points)` with the following parameters: -* Network ID (SSID) ``test.ax`` -* WPA passphrase ``super-dooper-secure-passphrase`` -* Use 802.11ax protocol -* Wireless channel ``11`` for 2.4GHz -* Wireless channel ``5`` for 6GHz +* Network ID (SSID): ``test.ax`` +* WPA passphrase: ``super-dooper-secure-passphrase`` +* Protocol: 802.11ax +* Wireless channel for 2.4 GHz: ``11`` +* Wireless channel for 6 GHz: ``5`` -Example Configuration: WiFi-6 at 2.4GHz ---------------------------------------- +Example configuration: Wi-Fi 6 at 2.4 GHz +----------------------------------------- -You may expect real throughputs around 10MBytes/s or higher in crowded areas. +You may expect real throughput around 10 MB/s or higher in crowded areas. .. code-block:: none @@ -768,7 +822,7 @@ You may expect real throughputs around 10MBytes/s or higher in crowded areas. set interfaces wireless wlan0 type access-point commit -Resulting in +Resulting configuration: .. code-block:: none @@ -824,13 +878,14 @@ Resulting in } } -Example Configuration: WiFi-6e at 6GHz --------------------------------------- +Example configuration: Wi-Fi 6E at 6 GHz +---------------------------------------- -You may expect real throughputs around 50MBytes/s to 150MBytes/s, -depending on obstructions by walls, water, metal or other materials -with high electro-magnetic dampening at 6GHz. Best results are achieved -with the AP being in the same room and in line-of-sight. +You may expect real throughput between 50 MB/s and 150 MB/s, depending on +obstructions from walls, water, metal, or other materials with high +electromagnetic damping at 6 GHz. + +Best results are achieved when the AP is in the same room and in line of sight. .. code-block:: none @@ -841,7 +896,7 @@ with the AP being in the same room and in line-of-sight. set interfaces wireless wlan0 capabilities he beamform single-user-beamformer set interfaces wireless wlan0 capabilities he bss-color 13 set interfaces wireless wlan0 capabilities he channel-set-width 134 - set interfaces wireless wlan0 capabilities he capabilities he center-channel-freq freq-1 15 + set interfaces wireless wlan0 capabilities he center-channel-freq freq-1 15 set interfaces wireless wlan0 channel 5 set interfaces wireless wlan0 description "802.11ax 6GHz" set interfaces wireless wlan0 mode ax @@ -858,7 +913,7 @@ with the AP being in the same room and in line-of-sight. set interfaces wireless wlan0 stationary-ap commit -Resulting in +Resulting configuration: .. code-block:: none @@ -913,9 +968,10 @@ Resulting in Intel AX200 =========== -The Intel AX200 card does not work out of the box in AP mode, see -https://unix.stackexchange.com/questions/598275/intel-ax200-ap-mode. You can -still put this card into AP mode using the following configuration: +The Intel AX200 card does not operate out of the box in ``access-point`` mode. + +You can still enable :abbr:`AP (Access Point)` functionality on this hardware +by applying the following configuration: .. stop_vyoslinter .. code-block:: none -- cgit v1.2.3 From dad139434e34d3bbf24fd46c8fa8ea7a54177d0a Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Mon, 30 Mar 2026 13:33:30 +0300 Subject: Split troubleshooting, add contributing index, clean VPN structure (#1804) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add design spec for documentation improvements Covers 4 work streams: mechanical fixes (headings, indentation, typos), content quality (TODO flags, TBD fills, stub markers), structural reorganization (troubleshooting split, contributing index, VPN cleanup), and RTD platform cleanup (hide versions, delete stale redirects). Co-Authored-By: Claude Opus 4.6 (1M context) * Fix spec issues from review: correct heading chars, tab counts, line numbers Addresses 10 reviewer findings: corrected heading character types (^ was actually -), removed ip.rst (already correct), updated file count from 37 to 35, listed all 13 tab-containing files, fixed troubleshooting line count to 460, added heading level guidance for split pages, clarified contributing/documentation.rst scope, removed current from hide list, added rollback verification step, updated success criteria. Co-Authored-By: Claude Opus 4.6 (1M context) * Add implementation plan for documentation improvements 16 tasks across 4 work streams: mechanical fixes (PR 1, tasks 1-6), content quality (PR 2, tasks 7-10), structural reorg (PR 3, tasks 11-14), and RTD platform cleanup (tasks 15-16). Co-Authored-By: Claude Opus 4.6 (1M context) * Fix 6 issues from plan review - Replace hardcoded RTD token with $RTD_TOKEN variable - Fix Task 7 heading reference to be format-agnostic - Correct RTD PATCH expected response (200, not 204) - Fix version verification to check hidden field, not active - Account for blank lines 402-403 in troubleshooting split - Clarify start/stop_vyoslinter handling in system.rst Co-Authored-By: Claude Opus 4.6 (1M context) * refactor: split troubleshooting into 5 focused sub-pages Split monolithic 460-line troubleshooting/index.rst into: - connectivity.rst (ping, traceroute, mtr, IPv6 discovery) - interfaces.rst (interface naming, MAC addresses) - monitoring.rst (traffic dumps, bandwidth, iperf) - terminal.rst (console clearing, counter resets) - system.rst (boot steps, system information) Co-Authored-By: Claude Sonnet 4.6 * refactor: create contributing/index.rst, simplify root toctree * fix: remove 'pages to sort' placeholders from VPN section * fix: wrap long lines in index.rst for linter compliance * Add design spec for sitemap generation improvement * Fix sitemap spec: remove invalid sitemap_excludes, add version pin * fix: address Copilot review suggestions — grammar, typos, RST markup fixes Co-Authored-By: Claude Sonnet 4.6 * fix: resolve remaining long lines in index.rst Shorten :ref: display text on two lines that exceeded the 80-char limit: "Virtual Environment" -> "VM" (line 24, 90 -> 73 chars) and "Configuration Blueprints" -> "Blueprints" (line 51, 85 -> 71 chars). Both targets remain correct; display text is clear in context. Co-Authored-By: Claude Sonnet 4.6 * chore: remove superpowers specs from PR Specs moved to personal branch yuriy/docs-modernization-specs. Co-Authored-By: Claude Opus 4.6 (1M context) --------- Co-authored-by: Claude Opus 4.6 (1M context) --- docs/configuration/vpn/index.rst | 10 +- docs/configuration/vpn/ipsec/index.rst | 8 - docs/contributing/index.rst | 14 + docs/index.rst | 44 ++-- docs/troubleshooting/connectivity.rst | 150 +++++++++++ docs/troubleshooting/index.rst | 458 +-------------------------------- docs/troubleshooting/interfaces.rst | 39 +++ docs/troubleshooting/monitoring.rst | 161 ++++++++++++ docs/troubleshooting/system.rst | 57 ++++ docs/troubleshooting/terminal.rst | 42 +++ 10 files changed, 498 insertions(+), 485 deletions(-) create mode 100644 docs/contributing/index.rst create mode 100644 docs/troubleshooting/connectivity.rst create mode 100644 docs/troubleshooting/interfaces.rst create mode 100644 docs/troubleshooting/monitoring.rst create mode 100644 docs/troubleshooting/system.rst create mode 100644 docs/troubleshooting/terminal.rst (limited to 'docs/configuration') diff --git a/docs/configuration/vpn/index.rst b/docs/configuration/vpn/index.rst index d0121abd..228f83ca 100644 --- a/docs/configuration/vpn/index.rst +++ b/docs/configuration/vpn/index.rst @@ -7,18 +7,10 @@ VPN :maxdepth: 1 :includehidden: + dmvpn ipsec/index l2tp openconnect pptp rsa-keys sstp - - -pages to sort - -.. toctree:: - :maxdepth: 1 - :includehidden: - - dmvpn diff --git a/docs/configuration/vpn/ipsec/index.rst b/docs/configuration/vpn/ipsec/index.rst index e454e2f6..7647d8d2 100644 --- a/docs/configuration/vpn/ipsec/index.rst +++ b/docs/configuration/vpn/ipsec/index.rst @@ -11,11 +11,3 @@ IPsec site2site_ipsec remoteaccess_ipsec troubleshooting_ipsec - -pages to sort - -.. toctree:: - :maxdepth: 1 - :includehidden: - - diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst new file mode 100644 index 00000000..18b925ec --- /dev/null +++ b/docs/contributing/index.rst @@ -0,0 +1,14 @@ +############ +Contributing +############ + +.. toctree:: + :maxdepth: 1 + + build-vyos + development + cla + issues-features + upstream-packages + debugging + testing diff --git a/docs/index.rst b/docs/index.rst index 70b862b4..660daa46 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,20 +11,27 @@ VyOS User Guide .. grid-item-card:: Get / Build VyOS - Quickly :ref:`Build` your own Image or take a look at how to :ref:`download` a free or supported version. + Quickly :ref:`Build` + your own Image or take a look at how to + :ref:`download` + a free or supported version. .. grid-item-card:: Install VyOS - Read about how to install VyOS on :ref:`Bare Metal` or in a - :ref:`Virtual Environment` and - how to use an image with the usual :ref:`cloud` providers + Read about how to install VyOS on + :ref:`Bare Metal` + or in a :ref:`VM ` + and how to use an image with the usual + :ref:`cloud` + providers .. grid-item-card:: Configuration and Operation - Use the :ref:`Quickstart Guide`, to have a fast overview. Or go deeper and - set up :ref:`advanced routing`, + Use the :ref:`Quickstart Guide`, + to have a fast overview. Or go deeper and set up + :ref:`advanced routing`, :ref:`VRFs`, or :ref:`VPNs` for example. @@ -33,21 +40,28 @@ VyOS User Guide Integrate VyOS in your automation Workflow with :ref:`Ansible`, - have your own :ref:`local scripts`, or configure VyOS with the :ref:`HTTPS-API`. + have your own :ref:`local scripts`, + or configure VyOS with the + :ref:`HTTPS-API`. .. grid-item-card:: Examples - Get some inspiration from the :ref:`Configuration Blueprints` + Get some inspiration from the + :ref:`Blueprints ` to build your infrastructure. .. grid-item-card:: Contribute and Community | There are many ways to contribute to the project. - | Add missing parts or improve the :ref:`Documentation`. - | Discuss in `Slack `_ or the `Forum `_. - | Or you can pick up a `Task `_ and fix the :ref:`code`. + | Add missing parts or improve the + :ref:`Documentation`. + | Discuss in `Slack `_ + or the `Forum `_. + | Or you can pick up a `Task `_ + and fix the + :ref:`code`. .. toctree:: @@ -86,13 +100,7 @@ VyOS User Guide :hidden: :caption: Development - contributing/build-vyos - contributing/development - contributing/cla - contributing/issues-features - contributing/upstream-packages - contributing/debugging - contributing/testing + contributing/index .. toctree:: diff --git a/docs/troubleshooting/connectivity.rst b/docs/troubleshooting/connectivity.rst new file mode 100644 index 00000000..aa2a0151 --- /dev/null +++ b/docs/troubleshooting/connectivity.rst @@ -0,0 +1,150 @@ +################## +Connectivity Tests +################## + +************************ +Basic Connectivity Tests +************************ + +Verifying connectivity can be done with the familiar `ping` and `traceroute` +commands. The options for each are shown (the options for each command were +displayed using the built-in help as described in the :ref:`cli` +section and are omitted from the output here): + +.. opcmd:: ping + + Send ICMP echo requests to destination host. There are multiple options to + ping, including VRF support. + + .. code-block:: none + + vyos@vyos:~$ ping 10.1.1.1 + Possible completions: + Execute the current command + adaptive Ping options + allow-broadcast + audible + bypass-route + count + deadline + do-not-fragment + flood + interface + interval + mark + no-loopback + numeric + pattern + quiet + record-route + size + timestamp + tos + ttl + verbose + vrf + + +.. opcmd:: traceroute + + Trace path to target. + + .. code-block:: none + + vyos@vyos:~$ traceroute + Possible completions: + Track network path to specified node + + + ipv4 Track network path to + ipv6 Track network path to + + +*************************** +Advanced Connectivity Tests +*************************** + +.. opcmd:: monitor traceroute + + However, another helper is available which combines ping and traceroute + into a single tool. An example of its output is shown: + + .. code-block:: none + + vyos@vyos:~$ mtr 10.62.212.12 + + My traceroute [v0.85] + vyos (0.0.0.0) + Keys: Help Display mode Restart statistics Order of fields quit + Packets Pings + Host Loss% Snt Last Avg Best Wrst StDev + 1. 10.11.110.4 0.0% 34 0.5 0.5 0.4 0.8 0.1 + 2. 10.62.255.184 0.0% 34 1.1 1.0 0.9 1.4 0.1 + 3. 10.62.255.71 0.0% 34 1.4 1.4 1.3 2.0 0.1 + 4. 10.62.212.12 0.0% 34 1.6 1.6 1.6 1.7 0.0 + + .. note:: The output consumes the screen and will replace your command + prompt. + + Several options are available for changing the display output. Press `h` to + invoke the built in help system. To quit, just press `q` and you'll be + returned to the VyOS command prompt. + +*********************** +IPv6 Topology Discovery +*********************** + +IPv6 uses different techniques to discover its Neighbors/topology. + +Router Discovery +================ + +.. opcmd:: force ipv6-rd interface [address ] + + Discover routers via eth0. + + Example: + + .. code-block:: none + + vyos@vyos:~$ force ipv6-rd interface eth0 + Soliciting ff02::2 (ff02::2) on eth0... + + Hop limit : 60 ( 0x3c) + Stateful address conf. : No + Stateful other conf. : No + Mobile home agent : No + Router preference : high + Neighbor discovery proxy : No + Router lifetime : 1800 (0x00000708) seconds + Reachable time : unspecified (0x00000000) + Retransmit time : unspecified (0x00000000) + Prefix : 240e:fe:8ca7:ea01::/64 + On-link : Yes + Autonomous address conf.: Yes + Valid time : 2592000 (0x00278d00) seconds + Pref. time : 14400 (0x00003840) seconds + Prefix : fc00:470:f1cd:101::/64 + On-link : Yes + Autonomous address conf.: Yes + Valid time : 2592000 (0x00278d00) seconds + Pref. time : 14400 (0x00003840) seconds + Recursive DNS server : fc00:470:f1cd::ff00 + DNS server lifetime : 600 (0x00000258) seconds + Source link-layer address: 00:98:2B:F8:3F:11 + from fe80::298:2bff:fef8:3f11 + +Neighbor Discovery +================== + +.. opcmd:: force ipv6-nd interface address + + + Example: + + .. code-block:: none + + vyos@vyos:~$ force ipv6-nd interface eth0 address fc00:470:f1cd:101::1 + + Soliciting fc00:470:f1cd:101::1 (fc00:470:f1cd:101::1) on eth0... + Target link-layer address: 00:98:2B:F8:3F:11 from fc00:470:f1cd:101::1 diff --git a/docs/troubleshooting/index.rst b/docs/troubleshooting/index.rst index 8a34edd9..791afc56 100644 --- a/docs/troubleshooting/index.rst +++ b/docs/troubleshooting/index.rst @@ -8,453 +8,11 @@ Sometimes things break or don't work as expected. This section describes several troubleshooting tools provided by VyOS that can help when something goes wrong. -****************** -Connectivity Tests -****************** - -Basic Connectivity Tests -======================== - -Verifying connectivity can be done with the familiar `ping` and `traceroute` -commands. The options for each are shown (the options for each command were -displayed using the built-in help as described in the :ref:`cli` -section and are omitted from the output here): - -.. opcmd:: ping - - Send ICMP echo requests to destination host. There are multiple options to - ping, inkl. VRF support. - - .. code-block:: none - - vyos@vyos:~$ ping 10.1.1.1 - Possible completions: - Execute the current command - adaptive Ping options - allow-broadcast - audible - bypass-route - count - deadline - do-not-fragment - flood - interface - interval - mark - no-loopback - numeric - pattern - quiet - record-route - size - timestamp - tos - ttl - verbose - vrf - - -.. opcmd:: traceroute - - Trace path to target. - - .. code-block:: none - - vyos@vyos:~$ traceroute - Possible completions: - Track network path to specified node - - - ipv4 Track network path to - ipv6 Track network path to - - -Advanced Connectivity Tests -=========================== - -.. opcmd:: monitor traceroute - - However, another helper is available which combines ping and traceroute - into a single tool. An example of its output is shown: - - .. code-block:: none - - vyos@vyos:~$ mtr 10.62.212.12 - - My traceroute [v0.85] - vyos (0.0.0.0) - Keys: Help Display mode Restart statistics Order of fields quit - Packets Pings - Host Loss% Snt Last Avg Best Wrst StDev - 1. 10.11.110.4 0.0% 34 0.5 0.5 0.4 0.8 0.1 - 2. 10.62.255.184 0.0% 34 1.1 1.0 0.9 1.4 0.1 - 3. 10.62.255.71 0.0% 34 1.4 1.4 1.3 2.0 0.1 - 4. 10.62.212.12 0.0% 34 1.6 1.6 1.6 1.7 0.0 - - .. note:: The output consumes the screen and will replace your command - prompt. - - Several options are available for changing the display output. Press `h` to - invoke the built in help system. To quit, just press `q` and you'll be - returned to the VyOS command prompt. - -IPv6 Topology Discovery -======================= - -IPv6 uses different techniques to discover its Neighbors/topology. - -Router Discovery ----------------- - -.. opcmd:: force ipv6-rd interface [address ] - - Discover routers via eth0. - - Example: - - .. code-block:: none - - vyos@vyos:~$ force ipv6-rd interface eth0 - Soliciting ff02::2 (ff02::2) on eth0... - - Hop limit : 60 ( 0x3c) - Stateful address conf. : No - Stateful other conf. : No - Mobile home agent : No - Router preference : high - Neighbor discovery proxy : No - Router lifetime : 1800 (0x00000708) seconds - Reachable time : unspecified (0x00000000) - Retransmit time : unspecified (0x00000000) - Prefix : 240e:fe:8ca7:ea01::/64 - On-link : Yes - Autonomous address conf.: Yes - Valid time : 2592000 (0x00278d00) seconds - Pref. time : 14400 (0x00003840) seconds - Prefix : fc00:470:f1cd:101::/64 - On-link : Yes - Autonomous address conf.: Yes - Valid time : 2592000 (0x00278d00) seconds - Pref. time : 14400 (0x00003840) seconds - Recursive DNS server : fc00:470:f1cd::ff00 - DNS server lifetime : 600 (0x00000258) seconds - Source link-layer address: 00:98:2B:F8:3F:11 - from fe80::298:2bff:fef8:3f11 - -Neighbor Discovery ------------------- - -.. opcmd:: force ipv6-nd interface address - - - Example: - - .. code-block:: none - - vyos@vyos:~$ force ipv6-nd interface eth0 address fc00:470:f1cd:101::1 - - Soliciting fc00:470:f1cd:101::1 (fc00:470:f1cd:101::1) on eth0... - Target link-layer address: 00:98:2B:F8:3F:11 from fc00:470:f1cd:101::1 - - -*************** -Interface names -*************** - -If you find the names of your interfaces have changed, this could be because -your MAC addresses have changed. - -* For example, you have a VyOS VM with 4 Ethernet interfaces named - eth0, eth1, eth2 and eth3. Then, you migrate your VyOS VM to a different - host and find your interfaces now are eth4, eth5, eth6 and eth7. - - One way to fix this issue **taking control of the MAC addresses** is: - - Log into VyOS and run this command to display your interface settings. - - .. code-block:: none - - show interfaces detail - - Take note of MAC addresses. - - Now, in order to update a MAC address in the configuration, run this command - specifying the interface name and MAC address you want. - - .. code-block:: none - - set interfaces eth0 hw-id 00:0c:29:da:a4:fe - - If it is a VM, go into the settings of the host and set the MAC address to - the settings found in the config.boot file. You can also set the MAC to - static if the host allows so. - - -* Another example could be when cloning VyOS VMs in GNS3 and you get into the - same issue: interface names have changed. - - And **a more generic way to fix it** is just deleting every MAC address at - the configuration file of the cloned machine. They will be correctly - regenerated automatically. - - -********** -Monitoring -********** - -VyOS features several monitoring tools. - -.. code-block:: none - - vyos@vyos:~$ monitor - Possible completions: - bandwidth Monitor interface bandwidth in real time - bandwidth-test - Initiate or wait for bandwidth test - cluster Monitor clustering service - command Monitor an operational mode command (refreshes every 2 seconds) - conntrack-sync - Monitor conntrack-sync - content-inspection - Monitor Content-Inspection - dhcp Monitor Dynamic Host Control Protocol (DHCP) - dns Monitor a Domain Name Service (DNS) daemon - firewall Monitor Firewall - https Monitor the Secure Hypertext Transfer Protocol (HTTPS) service - lldp Monitor Link Layer Discovery Protocol (LLDP) daemon - log Monitor last lines of messages file - nat Monitor network address translation (NAT) - ndp Monitor the NDP information received by the router through the device - openvpn Monitor OpenVPN - protocol Monitor routing protocols - snmp Monitor Simple Network Management Protocol (SNMP) daemon - stop-all Stop all current background monitoring processes - traceroute Monitor the path to a destination in realtime - traffic Monitor traffic dumps - vpn Monitor VPN - vrrp Monitor Virtual Router Redundancy Protocol (VRRP) - webproxy Monitor Webproxy service - - -Traffic Dumps -============= - -To monitor interface traffic, issue the :code:`monitor traffic interface ` -command, replacing `` with your chosen interface. - -.. code-block:: none - - vyos@vyos:~$ monitor traffic interface eth0 - tcpdump: verbose output suppressed, use -v or -vv for full protocol decode - listening on eth0, link-type EN10MB (Ethernet), capture size 262144 bytes - 15:54:28.581601 IP 192.168.0.1 > vyos: ICMP echo request, id 1870, seq 3848, length 64 - 15:54:28.581660 IP vyos > 192.168.0.1: ICMP echo reply, id 1870, seq 3848, length 64 - 15:54:29.583399 IP 192.168.0.1 > vyos: ICMP echo request, id 1870, seq 3849, length 64 - 15:54:29.583454 IP vyos > 192.168.0.1: ICMP echo reply, id 1870, seq 3849, length 64 - ^C - 4 packets captured - 4 packets received by filter - 0 packets dropped by kernel - vyos@vyos:~$ - -To quit monitoring, press `Ctrl-c` and you'll be returned to the VyOS command -prompt. - -Traffic can be filtered and saved. - -.. code-block:: none - - vyos@vyos:~$ monitor traffic interface eth0 - Possible completions: - Execute the current command - filter Monitor traffic matching filter conditions - save Save traffic dump from an interface to a file - - -Interface Bandwidth Usage -========================= - -to take a quick view on the used bandwidth of an interface use the ``monitor -bandwidth`` command - -.. code-block:: none - - vyos@vyos:~$ monitor bandwidth interface eth0 - -show the following: - -.. code-block:: none - - B (RX Bytes/second) - 198.00 .|....|..................................................... - 165.00 .|....|..................................................... - 132.00 ||..|.|..................................................... - 99.00 ||..|.|..................................................... - 66.00 |||||||..................................................... - 33.00 |||||||..................................................... - 1 5 10 15 20 25 30 35 40 45 50 55 60 - - KiB (TX Bytes/second) - 3.67 ......|..................................................... - 3.06 ......|..................................................... - 2.45 ......|..................................................... - 1.84 ......|..................................................... - 1.22 ......|..................................................... - 0.61 :::::||..................................................... - 1 5 10 15 20 25 30 35 40 45 50 55 60 - -Interface Performance -===================== - -To take a look on the network bandwidth between two nodes, the ``monitor -bandwidth-test`` command is used to run iperf. - -.. code-block:: none - - vyos@vyos:~$ monitor bandwidth-test - Possible completions: - accept Wait for bandwidth test connections (port TCP/5001) - initiate Initiate a bandwidth test - -* The ``accept`` command opens a listening iperf server on TCP Port 5001 -* The ``initiate`` command connects to that server to perform the test. - -.. code-block:: none - - vyos@vyos:~$ monitor bandwidth-test initiate - Possible completions: - Initiate a bandwidth test to specified host (port TCP/5001) - - - - -Monitor command -=============== - -The ``monitor command`` command allows you to repeatedly run a command to view -a continuously refreshed output. The command is run and output every 2 seconds, -allowing you to monitor the output continuously without having to re-run the -command. This can be useful to follow routing adjacency formation. - -.. code-block:: none - - vyos@router:~$ monitor command "show interfaces" - -Will clear the screen and show you the output of ``show interfaces`` every -2 seconds. - -.. code-block:: none - - Every 2.0s: /opt/vyatta/bin/vyatta-op-cmd-wrapper Sun Mar 26 02:49:46 2019 - - Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down - Interface IP Address S/L Description - --------- ---------- --- ----------- - eth0 192.168.1.1/24 u/u - eth0.5 198.51.100.4/24 u/u WAN - lo 127.0.0.1/8 u/u - ::1/128 - vti0 172.25.254.2/30 u/u - vti1 172.25.254.9/30 u/u - -**************** -Terminal/Console -**************** - -Sometimes you need to clear counters or statistics to troubleshoot better. - -To do this use the ``clear`` command in Operational mode. - -to clear the console output - -.. code-block:: none - - vyos@vyos:~$ clear console - -to clear interface counters - -.. code-block:: none - - # clear all interfaces - vyos@vyos:~$ clear interface ethernet counters - # clear specific interface - vyos@vyos:~$ clear interface ethernet eth0 counters - -The command follow the same logic as the ``set`` command in configuration mode. - -.. code-block:: none - - # clear all counters of a interface type - vyos@vyos:~$ clear interface counters - # clear counter of a interface in interface_type - vyos@vyos:~$ clear interface counters - - -to clear counters on firewall rulesets or single rules - -.. code-block:: none - - vyos@vyos:~$ clear firewall name counters - vyos@vyos:~$ clear firewall name rule counters - - vyos@vyos:~$ clear firewall ipv6-name counters - vyos@vyos:~$ clear firewall ipv6-name rule counters - - -****************** -System Information -****************** - -.. _boot-steps: - -Boot Steps -========== - -VyOS 1.2 uses `Debian Jessie`_ as the base Linux operating system. Jessie was -the first version of Debian that uses systemd_ as the default init system. - -These are the boot steps for VyOS 1.2 - -1. The BIOS loads Grub (or isolinux for the Live CD) -2. Grub then starts the Linux boot and loads the Linux Kernel ``/boot/vmlinuz`` -3. Kernel Launches Systemd ``/lib/systemd/systemd`` -4. Systemd loads the VyOS service file - ``/lib/systemd/system/vyos-router.service`` -5. The service file launches the VyOS router init script - ``/usr/libexec/vyos/init/vyos-router`` - this is part of the vyatta-cfg_ - Debian package - - 1. Starts FRR_ - successor to `GNU Zebra`_ and Quagga_ - - 2. Initialises the boot configuration file - copies over - ``config.boot.default`` if there is no configuration - 3. Runs the configuration migration, if the configuration is for an older - version of VyOS - 4. Runs The pre-config script, if there is one - ``/config/scripts/vyos-preconfig-bootup.script`` - 5. If the config file was upgraded, runs any post upgrade scripts - ``/config/scripts/post-upgrade.d`` - 6. Starts ``rl-system`` and ``firewall`` - 7. Mounts the ``/boot`` partition - 8. The boot configuration file is then applied by ``/opt/vyatta/sbin/ - vyatta-boot-config-loader/opt/vyatta/etc/config/config.boot`` - - 1. The config loader script writes log entries to - ``/var/log/vyatta-config-loader.log`` - - 9. Runs ``telinit q`` to tell the init system to reload ``/etc/inittab`` - 10. Finally it runs the post-config script - ``/config/scripts/vyos-postconfig-bootup.script`` - -.. stop_vyoslinter - -.. _Quagga: https://www.quagga.net/ -.. _`GNU Zebra`: https://www.gnu.org/software/zebra/ -.. _FRR: https://frrouting.org/ -.. _vyatta-cfg: https://github.com/vyos/vyatta-cfg -.. _systemd: https://freedesktop.org/wiki/Software/systemd/ -.. _`Debian Jessie`: https://www.debian.org/releases/jessie/ -.. _tshark: https://www.wireshark.org/docs/man-pages/tshark.html -.. _`PCAP filter expressions`: http://www.tcpdump.org/manpages/pcap-filter.7.html - -.. start_vyoslinter +.. toctree:: + :maxdepth: 1 + + connectivity + interfaces + monitoring + terminal + system diff --git a/docs/troubleshooting/interfaces.rst b/docs/troubleshooting/interfaces.rst new file mode 100644 index 00000000..95aceb12 --- /dev/null +++ b/docs/troubleshooting/interfaces.rst @@ -0,0 +1,39 @@ +############### +Interface Names +############### + +If you find the names of your interfaces have changed, this could be because +your MAC addresses have changed. + +* For example, you have a VyOS VM with 4 Ethernet interfaces named + eth0, eth1, eth2 and eth3. Then, you migrate your VyOS VM to a different + host and find your interfaces now are eth4, eth5, eth6 and eth7. + + One way to fix this issue **taking control of the MAC addresses** is: + + Log into VyOS and run this command to display your interface settings. + + .. code-block:: none + + show interfaces detail + + Take note of MAC addresses. + + Now, in order to update a MAC address in the configuration, run this command + specifying the interface name and MAC address you want. + + .. code-block:: none + + set interfaces ethernet eth0 hw-id 00:0c:29:da:a4:fe + + If it is a VM, go into the settings of the host and set the MAC address to + the settings found in the config.boot file. You can also set the MAC to + static if the host allows so. + + +* Another example could be when cloning VyOS VMs in GNS3 and you get into the + same issue: interface names have changed. + + And **a more generic way to fix it** is just deleting every MAC address at + the configuration file of the cloned machine. They will be correctly + regenerated automatically. diff --git a/docs/troubleshooting/monitoring.rst b/docs/troubleshooting/monitoring.rst new file mode 100644 index 00000000..ef40c937 --- /dev/null +++ b/docs/troubleshooting/monitoring.rst @@ -0,0 +1,161 @@ +########## +Monitoring +########## + +VyOS features several monitoring tools. + +.. code-block:: none + + vyos@vyos:~$ monitor + Possible completions: + bandwidth Monitor interface bandwidth in real time + bandwidth-test + Initiate or wait for bandwidth test + cluster Monitor clustering service + command Monitor an operational mode command (refreshes every 2 seconds) + conntrack-sync + Monitor conntrack-sync + content-inspection + Monitor Content-Inspection + dhcp Monitor Dynamic Host Control Protocol (DHCP) + dns Monitor a Domain Name Service (DNS) daemon + firewall Monitor Firewall + https Monitor the Secure Hypertext Transfer Protocol (HTTPS) service + lldp Monitor Link Layer Discovery Protocol (LLDP) daemon + log Monitor last lines of messages file + nat Monitor network address translation (NAT) + ndp Monitor the NDP information received by the router through the device + openvpn Monitor OpenVPN + protocol Monitor routing protocols + snmp Monitor Simple Network Management Protocol (SNMP) daemon + stop-all Stop all current background monitoring processes + traceroute Monitor the path to a destination in realtime + traffic Monitor traffic dumps + vpn Monitor VPN + vrrp Monitor Virtual Router Redundancy Protocol (VRRP) + webproxy Monitor Webproxy service + + +************* +Traffic Dumps +************* + +To monitor interface traffic, issue the :code:`monitor traffic interface ` +command, replacing `` with your chosen interface. + +.. code-block:: none + + vyos@vyos:~$ monitor traffic interface eth0 + tcpdump: verbose output suppressed, use -v or -vv for full protocol decode + listening on eth0, link-type EN10MB (Ethernet), capture size 262144 bytes + 15:54:28.581601 IP 192.168.0.1 > vyos: ICMP echo request, id 1870, seq 3848, length 64 + 15:54:28.581660 IP vyos > 192.168.0.1: ICMP echo reply, id 1870, seq 3848, length 64 + 15:54:29.583399 IP 192.168.0.1 > vyos: ICMP echo request, id 1870, seq 3849, length 64 + 15:54:29.583454 IP vyos > 192.168.0.1: ICMP echo reply, id 1870, seq 3849, length 64 + ^C + 4 packets captured + 4 packets received by filter + 0 packets dropped by kernel + vyos@vyos:~$ + +To quit monitoring, press :kbd:`Ctrl-C` and you'll be returned to the VyOS command +prompt. + +Traffic can be filtered and saved. + +.. code-block:: none + + vyos@vyos:~$ monitor traffic interface eth0 + Possible completions: + Execute the current command + filter Monitor traffic matching filter conditions + save Save traffic dump from an interface to a file + + +************************* +Interface Bandwidth Usage +************************* + +To quickly view the bandwidth usage of an interface, use the ``monitor bandwidth`` command: + +.. code-block:: none + + vyos@vyos:~$ monitor bandwidth interface eth0 + +This shows the following: + +.. code-block:: none + + B (RX Bytes/second) + 198.00 .|....|..................................................... + 165.00 .|....|..................................................... + 132.00 ||..|.|..................................................... + 99.00 ||..|.|..................................................... + 66.00 |||||||..................................................... + 33.00 |||||||..................................................... + 1 5 10 15 20 25 30 35 40 45 50 55 60 + + KiB (TX Bytes/second) + 3.67 ......|..................................................... + 3.06 ......|..................................................... + 2.45 ......|..................................................... + 1.84 ......|..................................................... + 1.22 ......|..................................................... + 0.61 :::::||..................................................... + 1 5 10 15 20 25 30 35 40 45 50 55 60 + +********************* +Interface Performance +********************* + +To take a look on the network bandwidth between two nodes, the ``monitor +bandwidth-test`` command is used to run iperf. + +.. code-block:: none + + vyos@vyos:~$ monitor bandwidth-test + Possible completions: + accept Wait for bandwidth test connections (port TCP/5001) + initiate Initiate a bandwidth test + +* The ``accept`` command opens a listening iperf server on TCP Port 5001 +* The ``initiate`` command connects to that server to perform the test. + +.. code-block:: none + + vyos@vyos:~$ monitor bandwidth-test initiate + Possible completions: + Initiate a bandwidth test to specified host (port TCP/5001) + + + + +*************** +Monitor command +*************** + +The ``monitor command`` command allows you to repeatedly run a command to view +a continuously refreshed output. The command is run and output every 2 seconds, +allowing you to monitor the output continuously without having to re-run the +command. This can be useful to follow routing adjacency formation. + +.. code-block:: none + + vyos@router:~$ monitor command "show interfaces" + +Will clear the screen and show you the output of ``show interfaces`` every +2 seconds. + +.. code-block:: none + + Every 2.0s: /opt/vyatta/bin/vyatta-op-cmd-wrapper Sun Mar 26 02:49:46 2019 + + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + eth0 192.168.1.1/24 u/u + eth0.5 198.51.100.4/24 u/u WAN + lo 127.0.0.1/8 u/u + ::1/128 + vti0 172.25.254.2/30 u/u + vti1 172.25.254.9/30 u/u diff --git a/docs/troubleshooting/system.rst b/docs/troubleshooting/system.rst new file mode 100644 index 00000000..3a9ec735 --- /dev/null +++ b/docs/troubleshooting/system.rst @@ -0,0 +1,57 @@ +################## +System Information +################## + +.. _boot-steps: + +********** +Boot Steps +********** + +VyOS 1.2 uses `Debian Jessie`_ as the base Linux operating system. Jessie was +the first version of Debian that uses systemd_ as the default init system. + +These are the boot steps for VyOS 1.2 + +1. The BIOS loads Grub (or isolinux for the Live CD) +2. Grub then starts the Linux boot and loads the Linux Kernel ``/boot/vmlinuz`` +3. Kernel Launches Systemd ``/lib/systemd/systemd`` +4. Systemd loads the VyOS service file + ``/lib/systemd/system/vyos-router.service`` +5. The service file launches the VyOS router init script + ``/usr/libexec/vyos/init/vyos-router`` - this is part of the vyatta-cfg_ + Debian package + + 1. Starts FRR_ - successor to `GNU Zebra`_ and Quagga_ + + 2. Initialises the boot configuration file - copies over + ``config.boot.default`` if there is no configuration + 3. Runs the configuration migration, if the configuration is for an older + version of VyOS + 4. Runs The pre-config script, if there is one + ``/config/scripts/vyos-preconfig-bootup.script`` + 5. If the config file was upgraded, runs any post upgrade scripts + ``/config/scripts/post-upgrade.d`` + 6. Starts ``rl-system`` and ``firewall`` + 7. Mounts the ``/boot`` partition + 8. The boot configuration file is then applied by ``/opt/vyatta/sbin/vyatta-boot-config-loader/opt/vyatta/etc/config/config.boot`` + + 1. The config loader script writes log entries to + ``/var/log/vyatta-config-loader.log`` + + 9. Runs ``telinit q`` to tell the init system to reload ``/etc/inittab`` + 10. Finally it runs the post-config script + ``/config/scripts/vyos-postconfig-bootup.script`` + +.. stop_vyoslinter + +.. _Quagga: https://www.quagga.net/ +.. _`GNU Zebra`: https://www.gnu.org/software/zebra/ +.. _FRR: https://frrouting.org/ +.. _vyatta-cfg: https://github.com/vyos/vyatta-cfg +.. _systemd: https://freedesktop.org/wiki/Software/systemd/ +.. _`Debian Jessie`: https://www.debian.org/releases/jessie/ +.. _tshark: https://www.wireshark.org/docs/man-pages/tshark.html +.. _`PCAP filter expressions`: http://www.tcpdump.org/manpages/pcap-filter.7.html + +.. start_vyoslinter diff --git a/docs/troubleshooting/terminal.rst b/docs/troubleshooting/terminal.rst new file mode 100644 index 00000000..fb197730 --- /dev/null +++ b/docs/troubleshooting/terminal.rst @@ -0,0 +1,42 @@ +################ +Terminal/Console +################ + +Sometimes you need to clear counters or statistics to troubleshoot better. + +To do this use the ``clear`` command in Operational mode. + +to clear the console output + +.. code-block:: none + + vyos@vyos:~$ clear console + +to clear interface counters + +.. code-block:: none + + # clear all interfaces + vyos@vyos:~$ clear interface ethernet counters + # clear specific interface + vyos@vyos:~$ clear interface ethernet eth0 counters + +The command follows the same logic as the ``set`` command in configuration mode. + +.. code-block:: none + + # clear all counters of an interface type + vyos@vyos:~$ clear interface counters + # clear counter of an interface in interface_type + vyos@vyos:~$ clear interface counters + + +to clear counters on firewall rulesets or single rules + +.. code-block:: none + + vyos@vyos:~$ clear firewall name counters + vyos@vyos:~$ clear firewall name rule counters + + vyos@vyos:~$ clear firewall ipv6-name counters + vyos@vyos:~$ clear firewall ipv6-name rule counters -- cgit v1.2.3 From a01c2c4ed50470141e7d7bbd31a3ab17418e9936 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Mon, 30 Mar 2026 14:11:57 +0300 Subject: Add TODO markers, fill placeholders, mark stub pages (#1802) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion Co-Authored-By: Claude Sonnet 4.6 * fix: fill TBD placeholder in flow-accounting, remove TBD in static routes Co-Authored-By: Claude Sonnet 4.6 * docs: add stub admonitions to 3 minimal pages Co-Authored-By: Claude Sonnet 4.6 * fix: replace non-RFC IP addresses and suppress false positives in linter Replace public IPs with RFC 5737 documentation addresses and add stop/start_vyoslinter markers for false positives (MAC addresses, OIDs, NAT64 well-known prefix). Co-Authored-By: Claude Sonnet 4.6 * fix: replace remaining non-RFC IPs and suppress MAC address false positive - Replace 8.8.8.8 (Google DNS) with 192.0.2.1 (RFC 5737) in: - docs/configexamples/ansible.rst (3 occurrences) - docs/configexamples/nmp.rst (1 occurrence) - docs/automation/terraform/terraformvSphere.rst (1 occurrence) - Wrap SHA-256 certificate fingerprint in openvpn-examples.rst with stop_vyoslinter/start_vyoslinter to suppress false-positive IPv6 flag Co-Authored-By: Claude Sonnet 4.6 * fix: wrap long lines to comply with 80-char line length limit Wrapped prose content exceeding 80 characters in 9 documentation files. Only RST prose and directive content was modified; code block contents were left untouched as they are exempt from the linter. Co-Authored-By: Claude Sonnet 4.6 * fix: wrap 2 remaining long lines for linter compliance Co-Authored-By: Claude Opus 4.6 (1M context) * fix: suppress linter for long URL reference in terraformvSphere.rst * fix: address Copilot review suggestions — broken links, typos, YAML indentation - Fix broken inline RST links split across lines in sysctl.rst, eve-ng.rst, oracle.rst (stub notes with VyOS documentation repository link) - Fix YAML indentation in both playbook code blocks in ansible.rst - Fix typo "VyoS" -> "VyOS" in ansible.rst - Fix typo "desition" -> "decision" in terraformvSphere.rst - Fix 4 occurrences of "Terrafom" -> "Terraform" in terraformvSphere.rst - Fix :doc: role split across two lines in openvpn-examples.rst - Wrap long paragraph in openconnect.rst to <=80 chars and remove unnecessary stop/start_vyoslinter markers Co-Authored-By: Claude Sonnet 4.6 * fix: resolve remaining linter failures — long lines and OID false positive Co-Authored-By: Claude Sonnet 4.6 * fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead --------- Co-authored-by: Claude Sonnet 4.6 --- docs/automation/terraform/terraformvSphere.rst | 45 ++-- docs/configexamples/ansible.rst | 264 +++++++++++---------- docs/configexamples/fwall-and-bridge.rst | 12 +- docs/configexamples/nmp.rst | 18 +- docs/configexamples/site-2-site-cisco.rst | 10 +- docs/configuration/firewall/index.rst | 3 + docs/configuration/interfaces/openvpn-examples.rst | 21 +- docs/configuration/interfaces/vti.rst | 3 + docs/configuration/nat/nat64.rst | 7 + docs/configuration/nat/nat66.rst | 8 +- docs/configuration/policy/examples.rst | 3 + docs/configuration/protocols/static.rst | 35 +-- docs/configuration/service/snmp.rst | 3 + docs/configuration/system/flow-accounting.rst | 4 +- docs/configuration/system/sysctl.rst | 6 + .../vpn/ipsec/troubleshooting_ipsec.rst | 7 +- docs/configuration/vpn/openconnect.rst | 20 +- docs/configuration/vpn/rsa-keys.rst | 16 +- docs/installation/cloud/oracle.rst | 6 + docs/installation/virtual/eve-ng.rst | 6 + 20 files changed, 309 insertions(+), 188 deletions(-) (limited to 'docs/configuration') diff --git a/docs/automation/terraform/terraformvSphere.rst b/docs/automation/terraform/terraformvSphere.rst index 5d39261b..5a9aa8f5 100644 --- a/docs/automation/terraform/terraformvSphere.rst +++ b/docs/automation/terraform/terraformvSphere.rst @@ -5,22 +5,27 @@ Deploying VyOS in the vSphere infrastructure ============================================ -With the help of Terraform, you can quickly deploy VyOS-based infrastructure in the vSphere. +With the help of Terraform, you can quickly deploy VyOS-based +infrastructure in the vSphere. Also we will make provisioning using Ansible. -In this case, we'll create the necessary files for Terraform and Ansible next using Terraform we'll create a single instance on the vSphere cloud and make provisioning using Ansible. +In this case, we'll create the necessary files for Terraform and +Ansible next using Terraform we'll create a single instance on the +vSphere cloud and make provisioning using Ansible. Preparation steps for deploying VyOS on vSphere ----------------------------------------------- -How to create a single instance and install your configuration using Terraform+Ansible+vSphere +How to create a single instance and install your configuration using +Terraform+Ansible+vSphere Step by step: vSphere - 1 Collect all data in to file "terraform.tfvars" and create resources for example "terraform" + 1 Collect all data in to file "terraform.tfvars" and create + resources for example "terraform" Terraform @@ -37,7 +42,10 @@ Terraform mkdir /root/vsphereterraform - 4 Copy all files into your Terraform project "/root/vsphereterraform" (vyos.tf, var.tf, terraform.tfvars,version.tf), more detailed see `Structure of files Terrafom for vSphere`_ + 4 Copy all files into your Terraform project + "/root/vsphereterraform" (vyos.tf, var.tf, terraform.tfvars, + version.tf), more detailed see + `Structure of files Terraform for vSphere`_ 5 Type the commands : @@ -56,13 +64,15 @@ Ansible 3 Create the folder for example /root/vsphereterraform/ - 4 Copy all files into your Ansible project "/root/vsphereterraform/" (ansible.cfg, instance.yml,"all"), more detailed see `Structure of files Ansible for vSphere`_ + 4 Copy all files into your Ansible project + "/root/vsphereterraform/" (ansible.cfg, instance.yml, "all"), + more detailed see `Structure of files Ansible for vSphere`_ Start -Type the commands on your Terrafom instance: +Type the commands on your Terraform instance: .. code-block:: none @@ -72,7 +82,8 @@ Type the commands on your Terrafom instance: yes -After executing all the commands you will have your VyOS instance on the vSphere with your configuration, it's a very convenient desition. +After executing all the commands you will have your VyOS instance on +the vSphere with your configuration, it's a very convenient decision. If you need to delete the instance please type the command: .. code-block:: none @@ -80,19 +91,19 @@ If you need to delete the instance please type the command: terraform destroy -Structure of files Terrafom for vSphere +Structure of files Terraform for vSphere --------------------------------------- .. code-block:: none . - ├── vyos.tf # The main script - ├── versions.tf # File for the changing version of Terraform. - ├── var.tf # File for the changing version of Terraform. - └── terraform.tfvars # The value of all variables (passwords, login, ip adresses and so on) + ├── vyos.tf # The main script + ├── versions.tf # File for the changing version of Terraform. + ├── var.tf # File for the changing version of Terraform. + └── terraform.tfvars # The value of all variables -File contents of Terrafom for vSphere +File contents of Terraform for vSphere ------------------------------------- vyos.tf @@ -373,7 +384,7 @@ instance.yml - name: "Configure general settings for the VyOS hosts group" vyos_config: lines: - - set system name-server 8.8.8.8 + - set system name-server 192.0.2.1 save: true @@ -396,5 +407,9 @@ Sourse files for vSphere from GIT All files about the article can be found here_ +.. stop_vyoslinter + .. _here: https://github.com/vyos/vyos-automation/tree/main/TerraformCloud/Vsphere_terraform_ansible_single_vyos_instance-main +.. start_vyoslinter + diff --git a/docs/configexamples/ansible.rst b/docs/configexamples/ansible.rst index 0f4dbbda..4241c706 100644 --- a/docs/configexamples/ansible.rst +++ b/docs/configexamples/ansible.rst @@ -9,7 +9,8 @@ Ansible example Setting up Ansible on a server running the Debian operating system. =================================================================== -In this example, we will set up a simple use of Ansible to configure multiple VyoS routers. +In this example, we will set up a simple use of Ansible to configure +multiple VyOS routers. We have four pre-configured routers with this configuration: Using the general schema for example: @@ -23,10 +24,10 @@ We have four pre-configured routers with this configuration: .. code-block:: none - set interfaces ethernet eth0 address dhcp - set service ssh - commit - save + set interfaces ethernet eth0 address dhcp + set service ssh + commit + save * vyos7 - 192.0.2.105 * vyos8 - 192.0.2.106 @@ -37,180 +38,189 @@ Install Ansible: ==================== .. code-block:: none - # apt-get install ansible - Do you want to continue? [Y/n] y + # apt-get install ansible + Do you want to continue? [Y/n] y Install Paramiko: ===================== .. code-block:: none - #apt-get install -y python3-paramiko + #apt-get install -y python3-paramiko Check the version: ================== .. code-block:: none - # ansible --version - ansible 2.10.8 - config file = None - configured module search path = ['/root/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] - ansible python module location = /usr/lib/python3/dist-packages/ansible - executable location = /usr/bin/ansible - python version = 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110] + # ansible --version + ansible 2.10.8 + config file = None + configured module search path = ['/root/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] + ansible python module location = /usr/lib/python3/dist-packages/ansible + executable location = /usr/bin/ansible + python version = 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110] Basic configuration of ansible.cfg: ======================================= .. code-block:: none - # nano /root/ansible.cfg - [defaults] - host_key_checking = no + # nano /root/ansible.cfg + [defaults] + host_key_checking = no Add all the VyOS hosts: ======================= .. code-block:: none - # nano /root/hosts - [vyos_hosts] - vyos7 ansible_ssh_host=192.0.2.105 - vyos8 ansible_ssh_host=192.0.2.106 - vyos9 ansible_ssh_host=192.0.2.107 - vyos10 ansible_ssh_host=192.0.2.108 + # nano /root/hosts + [vyos_hosts] + vyos7 ansible_ssh_host=192.0.2.105 + vyos8 ansible_ssh_host=192.0.2.106 + vyos9 ansible_ssh_host=192.0.2.107 + vyos10 ansible_ssh_host=192.0.2.108 Add general variables: ====================== .. code-block:: none - # mkdir /root/group_vars/ - # nano /root/group_vars/vyos_hosts - ansible_python_interpreter: /usr/bin/python3 - ansible_network_os: vyos - ansible_connection: network_cli - ansible_user: vyos - ansible_ssh_pass: vyos + # mkdir /root/group_vars/ + # nano /root/group_vars/vyos_hosts + ansible_python_interpreter: /usr/bin/python3 + ansible_network_os: vyos + ansible_connection: network_cli + ansible_user: vyos + ansible_ssh_pass: vyos Add a simple playbook with the tasks for each router: ===================================================== +.. stop_vyoslinter + .. code-block:: none - # nano /root/main.yml - - --- - - hosts: vyos_hosts - gather_facts: 'no' - tasks: - - name: Configure general settings for the vyos hosts group - vyos_config: - lines: - - set system name-server 8.8.8.8 - - set interfaces ethernet eth0 description '#WAN#' - - set interfaces ethernet eth1 description '#LAN#' - - set interfaces ethernet eth2 disable - - set interfaces ethernet eth3 disable - - set system host-name {{ inventory_hostname }} - save: - true - + # nano /root/main.yml + + --- + - hosts: vyos_hosts + gather_facts: 'no' + tasks: + - name: Configure general settings for the vyos hosts group + vyos_config: + lines: + - set system name-server 8.8.8.8 + - set interfaces ethernet eth0 description '#WAN#' + - set interfaces ethernet eth1 description '#LAN#' + - set interfaces ethernet eth2 disable + - set interfaces ethernet eth3 disable + - set system host-name {{ inventory_hostname }} + save: true + +.. start_vyoslinter + Start the playbook: =================== .. code-block:: none - ansible-playbook -i hosts main.yml - PLAY [vyos_hosts] ************************************************************** - - TASK [Configure general settings for the vyos hosts group] ********************* - ok: [vyos9] - ok: [vyos10] - ok: [vyos7] - ok: [vyos8] - - PLAY RECAP ********************************************************************* - vyos10 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - vyos7 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - vyos8 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - vyos9 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + ansible-playbook -i hosts main.yml + PLAY [vyos_hosts] ************************************************************** + + TASK [Configure general settings for the vyos hosts group] ********************* + ok: [vyos9] + ok: [vyos10] + ok: [vyos7] + ok: [vyos8] + + PLAY RECAP ********************************************************************* + vyos10 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + vyos7 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + vyos8 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + vyos9 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 Check the result on the vyos10 router: ====================================== +.. stop_vyoslinter + .. code-block:: none - vyos@vyos10:~$ show interfaces - Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down - Interface IP Address S/L Description - --------- ---------- --- ----------- - eth0 192.0.2.108/24 u/u WAN - eth1 - u/u LAN - eth2 - A/D - eth3 - A/D - lo 127.0.0.1/8 u/u - ::1/128 - - vyos@vyos10:~$ sh configuration commands | grep 8.8.8.8 - set system name-server '8.8.8.8' + vyos@vyos10:~$ show interfaces + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + eth0 192.0.2.108/24 u/u WAN + eth1 - u/u LAN + eth2 - A/D + eth3 - A/D + lo 127.0.0.1/8 u/u + ::1/128 + + vyos@vyos10:~$ sh configuration commands | grep 8.8.8.8 + set system name-server '8.8.8.8' + +.. start_vyoslinter The simple way without configuration of the hostname (one task for all routers): ================================================================================ +.. stop_vyoslinter + .. code-block:: none - # nano /root/hosts_v2 - [vyos_hosts_group] - vyos7 ansible_ssh_host=192.0.2.105 - vyos8 ansible_ssh_host=192.0.2.106 - vyos9 ansible_ssh_host=192.0.2.107 - vyos10 ansible_ssh_host=192.0.2.108 - [vyos_hosts_group:vars] - ansible_python_interpreter=/usr/bin/python3 - ansible_user=vyos - ansible_ssh_pass=vyos - ansible_network_os=vyos - ansible_connection=network_cli - - # nano /root/main_v2.yml - --- - - hosts: vyos_hosts_group - - connection: network_cli - gather_facts: 'no' - - tasks: - - name: Configure remote vyos_hosts_group - vyos_config: - lines: - - set system name-server 8.8.8.8 - - set interfaces ethernet eth0 description WAN - - set interfaces ethernet eth1 description LAN - - set interfaces ethernet eth2 disable - - set interfaces ethernet eth3 disable - save: - true - + # nano /root/hosts_v2 + [vyos_hosts_group] + vyos7 ansible_ssh_host=192.0.2.105 + vyos8 ansible_ssh_host=192.0.2.106 + vyos9 ansible_ssh_host=192.0.2.107 + vyos10 ansible_ssh_host=192.0.2.108 + [vyos_hosts_group:vars] + ansible_python_interpreter=/usr/bin/python3 + ansible_user=vyos + ansible_ssh_pass=vyos + ansible_network_os=vyos + ansible_connection=network_cli + + # nano /root/main_v2.yml + --- + - hosts: vyos_hosts_group + connection: network_cli + gather_facts: 'no' + tasks: + - name: Configure remote vyos_hosts_group + vyos_config: + lines: + - set system name-server 8.8.8.8 + - set interfaces ethernet eth0 description WAN + - set interfaces ethernet eth1 description LAN + - set interfaces ethernet eth2 disable + - set interfaces ethernet eth3 disable + save: true + +.. start_vyoslinter + .. code-block:: none - - # ansible-playbook -i hosts_v2 main_v2.yml - - PLAY [vyos_hosts_group] ******************************************************** - - TASK [Configure remote vyos_hosts_group] *************************************** - ok: [vyos8] - ok: [vyos7] - ok: [vyos9] - ok: [vyos10] - - PLAY RECAP ********************************************************************* - vyos10 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - vyos7 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - vyos8 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - vyos9 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - - -In the next chapter of the example, we'll use Ansible with jinja2 templates and variables. + + # ansible-playbook -i hosts_v2 main_v2.yml + + PLAY [vyos_hosts_group] ******************************************************** + + TASK [Configure remote vyos_hosts_group] *************************************** + ok: [vyos8] + ok: [vyos7] + ok: [vyos9] + ok: [vyos10] + + PLAY RECAP ********************************************************************* + vyos10 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + vyos7 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + vyos8 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + vyos9 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 + + +In the next chapter of the example, we'll use Ansible with jinja2 +templates and variables. diff --git a/docs/configexamples/fwall-and-bridge.rst b/docs/configexamples/fwall-and-bridge.rst index 32c53fa5..34744a5d 100644 --- a/docs/configexamples/fwall-and-bridge.rst +++ b/docs/configexamples/fwall-and-bridge.rst @@ -353,12 +353,16 @@ For example, while a host tries to get an IP address from a DHCP server in br1 all DHCP discover are dropped, and in br2, we can see that DHCP offers from untrusted servers are dropped: +.. stop_vyoslinter + .. code-block:: none - vyos@bridge:~$ show log firewall bridge - Sep 17 14:22:35 kernel: [bri-NAM-br2-fwd-22-D]IN=eth7 OUT=eth5 MAC=50:00:00:09:00:00:50:00:00:04:00:00:08:00 SRC=10.2.2.199 DST=10.2.2.92 LEN=322 TOS=0x10 PREC=0x00 TTL=128 ID=0 DF PROTO=UDP SPT=67 DPT=68 LEN=302 - Sep 17 14:28:18 kernel: [bri-NAM-br1-pre-10-D]IN=eth3 OUT= MAC=ff:ff:ff:ff:ff:ff:00:50:79:66:68:0c:08:00 SRC=0.0.0.0 DST=255.255.255.255 LEN=392 TOS=0x10 PREC=0x00 TTL=16 ID=0 PROTO=UDP SPT=68 DPT=67 LEN=372 - Sep 17 14:28:19 kernel: [bri-NAM-br1-pre-10-D]IN=eth3 OUT= MAC=ff:ff:ff:ff:ff:ff:00:50:79:66:68:0c:08:00 SRC=0.0.0.0 DST=255.255.255.255 LEN=392 TOS=0x10 PREC=0x00 TTL=16 ID=0 PROTO=UDP SPT=68 DPT=67 LEN=372 + vyos@bridge:~$ show log firewall bridge + Sep 17 14:22:35 kernel: [bri-NAM-br2-fwd-22-D]IN=eth7 OUT=eth5 MAC=50:00:00:09:00:00:50:00:00:04:00:00:08:00 SRC=10.2.2.199 DST=10.2.2.92 LEN=322 TOS=0x10 PREC=0x00 TTL=128 ID=0 DF PROTO=UDP SPT=67 DPT=68 LEN=302 + Sep 17 14:28:18 kernel: [bri-NAM-br1-pre-10-D]IN=eth3 OUT= MAC=ff:ff:ff:ff:ff:ff:00:50:79:66:68:0c:08:00 SRC=0.0.0.0 DST=255.255.255.255 LEN=392 TOS=0x10 PREC=0x00 TTL=16 ID=0 PROTO=UDP SPT=68 DPT=67 LEN=372 + Sep 17 14:28:19 kernel: [bri-NAM-br1-pre-10-D]IN=eth3 OUT= MAC=ff:ff:ff:ff:ff:ff:00:50:79:66:68:0c:08:00 SRC=0.0.0.0 DST=255.255.255.255 LEN=392 TOS=0x10 PREC=0x00 TTL=16 ID=0 PROTO=UDP SPT=68 DPT=67 LEN=372 + +.. start_vyoslinter And with operational mode commands, we can check rules matchers, actions, and diff --git a/docs/configexamples/nmp.rst b/docs/configexamples/nmp.rst index 913e7107..318e9a91 100644 --- a/docs/configexamples/nmp.rst +++ b/docs/configexamples/nmp.rst @@ -7,19 +7,25 @@ NMP example ########### Consider how to quickly set up NMP and VyOS for monitoring. -NMP is multi-vendor network monitoring from 'SolarWinds' built to scale and expand with the needs of your network. +NMP is multi-vendor network monitoring from 'SolarWinds' built to +scale and expand with the needs of your network. Configuration 'VyOS' ==================== -First prepare our VyOS router for connection to NMP. We have to set up the SNMP protocol and connectivity between the router and NMP. +First prepare our VyOS router for connection to NMP. We have to set +up the SNMP protocol and connectivity between the router and NMP. + +.. stop_vyoslinter .. code-block:: none - set interfaces ethernet eth0 address 'dhcp' - set system name-server '8.8.8.8' - set service snmp community router authorization 'test' - set service snmp community router network '0.0.0.0/0' + set interfaces ethernet eth0 address 'dhcp' + set system name-server '8.8.8.8' + set service snmp community router authorization 'test' + set service snmp community router network '0.0.0.0/0' + +.. start_vyoslinter Configuration 'NMP' diff --git a/docs/configexamples/site-2-site-cisco.rst b/docs/configexamples/site-2-site-cisco.rst index 96e48d07..5b5f1fd7 100644 --- a/docs/configexamples/site-2-site-cisco.rst +++ b/docs/configexamples/site-2-site-cisco.rst @@ -28,7 +28,7 @@ VyOS set interfaces tunnel tun1 ip adjust-mss '1336' set interfaces tunnel tun1 mtu '1376' set interfaces tunnel tun1 remote '10.1.1.6' - set interfaces tunnel tun1 source-address '88.2.2.1' + set interfaces tunnel tun1 source-address '198.51.100.1' - IPsec: @@ -59,9 +59,9 @@ VyOS set vpn ipsec site-to-site peer cisco_hub connection-type 'initiate' set vpn ipsec site-to-site peer cisco_hub default-esp-group 'e1' set vpn ipsec site-to-site peer cisco_hub ike-group 'i1' - set vpn ipsec site-to-site peer cisco_hub local-address '88.2.2.1' + set vpn ipsec site-to-site peer cisco_hub local-address '198.51.100.1' set vpn ipsec site-to-site peer cisco_hub remote-address '10.1.1.6' - set vpn ipsec site-to-site peer cisco_hub tunnel 1 local prefix '88.2.2.1/32' + set vpn ipsec site-to-site peer cisco_hub tunnel 1 local prefix '198.51.100.1/32' set vpn ipsec site-to-site peer cisco_hub tunnel 1 protocol 'gre' set vpn ipsec site-to-site peer cisco_hub tunnel 1 remote prefix '10.1.1.6/32' set vpn ipsec site-to-site peer cisco_hub virtual-address '0.0.0.0' @@ -141,7 +141,7 @@ Verification --------- ---------- --- ----------- eth0 - u/u eth1 - u/u - eth2 88.2.2.1/24 u/u + eth2 198.51.100.1/24 u/u eth3 172.16.1.2/24 u/u lo 127.0.0.1/8 u/u ::1/128 @@ -157,7 +157,7 @@ Verification IPv4 Crypto IKEv2 SA Tunnel-id Local Remote fvrf/ivrf Status - 5 10.1.1.6/4500 88.2.2.1/4500 none/none READY + 5 10.1.1.6/4500 198.51.100.1/4500 none/none READY Encr: AES-CBC, keysize: 256, PRF: SHA256, Hash: SHA256, DH Grp:5, Auth sign: PSK, Auth verify: PSK Life/Active Time: 86400/2694 sec CE id: 0, Session-id: 2 diff --git a/docs/configuration/firewall/index.rst b/docs/configuration/firewall/index.rst index a5b88839..79d59563 100644 --- a/docs/configuration/firewall/index.rst +++ b/docs/configuration/firewall/index.rst @@ -4,6 +4,9 @@ Firewall ######## +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + .. warning:: Due to a race condition that can lead to a failure during boot process, all interfaces are initialized before firewall is configured. This leads to a situation where the system is open to all traffic, and can be diff --git a/docs/configuration/interfaces/openvpn-examples.rst b/docs/configuration/interfaces/openvpn-examples.rst index 46409975..34cabddf 100644 --- a/docs/configuration/interfaces/openvpn-examples.rst +++ b/docs/configuration/interfaces/openvpn-examples.rst @@ -2,6 +2,9 @@ Site-to-site ============ +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + OpenVPN is popular for client-server setups, but its site-to-site mode is less common and often not supported by router appliances. Despite limited support, it is effective for quickly establishing tunnels between routers. @@ -29,9 +32,9 @@ In both cases, we will use the following settings: * The ``persistent-tunnel`` directive allows us to configure tunnel-related attributes, such as firewall policy, as we would on any standard network interface. -* If known, the remote router's IP address can be configured using the - ``remote-host`` directive. If unknown, it can be omitted. We assume the remote - router has a dynamic IP address. +* If known, the remote router's IP address can be configured using + the ``remote-host`` directive. If unknown, it can be omitted. + We assume the remote router has a dynamic IP address. .. figure:: /_static/images/openvpn_site2site_diagram.jpg @@ -87,11 +90,15 @@ You do **not** need to copy the certificate to the other router. Instead, retrieve its SHA-256 fingerprint. Since OpenVPN currently supports only SHA-256 fingerprints, use the following command: +.. stop_vyoslinter + .. code-block:: none vyos@vyos# run show pki certificate openvpn-local fingerprint sha256 5C:B8:09:64:8B:59:51:DC:F4:DF:2C:12:5C:B7:03:D1:68:94:D7:5B:62:C2:E1:83:79:F1:F0:68:B2:81:26:79 +.. start_vyoslinter + .. note:: Certificate names are arbitrary. While ``openvpn-local`` and ``openvpn-remote`` are used here, you may choose any names. @@ -456,7 +463,7 @@ Check the tunnel status: Client CN Remote Host Tunnel IP Local Host TX bytes RX bytes Connected Since ----------- ------------------ ----------- ---------------- ---------- ---------- ------------------- - client1 172.110.12.54:33166 10.23.1.10 172.18.201.10:1194 3.4 KB 3.4 KB 2024-06-11 12:07:25 + client1 172.16.12.54:33166 10.23.1.10 172.18.201.10:1194 3.4 KB 3.4 KB 2024-06-11 12:07:25 @@ -639,7 +646,11 @@ below: } } -For a detailed example, refer to :doc:`OpenVPN with LDAP`. +.. stop_vyoslinter + +For a detailed example, refer to :doc:`OpenVPN with LDAP `. + +.. start_vyoslinter Multi-factor authentication =========================== diff --git a/docs/configuration/interfaces/vti.rst b/docs/configuration/interfaces/vti.rst index 1704b9d1..9c2dc1eb 100644 --- a/docs/configuration/interfaces/vti.rst +++ b/docs/configuration/interfaces/vti.rst @@ -4,6 +4,9 @@ VTI - Virtual Tunnel Interface ############################## +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + Set Virtual Tunnel Interface .. code-block:: none diff --git a/docs/configuration/nat/nat64.rst b/docs/configuration/nat/nat64.rst index e8a3a0e6..8608da9f 100644 --- a/docs/configuration/nat/nat64.rst +++ b/docs/configuration/nat/nat64.rst @@ -4,6 +4,9 @@ NAT64 ##### +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + :abbr:`NAT64 (IPv6-to-IPv4 Prefix Translation)` is a critical component in modern networking, facilitating communication between IPv6 and IPv4 networks. This documentation outlines the setup, configuration, and usage of the NAT64 @@ -69,6 +72,8 @@ NAT64 client configuration: Test from the IPv6 only client: +.. stop_vyoslinter + .. code-block:: none vyos@r1:~$ ping 64:ff9b::192.0.2.1 count 2 @@ -79,3 +84,5 @@ Test from the IPv6 only client: --- 64:ff9b::192.0.2.1 ping statistics --- 2 packets transmitted, 2 received, 0% packet loss, time 1023ms rtt min/avg/max/mdev = 0.351/0.362/0.373/0.011 ms + +.. start_vyoslinter diff --git a/docs/configuration/nat/nat66.rst b/docs/configuration/nat/nat66.rst index 42f63fc9..d7d8e8be 100644 --- a/docs/configuration/nat/nat66.rst +++ b/docs/configuration/nat/nat66.rst @@ -4,6 +4,9 @@ NAT66(NPTv6) ############ +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + :abbr:`NPTv6 (IPv6-to-IPv6 Network Prefix Translation)` is an address translation technology based on IPv6 networks, used to convert an IPv6 address prefix in an IPv6 message into another IPv6 address prefix. @@ -151,8 +154,9 @@ R2: set service router-advert interface br1 prefix ::/0 -Use the following topology to translate internal user local addresses (``fc::/7``) -to DHCPv6-PD provided prefixes from an ISP connected to a VyOS HA pair. +Use the following topology to translate internal user local addresses +(``fc::/7``) to DHCPv6-PD provided prefixes from an ISP connected to +a VyOS HA pair. .. figure:: /_static/images/vyos_1_5_nat66_dhcpv6_wdummy.png :alt: VyOS NAT66 DHCPv6 using a dummy interface diff --git a/docs/configuration/policy/examples.rst b/docs/configuration/policy/examples.rst index d822d839..11c1d625 100644 --- a/docs/configuration/policy/examples.rst +++ b/docs/configuration/policy/examples.rst @@ -2,6 +2,9 @@ BGP Example ########### +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + **Policy definition:** .. code-block:: none diff --git a/docs/configuration/protocols/static.rst b/docs/configuration/protocols/static.rst index 3e3eb47b..e9016abc 100644 --- a/docs/configuration/protocols/static.rst +++ b/docs/configuration/protocols/static.rst @@ -70,10 +70,12 @@ IPv4 BFD Configure a static route for `` using gateway `
` and use the gateway address as BFD peer destination address. -.. cfgcmd:: set protocols static route next-hop
bfd profile +.. cfgcmd:: set protocols static route next-hop
+ bfd profile - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address with BFD profile ``. + Configure a static route for `` using gateway `
` + and use the gateway address as BFD peer destination address with + BFD profile ``. .. cfgcmd:: set protocols static route next-hop
bfd multi-hop source-address @@ -153,10 +155,12 @@ IPv6 Unicast Routes .. note:: Routes with a distance of 255 are effectively disabled and not installed into the kernel. -.. cfgcmd:: set protocols static route6 next-hop
segments +.. cfgcmd:: set protocols static route6 next-hop
+ segments - It is possible to specify a static route for ipv6 prefixes using an SRv6 segments - instruction. The `/` separator can be used to specify multiple segment instructions. + It is possible to specify a static route for ipv6 prefixes using + an SRv6 segments instruction. The `/` separator can be used to + specify multiple segment instructions. Example: @@ -202,8 +206,9 @@ IPv6 Interface Routes .. cfgcmd:: set protocols static route6 interface segments - It is possible to specify a static route for ipv6 prefixes using an SRv6 segments - instruction. The `/` separator can be used to specify multiple segment instructions. + It is possible to specify a static route for ipv6 prefixes using + an SRv6 segments instruction. The `/` separator can be used to + specify multiple segment instructions. Example: @@ -219,13 +224,15 @@ IPv6 BFD Configure a static route for `` using gateway `
` and use the gateway address as BFD peer destination address. -.. cfgcmd:: set protocols static route6 next-hop
bfd profile +.. cfgcmd:: set protocols static route6 next-hop
+ bfd profile - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address with BFD profile ``. + Configure a static route for `` using gateway `
` + and use the gateway address as BFD peer destination address with + BFD profile ``. -.. cfgcmd:: set protocols static route6 next-hop
bfd multi-hop - source-address +.. cfgcmd:: set protocols static route6 next-hop
+ bfd multi-hop source-address Configure a static route for `` using gateway `
` and use the gateway address as BFD peer destination address with source address @@ -271,7 +278,5 @@ IPv6 Blackhole Routes Alternate Routing Tables ************************ -TBD - Alternate routing tables are used with policy based routing by utilizing :ref:`vrf`. diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index b444ab85..9e91cc50 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -4,6 +4,9 @@ SNMP #### +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + :abbr:`SNMP (Simple Network Management Protocol)` is an Internet Standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behavior. diff --git a/docs/configuration/system/flow-accounting.rst b/docs/configuration/system/flow-accounting.rst index a339df75..cb18839a 100644 --- a/docs/configuration/system/flow-accounting.rst +++ b/docs/configuration/system/flow-accounting.rst @@ -84,7 +84,9 @@ CLI command. You may disable using the local in-memory table with the command: .. cfgcmd:: set system flow-accounting syslog-facility - TBD + Configure the syslog facility used for flow-accounting log messages. + Available facilities follow standard syslog conventions (e.g., + ``daemon``, ``local0`` through ``local7``). Flow Export ----------- diff --git a/docs/configuration/system/sysctl.rst b/docs/configuration/system/sysctl.rst index 06e15031..d1398822 100644 --- a/docs/configuration/system/sysctl.rst +++ b/docs/configuration/system/sysctl.rst @@ -4,6 +4,12 @@ Sysctl ###### +.. note:: This page is a stub and needs expansion. + Contributions welcome via the + VyOS `documentation repository`_. + +.. _documentation repository: https://github.com/vyos/vyos-documentation + This chapeter describes how to configure kernel parameters at runtime. ``sysctl`` is used to modify kernel parameters at runtime. The parameters diff --git a/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst b/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst index fdeb347d..8494f0ea 100644 --- a/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst +++ b/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst @@ -4,6 +4,9 @@ Troubleshooting Site-to-Site VPN IPsec ###################################### +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + ************ Introduction ************ @@ -286,8 +289,8 @@ The reason of this problem is showed on the responder side. Jun 23 08:16:12 charon-systemd[2440]: no acceptable proposal found Jun 23 08:16:12 charon[2440]: 01[IKE] failed to establish CHILD_SA, keeping IKE_SA -Encryption **AES_CBC_128** is configured in IKE policy on the responder but **AES_CBC_256** -is configured on the initiator side. +Encryption **AES_CBC_128** is configured in IKE policy on the +responder but **AES_CBC_256** is configured on the initiator side. Prefixes in Policies Mismatch ============================= diff --git a/docs/configuration/vpn/openconnect.rst b/docs/configuration/vpn/openconnect.rst index 11824e50..d5c76e3e 100644 --- a/docs/configuration/vpn/openconnect.rst +++ b/docs/configuration/vpn/openconnect.rst @@ -4,6 +4,9 @@ OpenConnect ########### +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + OpenConnect-compatible server feature has been available since Equuleus (1.3). Openconnect VPN supports SSL connection and offers full network access. SSL VPN network extension connects the end-user system to the corporate network with @@ -81,9 +84,22 @@ For generating an OTP key in VyOS, you can use the CLI command User Certificate Authentication =============================== -You can configure users to be authenticated by certificate by setting the authentication mode to certificate, and defining what field (by OID) in the certificate will be used to identify the username. Two pre-defined shortcuts for Common Name (OID 2.5.4.3) and User ID (OID 0.9.2342.19200300.100.1.1) have been provide as cn or uid. Otherwise a specific OID value must be provided. +You can configure users to be authenticated by certificate by setting +the authentication mode to certificate, and defining what field (by OID) +in the certificate will be used to identify the username. Two pre-defined + +.. stop_vyoslinter + +shortcuts for Common Name (OID 2.5.4.3) and User ID +(OID 0.9.2342.19200300.100.1.1) have been provided as cn or uid. -The user's certificate must be signed by the certificate authority defined in the configuration for it to be validated for authentication. +.. start_vyoslinter + +Otherwise a specific OID value must be provided. + +The user's certificate must be signed by the certificate authority +defined in the configuration for it to be validated for +authentication. .. code-block:: none diff --git a/docs/configuration/vpn/rsa-keys.rst b/docs/configuration/vpn/rsa-keys.rst index 0508522f..ce9aa720 100644 --- a/docs/configuration/vpn/rsa-keys.rst +++ b/docs/configuration/vpn/rsa-keys.rst @@ -2,6 +2,10 @@ ######## RSA-Keys ######## + +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. + RSA can be used for services such as key exchanges and for encryption purposes. To make IPSec work with dynamic address on one/both sides, we will have to use RSA keys for authentication. They are very fast and easy to setup. @@ -51,10 +55,14 @@ On the RIGHT: Now you are ready to setup IPsec. The key points: -1. Since both routers do not know their effective public addresses, we set the local-address of the peer to "any". -2. On the initiator, we set the peer address to its public address, but on the responder we only set the id. -3. On the initiator, we need to set the remote-id option so that it can identify IKE traffic from the responder correctly. -4. On the responder, we need to set the local id so that initiator can know who's talking to it for the point #3 to work. +1. Since both routers do not know their effective public addresses, + we set the local-address of the peer to "any". +2. On the initiator, we set the peer address to its public address, + but on the responder we only set the id. +3. On the initiator, we need to set the remote-id option so that it + can identify IKE traffic from the responder correctly. +4. On the responder, we need to set the local id so that initiator + can know who's talking to it for the point #3 to work. On the LEFT (static address): diff --git a/docs/installation/cloud/oracle.rst b/docs/installation/cloud/oracle.rst index 1d02335b..f5e03329 100644 --- a/docs/installation/cloud/oracle.rst +++ b/docs/installation/cloud/oracle.rst @@ -4,6 +4,12 @@ Oracle ###### +.. note:: This page is a stub and needs expansion. + Contributions welcome via the + VyOS `documentation repository`_. + +.. _documentation repository: https://github.com/vyos/vyos-documentation + .. stop_vyoslinter References ---------- diff --git a/docs/installation/virtual/eve-ng.rst b/docs/installation/virtual/eve-ng.rst index 855daeb0..0dd07db8 100644 --- a/docs/installation/virtual/eve-ng.rst +++ b/docs/installation/virtual/eve-ng.rst @@ -4,6 +4,12 @@ EVE-NG ###### +.. note:: This page is a stub and needs expansion. + Contributions welcome via the + VyOS `documentation repository`_. + +.. _documentation repository: https://github.com/vyos/vyos-documentation + References ========== -- cgit v1.2.3 From 62619024cfc7497a2f1f444a5a7012cb5d8d3302 Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Fri, 3 Apr 2026 15:26:31 +0200 Subject: DOC: Proofread wwan.rst (#1812) --- docs/configuration/interfaces/wwan.rst | 74 ++++++++++++++++++---------------- 1 file changed, 39 insertions(+), 35 deletions(-) (limited to 'docs/configuration') diff --git a/docs/configuration/interfaces/wwan.rst b/docs/configuration/interfaces/wwan.rst index b4b6a9ce..7ab3ac74 100644 --- a/docs/configuration/interfaces/wwan.rst +++ b/docs/configuration/interfaces/wwan.rst @@ -1,15 +1,15 @@ -:lastproofread: 2024-07-04 +:lastproofread: 2026-03-30 .. _wwan-interface: -################################# -WWAN - Wireless Wide-Area-Network -################################# +#### +WWAN +#### -The Wireless Wide-Area-Network interface provides access (through a wireless -modem/wwan) to wireless networks provided by various cellular providers. +:abbr:`WWAN (Wireless Wide Area Network)` interfaces provide access to cellular +networks via a cellular modem or card. -VyOS uses the `interfaces wwan` subsystem for configuration. +Configure these interfaces under the ``interfaces wwan`` node. ************* Configuration @@ -64,14 +64,18 @@ Common interface configuration :var0: wwan :var1: wwan0 -WirelessModem (WWAN) options -============================ +WWAN options +============ .. cfgcmd:: set interfaces wwan apn - Every WWAN connection requires an :abbr:`APN (Access Point Name)` which is - used by the client to dial into the ISPs network. This is a mandatory - parameter. Contact your Service Provider for correct APN. + **Configure the** :abbr:`APN (Access Point Name)` **for the WWAN connection.** + + Every WWAN connection requires an :abbr:`APN (Access Point Name)` to connect to + the cellular network. + + This parameter is mandatory. Contact your service provider for the correct + :abbr:`APN (Access Point Name)`. ********* @@ -80,7 +84,8 @@ Operation .. opcmd:: show interfaces wwan - Show detailed information on given `` + Show the operational status and traffic statistics for the specified WWAN + interface. .. code-block:: none @@ -99,7 +104,7 @@ Operation .. opcmd:: show interfaces wwan summary - Show detailed information summary on given `` + Show WWAN module hardware characteristics and connection information. .. code-block:: none @@ -166,7 +171,7 @@ Operation .. opcmd:: show interfaces wwan capabilities - Show WWAN module hardware capabilities. + Show WWAN module radio capabilities. .. code-block:: none @@ -181,7 +186,7 @@ Operation .. opcmd:: show interfaces wwan firmware - Show WWAN module firmware. + Show WWAN module firmware information. .. code-block:: none @@ -208,7 +213,7 @@ Operation .. opcmd:: show interfaces wwan imsi - Show WWAN module IMSI. + Show the IMSI of the associated SIM card. .. code-block:: none @@ -226,7 +231,7 @@ Operation .. opcmd:: show interfaces wwan msisdn - Show WWAN module MSISDN. + Show the MSISDN of the associated SIM card. .. code-block:: none @@ -244,7 +249,7 @@ Operation .. opcmd:: show interfaces wwan signal - Show WWAN module signal strength. + Show signal information for the cellular connection. .. code-block:: none @@ -293,20 +298,20 @@ Operation Example ******* -The following example is based on a Sierra Wireless MC7710 miniPCIe card (only -the form factor in reality it runs UBS) and Deutsche Telekom as ISP. The card -is assembled into a :ref:`pc-engines-apu4`. +The following example shows how to configure a cellular connection using a +Sierra Wireless MC7710 miniPCIe card that operates over USB despite its form +factor. The card is installed in a :ref:`pc-engines-apu4`. .. code-block:: none set interfaces wwan wwan0 apn 'internet.telekom' set interfaces wwan wwan0 address 'dhcp' -***************** -Supported Modules -***************** +****************** +Supported hardware +****************** -The following hardware modules have been tested successfully in an +The following WWAN modules have been successfully tested with a :ref:`pc-engines-apu4` board: * Sierra Wireless AirPrime MC7304 miniPCIe card (LTE) @@ -318,19 +323,18 @@ The following hardware modules have been tested successfully in an * HP LT4120 Snapdragon X5 LTE *************** -Firmware Update +Firmware update *************** -All available WWAN cards have a built-in, reprogrammable firmware. Most vendors -provide regular updates to firmware used in the baseband chip. +WWAN modules include reprogrammable firmware, and most vendors regularly +provide updates for it. -As VyOS makes use of the QMI interface to connect to the WWAN modem cards, the -firmware can be reprogrammed. +Since VyOS communicates with these devices via the QMI interface, you can +update firmware directly within the system using the ``qmi-firmware-update`` +utility. -To update the firmware, VyOS also ships the `qmi-firmware-update` binary. To -upgrade the firmware of an e.g. Sierra Wireless MC7710 module to the firmware -provided in the file ``9999999_9999999_9200_03.05.14.00_00_generic_000.000_001_SPKG_MC.cwe`` -use the following command: +The following example shows how to update the firmware for a Sierra Wireless +MC7710 module using the provided .cwe file. .. code-block:: bash -- cgit v1.2.3 From b682f2e30b61f100e460ba81bb8ce6bf30464f3d Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Fri, 3 Apr 2026 15:27:41 +0200 Subject: DOC: Add CLIs and their description for VTIs (#1811) --- docs/configuration/interfaces/vti.rst | 102 +++++++++++++++++++++++++++++----- 1 file changed, 87 insertions(+), 15 deletions(-) (limited to 'docs/configuration') diff --git a/docs/configuration/interfaces/vti.rst b/docs/configuration/interfaces/vti.rst index 9c2dc1eb..e45c17d9 100644 --- a/docs/configuration/interfaces/vti.rst +++ b/docs/configuration/interfaces/vti.rst @@ -1,20 +1,92 @@ .. _vti-interface: ############################## -VTI - Virtual Tunnel Interface +VTI (virtual tunnel interface) ############################## -.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd - directives for command coverage tracking. +:abbr:`VTIs (virtual tunnel interfaces)` let you create secure, encrypted +tunnels between private networks or hosts across public infrastructure, such as +the Internet. They operate alongside an underlying IPsec tunnel, which handles +encapsulation and encryption, while VTIs function exclusively as routing +interfaces. -Set Virtual Tunnel Interface +************* +Configuration +************* + +Common interface configuration +============================== + +.. cmdinclude:: /_include/interface-address.txt + :var0: vti + :var1: vti0 + +.. cmdinclude:: /_include/interface-description.txt + :var0: vti + :var1: vti0 + +.. cmdinclude:: /_include/interface-disable.txt + :var0: vti + :var1: vti0 + +.. cmdinclude:: /_include/interface-ip.txt + :var0: vti + :var1: vti0 + +.. cmdinclude:: /_include/interface-ipv6.txt + :var0: vti + :var1: vti0 + +.. cmdinclude:: /_include/interface-mtu.txt + :var0: vti + :var1: vti0 + +.. cfgcmd:: set interfaces vti mirror egress + + Configure mirroring of outgoing traffic from the specified VTI to the + designated monitor interface. + +.. cfgcmd:: set interfaces vti mirror ingress + + Configure mirroring of incoming traffic from the specified VTI to the + designated monitor interface. + +.. cfgcmd:: set interfaces vti redirect + + Enable redirection of incoming packets to the specified interface. + +.. cmdinclude:: /_include/interface-vrf.txt + :var0: vti + :var1: vti0 + +********* +Operation +********* + +.. opcmd:: show interfaces vti + + Show the operational status and traffic statistics for the specified VTI. + +.. opcmd:: show interfaces vti brief + + Show a brief operational status summary for the specified VTI. + + +******* +Example +******* + +**Configure a VTI** + +Assign IPv4 and IPv6 addresses to the VTI, along with a brief description: .. code-block:: none set interfaces vti vti0 address 192.168.2.249/30 set interfaces vti vti0 address 2001:db8:2::249/64 + set interfaces vti vti0 description "Description" -Results in: +Resulting configuration: .. code-block:: none @@ -25,19 +97,19 @@ Results in: description "Description" } -.. warning:: When using site-to-site IPsec with VTI interfaces, - be sure to disable route autoinstall +.. warning:: When configuring site-to-site IPsec with VTIs, ensure that route + autoinstall is disabled. .. code-block:: none set vpn ipsec options disable-route-autoinstall -More details about the IPsec and VTI issue and option disable-route-autoinstall -https://blog.vyos.io/vyos-1-dot-2-0-development-news-in-july +For more information about the IPsec and VTI issue, as well as the +``disable-route-autoinstall`` option, see: +https://blog.vyos.io/vyos-1-dot-2-0-development-news-in-july. -The root cause of the problem is that for VTI tunnels to work, their traffic -selectors have to be set to 0.0.0.0/0 for traffic to match the tunnel, even -though actual routing decision is made according to netfilter marks. Unless -route insertion is disabled entirely, StrongSWAN thus mistakenly inserts a -default route through the VTI peer address, which makes all traffic routed -to nowhere. \ No newline at end of file +The root cause of the problem is that VTI tunnels require their traffic +selectors to be set to ``0.0.0.0/0`` for traffic to match the tunnel, even +though routing decisions are based on netfilter marks. Unless route insertion +is explicitly disabled, strongSWAN incorrectly inserts a default route through +the VTI peer address, causing all traffic to be misrouted. -- cgit v1.2.3 From be1128aaae24bba68e2fe115b41fb4c51fe025ef Mon Sep 17 00:00:00 2001 From: Kyrylo Yatsenko Date: Tue, 7 Apr 2026 15:42:36 +0300 Subject: T8046: traffic-engineering (#1726) --- docs/configuration/protocols/index.rst | 1 + .../protocols/traffic-engineering.rst | 51 ++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 docs/configuration/protocols/traffic-engineering.rst (limited to 'docs/configuration') diff --git a/docs/configuration/protocols/index.rst b/docs/configuration/protocols/index.rst index f95c1cf6..d40a4b12 100644 --- a/docs/configuration/protocols/index.rst +++ b/docs/configuration/protocols/index.rst @@ -16,6 +16,7 @@ Protocols mpls multicast segment-routing + traffic-engineering openfabric ospf pim diff --git a/docs/configuration/protocols/traffic-engineering.rst b/docs/configuration/protocols/traffic-engineering.rst new file mode 100644 index 00000000..977a5e5c --- /dev/null +++ b/docs/configuration/protocols/traffic-engineering.rst @@ -0,0 +1,51 @@ +.. _traffic-engineering: + +################### +Traffic Engineering +################### + +Traffic Engineering (TE) is possibility to send traffic from node to node using +alternative path. + +Common link parameters +---------------------- + +Traffic Engineering parameters are used for both IS-IS and OSPF (not supported yet). + +.. cfgcmd:: set protocols traffic-engineering admin-group bit-position + + Create Administrative group and assosiate bit position with it. These groups can be + used in the following commands. + + can have value 0-31. There cannot be two groups with same bit position. + +.. cfgcmd:: set protocols traffic-engineering interface admin-group + + Set administrative group for interface . Multiple values can be provided. + +.. cfgcmd:: set protocols traffic-engineering interface max-bandwidth + + Set maximum bandwidth for interface . Value given in Mbits per second. + +.. cfgcmd:: set protocols traffic-engineering interface max-reservable-bandwidth + + Set maximum reservable bandwidth for interface . Value given in Mbits per second. + + +IS-IS TE Configuration +---------------------- + +Traffic Engineering (TE) can be enabled and exported for IS-IS +using the following commands: + +.. cfgcmd:: set protocols isis traffic-engineering enable + + Enable Traffic Engineering for IS-IS. + +.. cfgcmd:: set protocols isis traffic-engineering export + + Export Traffic Engineering data to neighbors. + +.. cfgcmd:: set protocols isis traffic-engineering address + + Configure IPv4 address for MPLS-TE. -- cgit v1.2.3 From eb46e9a02199ef35b2cb9e9273c2e2ff793b36be Mon Sep 17 00:00:00 2001 From: Quill <69414602+teslazonda@users.noreply.github.com> Date: Thu, 9 Apr 2026 20:07:46 +0900 Subject: DOC: Proofread files in the /configuration/loadbalancing directory (#1821) * Initial proofread * Fix line length lint errors --- docs/configuration/loadbalancing/haproxy.rst | 167 ++++++++++++----------- docs/configuration/loadbalancing/index.rst | 2 + docs/configuration/loadbalancing/wan.rst | 194 +++++++++++++-------------- 3 files changed, 184 insertions(+), 179 deletions(-) (limited to 'docs/configuration') diff --git a/docs/configuration/loadbalancing/haproxy.rst b/docs/configuration/loadbalancing/haproxy.rst index 667ebb95..d742ec18 100644 --- a/docs/configuration/loadbalancing/haproxy.rst +++ b/docs/configuration/loadbalancing/haproxy.rst @@ -1,21 +1,22 @@ +:lastproofread: 2026-04-06 ############# -Haproxy +HAproxy ############# .. include:: /_include/need_improvement.txt -Haproxy is a balancer and proxy server that provides -high-availability, load balancing and proxying for TCP (level 4) -and HTTP-based (level 7) applications. +HAProxy is a load balancer and proxy server that provides +high-availability, load balancing, and proxying for TCP (level 4) and +HTTP-based (level 7) applications. Configuration ============= -Service configuration is responsible for binding to a specific port, -while the backend configuration determines the type of load balancing -to be applied and specifies the real servers to be utilized. +Service configuration specifies the port to bind to. Backend +configuration defines the load balancing method and specifies the backend +servers. Service ------- @@ -23,7 +24,8 @@ Service .. cfgcmd:: set load-balancing haproxy service listen-address
- Set service to bind on IP address, by default listen on any IPv4 and IPv6 + Set the IP address for the service to bind to. By default, the service + listens on all IPv4 and IPv6 addresses. .. cfgcmd:: set load-balancing haproxy service port @@ -43,19 +45,21 @@ Service .. cfgcmd:: set load-balancing haproxy service ssl certificate - Set SSL certificate for service . Multiple certificates could be defined. + Set the SSL certificate for service . You can define + multiple certificates. .. cfgcmd:: set load-balancing haproxy service http-response-headers value - Set custom HTTP headers to be included in all responses + Set custom HTTP headers to include in all responses. .. cfgcmd:: set load-balancing haproxy service logging facility level Specify facility and level for logging. - For an explanation on :ref:`syslog_facilities` and :ref:`syslog_severity_level` - see tables in syslog configuration section. + For an explanation on :ref:`syslog_facilities` and + :ref:`syslog_severity_level`, + see tables in the syslog configuration section. .. cfgcmd:: set load-balancing haproxy service timeout client @@ -76,9 +80,9 @@ Service Rules ^^^^^ -Rules allow to control and route incoming traffic to specific backend based -on predefined conditions. Rules allow to define matching criteria and -perform action accordingly. +Rules control and route incoming traffic to specific backends based on +predefined conditions. Rules define matching criteria and specify actions +to perform. .. cfgcmd:: set load-balancing haproxy service rule domain-name @@ -98,15 +102,13 @@ perform action accordingly. .. cfgcmd:: set load-balancing haproxy service rule url-path - Allows to define URL path matching rules for a specific service. - - With this command, you can specify how the URL path should be matched - against incoming requests. + Define URL path matching rules for a specific service. Use this command + to specify how to match the URL path against incoming requests. The available options for are: * ``begin`` Matches the beginning of the URL path * ``end`` Matches the end of the URL path. - * ``exact`` Requires an exactly match of the URL path + * ``exact`` Matches the URL path exactly. .. cfgcmd:: set load-balancing haproxy service rule set backend @@ -116,7 +118,7 @@ perform action accordingly. .. cfgcmd:: set load-balancing haproxy service rule redirect-location - Redirect URL to a new location + Redirect URL to a new location. Backend @@ -125,37 +127,36 @@ Backend .. cfgcmd:: set load-balancing haproxy backend balance - Load-balancing algorithms to be used for distributed requests among the - available servers + Specify the load balancing algorithm for distributing requests among + available servers. Balance algorithms: * ``source-address`` Distributes requests based on the source IP address - of the client + of the client. * ``round-robin`` Distributes requests in a circular manner, - sequentially sending each request to the next server in line + sequentially sending each request to the next server in line. * ``least-connection`` Distributes requests to the server with the fewest - active connections + active connections. .. cfgcmd:: set load-balancing haproxy backend mode - Configure backend `` mode TCP or HTTP + Configure backend `` mode TCP or HTTP. .. cfgcmd:: set load-balancing haproxy backend server address - Set the address of the backend server to which the incoming traffic will - be forwarded + Set the address of the backend server that receives incoming traffic. .. cfgcmd:: set load-balancing haproxy backend server port - Set the address of the backend port + Set the address of the backend port. .. cfgcmd:: set load-balancing haproxy backend server check - Active health check backend server + Active health check backend server. .. cfgcmd:: set load-balancing haproxy backend server check port @@ -166,35 +167,36 @@ Backend .. cfgcmd:: set load-balancing haproxy backend server send-proxy - Send a Proxy Protocol version 1 header (text format) + Send a Proxy Protocol version 1 header (text format). .. cfgcmd:: set load-balancing haproxy backend server send-proxy-v2 - Send a Proxy Protocol version 2 header (binary format) + Send a Proxy Protocol version 2 header (binary format). .. cfgcmd:: set load-balancing haproxy backend ssl ca-certificate - Configure requests to the backend server to use SSL encryption and - authenticate backend against + Use SSL encryption for backend requests and authenticate the backend + against ````. .. cfgcmd:: set load-balancing haproxy backend ssl no-verify - Configure requests to the backend server to use SSL encryption without - validating server certificate + Use SSL encryption for backend requests without validating the server + certificate. .. cfgcmd:: set load-balancing haproxy backend http-response-headers value - Set custom HTTP headers to be included in all responses using the backend + Set custom HTTP headers to include in all responses from the backend. .. cfgcmd:: set load-balancing haproxy backend logging facility level Specify facility and level for logging. - For an explanation on :ref:`syslog_facilities` and :ref:`syslog_severity_level` - see tables in syslog configuration section. + For an explanation on :ref:`syslog_facilities` and + :ref:`syslog_severity_level`, + see tables in the :ref:`syslog` configuration section. .. cfgcmd:: set load-balancing haproxy backend timeout check @@ -220,7 +222,7 @@ Backend Global ------- -Global parameters +Global configuration parameters: .. cfgcmd:: set load-balancing haproxy global-parameters max-connections @@ -230,7 +232,7 @@ Global parameters .. cfgcmd:: set load-balancing haproxy global-parameters ssl-bind-ciphers - Limit allowed cipher algorithms used during SSL/TLS handshake + Limit the cipher algorithms allowed during SSL/TLS handshake. .. cfgcmd:: set load-balancing haproxy global-parameters tls-version-min @@ -241,7 +243,8 @@ Global parameters facility level Specify facility and level for logging. - For an explanation on :ref:`syslog_facilities` and :ref:`syslog_severity_level` + For an explanation on :ref:`syslog_facilities` and + :ref:`syslog_severity_level` see tables in syslog configuration section. .. cfgcmd:: set load-balancing haproxy timeout check @@ -271,8 +274,8 @@ Health checks HTTP checks ----------- -For web application providing information about their state HTTP health -checks can be used to determine their availability. +Use HTTP health checks to monitor web applications that provide health status +information and determine their availability. .. cfgcmd:: set load-balancing haproxy backend http-check @@ -282,17 +285,17 @@ checks can be used to determine their availability. .. cfgcmd:: set load-balancing haproxy backend http-check method - Sets the HTTP method to be used, can be either: option, get, post, put + Set the HTTP method: ``OPTION``, ``GET``, ``POST``, or ``PUT``. .. cfgcmd:: set load-balancing haproxy backend http-check uri - Sets the endpoint to be used for health checks + Set the endpoint to use for health checks. .. cfgcmd:: set load-balancing haproxy backend http-check expect - Sets the expected result condition for considering a server healthy. + Set the expected result condition for a server to be considered healthy. Some possible examples are: * ``status 200`` Expecting a 200 response code @@ -303,8 +306,8 @@ checks can be used to determine their availability. TCP checks ---------- -Health checks can also be configured for TCP mode backends. You can configure -protocol aware checks for a range of Layer 7 protocols: +Configure health checks for TCP mode backends. You can configure protocol-aware +checks for a range of Layer 7 protocols: .. cfgcmd:: set load-balancing haproxy backend health-check @@ -315,25 +318,23 @@ protocol aware checks for a range of Layer 7 protocols: * ``pgsql`` PostgreSQL protocol check. * ``smtp`` SMTP protocol check. -.. note:: If you specify a server to be checked but do not configure a - protocol, a basic TCP health check will be attempted. A server shall be - deemed online if it responses to a connection attempt with a valid - ``SYN/ACK`` packet. +.. note:: If you specify a server to check but do not configure a + protocol, HAProxy performs a basic TCP health check. A server is online if + it responds to a connection attempt with a valid ``SYN/ACK`` packet. Redirect HTTP to HTTPS ====================== -Configure the load-balancing haproxy service for HTTP. -This configuration listen on port 80 and redirect incoming -requests to HTTPS: +Configure a HAProxy service for HTTP that listens on port 80 and redirects +incoming requests to HTTPS: .. code-block:: none set load-balancing haproxy service http port '80' set load-balancing haproxy service http redirect-http-to-https -The name of the service can be different, in this example it is only for +You can use a different service name; in this example, ``http`` is just for convenience. @@ -343,9 +344,10 @@ Examples Level 4 balancing ----------------- -This configuration enables the TCP reverse proxy for the "my-tcp-api" service. -Incoming TCP connections on port 8888 will be load balanced across the backend -servers (srv01 and srv02) using the round-robin load-balancing algorithm. +This configuration enables the TCP reverse proxy for the ``my-tcp-api`` +service. Incoming TCP connections on port 8888 are load balanced across the +backend servers (srv01 and srv02) using the round-robin load balancing +algorithm. .. code-block:: none @@ -365,15 +367,15 @@ servers (srv01 and srv02) using the round-robin load-balancing algorithm. Balancing based on domain name ------------------------------ The following configuration demonstrates how to use VyOS -to achieve load balancing based on the domain name. +to achieve load balancing based on the domain name: -The HTTP service listen on TCP port 80. +The HTTP service listens on TCP port 80. -Rule 10 matches requests with the domain name ``node1.example.com`` forwards -to the backend ``bk-api-01`` +Rule 10 matches requests with the domain name ``node1.example.com`` and +forwards them to the backend ``bk-api-01``. -Rule 20 matches requests with the domain name ``node2.example.com`` forwards -to the backend ``bk-api-02`` +Rule 20 matches requests with the domain name ``node2.example.com`` and +forwards them to the backend ``bk-api-02``. .. code-block:: none @@ -398,23 +400,25 @@ to the backend ``bk-api-02`` Terminate SSL ------------- + The following configuration terminates SSL on the router. -The ``http`` service is listens on port 80 and force redirects from HTTP to +The ``http`` service listens on port 80 and redirects HTTP requests to HTTPS. -The ``https`` service listens on port 443 with backend ``bk-default`` to -handle HTTPS traffic. It uses certificate named ``cert`` for SSL termination. -HSTS header is set with a 1-year expiry, to tell browsers to always use SSL for site. +The ``https`` service listens on port 443 with the ``bk-default`` backend +and handles HTTPS traffic using the ``cert`` certificate for SSL termination. +The HSTS header is set with a 1-year expiry to tell browsers to always use +SSL for the site. -Rule 10 matches requests with the exact URL path ``/.well-known/xxx`` -and redirects to location ``/certs/``. +Rule 10 matches requests with the exact URL path ``/.well-known/xxx`` and +redirects them to ``/certs/``. -Rule 20 matches requests with URL paths ending in ``/mail`` or exact -path ``/email/bar`` redirect to location ``/postfix/``. +Rule 20 matches requests with URL paths ending in ``/mail`` or the exact +path ``/email/bar`` and redirects them to ``/postfix/``. -Additional global parameters are set, including the maximum number -connection limit of 4000 and a minimum TLS version of 1.3. +Global parameters include a maximum connection limit of 4000 and a minimum +TLS version of 1.3. .. code-block:: none @@ -447,9 +451,10 @@ connection limit of 4000 and a minimum TLS version of 1.3. SSL Bridging ------------- + The following configuration terminates incoming HTTPS traffic on the router, -then re-encrypts the traffic and sends to the backend server via HTTPS. -This is useful if encryption is required for both legs, but you do not want to +then re-encrypts the traffic and sends it to the backend server via HTTPS. +Use this when encryption is required for both paths but you do not want to install publicly trusted certificates on each backend server. Backend service certificates are checked against the certificate authority @@ -458,7 +463,7 @@ specified in the configuration, which could be an internal CA. The ``https`` service listens on port 443 with backend ``bk-bridge-ssl`` to handle HTTPS traffic. It uses certificate named ``cert`` for SSL termination. -The ``bk-bridge-ssl`` backend connects to sr01 server on port 443 via HTTPS +The ``bk-bridge-ssl`` backend connects to ``sr01`` server on port 443 via HTTPS and checks backend server has a valid certificate trusted by CA ``cacert`` @@ -480,7 +485,7 @@ and checks backend server has a valid certificate trusted by CA ``cacert`` Balancing with HTTP health checks --------------------------------- -This configuration enables HTTP health checks on backend servers. +This configuration enables HTTP health checks for backend servers. .. code-block:: none diff --git a/docs/configuration/loadbalancing/index.rst b/docs/configuration/loadbalancing/index.rst index 92dcc622..b87faed2 100644 --- a/docs/configuration/loadbalancing/index.rst +++ b/docs/configuration/loadbalancing/index.rst @@ -1,3 +1,5 @@ +:lastproofread: 2026-04-06 + .. _load-balancing: ############## diff --git a/docs/configuration/loadbalancing/wan.rst b/docs/configuration/loadbalancing/wan.rst index 745cd8c2..3d5a3cc6 100644 --- a/docs/configuration/loadbalancing/wan.rst +++ b/docs/configuration/loadbalancing/wan.rst @@ -1,22 +1,21 @@ -:lastproofread: 2023-01-27 +:lastproofread: 2026-04-06 WAN load balancing ================== -Outbound traffic can be balanced between two or more outbound interfaces. -If a path fails, traffic is balanced across the remaining healthy paths, -a recovered path is automatically added back to the routing table and used by -the load balancer. The load balancer automatically adds routes for each path to -the routing table and balances traffic across the configured interfaces, -determined by interface health and weight. +The load balancer distributes outbound traffic across two or more +interfaces. If a path fails, the load balancer balances traffic across the +remaining healthy paths. When a path recovers, it is automatically added back +to the routing table. The load balancer adds routes for each path and +distributes traffic based on interface health and weight. In a minimal configuration, the following must be provided: - * an interface with a nexthop - * one rule with a LAN (inbound-interface) and the WAN (interface). + * An interface with a ``nexthop``. + * One rule with a LAN (inbound-interface) and the WAN (interface). -Let's assume we have two DHCP WAN interfaces and one LAN (eth2): +The following examples uses two DHCP WAN interfaces and one LAN (``eth2``): .. code-block:: none @@ -28,18 +27,18 @@ Let's assume we have two DHCP WAN interfaces and one LAN (eth2): .. note:: - WAN Load Balacing should not be used when dynamic routing protocol is - used/needed. This feature creates customized routing tables and firewall - rules, that makes it incompatible to use with routing protocols. + Do not use WAN load balancing with dynamic routing protocols. This + feature creates customized routing tables and firewall rules that are + incompatible with routing protocols. -Balancing Rules ---------------- +Load balancing rules +-------------------- -Interfaces, their weight and the type of traffic to be balanced are defined in -numbered balancing rule sets. The rule sets are executed in numerical order -against outgoing packets. In case of a match the packet is sent through an -interface specified in the matching rule. If a packet doesn't match any rule -it is sent by using the system routing table. Rule numbers can't be changed. +You define interfaces, their weight, and the traffic type to balance in +numbered rule sets. The load balancer executes rules in numerical order +against outgoing packets. When a packet matches a rule, it is sent through the +specified interface. Packets that do not match any rule use the system routing +table. You cannot change rule numbers. Create a load balancing rule, it can be a number between 1 and 9999: @@ -61,23 +60,25 @@ Create a load balancing rule, it can be a number between 1 and 9999: Interface weight **************** -Let's expand the example from above and add weight to the interfaces. -The bandwidth from eth0 is larger than eth1. Per default, outbound traffic is -distributed randomly across available interfaces. Weights can be assigned to -interfaces to influence the balancing. +By default, the load balancer distributes outbound +traffic randomly across available interfaces. You can assign weights to +interfaces to influence the distribution. If ``eth0`` has more bandwidth +than ``eth1``, you can assign a higher weight to ``eth0`` to send more +traffic through it: .. code-block:: none set load-balancing wan rule 1 interface eth0 weight 2 set load-balancing wan rule 1 interface eth1 weight 1 -66% of traffic is routed to eth0, eth1 gets 33% of traffic. +In this example,``eth0`` receives 66% of traffic, and ``eth1`` receives +33% of traffic. Rate limit ********** -A packet rate limit can be set for a rule to apply the rule to traffic above or -below a specified threshold. To configure the rate limiting use: +Set a packet rate limit for a rule to apply it to traffic above or below a +specified threshold. To configure rate limiting, use: .. code-block:: none @@ -88,22 +89,20 @@ below a specified threshold. To configure the rate limiting use: * ``period``: Time window for rate calculation. Possible values: ``second`` (one second), ``minute`` (one minute), ``hour`` (one hour). Default is ``second``. -* ``rate``: Number of packets. Default 5. +* ``rate``: Number of packets. Default: ``5``. * ``threshold``: ``below`` or ``above`` the specified rate limit. Flow and packet-based balancing ******************************* -Outgoing traffic is balanced in a flow-based manner. -A connection tracking table is used to track flows by their source address, -destination address and port. Each flow is assigned to an interface according -to the defined balancing rules and subsequent packets are sent through the -same interface. This has the advantage that packets always arrive in order if -links with different speeds are in use. +The load balancer balances outgoing traffic by flow. A connection tracking +table tracks flows by source address, destination address, and port. Each +flow is assigned to an interface based on the balancing rules, and subsequent +packets use the same interface. This ensures packets arrive in order when links +have different speeds. -Packet-based balancing can lead to a better balance across interfaces when out -of order packets are no issue. Per-packet-based balancing can be set for a -balancing rule with: +Packet-based balancing can improve balance across interfaces when packet +order is not critical. Enable per-packet balancing for a rule with: .. code-block:: none @@ -112,8 +111,8 @@ balancing rule with: Exclude traffic *************** -To exclude traffic from load balancing, traffic matching an exclude rule is not -balanced but routed through the system routing table instead: +To exclude traffic from load balancing, traffic matching an exclude rule +bypasses load balancing and uses the system routing table instead: .. code-block:: none @@ -123,10 +122,10 @@ balanced but routed through the system routing table instead: Health checks ------------- -The health of interfaces and paths assigned to the load balancer is -periodically checked by sending ICMP packets (ping) to remote destinations, -a TTL test or the execution of a user defined script. If an interface fails the -health check it is removed from the load balancer's pool of interfaces. +The load balancer periodically checks the health of interfaces and paths by +sending ICMP packets (ping) to remote destinations, performing TTL tests, or +executing a user-defined script. If an interface fails the health check, the +load balancer removes it from its interface pool. To enable health checking for an interface: .. code-block:: none @@ -138,26 +137,26 @@ To enable health checking for an interface: success-count Success count +> test Rule number -Specify nexthop on the path to the destination, ``ipv4-address`` can be set to -``dhcp`` +Specify the nexthop on the path to the destination. You can set +``ipv4-address`` to ``dhcp``. .. code-block:: none set load-balancing wan interface-health nexthop -Set the number of health check failures before an interface is marked as -unavailable, range for number is 1 to 10, default 1. Or set the number of -successful health checks before an interface is added back to the interface -pool, range for number is 1 to 10, default 1. +Set the number of health check failures before the load balancer marks an +interface as unavailable (range 1-10, default 1). Or set the number of +successful health checks before adding an interface back to the pool +(range 1-10, default 1). .. code-block:: none set load-balancing wan interface-health failure-count set load-balancing wan interface-health success-count -Each health check is configured in its own test, tests are numbered and -processed in numeric order. For multi target health checking multiple tests -can be defined: +Configure each health check in its own test. Tests are numbered and processed +in numeric order. You can define multiple tests for multi-target health +checking: .. code-block:: none @@ -169,46 +168,45 @@ can be defined: ttl-limit Ttl limit (hop count) type WLB test type -* ``resp-time``: the maximum response time for ping in seconds. - Range 1...30, default 5 -* ``target``: the target to be sent ICMP packets to, address can be an IPv4 - address or hostname -* ``test-script``: A user defined script must return 0 to be considered - successful and non-zero to fail. Scripts are located in /config/scripts, - for different locations the full path needs to be provided -* ``ttl-limit``: For the UDP TTL limit test the hop count limit must be - specified. The limit must be shorter than the path length, an ICMP time - expired message is needed to be returned for a successful test. default 1 -* ``type``: Specify the type of test. type can be ping, ttl or a user defined - script +* ``resp-time``: The maximum response time for ping in seconds. Range + 1-30, default ``5``. +* ``target``: The target to receive ICMP packets. The address can be an IPv4 + address or hostname. +* ``test-script``: A user-defined script must return 0 to succeed and + non-zero to fail. Scripts reside in ``/config/scripts``. For other locations, + provide the full path. +* ``ttl-limit``: For the UDP TTL limit test, specify the hop count limit. + The limit must be shorter than the path length. The test succeeds when an + ICMP time-expired message is returned. Default ``1``. +* ``type``: Specify the test type: ``ping``, ``ttl``, or a user-defined + script. Source NAT rules ---------------- -Per default, interfaces used in a load balancing pool replace the source IP -of each outgoing packet with its own address to ensure that replies arrive on -the same interface. This works through automatically generated source NAT (SNAT) -rules, these rules are only applied to balanced traffic. In cases where this -behaviour is not desired, the automatic generation of SNAT rules can be -disabled: +By default, interfaces in a load balancing pool replace the source IP of +each outgoing packet with their own address to ensure replies arrive on the +same interface. The load balancer handles this through automatically generated +Source NAT (SNAT) rules applied only to balanced traffic. To disable the +automatic generation of SNAT rules when this behavior is not desired, use: .. code-block:: none set load-balancing wan disable-source-nat -Sticky Connections +Sticky connections ------------------ -Inbound connections to a WAN interface can be improperly handled when the reply -is sent back to the client. +Inbound connections to a WAN interface can be improperly handled when +replies are sent back to the client. .. image:: /_static/images/sticky-connections.jpg :width: 80% :align: center -Upon reception of an incoming packet, when a response is sent, it might be -desired to ensure that it leaves from the same interface as the inbound one. -This can be achieved by enabling sticky connections in the load balancing: +When responding to an incoming packet, you may want to ensure the response +leaves from the same interface as the incoming packet. Enable sticky +connections in the load balancer to do this: .. code-block:: none @@ -217,23 +215,21 @@ This can be achieved by enabling sticky connections in the load balancing: Failover -------- -In failover mode, one interface is set to be the primary interface and other -interfaces are secondary or spare. Instead of balancing traffic across all -healthy interfaces, only the primary interface is used and in case of failure, -a secondary interface selected from the pool of available interfaces takes over. -The primary interface is selected based on its weight and health, others become -secondary interfaces. Secondary interfaces to take over a failed primary -interface are chosen from the load balancer's interface pool, depending -on their weight and health. Interface roles can also be selected based on rule -order by including interfaces in balancing rules and ordering those rules -accordingly. To put the load balancer in failover mode, create a failover rule: +In failover mode, one interface is primary and other interfaces are +secondary or spare. The load balancer uses only the primary interface. If it +fails, a secondary interface from the available pool takes over. The load +balancer selects the primary interface based on its weight and health. Other +interfaces become secondary. Secondary interfaces are chosen based on their +weight and health. You can also select interface roles based on rule order by +including interfaces in balancing rules and ordering those rules accordingly. +To enable failover mode, create a failover rule: .. code-block:: none set load-balancing wan rule failover -Because existing sessions do not automatically fail over to a new path, -the session table can be flushed on each connection state change: +Existing sessions do not automatically fail over to a new path. Flush the +session table on each connection state change to enable failover: .. code-block:: none @@ -241,14 +237,15 @@ the session table can be flushed on each connection state change: .. warning:: - Flushing the session table will cause other connections to fall back from + Flushing the session table causes other connections to revert from flow-based to packet-based balancing until each flow is reestablished. Script execution ---------------- -A script can be run when an interface state change occurs. Scripts are run -from /config/scripts, for a different location specify the full path: +Run a script when an interface state changes. Scripts run from the +``/config/scripts`` directory. To use a script in another location, +specify the full path: .. code-block:: none @@ -261,19 +258,20 @@ Two environment variables are available: .. warning:: - Blocking call with no timeout. System will become unresponsive if script - does not return! + Blocking call with no timeout: VyOS becomes unresponsive if the + script does not return. Handling and monitoring ----------------------- -Show WAN load balancer information including test types and targets. -A character at the start of each line depicts the state of the test +The following command shows WAN load balancer information including test +types and targets. The character at the start of each line indicates the test +state: -* ``+`` successful -* ``-`` failed -* a blank indicates that no test has been carried out +* ``+`` successful. +* ``-`` failed. +* A blank indicates that no test has been carried out. .. code-block:: none -- cgit v1.2.3 From 9f334f3d5547735fa8c83fd6b6e7bbafa589f11a Mon Sep 17 00:00:00 2001 From: "Nataliia S." <81954790+natali-rs1985@users.noreply.github.com> Date: Fri, 10 Apr 2026 14:41:50 +0300 Subject: T8189: Add conntrackd FTFW PurgeTimeout setting (#1819) --- docs/configuration/service/conntrack-sync.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'docs/configuration') diff --git a/docs/configuration/service/conntrack-sync.rst b/docs/configuration/service/conntrack-sync.rst index 232db1a8..27bc977d 100644 --- a/docs/configuration/service/conntrack-sync.rst +++ b/docs/configuration/service/conntrack-sync.rst @@ -98,6 +98,20 @@ Configuration This diable the external cache and directly injects the flow-states into the in-kernel Connection Tracking System of the backup firewall. +.. cfgcmd:: set service conntrack-sync purge-timeout + + Timeout (in seconds) for purging synchronized entries on handover events. + + On handover, ``conntrackd -t`` is invoked, which schedules a conntrack table + flush after ```` seconds to purge stale (“zombie”) entries and + reduce clashes when multiple handovers occur in a short period. + The default is 60 seconds. + +.. note:: In VRRP stateful firewall deployments, align VRRP timing with this + behavior: because synchronized conntrack state is purged after the purge + timeout, set **VRRP preempt-delay** to ≥ **purge-timeout** so mastership + can be restored before conntrack state is purged. + .. cfgcmd:: set service conntrack-sync disable-syslog Disable connection logging via Syslog. -- cgit v1.2.3 From 71968b65b0f53dbf25963b11c640491c973d2896 Mon Sep 17 00:00:00 2001 From: Quill <69414602+teslazonda@users.noreply.github.com> Date: Fri, 10 Apr 2026 20:48:54 +0900 Subject: Proofread files in the /configuration/firewall directory (#1810) * Initial proofread * Edit ipv6.rst * Use cfgcmd command syntax * Fix line length lint errors * Implement feedback --- docs/configuration/firewall/bridge.rst | 75 +++--- docs/configuration/firewall/flowtables.rst | 125 +++++----- docs/configuration/firewall/global-options.rst | 78 +++---- docs/configuration/firewall/groups.rst | 138 ++++++----- docs/configuration/firewall/index.rst | 221 ++++++++++-------- docs/configuration/firewall/ipv4.rst | 247 ++++++++++---------- docs/configuration/firewall/ipv6.rst | 311 ++++++++++++------------- docs/configuration/firewall/zone.rst | 119 +++++----- 8 files changed, 670 insertions(+), 644 deletions(-) (limited to 'docs/configuration') diff --git a/docs/configuration/firewall/bridge.rst b/docs/configuration/firewall/bridge.rst index 9c360d35..d0847801 100644 --- a/docs/configuration/firewall/bridge.rst +++ b/docs/configuration/firewall/bridge.rst @@ -1,4 +1,4 @@ -:lastproofread: 2024-08-05 +:lastproofread: 2026-03-28 .. _firewall-configuration: @@ -10,13 +10,15 @@ Bridge Firewall Configuration Overview ******** -In this section there's useful information on all firewall configuration that -can be done regarding bridges, and appropriate op-mode commands. -Configuration commands covered in this section: +Learn more about bridge firewall configuration +and related op-mode commands. -.. cfgcmd:: set firewall bridge ... +The following commands are covered in this section: -From the main structure defined in :doc:`Firewall Overview` +.. cfgcmd:: set firewall bridge + +From the main structure defined in +:doc:`Firewall Overview` in this section you can find detailed information only for the next part of the general structure: @@ -35,7 +37,7 @@ of the general structure: - name + custom_name -Traffic which is received by the router on an interface which is member of a +Traffic that is received by the router on an interface that is a member of a bridge is processed on the **Bridge Layer**. Before the bridge decision is made, all packets are analyzed at **Prerouting**. First filters can be applied here, and also rules for ignoring connection tracking system can be configured. @@ -43,15 +45,16 @@ The relevant configuration that acts in **prerouting** is: * ``set firewall bridge prerouting filter ...``. -For traffic that needs to be switched internally by the bridge, base chain is -**forward**, and it's base command for filtering is ``set firewall bridge -forward filter ...``, which happens in stage 4, highlighted with red color. +For traffic that needs to be switched internally by the bridge, the base +chain is **forward**, and its base command for filtering is ``set firewall +bridge forward filter ...``, which happens in stage 4, highlighted with red +color. .. figure:: /_static/images/firewall-bridge-forward.png -For traffic destined to the router itself, or that needs to be routed (assuming -a layer3 bridge is configured), the base chain is **input**, the base command -is ``set firewall bridge input filter ...`` and the path is: +For traffic destined to the router itself or that needs to be routed +(assuming a layer3 bridge is configured), the base chain is **input**, and the +base command is ``set firewall bridge input filter ...`` and the path is: .. figure:: /_static/images/firewall-bridge-input.png @@ -60,15 +63,15 @@ processed by the **IP Layer** firewall: IPv4 or IPv6 ruleset. Check once again the :doc:`general packet flow diagram` if needed. -And for traffic that originates from the bridge itself, the base chain is -**output**, base command is ``set firewall bridge output filter ...``, and -the path is: +For traffic that originates from the bridge itself, the base chain is +**output**, and the base command is ``set firewall bridge output filter +...``, and the path is: .. figure:: /_static/images/firewall-bridge-output.png -Custom bridge firewall chains can be created with the command ``set firewall bridge -name ...``. In order to use such custom chain, a rule with action jump, -and the appropriate target should be defined in a base chain. +Custom bridge firewall chains can be created with the command ``set firewall +bridge name ...``. To use such a custom chain, a rule with action jump +and the appropriate target must be defined in a base chain. ************ Bridge Rules @@ -83,8 +86,8 @@ rule will be executed. Actions ======= -If a rule is defined, then an action must be defined for it. This tells the -firewall what to do if all matching criterea in the rule are met. +If a rule is defined, an action must also be defined for it. This tells the +firewall what to do if all matching criteria in the rule are met. In firewall bridge rules, the action can be: @@ -169,7 +172,7 @@ In firewall bridge rules, the action can be: queue-options fanout Also, **default-action** is an action that takes place whenever a packet does -not match any rule in its' chain. For base chains, possible options for +not match any rule in its chain. For base chains, possible options for **default-action** are **accept** or **drop**. .. cfgcmd:: set firewall bridge forward filter default-action @@ -202,8 +205,8 @@ not match any rule in its' chain. For base chains, possible options for Firewall Logs ============= -Logging can be enable for every single firewall rule. If enabled, other -log options can be defined. +You can enable logging for every firewall rule. If enabled, other log options +can be configured. .. cfgcmd:: set firewall bridge forward filter rule <1-999999> log .. cfgcmd:: set firewall bridge input filter rule <1-999999> log @@ -287,7 +290,7 @@ log options can be defined. Firewall Description ==================== -For reference, a description can be defined for every defined custom chain. +You can define a description for reference for every custom chain. .. cfgcmd:: set firewall bridge name description @@ -309,8 +312,8 @@ For reference, a description can be defined for every defined custom chain. Rule Status =========== -When defining a rule, it is enabled by default. In some cases, it is useful to -just disable the rule, rather than removing it. +By default, when you define a rule, it is enabled. In some cases, it is +useful to disable the rule instead of removing it. .. cfgcmd:: set firewall bridge forward filter rule <1-999999> disable .. cfgcmd:: set firewall bridge input filter rule <1-999999> disable @@ -323,11 +326,11 @@ just disable the rule, rather than removing it. Matching criteria ================= -There are a lot of matching criteria against which the packet can be tested. -Please refer to :doc:`IPv4` and +There are many matching criteria against which a packet can be tested. Refer +to :doc:`IPv4` and :doc:`IPv6` matching criteria for more details. -Since bridges operats at layer 2, both matchers for IPv4 and IPv6 are +Since bridges operate at layer 2, both matchers for IPv4 and IPv6 are supported in bridge firewall configuration. Same applies to firewall groups. Same specific matching criteria that can be used in bridge firewall are @@ -434,15 +437,15 @@ are: .. cfgcmd:: set firewall global-options apply-to-bridged-traffic ipv4 - This command enables the IPv4 firewall for bridged traffic. If this - options is used, then packet will also be parsed by rules defined in ``set - firewall ipv4 ...`` + This command enables the IPv4 firewall for bridged traffic. If this option + is used, packets are also parsed by rules defined in ``set firewall ipv4 + ...`` .. cfgcmd:: set firewall global-options apply-to-bridged-traffic ipv6 - This command enables the IPv6 firewall for bridged traffic. If this - options is used, then packet will also be parsed by rules defined in ``set - firewall ipv6 ...`` + This command enables the IPv6 firewall for bridged traffic. If this option + is used, packets are also parsed by rules defined in ``set firewall ipv6 + ...`` *********************** Operation-mode Firewall diff --git a/docs/configuration/firewall/flowtables.rst b/docs/configuration/firewall/flowtables.rst index 915bf39d..152a4380 100644 --- a/docs/configuration/firewall/flowtables.rst +++ b/docs/configuration/firewall/flowtables.rst @@ -1,4 +1,4 @@ -:lastproofread: 2024-07-02 +:lastproofread: 2026-03-30 .. _firewall-flowtables-configuration: @@ -6,21 +6,18 @@ Flowtables Firewall Configuration ################################# -.. note:: **Documentation under development** +.. include:: /_include/need_improvement.txt ******** Overview ******** -In this section there's useful information on all firewall configuration that -can be done regarding flowtables. +This section provides information on firewall configuration for flowtables. -.. cfgcmd:: set firewall flowtables ... +.. cfgcmd:: set firewall flowtable ... -From the main structure defined in -:doc:`Firewall Overview` -in this section you can find detailed information only for the next part -of the general structure: +To learn about the general traffic flow in VyOS firewalls, +see :doc:`Firewall `. .. code-block:: none @@ -30,24 +27,23 @@ of the general structure: + ... -Flowtables allow you to define a fastpath through the flowtable datapath. -The flowtable supports for the layer 3 IPv4 and IPv6 and the layer 4 TCP -and UDP protocols. +Flowtables let you define a fastpath through the flowtable datapath. +Flowtables support layer 3 (IPv4 and IPv6) and layer 4 (TCP and UDP) +protocols. .. figure:: /_static/images/firewall-flowtable-packet-flow.png -Once the first packet of the flow successfully goes through the IP forwarding -path (black circles path), from the second packet on, you might decide to -offload the flow to the flowtable through your ruleset. The flowtable -infrastructure provides a rule action that allows you to specify when to add -a flow to the flowtable (On forward filtering, red circle number 6) +After the first packet successfully traverses the IP forwarding path (black +circles path), you can offload subsequent packets to the flowtable through your +ruleset. You specify when to add a flow to the flowtable during forward +filtering (red circle number 6). -A packet that finds a matching entry in the flowtable (flowtable hit) is -transmitted to the output netdevice, hence, packets bypass the classic IP -forwarding path and uses the **Fast Path** (orange circles path). The visible -effect is that you do not see these packets from any of the Netfilter -hooks coming after ingress. In case that there is no matching entry in the -flowtable (flowtable miss), the packet follows the classic IP forwarding path. +When a packet finds a matching entry in the flowtable (flowtable hit), the +system transmits it to the output netdevice. This means packets bypass the +classic IP forwarding path and use the **Fast Path** (orange circles path). +As a result, you do not see these packets from any Netfilter hooks after +ingress. If no matching entry exists in the flowtable (flowtable miss), the +packet traverses the classic IP forwarding path. .. note:: **Flowtable Reference:** https://docs.kernel.org/networking/nf_flowtable.html @@ -57,64 +53,68 @@ flowtable (flowtable miss), the packet follows the classic IP forwarding path. Flowtable Configuration *********************** -In order to use flowtables, the minimal configuration needed includes: +To use flowtables, you need to configure the following: - * Create flowtable: create flowtable, which includes the interfaces + * Create a flowtable that includes the interfaces that are going to be used by the flowtable. - * Create firewall rule: create a firewall rule, setting action to - ``offload`` and using desired flowtable for ``offload-target``. + * Create a firewall rule. Set the action to + ``offload`` and use your desired flowtable for ``offload-target``. Creating a flow table: .. cfgcmd:: set firewall flowtable interface - Define interfaces to be used in the flowtable. + Specify interfaces to use in the flowtable. .. cfgcmd:: set firewall flowtable description -Provide a description to the flow table. +Provide a description for the flow table. .. cfgcmd:: set firewall flowtable offload - Define type of offload to be used by the flowtable: ``hardware`` or - ``software``. By default, ``software`` offload is used. + Specify the offload type the flowtable uses: ``hardware`` or + ``software``. The default is ``software`` offload. -.. note:: **Hardware offload:** should be supported by the NICs used. +.. note:: **Hardware offload**: Make sure your network interface controller + (NIC) supports hardware offloading and that you have the necessary drivers + installed before enabling this option. Creating rules for using flow tables: .. cfgcmd:: set firewall [ipv4 | ipv6] forward filter rule <1-999999> action offload - Create firewall rule in forward chain, and set action to ``offload``. + Create a firewall rule in the forward chain with the action set to + ``offload``. .. cfgcmd:: set firewall [ipv4 | ipv6] forward filter rule <1-999999> offload-target - Create firewall rule in forward chain, and define which flowtbale - should be used. Only applicable if action is ``offload``. + Create a firewall rule in the forward chain and specify which flowtable + to use. Only applicable if the action is ``offload``. ********************* Configuration Example ********************* -Things to be considered in this setup: +Consider the following in this setup: - * Two interfaces are going to be used in the flowtables: eth0 and eth1 + * This example uses two interfaces in the flowtables: ``eth0`` and ``eth1``. - * Minimum firewall ruleset is provided, which includes some filtering rules, - and appropriate rules for using flowtable offload capabilities. + * The example provides a minimal firewall ruleset with filtering rules + and rules for using flowtable offload capabilities. -As described, the first packet will be evaluated by the firewall path, so a -desired connection should be explicitly accepted. Same thing should be taken -into account for traffic in reverse order. In most cases state policies are -used in order to accept a connection in the reverse path. +The first packet is evaluated by the firewall path, so a +desired connection should be explicitly accepted. +The same should occur for traffic in reverse order. +In most cases, state policies are +used to accept a connection in the reverse path. -We will only accept traffic coming from interface eth0, protocol tcp and -destination port 1122. All other traffic trespassing the router should be -blocked. +In the following example only traffic coming from interface ``eth0``, +TCP protocol, and destination port 1122 is accepted. +All other traffic to the router is dropped. Commands -------- @@ -140,33 +140,32 @@ Commands Explanation ----------- -Analysis on what happens for desired connection: +Here's what happens for a desired connection: - 1. Firstly, a packet is received on eth0, with destination address 192.0.2.100, - protocol tcp and destination port 1122. Assume such destination address is - reachable through interface eth1. + 1. A packet arrives on ``eth0`` with destination address ``192.0.2.100``, TCP + protocol, and destination port 1122. Assume this address is reachable + through interface ``eth1``. - 2. Since this is the first packet, connection status of this connection, - so far is **new**. So neither rule 10 nor 20 are valid. + 2. For this first packet, the connection state is **new**. Neither rule 10 + nor rule 20 applies. - 3. Rule 110 is hit, so connection is accepted. + 3. Rule 110 matches, so the connection is accepted. - 4. Once an answer from server 192.0.2.100 is seen in opposite direction, - connection state will be triggered to **established**, so this reply is - accepted in rule 20. + 4. When the server 192.0.2.100 replies, the connection state becomes + **established**, and rule 20 accepts the reply. - 5. The second packet for this connection is received by the router. Since - connection state is **established**, then rule 10 is hit, and a new entry - in the flowtable FT01 is added for this connection. + 5. The router receives the second packet for this connection. Because the + connection state is **established**, rule 10 matches and adds a new + entry in the flowtable FT01 for this connection. - 6. All the following packets will skip the traditional path, will be - offloaded and use the **Fast Path**. + 6. Subsequent packets skip the traditional path and use the **Fast Path** + for offloading. Checks ------ -It's time to check the conntrack table, to see if any connections were accepted, -and if it was properly offloaded +Check the conntrack table to verify that the system accepted and properly +offloaded connections. .. code-block:: none diff --git a/docs/configuration/firewall/global-options.rst b/docs/configuration/firewall/global-options.rst index 60addbe9..8eec5c3f 100644 --- a/docs/configuration/firewall/global-options.rst +++ b/docs/configuration/firewall/global-options.rst @@ -1,4 +1,4 @@ -:lastproofread: 2024-07-03 +:lastproofread: 2026-03-30 .. _firewall-global-options-configuration: @@ -10,9 +10,9 @@ Global Options Firewall Configuration Overview ******** -Some firewall settings are global and have an affect on the whole system. -In this section there's useful information about these global-options that can -be configured using vyos cli. +Some firewall settings are global and affect the entire system. This section +provides information about these global options that you can configure using +the VyOS CLI. Configuration commands covered in this section: @@ -25,51 +25,50 @@ Configuration .. cfgcmd:: set firewall global-options all-ping [enable | disable] By default, when VyOS receives an ICMP echo request packet destined for - itself, it will answer with an ICMP echo reply, unless you prevent it - through its firewall. + itself, it answers with an ICMP echo reply, unless your firewall prevents + it. - With the firewall you can set rules to accept, drop or reject ICMP in, - out or local traffic. You can also use the general **firewall all-ping** - command. This command affects only to LOCAL (packets destined for your - VyOS system), not to IN or OUT traffic. + You can set firewall rules to accept, drop, or reject ICMP in, out, or + local traffic. You can also use the **firewall global-options all-ping** + command. This command affects only LOCAL traffic (packets destined for your + VyOS system), not IN or OUT traffic. - .. note:: **firewall global-options all-ping** affects only to LOCAL - and it always behaves in the most restrictive way + .. note:: **firewall global-options all-ping** affects only LOCAL traffic + and always behaves in the most restrictive way .. code-block:: none set firewall global-options all-ping enable - When the command above is set, VyOS will answer every ICMP echo request - addressed to itself, but that will only happen if no other rule is - applied dropping or rejecting local echo requests. In case of conflict, - VyOS will not answer ICMP echo requests. + When you set this command, VyOS answers every ICMP echo request addressed + to itself, but that response occurs only if no other rule drops or rejects + local echo requests. In case of conflict, VyOS does not answer ICMP echo + requests. .. code-block:: none set firewall global-options all-ping disable - When the command above is set, VyOS will answer no ICMP echo request - addressed to itself at all, no matter where it comes from or whether - more specific rules are being applied to accept them. + When you set this command, VyOS answers no ICMP echo requests addressed to + itself, regardless of where they come from or what specific rules accept + them. .. cfgcmd:: set firewall global-options apply-to-bridged-traffic [ipv4 | ipv6] - Use these commands to also use IPv4, or IPv6 firewall rules for bridged - traffic + Apply IPv4 or IPv6 firewall rules to bridged traffic. .. cfgcmd:: set firewall global-options broadcast-ping [enable | disable] - This setting enables or disables the response to icmp broadcast - messages. The following system parameter will be altered: + Enable or disable the response to ICMP broadcast messages. The system + alters the following parameter: * ``net.ipv4.icmp_echo_ignore_broadcasts`` .. cfgcmd:: set firewall global-options ip-src-route [enable | disable] .. cfgcmd:: set firewall global-options ipv6-src-route [enable | disable] - This setting handles if VyOS accepts packets with a source route - option. The following system parameters will be altered: + Set whether VyOS accepts packets with a source route option. + The following sysctl parameters will be changed: * ``net.ipv4.conf.all.accept_source_route`` * ``net.ipv6.conf.all.accept_source_route`` @@ -78,23 +77,23 @@ Configuration .. cfgcmd:: set firewall global-options ipv6-receive-redirects [enable | disable] - Enable or disable ICMPv4 or ICMPv6 redirect messages being accepted by - VyOS. The following system parameters will be altered: + Allow VyOS to accept ICMPv4 and ICMPv6 redirect messages. + The following sysctl parameters will be changed: * ``net.ipv4.conf.all.accept_redirects`` * ``net.ipv6.conf.all.accept_redirects`` .. cfgcmd:: set firewall global-options send-redirects [enable | disable] - Enable or disable ICMPv4 redirect messages being sent by VyOS - The following system parameter will be altered: + Allow VyOS to send ICMPv4 redirect messages. + The following sysctl parameter will be changed: * ``net.ipv4.conf.all.send_redirects`` .. cfgcmd:: set firewall global-options log-martians [enable | disable] - Enable or disable the logging of martian IPv4 packets. - The following system parameter will be altered: + Allow VyOS to log martian IPv4 packets. + The following sysctl parameter will be changed: * ``net.ipv4.conf.all.log_martians`` @@ -102,22 +101,22 @@ Configuration [strict | loose | disable] Set the IPv4 source validation mode. - The following system parameter will be altered: + The following sysctl parameter will be changed: * ``net.ipv4.conf.all.rp_filter`` .. cfgcmd:: set firewall global-options syn-cookies [enable | disable] - Enable or disable if VyOS uses IPv4 TCP SYN Cookies. - The following system parameter will be altered: + Allow VyOS to use IPv4 TCP SYN Cookies. + The following sysctl parameter will be changed: * ``net.ipv4.tcp_syncookies`` .. cfgcmd:: set firewall global-options twa-hazards-protection [enable | disable] - Enable or Disable VyOS to be :rfc:`1337` conformant. - The following system parameter will be altered: + Enable or disable VyOS :rfc:`1337` conformance. + The following sysctl parameter will be changed: * ``net.ipv4.tcp_rfc1337`` @@ -151,10 +150,9 @@ Configuration Set the global setting for related connections. -VyOS supports setting timeouts for connections according to the -connection type. You can set timeout values for generic connections, for ICMP -connections, UDP connections, or for TCP connections in a number of different -states. +VyOS supports setting timeouts for connections by connection type. You can +set timeout values for generic connections, ICMP connections, UDP +connections, or TCP connections in various states. .. cfgcmd:: set firewall global-options timeout icmp <1-21474836> :defaultvalue: diff --git a/docs/configuration/firewall/groups.rst b/docs/configuration/firewall/groups.rst index b1accca5..9d29866e 100644 --- a/docs/configuration/firewall/groups.rst +++ b/docs/configuration/firewall/groups.rst @@ -1,4 +1,4 @@ -:lastproofread: 2024-07-03 +:lastproofread: 2026-03-30 .. _firewall-groups-configuration: @@ -11,20 +11,20 @@ Configuration ************* Firewall groups represent collections of IP addresses, networks, ports, -mac addresses, domains or interfaces. Once created, a group can be referenced -by firewall, nat and policy route rules as either a source or destination -matcher, and/or as inbound/outbound in the case of interface group. +MAC addresses, domains, or interfaces. You can reference a group in firewall, +NAT, and policy route rules as either a source or destination matcher, and/or +as inbound or outbound in the case of interface groups. Address Groups ============== -In an **address group** a single IP address or IP address range is defined. +An **address group** contains a single IP address or IP address range. .. cfgcmd:: set firewall group address-group address [address | address range] .. cfgcmd:: set firewall group ipv6-address-group address
- Define a IPv4 or a IPv6 address group + Define an IPv4 or IPv6 address group. .. code-block:: none @@ -35,30 +35,31 @@ In an **address group** a single IP address or IP address range is defined. .. cfgcmd:: set firewall group address-group description .. cfgcmd:: set firewall group ipv6-address-group description - Provide a IPv4 or IPv6 address group description + Provide an IPv4 or IPv6 address group description. Remote Groups ============== -A **remote-group** takes an argument of a URL hosting a linebreak-deliminated -list of IPv4 and/or IPv6 addresses, CIDRs and ranges. VyOS will pull this list periodicity -according to the frequency defined in the firewall **resolver-interval** and load -matching entries into the group for use in rules. The list will be cached in -persistent storage, so in cases of update failure rules will still function. +A **remote-group** uses a URL that hosts a newline-delimited list of IPv4 +and/or IPv6 addresses, CIDRs, and ranges. VyOS pulls this list periodically +according to the frequency you define in the firewall **resolver-interval** +and loads matching entries into the group for use in rules. The list is cached +in persistent storage, so rules continue to function if updates fail. .. cfgcmd:: set firewall group remote-group url - Define remote list of IPv4 and/or IPv6 addresses/ranges/CIDRs to fetch + Specify a remote list of IPv4 and/or IPv6 addresses, ranges, and CIDRs + to fetch. .. cfgcmd:: set firewall group remote-group description - Set a description for a remote group + Set a description for a remote group. -The format of the remote list is very flexible. VyOS will attempt to parse the -first word of each line as an entry, and will skip if it cannot find a valid -match. Lines that begin with an alphanumeric character but do not match valid IPv4 -or IPv6 addresses, ranges, or CIDRs will be logged to the system log. Below is a -list of acceptable matches that would be parsed correctly: +The remote list format is flexible. VyOS attempts to parse the first word of +each line as an entry and skips lines it cannot match. Lines that begin with +an alphanumeric character but do not match valid IPv4 or IPv6 addresses, +ranges, or CIDRs are logged to the system log. The following examples show +acceptable formats that VyOS parses correctly: .. code-block:: none @@ -72,15 +73,14 @@ list of acceptable matches that would be parsed correctly: Network Groups ============== -While **network groups** accept IP networks in CIDR notation, specific -IP addresses can be added as a 32-bit prefix. If you foresee the need -to add a mix of addresses and networks, then a network group is -recommended. +**Network groups** accept IP networks in CIDR notation. You can add specific +IP addresses as a 32-bit prefix. If you need to add a mix of addresses and +networks, use a network group. .. cfgcmd:: set firewall group network-group network .. cfgcmd:: set firewall group ipv6-network-group network - Define a IPv4 or IPv6 Network group. + Define an IPv4 or IPv6 network group. .. code-block:: none @@ -100,7 +100,9 @@ An **interface group** represents a collection of interfaces. .. cfgcmd:: set firewall group interface-group interface - Define an interface group. Wildcard are accepted too. + Define an interface group. + Wildcard ``*`` is supported. For example: ``eth3*``. + Prepend the character ``!`` to invert the criteria. For example: ``!eth2``. .. code-block:: none @@ -109,22 +111,21 @@ An **interface group** represents a collection of interfaces. .. cfgcmd:: set firewall group interface-group description - Provide an interface group description + Provide an interface group description. Port Groups =========== -A **port group** represents only port numbers, not the protocol. Port -groups can be referenced for either TCP or UDP. It is recommended that -TCP and UDP groups are created separately to avoid accidentally -filtering unnecessary ports. Ranges of ports can be specified by using -`-`. +A **port group** represents only port numbers, not the protocol. You can +reference port groups for either TCP or UDP. Create TCP and UDP groups +separately to avoid accidentally filtering unnecessary ports. Specify port +ranges by using `-`. .. cfgcmd:: set firewall group port-group port [portname | portnumber | startport-endport] Define a port group. A port name can be any name defined in - /etc/services. e.g.: http + /etc/services. For example, ``http``. .. code-block:: none @@ -152,7 +153,7 @@ A **mac group** represents a collection of mac addresses. .. cfgcmd:: set firewall group mac-group description - Provide a mac group description. + Provide a MAC group description. Domain Groups ============= @@ -169,24 +170,21 @@ A **domain group** represents a collection of domains. .. cfgcmd:: set firewall group domain-group description - Provide a domain group description. + Provide a domain group description. Dynamic Groups ============== -Firewall dynamic groups are different from all the groups defined previously -because, not only they can be used as source/destination in firewall rules, -but members of these groups are not defined statically using vyos -configuration. - -Instead, members of these groups are added dynamically using firewall -rules. +Firewall dynamic groups differ from other groups because you can use them as +source/destination in firewall rules, and members are not defined statically +in VyOS configuration. Instead, firewall rules dynamically add members to +these groups. Defining Dynamic Address Groups ------------------------------- -Dynamic address group is supported by both IPv4 and IPv6 families. -Commands used to define dynamic IPv4|IPv6 address groups are: +Dynamic address groups support both IPv4 and IPv6 families. Use these +commands to define dynamic IPv4 and IPv6 address groups: .. cfgcmd:: set firewall group dynamic-group address-group .. cfgcmd:: set firewall group dynamic-group ipv6-address-group @@ -201,8 +199,8 @@ Add description to firewall groups: Adding elements to Dynamic Firewall Groups ------------------------------------------ -Once dynamic firewall groups are defined, they should be used in firewall -rules in order to dynamically add elements to it. +After you define dynamic firewall groups, use them in firewall rules to +dynamically add elements to them. Commands used for this task are: @@ -228,11 +226,11 @@ Commands used for this task are: .. cfgcmd:: set firewall ipv6 name rule <1-999999> add-address-to-group source-address address-group -Also, specific timeouts can be defined per rule. In case rule gets a hit, -a source or destinatination address will be added to the group, and this -element will remain in the group until the timeout expires. If no timeout -is defined, then the element will remain in the group until next reboot, -or until a new commit that changes firewall configuration is done. +You can define specific timeouts per rule. When a rule matches, the source or +destination address is added to the group, and the element remains in the group +until the timeout expires. If you do not define a timeout, the element remains +in the group until the next reboot or until you commit firewall configuration +changes. .. cfgcmd:: set firewall ipv4 [forward | input | output] filter rule <1-999999> add-address-to-group [destination-address | source-address] @@ -259,7 +257,7 @@ Timeout can be defined using seconds, minutes, hours or days: Using Dynamic Firewall Groups ----------------------------- -As any other firewall group, dynamic firewall groups can be used in firewall +Like other firewall groups, you can use dynamic firewall groups in firewall rules as matching options. For example: .. code-block:: none @@ -274,10 +272,9 @@ Examples General example =============== -As said before, once firewall groups are created, they can be referenced -either in firewall, nat, nat66 and/or policy-route rules. - -Here is an example were multiple groups are created: +After you create firewall groups, you can reference them in firewall, NAT, +NAT66, and/or policy-route rules. The following example creates multiple +groups: .. code-block:: none @@ -314,10 +311,9 @@ And next, some configuration example where groups are used: Port knocking example ===================== -Using dynamic firewall groups, we can secure access to the router, or any other -device if needed, by using the technique of port knocking. - -A 4 step port knocking example is shown next: +You can use dynamic firewall groups with port knocking to secure access to +the router or any other device. The following example shows a 4-step port +knocking configuration: .. code-block:: none @@ -371,11 +367,10 @@ Before testing, we can check the members of firewall groups: [edit] vyos@vyos# -With this configuration, in order to get ssh access to the router, the user -needs to: +With this configuration, to gain SSH access to the router, the user must: -1. Generate a new TCP connection with destination port 9990. As shown next, -a new entry was added to dynamic firewall group **PN_01** +1. Create a new TCP connection to destination port 9990. A new entry is added + to dynamic firewall group ``PN_01``. .. code-block:: none @@ -390,8 +385,8 @@ a new entry was added to dynamic firewall group **PN_01** [edit] vyos@vyos# -2. Generate a new TCP connection with destination port 9991. As shown next, -a new entry was added to dynamic firewall group **PN_02** +2. Create a new TCP connection to destination port 9991. A new entry is added + to dynamic firewall group ``PN_02``. .. code-block:: none @@ -406,8 +401,8 @@ a new entry was added to dynamic firewall group **PN_02** [edit] vyos@vyos# -3. Generate a new TCP connection with destination port 9992. As shown next, -a new entry was added to dynamic firewall group **ALLOWED** +3. Create a new TCP connection to destination port 9992. A new entry is added + to dynamic firewall group ``ALLOWED``. .. code-block:: none @@ -422,7 +417,8 @@ a new entry was added to dynamic firewall group **ALLOWED** [edit] vyos@vyos# -4. Now the user can connect through ssh to the router (assuming ssh is configured). +4. Now you can connect via SSH to the router (assuming SSH is + configured). ************** Operation-mode @@ -431,9 +427,9 @@ Operation-mode .. opcmd:: show firewall group .. opcmd:: show firewall group - Overview of defined groups. You see the firewall group name, type, - references (where the group is used), members, timeout and expiration (last - two only present in dynamic firewall groups). + Display an overview of defined groups, including the firewall group name, + type, references (where the group is used), members, timeout, and + expiration (the last two only apply to dynamic firewall groups). Here is an example of such command: diff --git a/docs/configuration/firewall/index.rst b/docs/configuration/firewall/index.rst index 79d59563..dc5af26f 100644 --- a/docs/configuration/firewall/index.rst +++ b/docs/configuration/firewall/index.rst @@ -1,131 +1,122 @@ -:lastproofread: 2024-08-05 +:lastproofread: 2026-03-30 ######## Firewall ######## -.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd - directives for command coverage tracking. +.. warning:: Due to a boot-time race condition, all interfaces initialize + before the firewall. This temporarily leaves the system open to all traffic + and poses a security risk. -.. warning:: Due to a race condition that can lead to a failure during boot - process, all interfaces are initialized before firewall is configured. This - leads to a situation where the system is open to all traffic, and can be - considered as a security risk. +VyOS uses Netfilter. The Netfilter +project developed ``iptables`` and its successor ``nftables`` for the Linux +kernel to process packet data flows directly. This extends the concept of +zone-based security to let you manipulate data at multiple stages after the +network interface and driver accept it, and before sending it to its +destination (for example, a web server or another device). -As VyOS is based on Linux it leverages its firewall. The Netfilter project -created iptables and its successor nftables for the Linux kernel to -work directly on packet data flows. This now extends the concept of -zone-based security to allow for manipulating the data at multiple stages once -accepted by the network interface and the driver before being handed off to -the destination (e.g., a web server OR another device). - -A simplified traffic flow diagram, based on Netfilter packet flow, is shown -next, in order to have a full view and understanding of how packets are -processed, and what possible paths traffic can take. +The following is a simplified traffic flow diagram based on Netfilter +packet flow. +This diagram provides an overview of how packets are processed and the +possible paths traffic can take. .. figure:: /_static/images/firewall-gral-packet-flow.png -The main points regarding this packet flow and terminology used in VyOS -firewall are covered below: +The main points regarding packet flow and terminology in VyOS firewall +are: - * **Bridge Port?**: choose appropriate path based on whether interface - where the packet was received is part of a bridge, or not. + * **Bridge Port?**: Choose the appropriate path based on whether the + interface where the packet was received is part of a bridge. -If the interface where the packet was received isn't part of a bridge, then +If the interface where the packet was received is not part of a bridge, the packet is processed at the **IP Layer**: - * **Prerouting**: All packets that are received by the router - are processed in this stage, regardless of the destination of the packet. - Starting from vyos-1.5-rolling-202406120020, a new section was added to - the firewall configuration. There are several actions that can be done in - this stage, and currently these actions are also defined in different - parts of the VyOS configuration. Order is important, and the relevant - configuration that acts in this stage are: + * **Prerouting**: The router processes all packets in this stage, + regardless of the destination. You can perform several actions in + this stage, and these actions are also defined in different parts of the + VyOS configuration. Order is important. The relevant configuration that + applies in this stage includes: - * **Firewall prerouting**: rules defined under ``set firewall [ipv4 | - ipv6] prerouting raw...``. All rules defined in this section are - processed before connection tracking subsystem. + * **Firewall prerouting**: Rules you define under ``set firewall + [ipv4 | ipv6] prerouting raw...``. The system processes all rules in + this section before the connection tracking subsystem. - * **Conntrack Ignore**: rules defined under ``set system conntrack ignore - [ipv4 | ipv6] ...``. Starting from vyos-1.5-rolling-202406120020, - configuration done in this section can be done in ``firewall [ipv4 | - ipv6] prerouting ...``. For compatibility reasons, this feature is - still present, but it will be removed in the future. + * **Conntrack Ignore**: Rules you define under ``set system conntrack + ignore [ipv4 | ipv6] ...``. You can configure this section with + ``firewall [ipv4 | ipv6] prerouting ...``. For compatibility reasons, + this feature is supported, but will be deprecated in the future. - * **Policy Route**: rules defined under ``set policy [route | route6] - ...``. + * **Policy Route**: Rules you define under ``set policy [route | + route6] ...``. - * **Destination NAT**: rules defined under ``set [nat | nat66] + * **Destination NAT**: Rules you define under ``set [nat | nat66] destination...``. - * **Destination is the router?**: choose an appropriate path based on - destination IP address. Transit forward continues to **forward**, - while traffic where the destination IP address is configured on the router - continues to **input**. + * **Destination is the router?**: Choose the appropriate path based on the + destination IP address. Transit traffic continues to **forward**, while + traffic destined for the router continues to **input**. - * **Input**: stage where traffic destined for the router itself can be - filtered and controlled. This is where all rules for securing the router - should take place. This includes ipv4 and ipv6 filtering rules, defined - in: + * **Input**: The stage where you filter and control traffic destined for + the router itself. This is where you enforce all rules for securing the + router. This includes IPv4 and IPv6 filtering rules, defined in: * ``set firewall ipv4 input filter ...``. * ``set firewall ipv6 input filter ...``. - * **Forward**: stage where transit traffic can be filtered and controlled. - This includes ipv4 and ipv6 filtering rules, defined in: + * **Forward**: The stage where you filter and control transit traffic. + This includes IPv4 and IPv6 filtering rules, defined in: * ``set firewall ipv4 forward filter ...``. * ``set firewall ipv6 forward filter ...``. - * **Output**: stage where traffic that originates from the router itself - can be filtered and controlled. Bear in mind that this traffic can be a - new connection originated by a internal process running on the VyOS router - such as NTP, or a response to traffic received externally through - **input** (for example response to an ssh login attempt to the router). - This includes ipv4 and ipv6 rules, and two different sections are present: + * **Output**: The stage where you filter and control traffic that the + router originates. Note that this traffic comes from either a new + connection that an internal process on the VyOS router (such as NTP) + originates or a response to traffic the router receives externally through + **input** (for example, a response to an SSH login attempt). This includes + IPv4 and IPv6 rules, and two different sections apply: - * **Output Prerouting**: ``set firewall [ipv4 | ipv6] output filter ...``. - As described in **Prerouting**, rules defined in this section are - processed before connection tracking subsystem. + * **Output Prerouting**: ``set firewall [ipv4 | ipv6] output + filter ...``. As described in **Prerouting**, the system processes + rules in this section before the connection tracking subsystem. * **Output Filter**: ``set firewall [ipv4 | ipv6] output filter ...``. - * **Postrouting**: as in **Prerouting**, several actions defined in - different parts of VyOS configuration are performed in this - stage. This includes: + * **Postrouting**: As in **Prerouting**, you can perform several actions + defined in different parts of VyOS configuration in this stage. This + includes: - * **Source NAT**: rules defined under ``set [nat | nat66] + * **Source NAT**: Rules you define under ``set [nat | nat66] destination...``. -If the interface where the packet was received is part of a bridge, then -the packet is processed at the **Bridge Layer**: +If the interface where the packet was received is part of a bridge, the +packet is processed at the **Bridge Layer**: - * **Prerouting (Bridge)**: all packets that are received by the bridge are - processed in this stage, regardless of the destination of the packet. - First filters can be applied here, and/or also configure rules for - ignoring connection tracking system. The relevant configuration that - acts in: + * **Prerouting (Bridge)**: The bridge processes all packets it receives in + this stage, regardless of the destination. First, you can apply filters + here, or you can configure rules that ignore the connection tracking + system. The relevant configuration that applies: * ``set firewall bridge prerouting filter ...``. - * **Forward (Bridge)**: stage where traffic that is trespassing through the - bridge is filtered and controlled: + * **Forward (Bridge)**: The stage where you filter and control traffic + that passes through the bridge: * ``set firewall bridge forward filter ...``. - * **Input (Bridge)**: stage where traffic destined for the bridge itself can - be filtered and controlled: + * **Input (Bridge)**: The stage where you filter and control traffic + destined for the bridge itself: * ``set firewall bridge input filter ...``. - * **Output (Bridge)**: stage where traffic that originates from the bridge - itself can be filtered and controlled: + * **Output (Bridge)**: The stage where you filter and control traffic that + the bridge originates: * ``set firewall bridge output filter ...``. -The main structure of the VyOS firewall CLI is shown next: +The following is the overall structure of the VyOS firewall CLI: .. code-block:: none @@ -185,8 +176,53 @@ The main structure of the VyOS firewall CLI is shown next: - custom_zone_name + ... -Please, refer to appropriate section for more information about firewall -configuration: +Here is a list of VyOS firewall CLI subcommands and their +corresponding pages in the documentation: + +.. cfgcmd:: set firewall bridge ... + + Configure bridge firewall rules for traffic at the bridge layer. For detailed + information, see + :doc:`Bridge Firewall Configuration`. + +.. cfgcmd:: set firewall flowtable ... + + Configure firewall flowtables for stateful connection tracking and rules. + For detailed information, see + :doc:`Flowtables Firewall Configuration ` + . + +.. cfgcmd:: set firewall global-options ... + + Configure global firewall options such as ``all-ping``, ``broadcast-ping``, + ``syn-cookies``, and other system-wide firewall settings. For detailed + information, see + :doc:`Global Firewall Options`. + +.. cfgcmd:: set firewall group ... + + Organize firewall rules by creating reusable address, network, interface, + MAC, port, and domain groups. Use groups in multiple rules to simplify + configuration and maintenance. For detailed information, see + :doc:`Firewall Groups`. + +.. cfgcmd:: set firewall ipv4 ... + + Configure IPv4-specific firewall rules. For detailed information, see + :doc:`IPv4 Firewall Configuration`. + +.. cfgcmd:: set firewall ipv6 ... + + Configure IPv6-specific firewall rules. For detailed information, see + :doc:`IPv6 Firewall Configuration`. + +.. cfgcmd:: set firewall zone ... + + Configure zone-based firewall policies for controlling traffic between + different network zones. For detailed information, see + :doc:`Zone-Based Firewall Configuration`. + +For more information on firewall configuration, see the following pages: .. toctree:: :maxdepth: 1 @@ -199,31 +235,32 @@ configuration: ipv6 flowtables -.. note:: **For more information** - of Netfilter hooks and Linux networking packet flows can be - found in `Netfilter-Hooks +.. note:: + For more information on Netfilter hooks and Linux networking packet flows, + see the `Netfilter-Hooks `_ + documentation. -Zone-based firewall +Zone-Based firewall ^^^^^^^^^^^^^^^^^^^ + .. toctree:: :maxdepth: 1 :includehidden: zone -With zone-based firewalls a new concept was implemented, in addition to the -standard in and out traffic flows, a local flow was added. This local flow was -for traffic originating and destined to the router itself. Which means that -additional rules were required to secure the firewall itself from the network, -in addition to the existing inbound and outbound rules from the traditional -concept above. +With zone-based firewalls, a new concept applies. In addition to the standard +in and out traffic flows, a local flow enables traffic originating from and +destined to the router itself. This means you must configure additional rules to +secure the firewall from the network, in addition to the existing inbound and +outbound rules. -To configure VyOS with the -:doc:`zone-based firewall configuration ` +To configure VyOS with zone-based firewall, see +:doc:`Zone-Based Firewall Configuration `. -As the example image below shows, the device now needs rules to allow/block +As the following example image shows, you must configure rules to allow or block traffic to or from the services running on the device that have open connections on that interface. diff --git a/docs/configuration/firewall/ipv4.rst b/docs/configuration/firewall/ipv4.rst index a9435fa8..0bac7e92 100644 --- a/docs/configuration/firewall/ipv4.rst +++ b/docs/configuration/firewall/ipv4.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-02-14 +:lastproofread: 2026-03-30 .. _firewall-ipv4-configuration: @@ -10,16 +10,14 @@ IPv4 Firewall Configuration Overview ******** -In this section there's useful information on all firewall configuration that -can be done regarding IPv4, and appropriate op-mode commands. -Configuration commands covered in this section: +This section provides information on IPv4 firewall configuration and +appropriate operation-mode commands. This section covers the following +configuration commands: .. cfgcmd:: set firewall ipv4 ... -From the main structure defined in -:doc:`Firewall Overview` -in this section you can find detailed information only for the next part -of the general structure: +To learn about the general traffic flow in VyOS firewalls, +see :doc:`Firewall `. .. code-block:: none @@ -37,8 +35,8 @@ of the general structure: - name + custom_name -First, all traffic is received by the router, and it is processed in the -**prerouting** section. +First, the router receives all traffic and processes it in the **prerouting** +stage. This stage includes: @@ -52,79 +50,78 @@ This stage includes: ``set nat destination ...`` For transit traffic, which is received by the router and forwarded, the base -chain is **forward**. A simplified packet flow diagram for transit traffic is -shown next: +chain is **forward**. The following is a simplified packet flow diagram for +transit traffic: .. figure:: /_static/images/firewall-fwd-packet-flow.png -The base firewall chain to configure filtering rules for transit traffic -is ``set firewall ipv4 forward filter ...``, which happens in stage 5, -highlighted in the color red. +The base firewall chain for configuring filtering rules for transit traffic is +``set firewall ipv4 forward filter ...``, which occurs in stage 5, highlighted +in red. -For traffic towards the router itself, the base chain is **input**, while -traffic originated by the router has the base chain **output**. -A new simplified packet flow diagram is shown next, which shows the path -for traffic destined to the router itself, and traffic generated by the -router (starting from circle number 6): +For traffic to the router itself, the base chain is **input**. For traffic +the router originates, the base chain is **output**. A simplified packet flow +diagram is shown next, which shows the path for traffic destined to the router +itself and traffic the router generates (starting from circle number 6): .. figure:: /_static/images/firewall-input-packet-flow.png -The base chain for traffic towards the router is ``set firewall ipv4 input -filter ...`` +The base chain for traffic towards the router is +``set firewall ipv4 input filter ...`` -And the base chain for traffic generated by the router is ``set firewall ipv4 +The base chain for traffic the router generates is ``set firewall ipv4 output ...``, where two sub-chains are available: **filter** and **raw**: -* **Output Prerouting**: ``set firewall ipv4 output raw ...``. - As described in **Prerouting**, rules defined in this section are - processed before connection tracking subsystem. -* **Output Filter**: ``set firewall ipv4 output filter ...``. Rules defined - in this section are processed after connection tracking subsystem. +* **Output Prerouting**: ``set firewall ipv4 output raw ...``. As described + in **Prerouting**, the system processes rules in this section before the + connection tracking subsystem. +* **Output Filter**: ``set firewall ipv4 output filter ...``. The system + processes rules in this section after the connection tracking subsystem. .. note:: **Important note about default-actions:** - If a default action for any base chain is not defined, then the default - action is set to **accept** for that chain. For custom chains, if the - default action is not defined, then the default-action is set to **drop** + If you do not define a default action for a base chain, the system sets + the default action to **accept** for that chain. For custom chains, if you + do not define a default action, the system sets the default-action to + **drop**. -Custom firewall chains can be created, with commands -``set firewall ipv4 name ...``. In order to use -such custom chain, a rule with **action jump**, and the appropriate **target** -should be defined in a base chain. +You can create custom firewall chains using the following commands: +``set firewall ipv4 name ...``. To use a custom chain, you must define +a rule with the **action jump** and the appropriate **target** in a base +chain. ********************* Firewall - IPv4 Rules ********************* -For firewall filtering, firewall rules need to be created. Each rule is -numbered, has an action to apply if the rule is matched, and the ability -to specify multiple matching criteria. Data packets go through the rules -from 1 - 999999, so order is crucial. At the first match the action of the -rule will be executed. +Each firewall rule has a +number, an action to apply if the rule matches, and the ability to specify +multiple matching criteria. Packets traverse rules numbered 1-999999, so order +is crucial. The system executes the rule action at the first match. Actions ======= -If a rule is defined, then an action must be defined for it. This tells the -firewall what to do if all of the criteria defined for that rule match. +If you define a rule, you must define an action for it. The action tells the +firewall what to do if all the criteria you define for that rule are met. -The action can be : +The action can be: - * ``accept``: accept the packet. + * ``accept``: Accept the packet. - * ``continue``: continue parsing next rule. + * ``continue``: Continue parsing the next rule. - * ``drop``: drop the packet. + * ``drop``: Drop the packet. - * ``reject``: reject the packet. + * ``reject``: Reject the packet. - * ``jump``: jump to another custom chain. + * ``jump``: Jump to another custom chain. * ``return``: Return from the current chain and continue at the next rule of the last chain. * ``queue``: Enqueue packet to userspace. - * ``synproxy``: synproxy the packet. + * ``synproxy``: Synproxy the packet. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> action [accept | continue | drop | jump | queue | reject | return | synproxy] @@ -135,8 +132,8 @@ The action can be : .. cfgcmd:: set firewall ipv4 name rule <1-999999> action [accept | continue | drop | jump | queue | reject | return] - This required setting defines the action of the current rule. If the action - is set to jump, then a jump-target is also needed. + This required setting defines the action of the current rule. If you set + the action to jump, you must also specify a jump-target. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> jump-target @@ -147,8 +144,8 @@ The action can be : .. cfgcmd:: set firewall ipv4 name rule <1-999999> jump-target - To be used only when action is set to ``jump``. Use this command to specify - the jump target. + Use this command only when the action is set to ``jump``. Specify the + jump target. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> queue <0-65535> @@ -159,8 +156,8 @@ The action can be : .. cfgcmd:: set firewall ipv4 name rule <1-999999> queue <0-65535> - To be used only when action is set to ``queue``. Use this command to specify - the queue target to use. Queue range is also supported. + Use this command only when the action is set to ``queue``. Specify the + queue target to use. Queue range is also supported. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> queue-options bypass @@ -171,8 +168,8 @@ The action can be : .. cfgcmd:: set firewall ipv4 name rule <1-999999> queue-options bypass - To be used only when action is set to ``queue``. Use this command to let the - packet go through firewall when no userspace software is connected to the + Use this command only when the action is set to ``queue``. Allow the packet + to pass through the firewall when no userspace software is connected to the queue. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> @@ -184,11 +181,11 @@ The action can be : .. cfgcmd:: set firewall ipv4 name rule <1-999999> queue-options fanout - To be used only when action is set to ``queue``. Use this command to - distribute packets between several queues. + Use this command only when the action is set to ``queue``. Distribute + packets between several queues. -Also, **default-action** is an action that takes place whenever a packet does -not match any rule in its chain. For base chains, possible options for +Also, **default-action** is an action that applies when a packet does not +match any rule in its chain. For base chains, possible options for **default-action** are **accept** or **drop**. .. cfgcmd:: set firewall ipv4 forward filter default-action @@ -200,43 +197,44 @@ not match any rule in its chain. For base chains, possible options for .. cfgcmd:: set firewall ipv4 name default-action [accept | drop | jump | queue | reject | return] - This sets the default action of the rule-set if a packet does not match the - criteria of any rule. If default-action is set to ``jump``, then - ``default-jump-target`` is also needed. Note that for base chains, the - default action can only be set to ``accept`` or ``drop``, while on custom - chains, more actions are available. + This command sets the default action of the rule-set if a packet does not + match the criteria of any rule. If you set the default-action to ``jump``, + you must also specify ``default-jump-target``. Note that for base chains, + you can set the default action only to ``accept`` or ``drop``, while on + custom chains, more actions are available. .. cfgcmd:: set firewall ipv4 name default-jump-target - To be used only when ``default-action`` is set to ``jump``. Use this - command to specify the jump target for the default rule. + Use this command only when you set ``default-action`` to ``jump``. Specify + the jump target for the default rule. .. note:: **Important note about default-actions:** - If the default action for any base chain is not defined, then the default - action is set to **accept** for that chain. For custom chains if a default - action is not defined then the default-action is set to **drop**. + If you do not define a default action for a base chain, the system sets + the default action to **accept** for that chain. For custom chains, if you + do not define a default action, the system sets the default-action to + **drop**. Firewall Logs ============= -Logging can be enabled for every single firewall rule. If enabled, other -log options can be defined. +You can enable logging for every single firewall rule. If you enable logging, +you can define other log options. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> log .. cfgcmd:: set firewall ipv4 input filter rule <1-999999> log .. cfgcmd:: set firewall ipv4 output filter rule <1-999999> log .. cfgcmd:: set firewall ipv4 name rule <1-999999> log - Enable logging for the matched packet. If this configuration command is not - present, then the log is not enabled. + Enable logging for the matched packet. If this command is not present, then + logging is not enabled. .. cfgcmd:: set firewall ipv4 forward filter default-log .. cfgcmd:: set firewall ipv4 input filter default-log .. cfgcmd:: set firewall ipv4 output filter default-log .. cfgcmd:: set firewall ipv4 name default-log - Use this command to enable the logging of the default action on - the specified chain. + Use this command to enable logging of the default action on the specified + chain. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> log-options level [emerg | alert | crit | err | warn | notice @@ -251,7 +249,7 @@ log options can be defined. log-options level [emerg | alert | crit | err | warn | notice | info | debug] - Define log-level. Only applicable if rule log is enabled. + Define the log level. Only applicable if you enable rule logging. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> log-options group <0-65535> @@ -262,8 +260,8 @@ log options can be defined. .. cfgcmd:: set firewall ipv4 name rule <1-999999> log-options group <0-65535> - Define the log group to send messages to. Only applicable if rule log is - enabled. + Define the log group to send messages to. Only applicable if you enable rule + logging. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> log-options snapshot-length <0-9000> @@ -275,7 +273,7 @@ log options can be defined. log-options snapshot-length <0-9000> Define the length of packet payload to include in a netlink message. Only - applicable if rule log is enabled and log group is defined. + applicable if you enable rule logging and define the log group. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> log-options queue-threshold <0-65535> @@ -287,17 +285,18 @@ log options can be defined. log-options queue-threshold <0-65535> Define the number of packets to queue inside the kernel before sending them - to userspace. Only applicable if rule log is enabled and log group is defined. + to userspace. Only applicable if you enable rule logging and define the log + group. Firewall Description ==================== -For reference, a description can be defined for every single rule, and for -every defined custom chain. +You can add a description for reference for every single rule and for every +defined custom chain. .. cfgcmd:: set firewall ipv4 name description - Provide a rule-set description to a custom firewall chain. + Provide a rule-set description for a custom firewall chain. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> description @@ -312,15 +311,15 @@ every defined custom chain. Rule Status =========== -When defining a rule, it is enabled by default. In some cases, it is useful to -just disable the rule, rather than removing it. +When you define a rule, it is enabled by default. In some cases, it is useful +to disable the rule rather than removing it. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> disable .. cfgcmd:: set firewall ipv4 input filter rule <1-999999> disable .. cfgcmd:: set firewall ipv4 output filter rule <1-999999> disable .. cfgcmd:: set firewall ipv4 name rule <1-999999> disable - Command for disabling a rule but keep it in the configuration. + Command for disabling a rule but keeping it in the configuration. Matching criteria ================= @@ -727,9 +726,9 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> inbound-interface name - Match based on inbound interface. Wildcard ``*`` can be used. - For example: ``eth2*``. Prepending the character ``!`` to invert the - criteria to match is also supported. For example ``!eth2`` + Match based on inbound interface. Wildcard ``*`` is supported. For example: + ``eth2*``. Prepend the character ``!`` to invert the criteria. For example: + ``!eth2`` .. note:: If an interface is attached to a non-default vrf, when using **inbound-interface**, the vrf name must be used. For example ``set firewall @@ -742,8 +741,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> inbound-interface group - Match based on the inbound interface group. Prepending the character ``!`` - to invert the criteria to match is also supported. For example ``!IFACE_GROUP`` + Match based on the inbound interface group. Prepend the character ``!`` to + invert the criteria. For example, ``!IFACE_GROUP`` .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> outbound-interface name @@ -752,9 +751,9 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> outbound-interface name - Match based on outbound interface. Wildcard ``*`` can be used. - For example: ``eth2*``. Prepending the character ``!`` to invert the - criteria to match is also supported. For example ``!eth2`` + Match based on outbound interface. Wildcard ``*`` is supported. For example: + ``eth2*``. Prepend the character ``!`` to invert the criteria. For example: + ``!eth2`` .. note:: If an interface is attached to a non-default vrf, when using **outbound-interface**, the real interface name must be used. For example @@ -767,8 +766,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> outbound-interface group - Match based on outbound interface group. Prepending the character ``!`` to - invert the criteria to match is also supported. For example ``!IFACE_GROUP`` + Match based on outbound interface group. Prepend the character ``!`` to + invert the criteria. For example: ``!IFACE_GROUP`` .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> ipsec [match-ipsec-in | match-ipsec-out | match-none-in | match-none-out] @@ -801,8 +800,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> limit rate - Match based on the maximum average rate, specified as **integer/unit**. - For example **5/minutes** + Specify the maximum average rate as **integer/unit**. For example: + **5/minutes** .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> packet-length @@ -822,8 +821,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> packet-length-exclude - Match based on the packet length. Multiple values from 1 to 65535 - and ranges are supported. + Match based on packet length. Specify multiple values from 1 to 65535 and + ranges. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> packet-type [broadcast | host | multicast | other] @@ -846,13 +845,13 @@ geoip) to keep database and rules updated. protocol [ | <0-255> | all | tcp_udp] Match based on protocol number or name as defined in ``/etc/protocols``. - Special names are ``all`` for all protocols and ``tcp_udp`` for tcp and udp - based packets. The ``!`` negates the selected protocol. + Special names are ``all`` for all protocols and ``tcp_udp`` for TCP and UDP + based packets. The ``!`` character negates the selected protocol. .. code-block:: none - set firewall ipv4 forward fitler rule 10 protocol tcp_udp - set firewall ipv4 forward fitler rule 11 protocol !tcp_udp + set firewall ipv4 forward filter rule 10 protocol tcp_udp + set firewall ipv4 forward filter rule 11 protocol !tcp_udp .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> recent count <1-255> @@ -883,9 +882,9 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> tcp flags [not] - Allowed values fpr TCP flags: ``ack``, ``cwr``, ``ecn``, ``fin``, ``psh``, - ``rst``, ``syn`` and ``urg``. Multiple values are supported, and for - inverted selection use ``not``, as shown in the example. + Specify TCP flags. Allowed values are ``ack``, ``cwr``, ``ecn``, ``fin``, + ``psh``, ``rst``, ``syn``, and ``urg``. Specify multiple values, and use + ``not`` for inverted selection, as shown in the example. .. code-block:: none @@ -956,8 +955,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> ttl <0-255> - Match the time to live parameter, where 'eq' stands for 'equal'; 'gt' stands - for 'greater than', and 'lt' stands for 'less than'. + Match the time to live parameter, where 'eq' means 'equal', 'gt' means + 'greater than', and 'lt' means 'less than'. .. cfgcmd:: set firewall ipv4 forward filter rule <1-999999> recent count <1-255> @@ -977,14 +976,14 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv4 name rule <1-999999> recent time - Match when 'count' amount of connections are seen within 'time'. These - matching criteria can be used to block brute-force attempts. + Match when 'count' amount of connections appear within 'time'. Use these + matching criteria to block brute-force attempts. Packet Modifications ==================== Starting from **VyOS-1.5-rolling-202410060007**, the firewall can modify -packets before they are sent out. This feaure provides more flexibility in +packets before sending them out. This feature provides more flexibility in packet handling. .. cfgcmd:: set firewall ipv4 prerouting raw rule <1-999999> @@ -1053,9 +1052,9 @@ Example synproxy ================ Requirements to enable synproxy: - * Traffic must be symmetric - * Synproxy relies on syncookies and TCP timestamps, ensure these are enabled - * Disable conntrack loose track option + * Traffic must be symmetric. + * Synproxy relies on syncookies and TCP timestamps, ensure these are enabled. + * Disable conntrack loose track option. .. code-block:: none @@ -1085,8 +1084,8 @@ Rule-set overview .. opcmd:: show firewall - This will show you a basic firewall overview, for all rule-sets, and not - only for ipv4 + This will show you a basic firewall overview, for all rule-sets, not + only for IPv4. .. code-block:: none @@ -1140,7 +1139,7 @@ Rule-set overview .. opcmd:: show firewall summary - This will show you a summary of rule-sets and groups + This shows you a summary of rule-sets and groups. .. code-block:: none @@ -1215,7 +1214,7 @@ Rule-set overview filter rule <1-999999> .. opcmd:: show firewall ipv4 name rule <1-999999> - This command will give an overview of a rule in a single rule-set, plus + This command gives an overview of a rule in a single rule-set, plus information for default action. .. code-block:: none @@ -1249,9 +1248,9 @@ Show Firewall log .. opcmd:: show log firewall ipv4 [forward | input | output] filter rule .. opcmd:: show log firewall ipv4 name rule - Show the logs of all firewall; show all ipv4 firewall logs; show all logs + Show the logs of all firewall; show all IPv4 firewall logs; show all logs for particular hook; show all logs for particular hook and priority; - show all logs for particular custom chain; show logs for specific Rule-Set. + show all logs for particular custom chain; show logs for specific rule-set. Example Partial Config ====================== @@ -1303,4 +1302,4 @@ Update geoip database .. opcmd:: update geoip - Command used to update GeoIP database and firewall sets. + Command to update GeoIP database and firewall sets. diff --git a/docs/configuration/firewall/ipv6.rst b/docs/configuration/firewall/ipv6.rst index 95502f4a..b1249e3d 100644 --- a/docs/configuration/firewall/ipv6.rst +++ b/docs/configuration/firewall/ipv6.rst @@ -1,4 +1,4 @@ -:lastproofread: 2025-02-14 +:lastproofread: 2026-04-01 .. _firewall-ipv6-configuration: @@ -10,16 +10,15 @@ IPv6 Firewall Configuration Overview ******** -In this section there's useful information on all firewall configuration that -can be done regarding IPv6, and appropriate op-mode commands. -Configuration commands covered in this section: +This section covers useful information about IPv6 firewall configuration and +appropriate operation-mode commands. + +This section describes the following configuration commands: .. cfgcmd:: set firewall ipv6 ... -From the main structure defined in -:doc:`Firewall Overview` -in this section you can find detailed information only for the next part -of the general structure: +To learn about the general traffic flow in VyOS firewalls, +see :doc:`Firewall `. .. code-block:: none @@ -37,8 +36,8 @@ of the general structure: - name + custom_name -First, all traffic is received by the router, and it is processed in the -**prerouting** section. +The router first receives all traffic and processes it in the **prerouting** +section. This stage includes: @@ -51,61 +50,59 @@ This stage includes: * :doc:`Destination NAT`: commands found under ``set nat66 destination ...`` -For transit traffic, which is received by the router and forwarded, the base -chain is **forward**. A simplified packet flow diagram for transit traffic is -shown next: +For transit traffic that the router receives and forwards, the base chain is +**forward**. The following diagram shows a simplified packet flow for transit +traffic: .. figure:: /_static/images/firewall-fwd-packet-flow.png -The base firewall chain to configure filtering rules for transit traffic -is ``set firewall ipv6 forward filter ...``, which happens in stage 5, -highlighted in the color red. +Use ``set firewall ipv6 forward filter ...`` to configure filtering rules for +transit traffic. This command corresponds to stage 5 and is highlighted in red +in the diagram. -For traffic towards the router itself, the base chain is **input**, while -traffic originated by the router has the base chain **output**. -A new simplified packet flow diagram is shown next, which shows the path -for traffic destined to the router itself, and traffic generated by the +For traffic destined to the router, use the **input** chain. For traffic the +router generates, use the **output** chain. The following diagram shows the +packet flow for traffic destined to the router and traffic generated by the router (starting from circle number 6): .. figure:: /_static/images/firewall-input-packet-flow.png -The base chain for traffic towards the router is ``set firewall ipv6 input -filter ...`` +Use ``set firewall ipv6 input filter ...`` to configure traffic destined to +the router. -And the base chain for traffic generated by the router is ``set firewall ipv6 -output ...``, where two sub-chains are available: **filter** and **raw**: +Use ``set firewall ipv6 output ...`` to configure traffic the router generates. +Two sub-chains are available: **filter** and **raw**: * **Output Prerouting**: ``set firewall ipv6 output raw ...``. - As described in **Prerouting**, rules defined in this section are - processed before connection tracking subsystem. -* **Output Filter**: ``set firewall ipv6 output filter ...``. Rules defined - in this section are processed after connection tracking subsystem. + As described in **Prerouting**, the firewall processes rules in this + section before the connection tracking subsystem. +* **Output Filter**: ``set firewall ipv6 output filter ...``. The firewall + processes rules in this section after the connection tracking subsystem. .. note:: **Important note about default-actions:** - If a default action for any base chain is not defined, then the default - action is set to **accept** for that chain. For custom chains, if the - default action is not defined, then the default-action is set to **drop** + If you do not define a default action for a base chain, the system sets + the default action to **accept** for that chain. For custom chains, if you + do not define a default action, the system sets the default-action to + **drop** -Custom firewall chains can be created, with commands -``set firewall ipv6 name ...``. In order to use -such custom chain, a rule with **action jump**, and the appropriate **target** -should be defined in a base chain. +Create custom firewall chains using the commands +``set firewall ipv6 name ...``. To use the custom chain, define a +rule with **action jump** and the appropriate **target** in a base chain. ****************************** Firewall - IPv6 Rules ****************************** -For firewall filtering, firewall rules need to be created. Each rule is -numbered, has an action to apply if the rule is matched, and the ability -to specify multiple matching criteria. Data packets go through the rules -from 1 - 999999, so order is crucial. At the first match the action of the -rule will be executed. +Create firewall rules for firewall filtering. Each rule is numbered and has +an action to apply when the rule is matched. You can specify multiple matching +criteria. Packets go through rules from 1 - 999999, so order is crucial. The +firewall executes the action of the first matching rule. Actions ======= -If a rule is defined, then an action must be defined for it. This tells the -firewall what to do if all of the criteria defined for that rule match. +If you define a rule, you must define an action for it. The action tells the +firewall what to do when all criteria for that rule are met. The action can be : @@ -135,8 +132,8 @@ The action can be : .. cfgcmd:: set firewall ipv6 name rule <1-999999> action [accept | continue | drop | jump | queue | reject | return] - This required setting defines the action of the current rule. If the action - is set to jump, then a jump-target is also needed. + This required setting defines the action of the current rule. If you set + the action to jump, you must also define a jump-target. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> jump-target @@ -147,8 +144,8 @@ The action can be : .. cfgcmd:: set firewall ipv6 name rule <1-999999> jump-target - To be used only when action is set to ``jump``. Use this command to specify - the jump target. + Use this command only when action is set to ``jump``. Specify the jump + target. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> queue <0-65535> @@ -159,8 +156,8 @@ The action can be : .. cfgcmd:: set firewall ipv6 name rule <1-999999> queue <0-65535> - To be used only when action is set to ``queue``. Use this command to specify - the queue target to use. Queue range is also supported. + Use this command only when action is set to ``queue``. Specify the queue + target. Queue ranges are also supported. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> queue-options bypass @@ -171,9 +168,9 @@ The action can be : .. cfgcmd:: set firewall ipv6 name rule <1-999999> queue-options bypass - To be used only when action is set to ``queue``. Use this command to let the - packet go through firewall when no userspace software is connected to the - queue. + Use this command only when action is set to ``queue``. This command allows + the packet to go through the firewall when no userspace software is connected + to the queue. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> queue-options fanout @@ -184,8 +181,8 @@ The action can be : .. cfgcmd:: set firewall ipv6 name rule <1-999999> queue-options fanout - To be used only when action is set to ``queue``. Use this command to - distribute packets between several queues. + Use this command only when action is set to ``queue``. This command + distributes packets among multiple queues. Also, **default-action** is an action that takes place whenever a packet does not match any rule in its chain. For base chains, possible options for @@ -200,11 +197,11 @@ not match any rule in its chain. For base chains, possible options for .. cfgcmd:: set firewall ipv6 name default-action [accept | drop | jump | queue | reject | return] - This sets the default action of the rule-set if a packet does not match the - criteria of any rule. If default-action is set to ``jump``, then - ``default-jump-target`` is also needed. Note that for base chains, the - default action can only be set to ``accept`` or ``drop``, while on custom - chains, more actions are available. + Set the default action of the rule-set if a packet does not match any rule + criteria. If you set default-action to ``jump``, you must also define + ``default-jump-target``. For base chains, you can only set the default + action to ``accept`` or ``drop``. For custom chains, more actions are + available. .. cfgcmd:: set firewall ipv6 name default-jump-target @@ -212,23 +209,24 @@ not match any rule in its chain. For base chains, possible options for command to specify the jump target for the default rule. .. note:: **Important note about default-actions:** - If the default action for any base chain is not defined, then the default - action is set to **accept** for that chain. For custom chains if a default - action is not defined then the default-action is set to **drop**. + If you do not define the default action for a base chain, the system sets + the default action to **accept** for that chain. For custom chains, if you + do not define a default action, the system sets the default-action to + **drop**. Firewall Logs ============= -Logging can be enabled for every single firewall rule. If enabled, other -log options can be defined. +You can enable logging for each firewall rule. When enabled, you can also +define other log options. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> log .. cfgcmd:: set firewall ipv6 input filter rule <1-999999> log .. cfgcmd:: set firewall ipv6 output filter rule <1-999999> log .. cfgcmd:: set firewall ipv6 name rule <1-999999> log - Enable logging for the matched packet. If this configuration command is not - present, then the log is not enabled. + Enable logging for matched packets. If this configuration command is not + present, logging is disabled. .. cfgcmd:: set firewall ipv6 forward filter default-log .. cfgcmd:: set firewall ipv6 input filter default-log @@ -275,7 +273,7 @@ log options can be defined. log-options snapshot-length <0-9000> Define the length of packet payload to include in a netlink message. Only - applicable if rule log is enabled and log group is defined. + applicable when rule logging is enabled and log group is defined. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> log-options queue-threshold <0-65535> @@ -287,13 +285,13 @@ log options can be defined. log-options queue-threshold <0-65535> Define the number of packets to queue inside the kernel before sending them - to userspace. Only applicable if rule log is enabled and log group is defined. + to userspace. Only applicable when rule logging is enabled and log group is + defined. Firewall Description ==================== -For reference, a description can be defined for every single rule, and for -every defined custom chain. +For reference, you can define descriptions on every rule and custom chain. .. cfgcmd:: set firewall ipv6 name description @@ -312,8 +310,8 @@ every defined custom chain. Rule Status =========== -When defining a rule, it is enabled by default. In some cases, it is useful to -just disable the rule, rather than removing it. +New rules are enabled by default. In some cases, you may want to disable a +rule rather than remove it. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> disable .. cfgcmd:: set firewall ipv6 input filter rule <1-999999> disable @@ -336,7 +334,7 @@ There are a lot of matching criteria against which the packet can be tested. .. cfgcmd:: set firewall ipv6 name rule <1-999999> connection-status nat [destination | source] - Match based on nat connection status. + Match packets based on NAT connection status. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> connection-mark <1-2147483647> @@ -347,7 +345,7 @@ There are a lot of matching criteria against which the packet can be tested. .. cfgcmd:: set firewall ipv6 name rule <1-999999> connection-mark <1-2147483647> - Match based on connection mark. + Match packets based on connection mark. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source address [address | addressrange | CIDR] @@ -367,8 +365,8 @@ There are a lot of matching criteria against which the packet can be tested. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination address [address | addressrange | CIDR] - Match based on source and/or destination address. This is similar to the - network groups part, but here you are able to negate the matching addresses. + Match based on source or destination address. This is similar to network + groups, but you can negate the matching addresses here. .. code-block:: none @@ -392,15 +390,14 @@ There are a lot of matching criteria against which the packet can be tested. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination address-mask [address] - An arbitrary netmask can be applied to mask addresses to only match against - a specific portion. This is particularly useful with IPv6 as rules will - remain valid if the IPv6 prefix changes and the host - portion of systems IPv6 address is static (for example, with SLAAC or - `tokenised IPv6 addresses - `_) + Apply an arbitrary netmask to mask addresses and match only a specific + portion. This is useful for IPv6 because rules remain valid when the IPv6 + prefix changes if the host portion of the system's IPv6 address is static. + Examples include SLAAC and `tokenised IPv6 addresses + `_ - This functions for both individual addresses and address groups. + This function works for both individual addresses and address groups. .. stop_vyoslinter .. code-block:: none @@ -433,8 +430,8 @@ There are a lot of matching criteria against which the packet can be tested. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination fqdn - Specify a Fully Qualified Domain Name as source/destination to match. Ensure - that the router is able to resolve this dns query. + Specify a Fully Qualified Domain Name as source or destination to match. + Ensure that the router can resolve the DNS query. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source geoip country-code @@ -472,14 +469,16 @@ There are a lot of matching criteria against which the packet can be tested. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination geoip inverse-match - Match IP addresses based on its geolocation. More info: `geoip matching - `_. - Use inverse-match to match anything except the given country-codes. + Match IP addresses based on their geolocation. For more information, see + `GeoIP matching `_. Use inverse-match to match anything except the specified + country codes. -Data is provided by DB-IP.com under CC-BY-4.0 license. Attribution required, -permits redistribution so we can include a database in images(~3MB -compressed). Includes cron script (manually callable by op-mode update -geoip) to keep database and rules updated. +DB-IP.com provides data under CC-BY-4.0 license. Attribution is required and +redistribution is permitted, allowing VyOS to include a database in images +(approximately 3 MB compressed). The package includes a cron script that you +can manually call through op-mode update geoip to keep the database and rules +updated. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> @@ -491,7 +490,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> source mac-address - You can only specify a source mac-address to match. + You can specify only a source MAC address to match. .. code-block:: none @@ -516,7 +515,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination port [1-65535 | portname | start-end] - A port can be set by number or name as defined in ``/etc/services``. + Specify a port by number or by name as defined in ``/etc/services``. .. code-block:: none @@ -549,8 +548,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination group address-group - Use a specific address-group. Prepending the character ``!`` to invert the - criteria to match is also supported. + Specify an address group. You can prepend the character ``!`` to invert the + matching criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source group dynamic-address-group @@ -570,8 +569,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination group dynamic-address-group - Use a specific dynamic-address-group. Prepending the character ``!`` to - invert the criteria to match is also supported. + Specify a dynamic address group. You can prepend the character ``!`` to + invert the matching criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source group network-group @@ -591,8 +590,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination group network-group - Use a specific network-group. Prepending the character ``!`` to invert the - criteria to match is also supported. + Specify a network group. You can prepend the character ``!`` to invert the + matching criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source group port-group @@ -612,8 +611,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination group port-group - Use a specific port-group. Prepending the character ``!`` to invert the - criteria to match is also supported. + Specify a port group. You can prepend the character ``!`` to invert the + matching criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source group domain-group @@ -633,8 +632,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination group domain-group - Use a specific domain-group. Prepending the character ``!`` to invert the - criteria to match is also supported. + Specify a domain group. You can prepend the character ``!`` to invert the + matching criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> source group mac-group @@ -654,8 +653,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> destination group mac-group - Use a specific mac-group. Prepending the character ``!`` to invert the - criteria to match is also supported. + Specify a MAC group. You can prepend the character ``!`` to invert the + matching criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> dscp [0-63 | start-end] @@ -686,7 +685,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> fragment [match-frag | match-non-frag] - Match based on fragmentation. + Match packets based on fragmentation. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> icmpv6 [code | type] <0-255> @@ -697,7 +696,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> icmpv6 [code | type] <0-255> - Match based on icmp|icmpv6 code and type. + Match packets based on ICMP or ICMPv6 code and type. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> icmpv6 type-name @@ -708,8 +707,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> icmpv6 type-name - Match based on icmpv6 type-name. Use tab for information - about what **type-name** criteria are supported. + Match based on ICMPv6 type-name. Press **Tab** for information about + supported **type-name** criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> inbound-interface name @@ -718,13 +717,13 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> inbound-interface name - Match based on inbound interface. Wildcard ``*`` can be used. - For example: ``eth2*``. Prepending the character ``!`` to invert the - criteria to match is also supported. For example ``!eth2`` + Match based on inbound interface. You can use the wildcard ``*``. For + example: ``eth2*``. You can prepend the character ``!`` to invert the + matching criteria. For example ``!eth2`` -.. note:: If an interface is attached to a non-default vrf, when using - **inbound-interface**, the vrf name must be used. For example ``set firewall - ipv6 forward filter rule 10 inbound-interface name MGMT`` +.. note:: If an interface is attached to a non-default VRF, when using + **inbound-interface**, use the VRF name. For example: + ``set firewall ipv6 forward filter rule 10 inbound-interface name MGMT`` .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> inbound-interface group @@ -733,8 +732,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> inbound-interface group - Match based on the inbound interface group. Prepending the character ``!`` - to invert the criteria to match is also supported. For example ``!IFACE_GROUP`` + Match based on the inbound interface group. You can prepend the character + ``!`` to invert the matching criteria. For example ``!IFACE_GROUP`` .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> outbound-interface name @@ -743,12 +742,12 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> outbound-interface name - Match based on outbound interface. Wildcard ``*`` can be used. - For example: ``eth2*``. Prepending the character ``!`` to invert the - criteria to match is also supported. For example ``!eth2`` + Match based on outbound interface. You can use the wildcard ``*``. For + example: ``eth2*``. You can prepend the character ``!`` to invert the + matching criteria. For example ``!eth2`` -.. note:: If an interface is attached to a non-default vrf, when using - **outbound-interface**, the real interface name must be used. For example +.. note:: If an interface is attached to a non-default VRF, when using + **outbound-interface**, use the physical interface name. For example: ``set firewall ipv6 forward filter rule 10 outbound-interface name eth0`` .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> @@ -758,8 +757,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> outbound-interface group - Match based on outbound interface group. Prepending the character ``!`` to - invert the criteria to match is also supported. For example ``!IFACE_GROUP`` + Match based on outbound interface group. You can prepend the character ``!`` + to invert the matching criteria. For example ``!IFACE_GROUP`` .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> ipsec [match-ipsec-in | match-ipsec-out | match-none-in | match-none-out] @@ -770,7 +769,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> ipsec [match-ipsec-in | match-ipsec-out | match-none-in | match-none-out] - Match based on ipsec. + Match packets based on IPsec. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> limit burst <0-4294967295> @@ -781,7 +780,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> limit burst <0-4294967295> - Match based on the maximum number of packets to allow in excess of rate. + Match based on the maximum number of packets allowed to exceed the rate + limit. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> limit rate @@ -792,8 +792,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> limit rate - Match based on the maximum average rate, specified as **integer/unit**. - For example **5/minutes** + Match based on the maximum average rate, specified as ``integer/unit``. + For example, specify ``5/minutes``. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> packet-length @@ -813,8 +813,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> packet-length-exclude - Match based on the packet length. Multiple values from 1 to 65535 - and ranges are supported. + Match based on packet length. You can specify multiple values from 1 to + 65535 and ranges. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> packet-type [broadcast | host | multicast | other] @@ -825,7 +825,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> packet-type [broadcast | host | multicast | other] - Match based on the packet type. + Match based on packet type. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> protocol [ | <0-255> | all | tcp_udp] @@ -837,8 +837,8 @@ geoip) to keep database and rules updated. protocol [ | <0-255> | all | tcp_udp] Match based on protocol number or name as defined in ``/etc/protocols``. - Special names are ``all`` for all protocols and ``tcp_udp`` for tcp and udp - based packets. The ``!`` negates the selected protocol. + Specify ``all`` for all protocols and ``tcp_udp`` for TCP and UDP packets. + Prepend ``!`` to negate the protocol selection. .. code-block:: none @@ -862,7 +862,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> recent time [second | minute | hour] - Match bases on recently seen sources. + Match packets based on recently seen sources. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> tcp flags [not] @@ -873,9 +873,9 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> tcp flags [not] - Allowed values fpr TCP flags: ``ack``, ``cwr``, ``ecn``, ``fin``, ``psh``, - ``rst``, ``syn`` and ``urg``. Multiple values are supported, and for - inverted selection use ``not``, as shown in the example. + Allowed values for TCP flags: ``ack``, ``cwr``, ``ecn``, ``fin``, ``psh``, + ``rst``, ``syn``, and ``urg``. You can specify multiple values. To invert + the selection, use ``not``, as shown in the following example. .. code-block:: none @@ -892,7 +892,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> state [established | invalid | new | related] - Match against the state of a packet. + Match based on packet state. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> time startdate @@ -935,7 +935,7 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> time weekdays - Time to match the defined rule. + Match packets based on time criteria. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> hop-limit <0-255> @@ -946,8 +946,8 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> hop-limit <0-255> - Match the hop-limit parameter, where 'eq' stands for 'equal'; 'gt' stands for - 'greater than', and 'lt' stands for 'less than'. + Match the hop-limit parameter. Use ``eq`` for equal, ``gt`` for greater than, + and ``lt`` for less than. .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999> recent count <1-255> @@ -967,15 +967,14 @@ geoip) to keep database and rules updated. .. cfgcmd:: set firewall ipv6 name rule <1-999999> recent time - Match when 'count' amount of connections are seen within 'time'. These - matching criteria can be used to block brute-force attempts. + Match when the specified number of connections occur within the specified + time period. Use these criteria to block brute-force attempts. Packet Modifications ==================== -Starting from **VyOS-1.5-rolling-202410060007**, the firewall can modify -packets before they are sent out. This feaure provides more flexibility in -packet handling. +The firewall can modify packets before sending them. +This feature provides more flexibility for packet handling. .. cfgcmd:: set firewall ipv6 prerouting raw rule <1-999999> set dscp <0-63> @@ -1032,12 +1031,12 @@ Synproxy connections .. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999> synproxy tcp mss <501-65535> - Set the TCP-MSS (maximum segment size) for the connection + Set the TCP MSS (maximum segment size) for the connection. .. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999> synproxy tcp window-scale <1-14> - Set the window scale factor for TCP window scaling + Set the window scale factor for TCP window scaling. Example synproxy ================ @@ -1075,8 +1074,7 @@ Rule-set overview .. opcmd:: show firewall - This will show you a basic firewall overview, for all rule-sets, and not - only for ipv6 + Show a basic firewall overview for all rule-sets, not only for IPv6: .. code-block:: none @@ -1224,8 +1222,8 @@ Rule-set overview .. opcmd:: show firewall group - Overview of defined groups. You see the type, the members, and where the - group is used. + Show an overview of defined groups, including the type, members, and where + the group is used. .. code-block:: none @@ -1242,7 +1240,7 @@ Rule-set overview .. opcmd:: show firewall statistics - This will show you statistics of all rule-sets since the last boot. + Show statistics of all rule-sets since the last boot. Show Firewall log ================= @@ -1255,9 +1253,8 @@ Show Firewall log .. opcmd:: show log firewall ipv6 [forward | input | output] filter rule .. opcmd:: show log firewall ipv6 name rule - Show the logs of all firewall; show all ipv6 firewall logs; show all logs - for particular hook; show all logs for particular hook and priority; - show all logs for particular custom chain; show logs for specific Rule-Set. + Show firewall logs for all firewalls, all IPv6 firewalls, specific hooks, + specific priorities, specific custom chains, or specific rule-sets. Example Partial Config ====================== diff --git a/docs/configuration/firewall/zone.rst b/docs/configuration/firewall/zone.rst index fde6c162..f3b12473 100644 --- a/docs/configuration/firewall/zone.rst +++ b/docs/configuration/firewall/zone.rst @@ -1,34 +1,27 @@ -:lastproofread: 2024-07-03 +:lastproofread: 2026-03-30 .. _firewall-zone: ################### -Zone Based Firewall +Zone-Based Firewall ################### ******** Overview ******** -.. note:: Starting from VyOS 1.4-rolling-202308040557, a new firewall - structure can be found on all VyOS installations. The Zone based firewall - was removed in that version, but re introduced in VyOS 1.4 and 1.5. All - versions built after 2023-10-22 have this feature. - Documentation for most of the new firewall CLI can be - found in the `firewall - `_ - chapter. +.. note:: + All VyOS versions built after 2023-10-22 (VyOS 1.4 and 1.5) support + this feature. -In this section there's useful information on all firewall configuration that -is needed for the zone-based firewall. -Configuration commands covered in this section: +This section provides information on firewall configuration for the +zone-based firewall. This section covers the following configuration +commands: .. cfgcmd:: set firewall zone ... -From the main structure defined in -:doc:`Firewall Overview` -in this section you can find detailed information only for the next part -of the general structure: +To learn about the general traffic flow in VyOS firewalls, +see :doc:`Firewall `. .. code-block:: none @@ -37,22 +30,23 @@ of the general structure: - custom_zone_name + ... -In zone-based policy, interfaces are assigned to zones, and inspection policy -is applied to traffic moving between the zones and acted on according to -firewall rules. A zone is a group of interfaces that have similar functions or -features. It establishes the security borders of a network. A zone defines a -boundary where traffic is subjected to policy restrictions as it crosses to -another region of a network. +In zone-based policy, you assign interfaces to zones and apply inspection +policy to traffic moving between zones. The firewall acts on traffic +according to rules. A zone is a group of interfaces that have similar +functions or features. It establishes the security borders of a network. +A zone defines a boundary where the system subjects traffic to policy +restrictions as it crosses to another region of a network. Key Points: -* A zone must be configured before an interface is assigned to it and an - interface can be assigned to only a single zone. -* All traffic to and from an interface within a zone is permitted. -* All traffic between zones is affected by existing policies -* Traffic cannot flow between a zone member interface and any interface that is - not a zone member. -* You need 2 separate firewalls to define traffic: one for each direction. +* A zone must be configured before you assign an interface to it, and you + can assign an interface to only a single zone. +* All traffic to and from an interface within a zone flows freely. +* Existing policies affect all traffic between zones. +* Traffic cannot flow between a zone member interface and any interface that + is not a zone member. +* You must define 2 separate firewalls to define traffic: one for each + direction. .. note:: In :vytask:`T2199` the syntax of the zone configuration was changed. The zone configuration moved from ``zone-policy zone `` to ``firewall @@ -62,12 +56,13 @@ Key Points: Configuration ************* -As an alternative to applying policy to an interface directly, a zone-based -firewall can be created to simplify configuration when multiple interfaces -belong to the same security zone. Instead of applying rule-sets to interfaces, -they are applied to source-destination zone pairs. +As an alternative to applying policy to an interface directly, you can +create a zone-based firewall to simplify configuration when multiple +interfaces belong to the same security zone. Instead of applying rule-sets +to interfaces, you apply them to source-destination zone pairs. -A basic introduction to zone-based firewalls can be found `here +You can find a basic introduction to zone-based firewalls in the +`VyOS Knowledge Base `_, and an example at :ref:`examples-zone-policy`. @@ -80,7 +75,7 @@ The following steps are required to create a zone-based firewall: Define a Zone ============= -To define a zone setup either one with interfaces or the local zone. +To define a zone, set up either one with interfaces or as the local zone. .. cfgcmd:: set firewall zone interface @@ -89,41 +84,41 @@ To define a zone setup either one with interfaces or the local zone. .. note:: * An interface can only be a member of one zone. - * A zone can have multiple interfaces, with traffic between interfaces in - the same zone subject to the intra-zone-filtering policy (allowed by - default). + * You can have multiple interfaces in a zone. Traffic between + interfaces in the same zone follows the intra-zone-filtering + policy (allowed by default). .. cfgcmd:: set firewall zone local-zone - Define the zone as the local zone, for traffic originating from and destined - to the router itself. + Define the zone as the local zone for traffic that originates from or is + destined to the router itself. .. note:: * A local zone cannot have any member interfaces - * There cannot be multiple local zones + * You cannot have multiple local zones .. cfgcmd:: set firewall zone default-action [drop | reject] - Change the zone default-action, which applies to traffic destined to this - zone that doesn't match any of the source zone rulesets applied. + Modify the zone default-action, which applies to traffic destined to this + zone that does not match any of the source zone rulesets applied. .. cfgcmd:: set firewall zone default-log - Enable logging of packets that hit this zone's default-action (disabled by - default). + Enable logging of packets that match this zone's default-action (disabled + by default). .. cfgcmd:: set firewall zone description - Set a meaningful description. + Add a meaningful description. Defining a Rule-Set ============================= -Zone-based firewall rule-sets are for traffic from a *Source Zone* to a +Zone-based firewall rule-sets define traffic from a *Source Zone* to a *Destination Zone*. -The rule-sets are created as a custom firewall chain using the commands below +You create rule-sets as a custom firewall chain using the commands below (refer to the firewall IPv4/IPv6 sections for the full syntax): * For :ref:`IPv4`: @@ -131,15 +126,16 @@ The rule-sets are created as a custom firewall chain using the commands below * For :ref:`IPv6`: ``set firewall ipv6 name ...`` -It can be helpful to name the rule-sets in the format -``--`` to make them easily identifiable. +It is helpful to name the rule-sets in the format +``--`` to make them easily +identifiable. Applying a Rule-Set to a Zone ============================= -Once a rule-set has been defined, it can then be applied to the source and -destination zones. The configuration syntax is anchored on the destination -zone, with each of the source zone rule-sets listed against the destination. +After you define a rule-set, apply it to the source and destination zones. +The configuration syntax anchors to the destination zone, with each of the +source zone rule-sets listed against the destination. .. cfgcmd:: set firewall zone from firewall name @@ -147,7 +143,8 @@ zone, with each of the source zone rule-sets listed against the destination. .. cfgcmd:: set firewall zone from firewall ipv6-name -It is recommended to create two rule-sets for each source-destination zone pair. +You should create two rule-sets for each source-destination zone +pair. .. code-block:: none @@ -157,10 +154,10 @@ It is recommended to create two rule-sets for each source-destination zone pair. Applying a Default Rule-Set to a Zone ===================================== -When a destination zone shares a common rule-set for multiple source zones or -a complex set of default policies are required, an optional default rule-set -can be applied. The default rule-set applies to all zones that do not have a -rule-set configured as defined in +When a destination zone shares a common rule-set for multiple source zones, +or when you require a complex set of default policies, you can apply an +optional default rule-set. The default rule-set applies to all zones that do +not have a rule-set configured as defined in :ref:`IPv4` .. cfgcmd:: set firewall zone default-firewall name @@ -175,7 +172,7 @@ Operation-mode .. opcmd:: show firewall zone-policy - This will show you a basic summary of the zone configuration. + Display a basic summary of the zone configuration. .. code-block:: none @@ -191,7 +188,7 @@ Operation-mode .. opcmd:: show firewall zone-policy zone - This will show you a basic summary of a particular zone. + Display a basic summary of a particular zone. .. code-block:: none -- cgit v1.2.3 From 129b232ea135019489ddf64e5287c04930b2a318 Mon Sep 17 00:00:00 2001 From: Jonathan Voss Date: Fri, 10 Apr 2026 06:53:11 -0500 Subject: isis: T6978: add IS-IS SRv6 configuration (#1760) --- docs/configuration/protocols/isis.rst | 147 ++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) (limited to 'docs/configuration') diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst index 0fb0e9e0..75634800 100644 --- a/docs/configuration/protocols/isis.rst +++ b/docs/configuration/protocols/isis.rst @@ -355,6 +355,69 @@ Loop Free Alternate (LFA) This command will limit LFA backup computation up to the specified prefix priority. +Segment Routing over IPv6 (SRv6) +------------------------- + +.. cfgcmd:: set protocols isis segment-routing srv6 interface + + The :ref:`dummy interface` used + to install SRv6 SIDs into the Linux data plane. The interface must exist and + must be present when configuring IS-IS with + SRv6. + +.. cfgcmd:: set protocols isis segment-routing srv6 locator + + Specifies the SRv6 locator to use for IS-IS. IS-IS automatically allocates + prefix and adjacency SIDs, creates local SID entries and advertises them + into the IGP domain. + +.. cfgcmd:: set protocols isis segment-routing srv6 node-msd max-end-d <0-255> + + The Maximum End D MSD Type specifies the maximum number of SIDs present in an + SRH when performing decapsulation. As specified in :rfc:`8986`, the permitted + SID types include, but are not limited to, End.DX6, End.DT4, End.DT46, End + with USD, and End.X with USD. + + If the advertised value is zero or no value is advertised, then the router + cannot apply any behavior that results in decapsulation and forwarding of the + inner packet if the outer IPv6 header contains an SRH. + + Reference: :rfc:`9352` + +.. cfgcmd:: set protocols isis segment-routing srv6 node-msd max-end-pop <0-255> + + The Maximum End Pop MSD Type signals the maximum number of SIDs in the SRH to + which the router can apply "Penultimate Segment Pop (PSP) of the SRH" or + "Ultimate Segment Pop (USP) of the SRH" behavior, as defined in "Flavors" + (Section 4.16 of :rfc:`8986`). + + If the advertised value is zero or no value is advertised, then the router + cannot apply PSP or USP flavors. + + Reference: :rfc:`9352` + +.. cfgcmd:: set protocols isis segment-routing srv6 node-msd max-h-encaps <0-255> + + The Maximum H.Encaps MSD Type signals the maximum number of SIDs that can be + added to the segment list of an SRH as part of the "H.Encaps" behavior, as + defined in :rfc:`8986`. + + If the advertised value is zero or no value is advertised, then the headend + can apply an SR Policy that only contains one segment without inserting any + SRH header. A non-zero SRH Max H.encaps MSD indicates that the headend can + insert an SRH up to the advertised number of SIDs. + + Reference: :rfc:`9352` + +.. cfgcmd:: set protocols isis segment-routing srv6 node-msd max-segs-left <0-255> + + The Maximum Segments Left MSD Type signals the maximum value of the + "Segments Left" field (:rfc:`8754`) in the SRH of a received packet before + applying the Endpoint behavior associated with a SID. + + If no value is advertised, the supported value is 0. + + Reference: :rfc:`9352` ******** Examples @@ -598,3 +661,87 @@ Here is the routing tables showing the MPLS segment routing label operations: I 192.0.2.0/24 [115/20] via 192.0.2.1, eth1 inactive, weight 1, 00:07:46 I>* 192.168.255.255/32 [115/20] via 192.0.2.1, eth1, label IPv4 Explicit Null, weight 1, 00:03:43 + +Enable IS-IS with Segment Routing over IPv6 (Experimental) +========================================================== + +**Node 1:** + +.. code-block:: none + + set interfaces dummy dum6 description "SRv6 IS-IS" + set interfaces ethernet eth1 address '192.0.2.1/24' + set interfaces loopback lo address '192.168.255.255/32' + + set protocols segment-routing srv6 locator MAIN prefix 2001:db8:1::/64 + set protocols segment-routing interface eth1 + + set protocols isis interface eth1 + set protocols isis interface lo + set protocols isis net '49.0001.1921.6825.5255.00' + set protocols isis segment-routing srv6 locator MAIN + set protocols isis segment-routing srv6 interface dum6 + +**Node 2:** + +.. code-block:: none + + set interfaces dummy dum6 description "SRv6 IS-IS" + set interfaces ethernet eth1 address '192.0.2.2/24' + set interfaces loopback lo address '192.168.255.254/32' + + set protocols segment-routing srv6 locator MAIN prefix 2001:db8:2::/64 + set protocols segment-routing interface eth1 + + set protocols isis interface eth1 + set protocols isis interface lo + set protocols isis net '49.0001.1921.6825.5254.00' + set protocols isis segment-routing srv6 locator MAIN + set protocols isis segment-routing srv6 interface dum6 + +Enable IS-IS with Segment Routing over IPv6 (uSID) (Experimental) +================================================================= + +**Node 1:** + +.. code-block:: none + + set interfaces dummy dum6 description "SRv6 IS-IS" + set interfaces ethernet eth1 address '192.0.2.1/24' + set interfaces loopback lo address '192.168.255.255/32' + + set protocols segment-routing interface eth1 + set protocols segment-routing srv6 locator MAIN prefix 2001:db8:1::/48 + set protocols segment-routing srv6 locator MAIN behavior-usid + set protocols segment-routing srv6 locator MAIN block-len 32 + set protocols segment-routing srv6 locator MAIN format usid-f3216 + set protocols segment-routing srv6 locator MAIN func-bits 16 + set protocols segment-routing srv6 locator MAIN node-len 16 + + set protocols isis interface eth1 + set protocols isis interface lo + set protocols isis net '49.0001.1921.6825.5255.00' + set protocols isis segment-routing srv6 interface dum6 + set protocols isis segment-routing srv6 locator MAIN + +**Node 2:** + +.. code-block:: none + + set interfaces dummy dum6 description "SRv6 IS-IS" + set interfaces ethernet eth1 address '192.0.2.2/24' + set interfaces loopback lo address '192.168.255.254/32' + + set protocols segment-routing interface eth1 + set protocols segment-routing srv6 locator MAIN prefix 2001:db8:2::/48 + set protocols segment-routing srv6 locator MAIN behavior-usid + set protocols segment-routing srv6 locator MAIN block-len 32 + set protocols segment-routing srv6 locator MAIN format usid-f3216 + set protocols segment-routing srv6 locator MAIN func-bits 16 + set protocols segment-routing srv6 locator MAIN node-len 16 + + set protocols isis interface eth1 + set protocols isis interface lo + set protocols isis net '49.0001.1921.6825.5254.00' + set protocols isis segment-routing srv6 interface dum6 + set protocols isis segment-routing srv6 locator MAIN -- cgit v1.2.3 From d21db5fddd91e20e420b63928a8398745f571710 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 10 Apr 2026 21:23:55 +0300 Subject: docs: fix code-block indentation (tabs to spaces) (#1825) * docs: fix tab-to-space indentation in code blocks across 5 files Replace tab characters with spaces inside code-block and output directives for consistent rendering. Also rewrap long prose lines for readability. Co-Authored-By: Claude Opus 4.6 (1M context) * chore: remove accidentally committed settings file Co-Authored-By: Claude Opus 4.6 (1M context) * docs: fix inconsistent indentation in trafficpolicy and qos code blocks Normalize indentation within code blocks where tab-to-space conversion left some entries misaligned (tbit, gibps, tibps in trafficpolicy; egress command in qos). Co-Authored-By: Claude Opus 4.6 (1M context) --------- Co-authored-by: Claude Opus 4.6 (1M context) --- docs/cli.rst | 44 +-- docs/configexamples/l3vpn-hub-and-spoke.rst | 419 ++++++++++++++-------------- docs/configexamples/qos.rst | 138 +++++---- docs/configuration/trafficpolicy/index.rst | 64 +++-- docs/installation/install.rst | 2 +- 5 files changed, 355 insertions(+), 312 deletions(-) (limited to 'docs/configuration') diff --git a/docs/cli.rst b/docs/cli.rst index 515ea85a..778d3954 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -878,21 +878,21 @@ VyOS lets you compare different configurations. vyos@vyos# compare [tab] Possible completions: - Compare working & active configurations - saved Compare working & saved configurations - Compare working with revision N - Compare revision N with M + Compare working & active configurations + saved Compare working & saved configurations + Compare working with revision N + Compare revision N with M Revisions: - 0 2013-12-17 20:01:37 root by boot-config-loader - 1 2013-12-13 15:59:31 root by boot-config-loader - 2 2013-12-12 21:56:22 vyos by cli - 3 2013-12-12 21:55:11 vyos by cli - 4 2013-12-12 21:27:54 vyos by cli - 5 2013-12-12 21:23:29 vyos by cli - 6 2013-12-12 21:13:59 root by boot-config-loader - 7 2013-12-12 16:25:19 vyos by cli - 8 2013-12-12 15:44:36 vyos by cli - 9 2013-12-12 15:42:07 root by boot-config-loader + 0 2013-12-17 20:01:37 root by boot-config-loader + 1 2013-12-13 15:59:31 root by boot-config-loader + 2 2013-12-12 21:56:22 vyos by cli + 3 2013-12-12 21:55:11 vyos by cli + 4 2013-12-12 21:27:54 vyos by cli + 5 2013-12-12 21:23:29 vyos by cli + 6 2013-12-12 21:13:59 root by boot-config-loader + 7 2013-12-12 16:25:19 vyos by cli + 8 2013-12-12 15:44:36 vyos by cli + 9 2013-12-12 15:42:07 root by boot-config-loader 10 2013-12-12 15:42:06 root by init The command :cfgcmd:`compare` allows you to compare different type of @@ -1027,14 +1027,14 @@ to load it with the ``load`` command: vyos@vyos# load Possible completions: - Load from system config file - Load from file on local machine - scp://:@:/ Load from file on remote machine - sftp://:@/ Load from file on remote machine - ftp://:@/ Load from file on remote machine - http:/// Load from file on remote machine - https:/// Load from file on remote machine - tftp:/// Load from file on remote machine + Load from system config file + Load from file on local machine + scp://:@:/ Load from file on remote machine + sftp://:@/ Load from file on remote machine + ftp://:@/ Load from file on remote machine + http:/// Load from file on remote machine + https:/// Load from file on remote machine + tftp:/// Load from file on remote machine diff --git a/docs/configexamples/l3vpn-hub-and-spoke.rst b/docs/configexamples/l3vpn-hub-and-spoke.rst index e4b0d933..c05b9a3f 100644 --- a/docs/configexamples/l3vpn-hub-and-spoke.rst +++ b/docs/configexamples/l3vpn-hub-and-spoke.rst @@ -46,7 +46,8 @@ The following software was used in the creation of this document: **NOTE:** VyOS Router (tested with VyOS 1.4-rolling-202110310317) – The configurations below are specifically for VyOS 1.4.x. -General information can be found in the :ref:`configuration/vrf/index:L3VPN VRFs` chapter. +General information can be found in the +:ref:`configuration/vrf/index:L3VPN VRFs` chapter. @@ -64,8 +65,9 @@ Topology How does it work? ***************** -As we know the main assumption of L3VPN “Hub and Spoke” is, that the traffic -between spokes have to pass via hub, in our scenario VyOS-PE2 is the Hub PE +As we know the main assumption of L3VPN “Hub and Spoke” is, that the +traffic between spokes have to pass via hub, in our scenario VyOS-PE2 +is the Hub PE and the VyOS-CE1-HUB is the central customer office device that is responsible for controlling access between all spokes and announcing its network prefixes (10.0.0.100/32). VyOS-PE2 has the main VRF (its name is BLUE_HUB), its @@ -325,10 +327,12 @@ At this step we are going to enable iBGP protocol on MPLS nodes and Route Reflectors (two routers for redundancy) that will deliver IPv4 VPN (L3VPN) routes between them: +.. stop_vyoslinter + - VyOS-RR1: .. code-block:: none - + set protocols bgp system-as '65001' set protocols bgp neighbor 10.0.0.7 address-family ipv4-vpn route-reflector-client set protocols bgp neighbor 10.0.0.7 peer-group 'RR_VPNv4' @@ -554,81 +558,81 @@ Let’s check IPv4 routing and MPLS information on provider nodes vyos@VyOS-P1:~$ show ip ospf neighbor - Neighbor ID Pri State Dead Time Address Interface RXmtL RqstL DBsmL - 10.0.0.4 1 Full/Backup 34.718s 172.16.30.2 eth0:172.16.30.1 0 0 0 - 10.0.0.5 1 Full/Backup 35.132s 172.16.40.2 eth1:172.16.40.1 0 0 0 - 10.0.0.7 1 Full/Backup 34.764s 172.16.90.2 eth2:172.16.90.1 0 0 0 - 10.0.0.1 1 Full/Backup 35.642s 172.16.10.2 eth3:172.16.10.1 0 0 0 - 10.0.0.8 1 Full/Backup 35.484s 172.16.100.2 eth5:172.16.100.1 0 0 0 + Neighbor ID Pri State Dead Time Address Interface RXmtL RqstL DBsmL + 10.0.0.4 1 Full/Backup 34.718s 172.16.30.2 eth0:172.16.30.1 0 0 0 + 10.0.0.5 1 Full/Backup 35.132s 172.16.40.2 eth1:172.16.40.1 0 0 0 + 10.0.0.7 1 Full/Backup 34.764s 172.16.90.2 eth2:172.16.90.1 0 0 0 + 10.0.0.1 1 Full/Backup 35.642s 172.16.10.2 eth3:172.16.10.1 0 0 0 + 10.0.0.8 1 Full/Backup 35.484s 172.16.100.2 eth5:172.16.100.1 0 0 0 - “show mpls ldp neighbor “ for checking ldp neighbors .. code-block:: none vyos@VyOS-P1:~$ show mpls ldp neighbor - AF ID State Remote Address Uptime - ipv4 10.0.0.1 OPERATIONAL 10.0.0.1 07w5d06h - ipv4 10.0.0.4 OPERATIONAL 10.0.0.4 09w3d00h - ipv4 10.0.0.5 OPERATIONAL 10.0.0.5 09w2d23h - ipv4 10.0.0.7 OPERATIONAL 10.0.0.7 03w0d01h - ipv4 10.0.0.8 OPERATIONAL 10.0.0.8 01w3d02h + AF ID State Remote Address Uptime + ipv4 10.0.0.1 OPERATIONAL 10.0.0.1 07w5d06h + ipv4 10.0.0.4 OPERATIONAL 10.0.0.4 09w3d00h + ipv4 10.0.0.5 OPERATIONAL 10.0.0.5 09w2d23h + ipv4 10.0.0.7 OPERATIONAL 10.0.0.7 03w0d01h + ipv4 10.0.0.8 OPERATIONAL 10.0.0.8 01w3d02h - “show mpls ldp binding” for checking mpls label assignment .. code-block:: none vyos@VyOS-P1:~$ show mpls ldp discovery - AF Destination Nexthop Local Label Remote Label In Use - ipv4 10.0.0.1/32 10.0.0.1 23 imp-null yes - ipv4 10.0.0.1/32 10.0.0.4 23 20 no - ipv4 10.0.0.1/32 10.0.0.5 23 17 no - ipv4 10.0.0.1/32 10.0.0.7 23 16 no - ipv4 10.0.0.1/32 10.0.0.8 23 16 no - ipv4 10.0.0.2/32 10.0.0.1 20 16 no - ipv4 10.0.0.2/32 10.0.0.4 20 22 no - ipv4 10.0.0.2/32 10.0.0.5 20 24 yes - ipv4 10.0.0.2/32 10.0.0.7 20 17 no - ipv4 10.0.0.2/32 10.0.0.8 20 17 no - ipv4 10.0.0.3/32 10.0.0.1 imp-null 17 no - ipv4 10.0.0.3/32 10.0.0.4 imp-null 16 no - ipv4 10.0.0.3/32 10.0.0.5 imp-null 18 no - ipv4 10.0.0.3/32 10.0.0.7 imp-null 18 no - ipv4 10.0.0.3/32 10.0.0.8 imp-null 18 no - ipv4 10.0.0.4/32 10.0.0.1 16 18 no - ipv4 10.0.0.4/32 10.0.0.4 16 imp-null yes - ipv4 10.0.0.4/32 10.0.0.5 16 19 no - ipv4 10.0.0.4/32 10.0.0.7 16 19 no - ipv4 10.0.0.4/32 10.0.0.8 16 19 no - ipv4 10.0.0.5/32 10.0.0.1 21 19 no - ipv4 10.0.0.5/32 10.0.0.4 21 17 no - ipv4 10.0.0.5/32 10.0.0.5 21 imp-null yes - ipv4 10.0.0.5/32 10.0.0.7 21 20 no - ipv4 10.0.0.5/32 10.0.0.8 21 20 no - ipv4 10.0.0.6/32 10.0.0.1 17 20 no - ipv4 10.0.0.6/32 10.0.0.4 17 23 yes - ipv4 10.0.0.6/32 10.0.0.5 17 21 yes - ipv4 10.0.0.6/32 10.0.0.7 17 21 no - ipv4 10.0.0.6/32 10.0.0.8 17 21 no - ipv4 10.0.0.7/32 10.0.0.1 22 21 no - ipv4 10.0.0.7/32 10.0.0.4 22 18 no - ipv4 10.0.0.7/32 10.0.0.5 22 20 no - ipv4 10.0.0.7/32 10.0.0.7 22 imp-null yes - ipv4 10.0.0.7/32 10.0.0.8 22 22 no - ipv4 10.0.0.8/32 10.0.0.1 24 22 no - ipv4 10.0.0.8/32 10.0.0.4 24 19 no - ipv4 10.0.0.8/32 10.0.0.5 24 16 no - ipv4 10.0.0.8/32 10.0.0.7 24 22 no - ipv4 10.0.0.8/32 10.0.0.8 24 imp-null yes - ipv4 10.0.0.9/32 10.0.0.1 18 23 no - ipv4 10.0.0.9/32 10.0.0.4 18 21 yes - ipv4 10.0.0.9/32 10.0.0.5 18 22 no - ipv4 10.0.0.9/32 10.0.0.7 18 23 no - ipv4 10.0.0.9/32 10.0.0.8 18 23 no - ipv4 10.0.0.10/32 10.0.0.1 19 24 no - ipv4 10.0.0.10/32 10.0.0.4 19 24 yes - ipv4 10.0.0.10/32 10.0.0.5 19 23 yes - ipv4 10.0.0.10/32 10.0.0.7 19 24 no - ipv4 10.0.0.10/32 10.0.0.8 19 24 no + AF Destination Nexthop Local Label Remote Label In Use + ipv4 10.0.0.1/32 10.0.0.1 23 imp-null yes + ipv4 10.0.0.1/32 10.0.0.4 23 20 no + ipv4 10.0.0.1/32 10.0.0.5 23 17 no + ipv4 10.0.0.1/32 10.0.0.7 23 16 no + ipv4 10.0.0.1/32 10.0.0.8 23 16 no + ipv4 10.0.0.2/32 10.0.0.1 20 16 no + ipv4 10.0.0.2/32 10.0.0.4 20 22 no + ipv4 10.0.0.2/32 10.0.0.5 20 24 yes + ipv4 10.0.0.2/32 10.0.0.7 20 17 no + ipv4 10.0.0.2/32 10.0.0.8 20 17 no + ipv4 10.0.0.3/32 10.0.0.1 imp-null 17 no + ipv4 10.0.0.3/32 10.0.0.4 imp-null 16 no + ipv4 10.0.0.3/32 10.0.0.5 imp-null 18 no + ipv4 10.0.0.3/32 10.0.0.7 imp-null 18 no + ipv4 10.0.0.3/32 10.0.0.8 imp-null 18 no + ipv4 10.0.0.4/32 10.0.0.1 16 18 no + ipv4 10.0.0.4/32 10.0.0.4 16 imp-null yes + ipv4 10.0.0.4/32 10.0.0.5 16 19 no + ipv4 10.0.0.4/32 10.0.0.7 16 19 no + ipv4 10.0.0.4/32 10.0.0.8 16 19 no + ipv4 10.0.0.5/32 10.0.0.1 21 19 no + ipv4 10.0.0.5/32 10.0.0.4 21 17 no + ipv4 10.0.0.5/32 10.0.0.5 21 imp-null yes + ipv4 10.0.0.5/32 10.0.0.7 21 20 no + ipv4 10.0.0.5/32 10.0.0.8 21 20 no + ipv4 10.0.0.6/32 10.0.0.1 17 20 no + ipv4 10.0.0.6/32 10.0.0.4 17 23 yes + ipv4 10.0.0.6/32 10.0.0.5 17 21 yes + ipv4 10.0.0.6/32 10.0.0.7 17 21 no + ipv4 10.0.0.6/32 10.0.0.8 17 21 no + ipv4 10.0.0.7/32 10.0.0.1 22 21 no + ipv4 10.0.0.7/32 10.0.0.4 22 18 no + ipv4 10.0.0.7/32 10.0.0.5 22 20 no + ipv4 10.0.0.7/32 10.0.0.7 22 imp-null yes + ipv4 10.0.0.7/32 10.0.0.8 22 22 no + ipv4 10.0.0.8/32 10.0.0.1 24 22 no + ipv4 10.0.0.8/32 10.0.0.4 24 19 no + ipv4 10.0.0.8/32 10.0.0.5 24 16 no + ipv4 10.0.0.8/32 10.0.0.7 24 22 no + ipv4 10.0.0.8/32 10.0.0.8 24 imp-null yes + ipv4 10.0.0.9/32 10.0.0.1 18 23 no + ipv4 10.0.0.9/32 10.0.0.4 18 21 yes + ipv4 10.0.0.9/32 10.0.0.5 18 22 no + ipv4 10.0.0.9/32 10.0.0.7 18 23 no + ipv4 10.0.0.9/32 10.0.0.8 18 23 no + ipv4 10.0.0.10/32 10.0.0.1 19 24 no + ipv4 10.0.0.10/32 10.0.0.4 19 24 yes + ipv4 10.0.0.10/32 10.0.0.5 19 23 yes + ipv4 10.0.0.10/32 10.0.0.7 19 24 no + ipv4 10.0.0.10/32 10.0.0.8 19 24 no Now we’re checking iBGP status and routes from route-reflector nodes to other devices: @@ -644,11 +648,11 @@ nodes to other devices: Peers 4, using 85 KiB of memory Peer groups 1, using 64 bytes of memory - Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt - 10.0.0.7 4 65001 7719 7733 0 0 0 5d07h56m 2 10 - 10.0.0.8 4 65001 7715 7724 0 0 0 5d08h28m 4 10 - 10.0.0.9 4 65001 7713 7724 0 0 0 5d08h28m 2 10 - 10.0.0.10 4 65001 7713 7724 0 0 0 5d08h28m 2 10 + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 10.0.0.7 4 65001 7719 7733 0 0 0 5d07h56m 2 10 + 10.0.0.8 4 65001 7715 7724 0 0 0 5d08h28m 4 10 + 10.0.0.9 4 65001 7713 7724 0 0 0 5d08h28m 2 10 + 10.0.0.10 4 65001 7713 7724 0 0 0 5d08h28m 2 10 Total number of neighbors 4 @@ -660,37 +664,37 @@ nodes to other devices: BGP table version is 2, local router ID is 10.0.0.1, vrf id 0 Default local pref 100, local AS 65001 Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, - i internal, r RIB-failure, S Stale, R Removed + i internal, r RIB-failure, S Stale, R Removed Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self Origin codes: i - IGP, e - EGP, ? - incomplete - Network Next Hop Metric LocPrf Weight Path + Network Next Hop Metric LocPrf Weight Path Route Distinguisher: 10.50.50.1:1011 - *>i10.50.50.0/24 10.0.0.7 0 100 0 i - UN=10.0.0.7 EC{65035:1011} label=80 type=bgp, subtype=0 - *>i80.80.80.80/32 10.0.0.7 0 100 0 65035 i - UN=10.0.0.7 EC{65035:1011} label=80 type=bgp, subtype=0 + *>i10.50.50.0/24 10.0.0.7 0 100 0 i + UN=10.0.0.7 EC{65035:1011} label=80 type=bgp, subtype=0 + *>i80.80.80.80/32 10.0.0.7 0 100 0 65035 i + UN=10.0.0.7 EC{65035:1011} label=80 type=bgp, subtype=0 Route Distinguisher: 10.60.60.1:1011 - *>i10.60.60.0/24 10.0.0.10 0 100 0 i - UN=10.0.0.10 EC{65035:1011} label=80 type=bgp, subtype=0 - *>i90.90.90.90/32 10.0.0.10 0 100 0 65035 i - UN=10.0.0.10 EC{65035:1011} label=80 type=bgp, subtype=0 + *>i10.60.60.0/24 10.0.0.10 0 100 0 i + UN=10.0.0.10 EC{65035:1011} label=80 type=bgp, subtype=0 + *>i90.90.90.90/32 10.0.0.10 0 100 0 65035 i + UN=10.0.0.10 EC{65035:1011} label=80 type=bgp, subtype=0 Route Distinguisher: 10.80.80.1:1011 - *>i10.80.80.0/24 10.0.0.8 0 100 0 i - UN=10.0.0.8 EC{65035:1030} label=80 type=bgp, subtype=0 + *>i10.80.80.0/24 10.0.0.8 0 100 0 i + UN=10.0.0.8 EC{65035:1030} label=80 type=bgp, subtype=0 *>i100.100.100.100/32 - 10.0.0.8 0 100 0 65035 i - UN=10.0.0.8 EC{65035:1030} label=80 type=bgp, subtype=0 + 10.0.0.8 0 100 0 65035 i + UN=10.0.0.8 EC{65035:1030} label=80 type=bgp, subtype=0 Route Distinguisher: 172.16.80.1:2011 - *>i10.110.110.0/24 10.0.0.8 0 100 0 65050 i - UN=10.0.0.8 EC{65050:2011} label=81 type=bgp, subtype=0 - *>i172.16.80.0/24 10.0.0.8 0 100 0 i - UN=10.0.0.8 EC{65050:2011} label=81 type=bgp, subtype=0 + *>i10.110.110.0/24 10.0.0.8 0 100 0 65050 i + UN=10.0.0.8 EC{65050:2011} label=81 type=bgp, subtype=0 + *>i172.16.80.0/24 10.0.0.8 0 100 0 i + UN=10.0.0.8 EC{65050:2011} label=81 type=bgp, subtype=0 Route Distinguisher: 172.16.100.1:2011 - *>i10.210.210.0/24 10.0.0.9 0 100 0 65050 i - UN=10.0.0.9 EC{65050:2011} label=80 type=bgp, subtype=0 - *>i172.16.100.0/24 10.0.0.9 0 100 0 i - UN=10.0.0.9 EC{65050:2011} label=80 type=bgp, subtype=0 + *>i10.210.210.0/24 10.0.0.9 0 100 0 65050 i + UN=10.0.0.9 EC{65050:2011} label=80 type=bgp, subtype=0 + *>i172.16.100.0/24 10.0.0.9 0 100 0 i + UN=10.0.0.9 EC{65050:2011} label=80 type=bgp, subtype=0 - “show bgp ipv4 vpn x.x.x.x/x” for checking best path selected for specific VPNv4 destination @@ -704,11 +708,11 @@ nodes to other devices: Advertised to non peer-group peers: 10.0.0.7 10.0.0.8 10.0.0.9 10.0.0.10 65035, (Received from a RR-client) - 10.0.0.8 from 10.0.0.8 (10.0.0.8) - Origin incomplete, metric 0, localpref 100, valid, internal, best (First path received) - Extended Community: RT:65035:1030 - Remote label: 80 - Last update: Tue Oct 19 13:45:32 202 + 10.0.0.8 from 10.0.0.8 (10.0.0.8) + Origin incomplete, metric 0, localpref 100, valid, internal, best (First path received) + Extended Community: RT:65035:1030 + Remote label: 80 + Last update: Tue Oct 19 13:45:32 202 Also we can verify how PE devices receives VPNv4 networks from the RRs and installing them to the specific customer VRFs: @@ -725,9 +729,9 @@ and installing them to the specific customer VRFs: Peers 2, using 43 KiB of memory Peer groups 1, using 64 bytes of memory - Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt - 10.0.0.1 4 65001 8812 8794 0 0 0 01:18:42 8 2 - 10.0.0.2 4 65001 8800 8792 0 0 0 6d02h27m 8 2 + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 10.0.0.1 4 65001 8812 8794 0 0 0 01:18:42 8 2 + 10.0.0.2 4 65001 8800 8792 0 0 0 6d02h27m 8 2 - “show bgp vrf all” for checking all the prefix learning on BGP within VRFs: @@ -743,19 +747,19 @@ and installing them to the specific customer VRFs: BGP table version is 8, local router ID is 10.50.50.1, vrf id 6 Default local pref 100, local AS 65001 Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, - i internal, r RIB-failure, S Stale, R Removed + i internal, r RIB-failure, S Stale, R Removed Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self Origin codes: i - IGP, e - EGP, ? - incomplete - Network Next Hop Metric LocPrf Weight Path - * 10.50.50.0/24 0.0.0.0 0 32768 ? - *> 0.0.0.0 0 32768 i - *> 10.80.80.0/24 10.0.0.8@0< 0 100 0 i - * 10.0.0.8@0< 0 100 0 i - *> 10.0.0.80/32 10.50.50.2 0 0 65035 i + Network Next Hop Metric LocPrf Weight Path + * 10.50.50.0/24 0.0.0.0 0 32768 ? + *> 0.0.0.0 0 32768 i + *> 10.80.80.0/24 10.0.0.8@0< 0 100 0 i + * 10.0.0.8@0< 0 100 0 i + *> 10.0.0.80/32 10.50.50.2 0 0 65035 i *> 10.0.0.100/32 - 10.0.0.8@0< 0 100 0 65035 ? - * 10.0.0.8@0< 0 100 0 65035 ? + 10.0.0.8@0< 0 100 0 65035 ? + * 10.0.0.8@0< 0 100 0 65035 ? - “show bgp vrf BLUE_SPOKE summary” for checking EBGP neighbor information between PE and CE: @@ -771,8 +775,8 @@ and installing them to the specific customer VRFs: RIB entries 7, using 1344 bytes of memory Peers 1, using 21 KiB of memory - Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt - 10.50.50.2 4 65035 9019 9023 0 0 0 6d06h12m 1 4 + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 10.50.50.2 4 65035 9019 9023 0 0 0 6d06h12m 1 4 Total number of neighbors 1 @@ -785,19 +789,19 @@ and installing them to the specific customer VRFs: vyos@VyOS-PE1:~$ show ip route vrf BLUE_SPOKE Codes: K - kernel route, C - connected, S - static, R - RIP, - O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, - T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, - F - PBR, f - OpenFabric, - > - selected route, * - FIB route, q - queued, r - rejected, b - backup + O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, + T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, + F - PBR, f - OpenFabric, + > - selected route, * - FIB route, q - queued, r - rejected, b - backup VRF BLUE_SPOKE: K>* 0.0.0.0/0 [255/8192] unreachable (ICMP unreachable), 03w0d23h C>* 10.50.50.0/24 is directly connected, eth3, 03w0d23h B> 10.80.80.0/24 [200/0] via 10.0.0.8 (vrf default) (recursive), label 80, weight 1, 04:22:00 - * via 172.16.90.1, eth0 (vrf default), label 24/80, weight 1, 04:22:00 + * via 172.16.90.1, eth0 (vrf default), label 24/80, weight 1, 04:22:00 B>* 10.0.0.80/32 [20/0] via 10.50.50.2, eth3, weight 1, 6d05h30m B> 10.0.0.100/32 [200/0] via 10.0.0.8 (vrf default) (recursive), label 80, weight 1, 04:22:00 - * via 172.16.90.1, eth0 (vrf default), label 24/80, weight 1, 04:22:00 + * via 172.16.90.1, eth0 (vrf default), label 24/80, weight 1, 04:22:00 - “show bgp ipv4 vpn x.x.x.x/32” for checking the best-path to the specific VPNv4 destination including extended community and @@ -811,19 +815,19 @@ and installing them to the specific customer VRFs: Paths: (2 available, best #1) Not advertised to any peer 65035 - 10.0.0.8 from 10.0.0.1 (10.0.0.8) - Origin incomplete, metric 0, localpref 100, valid, internal, best (Neighbor IP) - Extended Community: RT:65035:1030 - Originator: 10.0.0.8, Cluster list: 10.0.0.1 - Remote label: 80 - Last update: Tue Oct 19 13:45:26 2021 + 10.0.0.8 from 10.0.0.1 (10.0.0.8) + Origin incomplete, metric 0, localpref 100, valid, internal, best (Neighbor IP) + Extended Community: RT:65035:1030 + Originator: 10.0.0.8, Cluster list: 10.0.0.1 + Remote label: 80 + Last update: Tue Oct 19 13:45:26 2021 65035 - 10.0.0.8 from 10.0.0.2 (10.0.0.8) - Origin incomplete, metric 0, localpref 100, valid, internal - Extended Community: RT:65035:1030 - Originator: 10.0.0.8, Cluster list: 10.0.0.1 - Remote label: 80 - Last update: Wed Oct 13 12:39:34 202 + 10.0.0.8 from 10.0.0.2 (10.0.0.8) + Origin incomplete, metric 0, localpref 100, valid, internal + Extended Community: RT:65035:1030 + Originator: 10.0.0.8, Cluster list: 10.0.0.1 + Remote label: 80 + Last update: Wed Oct 13 12:39:34 202 Now, let’s check routing information on out Hub PE: @@ -839,9 +843,9 @@ Now, let’s check routing information on out Hub PE: Peers 2, using 43 KiB of memory Peer groups 1, using 64 bytes of memory - Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt - 10.0.0.1 4 65001 15982 15949 0 0 0 05:41:28 6 4 - 10.0.0.2 4 65001 9060 9054 0 0 0 6d06h47m 6 4 + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 10.0.0.1 4 65001 15982 15949 0 0 0 05:41:28 6 4 + 10.0.0.2 4 65001 9060 9054 0 0 0 6d06h47m 6 4 Total number of neighbors @@ -858,31 +862,31 @@ Now, let’s check routing information on out Hub PE: BGP table version is 50, local router ID is 10.80.80.1, vrf id 8 Default local pref 100, local AS 65001 Status codes: s suppressed, d damped, h history, * valid, > best, = multipath, - i internal, r RIB-failure, S Stale, R Removed + i internal, r RIB-failure, S Stale, R Removed Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self Origin codes: i - IGP, e - EGP, ? - incomplete - Network Next Hop Metric LocPrf Weight Path - *> 10.50.50.0/24 10.0.0.7@0< 0 100 0 i - * 10.0.0.7@0< 0 100 0 i - *> 10.60.60.0/24 10.0.0.10@0< 0 100 0 i - * 10.0.0.10@0< 0 100 0 i - * 10.80.80.0/24 10.80.80.2 0 0 65035 ? - * 0.0.0.0 0 32768 i - *> 0.0.0.0 0 32768 ? - *> 10.110.110.0/24 172.16.80.2@9< 0 0 65050 i - *> 10.210.210.0/24 10.0.0.9@0< 0 100 0 65050 i - * 10.0.0.9@0< 0 100 0 65050 i - *> 10.0.0.80/32 10.0.0.7@0< 0 100 0 65035 i - * 10.0.0.7@0< 0 100 0 65035 i - *> 10.0.0.90/32 10.0.0.10@0< 0 100 0 65035 i - * 10.0.0.10@0< 0 100 0 65035 i + Network Next Hop Metric LocPrf Weight Path + *> 10.50.50.0/24 10.0.0.7@0< 0 100 0 i + * 10.0.0.7@0< 0 100 0 i + *> 10.60.60.0/24 10.0.0.10@0< 0 100 0 i + * 10.0.0.10@0< 0 100 0 i + * 10.80.80.0/24 10.80.80.2 0 0 65035 ? + * 0.0.0.0 0 32768 i + *> 0.0.0.0 0 32768 ? + *> 10.110.110.0/24 172.16.80.2@9< 0 0 65050 i + *> 10.210.210.0/24 10.0.0.9@0< 0 100 0 65050 i + * 10.0.0.9@0< 0 100 0 65050 i + *> 10.0.0.80/32 10.0.0.7@0< 0 100 0 65035 i + * 10.0.0.7@0< 0 100 0 65035 i + *> 10.0.0.90/32 10.0.0.10@0< 0 100 0 65035 i + * 10.0.0.10@0< 0 100 0 65035 i *> 10.0.0.100/32 - 10.80.80.2 0 0 65035 ? - *> 172.16.80.0/24 0.0.0.0@9< 0 32768 ? - 0.0.0.0@9< 0 32768 i - *> 172.16.100.0/24 10.0.0.9@0< 0 100 0 i - * 10.0.0.9@0< 0 100 0 i + 10.80.80.2 0 0 65035 ? + *> 172.16.80.0/24 0.0.0.0@9< 0 32768 ? + 0.0.0.0@9< 0 32768 i + *> 172.16.100.0/24 10.0.0.9@0< 0 100 0 i + * 10.0.0.9@0< 0 100 0 i - “show bgp vrf BLUE_HUB summary” for checking EBGP neighbor CE Hub device @@ -897,8 +901,8 @@ Now, let’s check routing information on out Hub PE: RIB entries 19, using 3648 bytes of memory Peers 1, using 21 KiB of memory - Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt - 10.80.80.2 4 65035 15954 15972 0 0 0 01w4d01h 2 10 + Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd PfxSnt + 10.80.80.2 4 65035 15954 15972 0 0 0 01w4d01h 2 10 - “show ip route vrf BLUE_HUB” to view the RIB in our Hub PE. With this command we are able to check the transport and @@ -909,30 +913,30 @@ Now, let’s check routing information on out Hub PE: vyos@VyOS-PE2:~$ show ip route vrf BLUE_HUB Codes: K - kernel route, C - connected, S - static, R - RIP, - O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, - T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, - F - PBR, f - OpenFabric, - > - selected route, * - FIB route, q - queued, r - rejected, b - backup + O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, + T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, + F - PBR, f - OpenFabric, + > - selected route, * - FIB route, q - queued, r - rejected, b - backup VRF BLUE_HUB: K>* 0.0.0.0/0 [255/8192] unreachable (ICMP unreachable), 01w4d01h B> 10.50.50.0/24 [200/0] via 10.0.0.7 (vrf default) (recursive), label 144, weight 1, 05:53:15 - * via 172.16.100.1, eth1 (vrf default), label 22/144, weight 1, 05:53:15 + * via 172.16.100.1, eth1 (vrf default), label 22/144, weight 1, 05:53:15 B> 10.60.60.0/24 [200/0] via 10.0.0.10 (vrf default) (recursive), label 144, weight 1, 05:53:15 - * via 172.16.110.1, eth0 (vrf default), label 23/144, weight 1, 05:53:15 + * via 172.16.110.1, eth0 (vrf default), label 23/144, weight 1, 05:53:15 C>* 10.80.80.0/24 is directly connected, eth3, 01w4d01h B>* 10.110.110.0/24 [200/0] via 172.16.80.2, eth2 (vrf GREEN), weight 1, 01w4d01h B> 10.210.210.0/24 [200/0] via 10.0.0.9 (vrf default) (recursive), label 144, weight 1, 05:53:15 - * via 172.16.100.1, eth1 (vrf default), label 18/144, weight 1, 05:53:15 - * via 172.16.110.1, eth0 (vrf default), label 22/144, weight 1, 05:53:15 + * via 172.16.100.1, eth1 (vrf default), label 18/144, weight 1, 05:53:15 + * via 172.16.110.1, eth0 (vrf default), label 22/144, weight 1, 05:53:15 B> 10.0.0.80/32 [200/0] via 10.0.0.7 (vrf default) (recursive), label 144, weight 1, 05:53:15 - * via 172.16.100.1, eth1 (vrf default), label 22/144, weight 1, 05:53:15 + * via 172.16.100.1, eth1 (vrf default), label 22/144, weight 1, 05:53:15 B> 10.0.0.90/32 [200/0] via 10.0.0.10 (vrf default) (recursive), label 144, weight 1, 05:53:15 - * via 172.16.110.1, eth0 (vrf default), label 23/144, weight 1, 05:53:15 + * via 172.16.110.1, eth0 (vrf default), label 23/144, weight 1, 05:53:15 B>* 10.0.0.100/32 [20/0] via 10.80.80.2, eth3, weight 1, 01w4d01h B>* 172.16.80.0/24 [200/0] is directly connected, eth2 (vrf GREEN), weight 1, 01w4d01h B> 172.16.100.0/24 [200/0] via 10.0.0.9 (vrf default) (recursive), label 144, weight 1, 05:53:15 - * via 172.16.100.1, eth1 (vrf default), label 18/144, weight 1, 05:53:15 - * via 172.16.110.1, eth0 (vrf default), label 22/144, weight 1, 05:53:15 + * via 172.16.100.1, eth1 (vrf default), label 18/144, weight 1, 05:53:15 + * via 172.16.110.1, eth0 (vrf default), label 22/144, weight 1, 05:53:15 - “show bgp ipv4 vpn x.x.x.x/32” for checking best-path, extended community and remote label of specific destination @@ -945,19 +949,19 @@ Now, let’s check routing information on out Hub PE: Paths: (2 available, best #1) Not advertised to any peer 65035 - 10.0.0.7 from 10.0.0.1 (10.0.0.7) - Origin IGP, metric 0, localpref 100, valid, internal, best (Neighbor IP) - Extended Community: RT:65035:1011 - Originator: 10.0.0.7, Cluster list: 10.0.0.1 - Remote label: 144 - Last update: Tue Oct 19 13:45:30 2021 + 10.0.0.7 from 10.0.0.1 (10.0.0.7) + Origin IGP, metric 0, localpref 100, valid, internal, best (Neighbor IP) + Extended Community: RT:65035:1011 + Originator: 10.0.0.7, Cluster list: 10.0.0.1 + Remote label: 144 + Last update: Tue Oct 19 13:45:30 2021 65035 - 10.0.0.7 from 10.0.0.2 (10.0.0.7) - Origin IGP, metric 0, localpref 100, valid, internal - Extended Community: RT:65035:1011 - Originator: 10.0.0.7, Cluster list: 10.0.0.1 - Remote label: 144 - Last update: Wed Oct 13 12:39:37 2021 + 10.0.0.7 from 10.0.0.2 (10.0.0.7) + Origin IGP, metric 0, localpref 100, valid, internal + Extended Community: RT:65035:1011 + Originator: 10.0.0.7, Cluster list: 10.0.0.1 + Remote label: 144 + Last update: Wed Oct 13 12:39:37 2021 vyos@VyOS-PE2:~$ show bgp ipv4 vpn 10.0.0.90/32 BGP routing table entry for 10.60.60.1:1011:10.0.0.90/32 @@ -965,19 +969,19 @@ Now, let’s check routing information on out Hub PE: Paths: (2 available, best #1) Not advertised to any peer 65035 - 10.0.0.10 from 10.0.0.1 (10.0.0.10) - Origin IGP, metric 0, localpref 100, valid, internal, best (Neighbor IP) - Extended Community: RT:65035:1011 - Originator: 10.0.0.10, Cluster list: 10.0.0.1 - Remote label: 144 - Last update: Tue Oct 19 13:45:30 2021 + 10.0.0.10 from 10.0.0.1 (10.0.0.10) + Origin IGP, metric 0, localpref 100, valid, internal, best (Neighbor IP) + Extended Community: RT:65035:1011 + Originator: 10.0.0.10, Cluster list: 10.0.0.1 + Remote label: 144 + Last update: Tue Oct 19 13:45:30 2021 65035 - 10.0.0.10 from 10.0.0.2 (10.0.0.10) - Origin IGP, metric 0, localpref 100, valid, internal - Extended Community: RT:65035:1011 - Originator: 10.0.0.10, Cluster list: 10.0.0.1 - Remote label: 144 - Last update: Wed Oct 13 12:45:44 2021 + 10.0.0.10 from 10.0.0.2 (10.0.0.10) + Origin IGP, metric 0, localpref 100, valid, internal + Extended Community: RT:65035:1011 + Originator: 10.0.0.10, Cluster list: 10.0.0.1 + Remote label: 144 + Last update: Wed Oct 13 12:45:44 2021 Finally, let’s check the reachability between CEs: @@ -989,10 +993,10 @@ Finally, let’s check the reachability between CEs: # check rib vyos@VyOS-CE1-SPOKE:~$ show ip route Codes: K - kernel route, C - connected, S - static, R - RIP, - O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, - T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, - F - PBR, f - OpenFabric, - > - selected route, * - FIB route, q - queued, r - rejected, b - backup + O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, + T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, + F - PBR, f - OpenFabric, + > - selected route, * - FIB route, q - queued, r - rejected, b - backup B 10.50.50.0/24 [20/0] via 10.50.50.1 inactive, weight 1, 6d07h53m C>* 10.50.50.0/24 is directly connected, eth0, 09w0d00h @@ -1027,10 +1031,10 @@ Finally, let’s check the reachability between CEs: # check rib vyos@VyOS-CE-HUB:~$ show ip route Codes: K - kernel route, C - connected, S - static, R - RIP, - O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, - T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, - F - PBR, f - OpenFabric, - > - selected route, * - FIB route, q - queued, r - rejected, b - backup + O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, + T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, + F - PBR, f - OpenFabric, + > - selected route, * - FIB route, q - queued, r - rejected, b - backup B>* 10.50.50.0/24 [20/0] via 10.80.80.1, eth0, weight 1, 6d08h04m B>* 10.60.60.0/24 [20/0] via 10.80.80.1, eth0, weight 1, 6d08h35m @@ -1086,10 +1090,10 @@ Finally, let’s check the reachability between CEs: # check rib vyos@rt-ce2-SPOKE:~$ show ip route Codes: K - kernel route, C - connected, S - static, R - RIP, - O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, - T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, - F - PBR, f - OpenFabric, - > - selected route, * - FIB route, q - queued, r - rejected, b - backup + O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP, + T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP, + F - PBR, f - OpenFabric, + > - selected route, * - FIB route, q - queued, r - rejected, b - backup B 10.60.60.0/24 [20/0] via 10.60.60.1 inactive, weight 1, 02w6d00h C>* 10.60.60.0/24 is directly connected, eth0, 02w6d00h @@ -1117,4 +1121,7 @@ Finally, let’s check the reachability between CEs: 3 * * * 4 10.0.0.100 (10.0.0.100) 7.504 ms 7.480 ms 7.488 ms -**Note:** At the moment, trace mpls doesn’t show labels/paths. So we’ll see * * * for the transit routers of the mpls backbone. +.. start_vyoslinter + +**Note:** At the moment, trace mpls doesn’t show labels/paths. So we’ll +see ``* * *`` for the transit routers of the mpls backbone. diff --git a/docs/configexamples/qos.rst b/docs/configexamples/qos.rst index 842719c5..268163df 100644 --- a/docs/configexamples/qos.rst +++ b/docs/configexamples/qos.rst @@ -9,8 +9,11 @@ QoS example Configuration 'dcsp' and shaper using QoS ========================================= -In this case, we'll try to make a simple lab using QoS and the general ability of the VyOS system. -We recommend you to go through the main article about `QoS `_ first. +In this case, we'll try to make a simple lab using QoS and the +general ability of the VyOS system. +We recommend you to go through the main article about +`QoS `_ +first. Using the general schema for example: @@ -20,8 +23,11 @@ Using the general schema for example: :align: center :alt: Network Topology Diagram -We have four hosts on the local network 172.17.1.0/24. All hosts are labeled CS0 by default. We need to replace labels on all hosts except vpc8. -We will replace the labels on the nearest router “VyOS3” using the IP addresses of the sources. +We have four hosts on the local network 172.17.1.0/24. All hosts are +labeled CS0 by default. We need to replace labels on all hosts except +vpc8. +We will replace the labels on the nearest router “VyOS3” using the IP +addresses of the sources. * 172.17.1.2 CS0 -> CS4 * 172.17.1.3 CS0 -> CS5 @@ -32,30 +38,37 @@ Next, we will replace only all CS4 labels on the “VyOS2” router. * CS4 -> CS5 -In the end, we will configure the traffic shaper using QoS mechanisms on the “VYOS2” router. +In the end, we will configure the traffic shaper using QoS mechanisms +on the “VYOS2” router. Configuration: ============== -Set IP addresses on all VPCs and a default gateway 172.17.1.1. We'll use in this case only static routes. -On the VyOS3 router, we need to change the 'dscp' labels for the VPCs. To do this, we use this configuration. +Set IP addresses on all VPCs and a default gateway 172.17.1.1. We'll +use in this case only static routes. +On the VyOS3 router, we need to change the 'dscp' labels for the +VPCs. To do this, we use this configuration. + +.. stop_vyoslinter .. code-block:: none - set interfaces ethernet eth0 address '10.1.1.100/24' - set interfaces ethernet eth1 address '172.17.1.1/24' - set protocols static route 0.0.0.0/0 next-hop 10.1.1.1 - set qos policy shaper vyos3 class 10 match ADDRESS10 ip source address '172.17.1.2/32' - set qos policy shaper vyos3 class 10 set-dscp 'CS4' - set qos policy shaper vyos3 class 20 match ADDRESS20 ip source address '172.17.1.3/32' - set qos policy shaper vyos3 class 20 set-dscp 'CS5' - set qos policy shaper vyos3 class 30 match ADDRESS20 ip source address '172.17.1.4/32' - set qos policy shaper vyos3 class 30 set-dscp 'CS6' - set qos policy shaper vyos3 default bandwidth '10%' - set qos policy shaper vyos3 default ceiling '100%' - set qos policy shaper vyos3 default priority '7' - set qos policy shaper vyos3 default queue-type 'fair-queue' - set qos interface eth0 egress 'vyos3' + set interfaces ethernet eth0 address '10.1.1.100/24' + set interfaces ethernet eth1 address '172.17.1.1/24' + set protocols static route 0.0.0.0/0 next-hop 10.1.1.1 + set qos policy shaper vyos3 class 10 match ADDRESS10 ip source address '172.17.1.2/32' + set qos policy shaper vyos3 class 10 set-dscp 'CS4' + set qos policy shaper vyos3 class 20 match ADDRESS20 ip source address '172.17.1.3/32' + set qos policy shaper vyos3 class 20 set-dscp 'CS5' + set qos policy shaper vyos3 class 30 match ADDRESS20 ip source address '172.17.1.4/32' + set qos policy shaper vyos3 class 30 set-dscp 'CS6' + set qos policy shaper vyos3 default bandwidth '10%' + set qos policy shaper vyos3 default ceiling '100%' + set qos policy shaper vyos3 default priority '7' + set qos policy shaper vyos3 default queue-type 'fair-queue' + set qos interface eth0 egress 'vyos3' + +.. start_vyoslinter Main rules: @@ -85,25 +98,27 @@ After the interface eth0 on router VyOS3 :align: center :alt: Network Topology Diagram -On the router, VyOS4 set all traffic as CS4. We have to configure the default class and class for changing all labels from CS0 to CS4 +On the router, VyOS4 set all traffic as CS4. We have to configure the +default class and class for changing all labels from CS0 to CS4 .. code-block:: none - set interfaces ethernet eth0 address '10.2.1.100/24' - set protocols static route 0.0.0.0/0 next-hop 10.2.1.1 - set qos policy shaper vyos4 class 10 bandwidth '100%' - set qos policy shaper vyos4 class 10 burst '15k' - set qos policy shaper vyos4 class 10 match ALL ether protocol 'all' - set qos policy shaper vyos4 class 10 queue-type 'fair-queue' - set qos policy shaper vyos4 class 10 set-dscp 'CS4' - set qos policy shaper vyos4 default bandwidth '10%' - set qos policy shaper vyos4 default burst '15k' - set qos policy shaper vyos4 default ceiling '100%' - set qos policy shaper vyos4 default priority '7' - set qos policy shaper vyos4 default queue-type 'fair-queue' + set interfaces ethernet eth0 address '10.2.1.100/24' + set protocols static route 0.0.0.0/0 next-hop 10.2.1.1 + set qos policy shaper vyos4 class 10 bandwidth '100%' + set qos policy shaper vyos4 class 10 burst '15k' + set qos policy shaper vyos4 class 10 match ALL ether protocol 'all' + set qos policy shaper vyos4 class 10 queue-type 'fair-queue' + set qos policy shaper vyos4 class 10 set-dscp 'CS4' + set qos policy shaper vyos4 default bandwidth '10%' + set qos policy shaper vyos4 default burst '15k' + set qos policy shaper vyos4 default ceiling '100%' + set qos policy shaper vyos4 default priority '7' + set qos policy shaper vyos4 default queue-type 'fair-queue' set qos interface eth0 egress 'vyos4' -Next on the router VyOS2 we will change labels on all incoming traffic only from CS4-> CS6 +Next on the router VyOS2 we will change labels on all incoming +traffic only from CS4-> CS6 .. image:: /_static/images/qos5.png :width: 80% @@ -112,20 +127,20 @@ Next on the router VyOS2 we will change labels on all incoming traffic only from .. code-block:: none - set interfaces ethernet eth0 address '10.1.1.1/24' - set interfaces ethernet eth1 address '10.2.1.1/24' - set interfaces ethernet eth2 address '10.9.9.1/24' - set protocols static route 172.17.1.0/24 next-hop 10.1.1.100 - set qos policy shaper vyos2 class 10 bandwidth '100%' - set qos policy shaper vyos2 class 10 burst '15k' - set qos policy shaper vyos2 class 10 match VYOS2 ip dscp 'CS4' - set qos policy shaper vyos2 class 10 queue-type 'fair-queue' - set qos policy shaper vyos2 class 10 set-dscp 'CS5' - set qos policy shaper vyos2 default bandwidth '100%' - set qos policy shaper vyos2 default burst '15k' - set qos policy shaper vyos2 default ceiling '100%' - set qos policy shaper vyos2 default priority '7' - set qos policy shaper vyos2 default queue-type 'fair-queue' + set interfaces ethernet eth0 address '10.1.1.1/24' + set interfaces ethernet eth1 address '10.2.1.1/24' + set interfaces ethernet eth2 address '10.9.9.1/24' + set protocols static route 172.17.1.0/24 next-hop 10.1.1.100 + set qos policy shaper vyos2 class 10 bandwidth '100%' + set qos policy shaper vyos2 class 10 burst '15k' + set qos policy shaper vyos2 class 10 match VYOS2 ip dscp 'CS4' + set qos policy shaper vyos2 class 10 queue-type 'fair-queue' + set qos policy shaper vyos2 class 10 set-dscp 'CS5' + set qos policy shaper vyos2 default bandwidth '100%' + set qos policy shaper vyos2 default burst '15k' + set qos policy shaper vyos2 default ceiling '100%' + set qos policy shaper vyos2 default priority '7' + set qos policy shaper vyos2 default queue-type 'fair-queue' set qos interface eth2 egress 'vyos2' .. image:: /_static/images/qos6.png @@ -154,23 +169,26 @@ Next on the router VyOS2 we will change labels on all incoming traffic only from :align: center :alt: Network Topology Diagram -In the end, on the router “VyOS2” we will set outgoing bandwidth limits between the “VyOS3” and “VyOS1” routers. Let's set a limit for IP 10.1.1.100 = 5 Mbps(Tx). We will check the result of the work with the help of the “iPerf” utility. +In the end, on the router “VyOS2” we will set outgoing bandwidth +limits between the “VyOS3” and “VyOS1” routers. Let's set a limit for +IP 10.1.1.100 = 5 Mbps(Tx). We will check the result of the work +with the help of the “iPerf” utility. Set up bandwidth limits on the eth2 interface of the router “VyOS2”. .. code-block:: none - vyos@vyos2# show qos policy shaper vyos2 class 20 - bandwidth 5mbit - description "for VyOS3 eth0" - match VyOS3 { - ip { - source { - address 10.1.1.100/32 - } - } - } + vyos@vyos2# show qos policy shaper vyos2 class 20 + bandwidth 5mbit + description "for VyOS3 eth0" + match VyOS3 { + ip { + source { + address 10.1.1.100/32 + } + } + } Check the result. diff --git a/docs/configuration/trafficpolicy/index.rst b/docs/configuration/trafficpolicy/index.rst index 5414ce77..13cfb9dc 100644 --- a/docs/configuration/trafficpolicy/index.rst +++ b/docs/configuration/trafficpolicy/index.rst @@ -53,29 +53,29 @@ They can be **decimal** prefixes. .. code-block:: none - kbit (10^3) kilobit per second - mbit (10^6) megabit per second - gbit (10^9) gigabit per second - tbit (10^12) terabit per second - - kbps (8*10^3) kilobyte per second - mbps (8*10^6) megabyte per second - gbps (8*10^9) gigabyte per second - tbps (8*10^12) terabyte per second + kbit (10^3) kilobit per second + mbit (10^6) megabit per second + gbit (10^9) gigabit per second + tbit (10^12) terabit per second + + kbps (8*10^3) kilobyte per second + mbps (8*10^6) megabyte per second + gbps (8*10^9) gigabyte per second + tbps (8*10^12) terabyte per second Or **binary** prefixes. .. code-block:: none - kibit (2^10 = 1024) kibibit per second - mibit (2^20 = 1024^2) mebibit per second - gibit (2^30 = 1024^3) gibibit per second - tbit (2^40 = 1024^4) tebibit per second + kibit (2^10 = 1024) kibibit per second + mibit (2^20 = 1024^2) mebibit per second + gibit (2^30 = 1024^3) gibibit per second + tbit (2^40 = 1024^4) tebibit per second - kibps (1024*8) kibibyte (KiB) per second - mibps (1024^2*8) mebibyte (MiB) per second - gibps (1024^3*8) gibibyte (GiB) per second - tibps (1024^4*8) tebibyte (TiB) per second + kibps (1024*8) kibibyte (KiB) per second + mibps (1024^2*8) mebibyte (MiB) per second + gibps (1024^3*8) gibibyte (GiB) per second + tibps (1024^4*8) tebibyte (TiB) per second Suffixes @@ -88,7 +88,7 @@ A *bit* is written as **bit**, kbit (kilobits per second) mbit (megabits per second) gbit (gigabits per second) - tbit (terabits per second) + tbit (terabits per second) while a *byte* is written as a single **b**. @@ -134,10 +134,13 @@ configuring it. identify it, it also defines its priority. +.. stop_vyoslinter + .. code-block:: none set qos policy class match +.. start_vyoslinter In the command above, we set the type of policy we are going to work with and the name we choose for it; a class (so that we can @@ -199,10 +202,14 @@ is based on marks done by the firewall, You can also write a description for a filter: +.. stop_vyoslinter + .. code-block:: none set qos policy shaper MY-SHAPER class 30 match MY-FIRST-FILTER description "My filter description" +.. start_vyoslinter + .. note:: An IPv4 TCP filter will only match packets with an IPv4 header @@ -281,9 +288,11 @@ you want to do with the traffic of that class, what specific Traffic-Control treatment you want to give it. You will have different possibilities depending on the Traffic Policy you are configuring. +.. stop_vyoslinter + .. code-block:: none - vyos@vyos# set qos policy shaper MY-SHAPER class 30 + vyos@vyos# set qos policy shaper MY-SHAPER class 30 Possible completions: bandwidth Available bandwidth for this policy (default: auto) burst Burst size for this class (default: 15k) @@ -299,7 +308,8 @@ possibilities depending on the Traffic Policy you are configuring. queue-type Queue type for default traffic (default: fq-codel) set-dscp Change the Differentiated Services (DiffServ) field in the IP header target Acceptable minimum standing/persistent queue delay (default: 5) - + +.. start_vyoslinter For instance, with :code:`set qos policy shaper MY-SHAPER class 30 set-dscp EF` you would be modifying the DSCP field value of packets in @@ -1140,9 +1150,11 @@ parameters. Random Early Detection (RED) +.. stop_vyoslinter + .. code-block:: none - vyos@vyos# set qos policy shaper HTB class 10 + vyos@vyos# set qos policy shaper HTB class 10 Possible completions: bandwidth Available bandwidth for this policy (default: auto) burst Burst size for this class (default: 15k) @@ -1159,6 +1171,8 @@ parameters. set-dscp Change the Differentiated Services (DiffServ) field in the IP header target Acceptable minimum standing/persistent queue delay (default: 5) +.. start_vyoslinter + .. note:: If you configure a class for **VoIP traffic**, don't give it any @@ -1174,6 +1188,8 @@ Example A simple example of Shaper using priorities. +.. stop_vyoslinter + .. code-block:: none set qos policy shaper MY-HTB bandwidth '50mbit' @@ -1195,6 +1211,8 @@ A simple example of Shaper using priorities. set qos policy shaper MY-HTB default priority '7' set qos policy shaper MY-HTB default queue-type 'fair-queue' +.. start_vyoslinter + .. _CAKE: CAKE @@ -1255,8 +1273,8 @@ edge. .. cfgcmd:: set qos policy cake flow-isolation triple-isolate - **(Default)** Flows are defined by the 5-tuple, fairness is applied over source and - destination addresses and also over individual flows. + **(Default)** Flows are defined by the 5-tuple, fairness is applied + over source and destination addresses and also over individual flows. .. cfgcmd:: set qos policy cake rtt diff --git a/docs/installation/install.rst b/docs/installation/install.rst index 80e4a5f6..4071af64 100644 --- a/docs/installation/install.rst +++ b/docs/installation/install.rst @@ -147,7 +147,7 @@ To verify a VyOS image starting with VyOS ``1.3.0-rc6``, run: $ minisign -V -P RWSIhkR/dkM2DSaBRniv/bbbAf8hmDqdbOEmgXkf1RxRoxzodgKcDyGq -m vyos-1.5-rolling-202409250007-generic-amd64.iso vyos-1.5-rolling-202409250007-generic-amd64.iso.minisig Signature and comment signature verified - Trusted comment: timestamp:1727223408 file:vyos-1.5-rolling-202409250007-generic-amd64.iso hashed + Trusted comment: timestamp:1727223408 file:vyos-1.5-rolling-202409250007-generic-amd64.iso hashed During an image upgrade, VyOS runs the following command: -- cgit v1.2.3 From b5858598e32441560da34a4a62dc687fe4df9c16 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 10 Apr 2026 21:26:49 +0300 Subject: docs: standardize RST heading hierarchy to # overline across 21 files (#1827) Normalize top-level page headings from = or * underline-only to # overline+underline format, following RST/Sphinx best practices for consistent heading hierarchy. Co-authored-by: Claude Opus 4.6 (1M context) --- docs/automation/vyos-ansible.rst | 3 ++- docs/automation/vyos-napalm.rst | 3 ++- docs/automation/vyos-netmiko.rst | 3 ++- docs/automation/vyos-pyvyos.rst | 3 ++- docs/configexamples/azure-vpn-bgp.rst | 3 ++- docs/configexamples/azure-vpn-dual-bgp.rst | 3 ++- docs/configexamples/firewall.rst | 6 ++++-- docs/configexamples/fwall-and-bridge.rst | 3 ++- docs/configexamples/fwall-and-vrf.rst | 3 ++- docs/configexamples/index.rst | 3 ++- docs/configexamples/policy-based-ipsec-and-firewall.rst | 3 ++- docs/configexamples/site-2-site-cisco.rst | 3 ++- docs/configexamples/wan-load-balancing.rst | 3 ++- docs/configexamples/zone-policy.rst | 3 ++- docs/configuration/interfaces/tunnel.rst | 3 ++- docs/configuration/service/mdns.rst | 3 ++- docs/configuration/system/lcd.rst | 4 ++-- docs/installation/update.rst | 3 ++- docs/installation/virtual/docker.rst | 4 ++-- docs/installation/virtual/libvirt.rst | 4 ++-- docs/installation/virtual/proxmox.rst | 4 ++-- 21 files changed, 44 insertions(+), 26 deletions(-) (limited to 'docs/configuration') diff --git a/docs/automation/vyos-ansible.rst b/docs/automation/vyos-ansible.rst index 0ebcb924..993d1b21 100644 --- a/docs/automation/vyos-ansible.rst +++ b/docs/automation/vyos-ansible.rst @@ -2,8 +2,9 @@ .. _vyos-ansible: +####### Ansible -======= +####### VyOS supports configuration via ansible. Need to install ``ansible`` and ``python3-paramiko`` module diff --git a/docs/automation/vyos-napalm.rst b/docs/automation/vyos-napalm.rst index 75e20b3c..dc4d154f 100644 --- a/docs/automation/vyos-napalm.rst +++ b/docs/automation/vyos-napalm.rst @@ -2,8 +2,9 @@ .. _vyos-napalm: +###### Napalm -====== +###### VyOS supports some napalm_ functions for configuration and op-mode. It requires more tests. diff --git a/docs/automation/vyos-netmiko.rst b/docs/automation/vyos-netmiko.rst index 075b0f34..53082e52 100644 --- a/docs/automation/vyos-netmiko.rst +++ b/docs/automation/vyos-netmiko.rst @@ -2,8 +2,9 @@ .. _vyos-netmiko: +####### Netmiko -======= +####### VyOS supports configuration via netmiko_. It requires to install ``python3-netmiko`` module. diff --git a/docs/automation/vyos-pyvyos.rst b/docs/automation/vyos-pyvyos.rst index 948534f8..c178aeb6 100644 --- a/docs/automation/vyos-pyvyos.rst +++ b/docs/automation/vyos-pyvyos.rst @@ -2,8 +2,9 @@ .. _vyos-pyvyos: +###### pyvyos -====== +###### pyvyos is a Python library designed for interacting with VyOS devices through their API. This documentation is intended to guide you in using pyvyos for diff --git a/docs/configexamples/azure-vpn-bgp.rst b/docs/configexamples/azure-vpn-bgp.rst index 03d637d8..597a4d15 100644 --- a/docs/configexamples/azure-vpn-bgp.rst +++ b/docs/configexamples/azure-vpn-bgp.rst @@ -2,8 +2,9 @@ .. _examples-azure-vpn-bgp: +############################################################ Route-Based Site-to-Site VPN to Azure (BGP over IKEv2/IPsec) ------------------------------------------------------------- +############################################################ This guide shows an example of a route-based IKEv2 site-to-site VPN to Azure using VTI and BGP for dynamic routing updates. diff --git a/docs/configexamples/azure-vpn-dual-bgp.rst b/docs/configexamples/azure-vpn-dual-bgp.rst index d37aa85c..04a6a631 100644 --- a/docs/configexamples/azure-vpn-dual-bgp.rst +++ b/docs/configexamples/azure-vpn-dual-bgp.rst @@ -2,8 +2,9 @@ .. _examples-azure-vpn-dual-bgp: +###################################################################### Route-Based Redundant Site-to-Site VPN to Azure (BGP over IKEv2/IPsec) ----------------------------------------------------------------------- +###################################################################### This guide shows an example of a redundant (active-active) route-based IKEv2 site-to-site VPN to Azure using VTI diff --git a/docs/configexamples/firewall.rst b/docs/configexamples/firewall.rst index a1ad7e19..6968eb04 100644 --- a/docs/configexamples/firewall.rst +++ b/docs/configexamples/firewall.rst @@ -1,9 +1,11 @@ :lastproofread: 2024-09-11 +################# Firewall Examples -================= +################# -This section contains examples of firewall configurations for various deployments. +This section contains examples of firewall configurations for various +deployments. .. toctree:: :maxdepth: 2 diff --git a/docs/configexamples/fwall-and-bridge.rst b/docs/configexamples/fwall-and-bridge.rst index 34744a5d..134dd6c0 100644 --- a/docs/configexamples/fwall-and-bridge.rst +++ b/docs/configexamples/fwall-and-bridge.rst @@ -1,7 +1,8 @@ :lastproofread: 2024-09-11 +########################### Bridge and firewall example ---------------------------- +########################### Scenario and requirements ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/configexamples/fwall-and-vrf.rst b/docs/configexamples/fwall-and-vrf.rst index 38663a18..992b625e 100644 --- a/docs/configexamples/fwall-and-vrf.rst +++ b/docs/configexamples/fwall-and-vrf.rst @@ -1,5 +1,6 @@ +######################## VRF and firewall example ------------------------- +######################## Scenario and requirements ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/configexamples/index.rst b/docs/configexamples/index.rst index 7f173b4a..b5985d7f 100644 --- a/docs/configexamples/index.rst +++ b/docs/configexamples/index.rst @@ -1,7 +1,8 @@ .. _examples: +######################## Configuration Blueprints -======================== +######################## This chapter contains various configuration examples: diff --git a/docs/configexamples/policy-based-ipsec-and-firewall.rst b/docs/configexamples/policy-based-ipsec-and-firewall.rst index 60f8b888..5d98e944 100644 --- a/docs/configexamples/policy-based-ipsec-and-firewall.rst +++ b/docs/configexamples/policy-based-ipsec-and-firewall.rst @@ -1,8 +1,9 @@ .. _examples-policy-based-ipsec-and-firewall: +######################################################## Policy-Based Site-to-Site VPN and Firewall Configuration --------------------------------------------------------- +######################################################## This guide shows an example policy-based IKEv2 site-to-site VPN between two VyOS routers, and firewall configuration. diff --git a/docs/configexamples/site-2-site-cisco.rst b/docs/configexamples/site-2-site-cisco.rst index 5b5f1fd7..e8322002 100644 --- a/docs/configexamples/site-2-site-cisco.rst +++ b/docs/configexamples/site-2-site-cisco.rst @@ -1,7 +1,8 @@ .. _examples-site-2-site-cisco: +############################################# Site-to-Site IPSec VPN to Cisco using FlexVPN ---------------------------------------------- +############################################# This guide shows a sample configuration for FlexVPN site-to-site Internet Protocol Security (IPsec)/Generic Routing Encapsulation (GRE) tunnel. diff --git a/docs/configexamples/wan-load-balancing.rst b/docs/configexamples/wan-load-balancing.rst index 0952cfe5..38490616 100644 --- a/docs/configexamples/wan-load-balancing.rst +++ b/docs/configexamples/wan-load-balancing.rst @@ -4,8 +4,9 @@ .. stop_vyoslinter # pictures and text have to change +########################## WAN Load Balancer examples -========================== +########################## Example 1: Distributing load evenly diff --git a/docs/configexamples/zone-policy.rst b/docs/configexamples/zone-policy.rst index d0101ebf..0c1c2617 100644 --- a/docs/configexamples/zone-policy.rst +++ b/docs/configexamples/zone-policy.rst @@ -2,8 +2,9 @@ .. _examples-zone-policy: +################### Zone-Policy example -------------------- +################### .. note:: In :vytask:`T2199` the syntax of the zone configuration was changed. The zone configuration moved from ``zone-policy zone `` to ``firewall diff --git a/docs/configuration/interfaces/tunnel.rst b/docs/configuration/interfaces/tunnel.rst index 27c47a91..f1376cdf 100644 --- a/docs/configuration/interfaces/tunnel.rst +++ b/docs/configuration/interfaces/tunnel.rst @@ -2,8 +2,9 @@ .. _tunnel-interface: +###### Tunnel -====== +###### Tunnel interfaces are virtual links that transmit encapsulated traffic between private networks or hosts across public infrastructure, such as the Internet. diff --git a/docs/configuration/service/mdns.rst b/docs/configuration/service/mdns.rst index b4ca1fd1..8a26722e 100644 --- a/docs/configuration/service/mdns.rst +++ b/docs/configuration/service/mdns.rst @@ -1,5 +1,6 @@ +############# mDNS Repeater -------------- +############# Starting with VyOS 1.2 a :abbr:`mDNS (Multicast DNS)` repeater functionality is provided. Additional information can be obtained from diff --git a/docs/configuration/system/lcd.rst b/docs/configuration/system/lcd.rst index 808d45a2..3fcf01dd 100644 --- a/docs/configuration/system/lcd.rst +++ b/docs/configuration/system/lcd.rst @@ -1,8 +1,8 @@ .. _system-display: -******************** +#################### System Display (LCD) -******************** +#################### The system LCD :abbr:`LCD (Liquid-crystal display)` option is for users running VyOS on hardware that features an LCD display. This is typically a small display diff --git a/docs/installation/update.rst b/docs/installation/update.rst index 967f494b..81750dc1 100644 --- a/docs/installation/update.rst +++ b/docs/installation/update.rst @@ -2,8 +2,9 @@ .. _update_vyos: +########### Update VyOS -=========== +########### New system images can be added using the :opcmd:`add system image` command. This command extracts the image and prompts you to use the current system diff --git a/docs/installation/virtual/docker.rst b/docs/installation/virtual/docker.rst index 282e4e63..d62c011b 100644 --- a/docs/installation/virtual/docker.rst +++ b/docs/installation/virtual/docker.rst @@ -2,9 +2,9 @@ .. _docker: -****************************** +############################## Run VyOS in a Docker Container -****************************** +############################## Docker is an open-source project for deploying applications as standardized units called containers. Deploying VyOS in a container provides a simple and diff --git a/docs/installation/virtual/libvirt.rst b/docs/installation/virtual/libvirt.rst index 20b3ff1a..3aa665c0 100644 --- a/docs/installation/virtual/libvirt.rst +++ b/docs/installation/virtual/libvirt.rst @@ -2,9 +2,9 @@ .. _libvirt: -**************************** +############################ Run VyOS on Libvirt QEMU/KVM -**************************** +############################ Libvirt is an open-source API, daemon, and management tool for managing platform virtualization. You can deploy VyOS on libvirt KVM in several ways: diff --git a/docs/installation/virtual/proxmox.rst b/docs/installation/virtual/proxmox.rst index 070627aa..6bd030e3 100644 --- a/docs/installation/virtual/proxmox.rst +++ b/docs/installation/virtual/proxmox.rst @@ -2,9 +2,9 @@ .. _proxmox: -****************** +################## Running on Proxmox -****************** +################## Proxmox is an open-source platform for virtualization. Visit https://vyos.io to download a ``.qcow2`` image that you can import into -- cgit v1.2.3 From ac00e1c4a6b456628e412123383450653f668bdb Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 10 Apr 2026 21:46:24 +0300 Subject: docs: remove TODO markers, fix stub notes, add linter markers (#1828) Remove TODO tracking comments, reformat stub notes with inline links, add stop/start_vyoslinter markers around long code blocks, and fix minor structural issues across 23 documentation files. Co-authored-by: Claude Opus 4.6 (1M context) --- docs/automation/vyos-govyos.rst | 20 +++- docs/automation/vyos-salt.rst | 24 +++- docs/configuration/highavailability/index.rst | 45 +++++++- docs/configuration/loadbalancing/wan.rst | 6 +- docs/configuration/nat/nat64.rst | 3 - docs/configuration/nat/nat66.rst | 4 + docs/configuration/policy/examples.rst | 3 - docs/configuration/policy/index.rst | 2 +- docs/configuration/protocols/static.rst | 59 ++++++---- docs/configuration/service/eventhandler.rst | 126 +++++++++++++-------- docs/configuration/service/snmp.rst | 3 - docs/configuration/system/flow-accounting.rst | 14 ++- docs/configuration/system/sysctl.rst | 10 +- docs/configuration/vpn/index.rst | 2 +- docs/configuration/vpn/ipsec/index.rst | 2 + .../configuration/vpn/ipsec/remoteaccess_ipsec.rst | 6 +- .../vpn/ipsec/troubleshooting_ipsec.rst | 8 +- docs/configuration/vpn/openconnect.rst | 44 ++++++- docs/configuration/vpn/rsa-keys.rst | 8 ++ docs/installation/cloud/oracle.rst | 8 +- docs/installation/virtual/eve-ng.rst | 8 +- docs/operation/information.rst | 17 ++- docs/vpp/configuration/ipfix.rst | 16 ++- 23 files changed, 311 insertions(+), 127 deletions(-) (limited to 'docs/configuration') diff --git a/docs/automation/vyos-govyos.rst b/docs/automation/vyos-govyos.rst index 32222441..659c2b6e 100644 --- a/docs/automation/vyos-govyos.rst +++ b/docs/automation/vyos-govyos.rst @@ -2,17 +2,21 @@ .. _vyos-govyos: +####### go-vyos -======= +####### go-vyos is a Go library designed for interacting with VyOS devices through their REST API. This documentation is intended to guide you in using go-vyos for programmatic management of your VyOS devices. -- `go-vyos Documentation & Source Code on GitHub `_ +- `go-vyos Documentation & Source Code on GitHub + `_ allows you to access and contribute to the library's code. -- `go-vyos on pkg.go.dev `_ for detailed instructions - on the installation, configuration, and operation of the go-vyos library. +- `go-vyos on pkg.go.dev + `_ + for detailed instructions on the installation, configuration, and + operation of the go-vyos library. Installation @@ -30,11 +34,15 @@ Getting Started Importing and Disabling TLS Verification ------------------------------------------------- +.. stop_vyoslinter + .. code-block:: none import "github.com/ganawaj/go-vyos/vyos" client := vyos.NewClient(nil).WithToken("AUTH_KEY").WithURL("https://192.168.0.1").Insecure() +.. start_vyoslinter + Initializing a VyDevice Object ------------------------------ @@ -64,6 +72,8 @@ Using go-vyos Configure, then Set ^^^^^^^^^^^^^^^^^^^^^^^^ +.. stop_vyoslinter + .. code-block:: none out, resp, err := c.Conf.Set(ctx, "interfaces ethernet eth0 address 192.168.1.1/24") @@ -73,6 +83,8 @@ Configure, then Set fmt.Println(out.Success) +.. start_vyoslinter + Show a Single Object Value ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/automation/vyos-salt.rst b/docs/automation/vyos-salt.rst index 12be32a1..3a5b17d7 100644 --- a/docs/automation/vyos-salt.rst +++ b/docs/automation/vyos-salt.rst @@ -4,8 +4,9 @@ .. include:: /_include/need_improvement.txt +#### Salt -==== +#### VyOS supports op-mode and configuration via salt_. @@ -172,6 +173,8 @@ Examples Example of op-mode: +.. stop_vyoslinter + .. code-block:: none / # salt r11-proxy netmiko.send_command 'show interfaces ethernet eth0 brief' host=192.0.2.14 device_type=vyos username=vyos password=vyos @@ -180,10 +183,14 @@ Example of op-mode: Interface IP Address S/L Description --------- ---------- --- ----------- eth0 192.0.2.14/24 u/u Upstream - / # + / # + +.. start_vyoslinter Example of configuration: +.. stop_vyoslinter + .. code-block:: none / # salt r11-proxy netmiko.send_config config_commands=['set interfaces ethernet eth0 description Link_to_WAN'] commit=True host=192.0.2.14 device_type=vyos username=vyos password=vyos @@ -196,7 +203,12 @@ Example of configuration: vyos@r14# / # -Example of configuration commands from the file "/srv/salt/states/commands.txt" +.. start_vyoslinter + +Example of configuration commands from the file +"/srv/salt/states/commands.txt" + +.. stop_vyoslinter .. code-block:: none @@ -212,5 +224,9 @@ Example of configuration commands from the file "/srv/salt/states/commands.txt" vyos@r1# / # +.. start_vyoslinter + .. _salt: https://docs.saltproject.io/en/latest/contents.html -.. _netmiko: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.netmiko_mod.html#module-salt.modules.netmiko_mod \ No newline at end of file +.. stop_vyoslinter +.. _netmiko: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.netmiko_mod.html#module-salt.modules.netmiko_mod +.. start_vyoslinter \ No newline at end of file diff --git a/docs/configuration/highavailability/index.rst b/docs/configuration/highavailability/index.rst index 40465c30..c82391c7 100644 --- a/docs/configuration/highavailability/index.rst +++ b/docs/configuration/highavailability/index.rst @@ -2,8 +2,9 @@ .. _high-availability: +################# High availability -================= +################# VRRP (Virtual Router Redundancy Protocol) provides active/backup redundancy for routers. Every VRRP router has a physical IP/IPv6 address, and a virtual @@ -252,8 +253,12 @@ need to configure it. But if necessary, Gratuitous ARP can be configured in 0 if not defined. +.. stop_vyoslinter + .. cfgcmd:: set high-availability vrrp global-parameters garp master-delay <1-255> +.. start_vyoslinter + .. cfgcmd:: set high-availability vrrp group garp master-delay <1-255> Set delay for second set of gratuitous ARPs after transition to MASTER. @@ -316,37 +321,46 @@ vice versa and can be used to enable or disable certain services, for example. chmod +x /config/scripts/script-name.sh -.. warning:: It is not recommended to change VRRP configuration inside health-check - and transition scripts. +.. warning:: It is not recommended to change VRRP configuration + inside health-check and transition scripts. Health check scripts ^^^^^^^^^^^^^^^^^^^^ -There is the ability to run an arbitrary script at regular intervals according to health-check -parameters. If a script returns 0, it indicates success. If a script returns anything -else, it will indicate that the VRRP instance should enter the FAULT state. +There is the ability to run an arbitrary script at regular intervals +according to health-check parameters. If a script returns 0, it +indicates success. If a script returns anything else, it will indicate +that the VRRP instance should enter the FAULT state. This setup will make the VRRP process execute the ``/config/scripts/vrrp-check.sh script`` every 60 seconds, and transition the group to the fault state if it fails (i.e. exits with non-zero status) three times: +.. stop_vyoslinter + .. code-block:: none set high-availability vrrp group Foo health-check script /config/scripts/vrrp-check.sh set high-availability vrrp group Foo health-check interval 60 set high-availability vrrp group Foo health-check failure-count 3 +.. start_vyoslinter + When the vrrp group is a member of the sync group will use only the sync group health check script. This example shows how to configure it for the sync group: +.. stop_vyoslinter + .. code-block:: none set high-availability vrrp sync-group Bar health-check script /config/scripts/vrrp-check.sh set high-availability vrrp sync-group Bar health-check interval 60 set high-availability vrrp sync-group Bar health-check failure-count 3 +.. start_vyoslinter + Transition scripts ^^^^^^^^^^^^^^^^^^ @@ -356,12 +370,16 @@ This setup will make the VRRP process execute the ``/config/scripts/vrrp-fail.sh`` with argument ``Foo`` when VRRP fails, and the ``/config/scripts/vrrp-master.sh`` when the router becomes the master: +.. stop_vyoslinter + .. code-block:: none set high-availability vrrp group Foo transition-script backup "/config/scripts/vrrp-fail.sh Foo" set high-availability vrrp group Foo transition-script fault "/config/scripts/vrrp-fail.sh Foo" set high-availability vrrp group Foo transition-script master "/config/scripts/vrrp-master.sh Foo" +.. start_vyoslinter + To know more about scripting, check the :ref:`command-scripting` section. Virtual-server @@ -401,10 +419,14 @@ Health-check ^^^^^^^^^^^^ Custom health-check script allows checking real-server availability +.. stop_vyoslinter + .. code-block:: none set high-availability virtual-server 203.0.113.1 real-server 192.0.2.11 health-check script +.. start_vyoslinter + Fwmark ^^^^^^ Firewall mark. It possible to loadbalancing traffic based on ``fwmark`` value @@ -417,10 +439,14 @@ Real server ^^^^^^^^^^^ Real server IP address and port +.. stop_vyoslinter + .. code-block:: none set high-availability virtual-server 203.0.113.1 real-server 192.0.2.11 port '80' +.. start_vyoslinter + Example ^^^^^^^ @@ -432,6 +458,8 @@ protocol TCP is balanced between 2 real servers ``192.0.2.11`` and Real server is auto-excluded if port check with this server fail. +.. stop_vyoslinter + .. code-block:: none set interfaces ethernet eth0 address '203.0.113.11/24' @@ -451,6 +479,7 @@ Real server is auto-excluded if port check with this server fail. set high-availability virtual-server 203.0.113.1 real-server 192.0.2.11 port '80' set high-availability virtual-server 203.0.113.1 real-server 192.0.2.12 port '80' +.. start_vyoslinter A firewall mark ``fwmark`` allows using multiple ports for high-availability virtual-server. @@ -460,6 +489,8 @@ In this example all traffic destined to ports "80, 2222, 8888" protocol TCP marks to fwmark "111" and balanced between 2 real servers. Port "0" is required if multiple ports are used. +.. stop_vyoslinter + .. code-block:: none set interfaces ethernet eth0 address 'dhcp' @@ -483,6 +514,8 @@ Port "0" is required if multiple ports are used. set nat source rule 100 source address '192.0.2.0/24' set nat source rule 100 translation address 'masquerade' +.. start_vyoslinter + Op-mode check virtual-server status .. code-block:: none diff --git a/docs/configuration/loadbalancing/wan.rst b/docs/configuration/loadbalancing/wan.rst index 3d5a3cc6..b9a513bc 100644 --- a/docs/configuration/loadbalancing/wan.rst +++ b/docs/configuration/loadbalancing/wan.rst @@ -1,7 +1,11 @@ :lastproofread: 2026-04-06 +################## WAN load balancing -================== +################## + +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. The load balancer distributes outbound traffic across two or more interfaces. If a path fails, the load balancer balances traffic across the diff --git a/docs/configuration/nat/nat64.rst b/docs/configuration/nat/nat64.rst index 8608da9f..04ba56f4 100644 --- a/docs/configuration/nat/nat64.rst +++ b/docs/configuration/nat/nat64.rst @@ -4,9 +4,6 @@ NAT64 ##### -.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd - directives for command coverage tracking. - :abbr:`NAT64 (IPv6-to-IPv4 Prefix Translation)` is a critical component in modern networking, facilitating communication between IPv6 and IPv4 networks. This documentation outlines the setup, configuration, and usage of the NAT64 diff --git a/docs/configuration/nat/nat66.rst b/docs/configuration/nat/nat66.rst index d7d8e8be..be5cf2b3 100644 --- a/docs/configuration/nat/nat66.rst +++ b/docs/configuration/nat/nat66.rst @@ -163,6 +163,8 @@ a VyOS HA pair. Configure both routers (a and b) for DHCPv6-PD via dummy interface: +.. stop_vyoslinter + .. code-block:: none set interfaces dummy dum1 description 'DHCPv6-PD NPT dummy' @@ -173,6 +175,8 @@ Configure both routers (a and b) for DHCPv6-PD via dummy interface: set interfaces bonding bond0 vif 20 dhcpv6-options rapid-commit commit +.. start_vyoslinter + Get the DHCPv6-PD prefixes from both routers: .. code-block:: none diff --git a/docs/configuration/policy/examples.rst b/docs/configuration/policy/examples.rst index 11c1d625..d822d839 100644 --- a/docs/configuration/policy/examples.rst +++ b/docs/configuration/policy/examples.rst @@ -2,9 +2,6 @@ BGP Example ########### -.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd - directives for command coverage tracking. - **Policy definition:** .. code-block:: none diff --git a/docs/configuration/policy/index.rst b/docs/configuration/policy/index.rst index 51f60479..0394eb21 100644 --- a/docs/configuration/policy/index.rst +++ b/docs/configuration/policy/index.rst @@ -1,4 +1,4 @@ -:lastproofread:2021-07-12 +:lastproofread: 2021-07-12 .. include:: /_include/need_improvement.txt diff --git a/docs/configuration/protocols/static.rst b/docs/configuration/protocols/static.rst index e9016abc..eb5a439c 100644 --- a/docs/configuration/protocols/static.rst +++ b/docs/configuration/protocols/static.rst @@ -70,12 +70,14 @@ IPv4 BFD Configure a static route for `` using gateway `
` and use the gateway address as BFD peer destination address. -.. cfgcmd:: set protocols static route next-hop
- bfd profile +.. stop_vyoslinter + +.. cfgcmd:: set protocols static route next-hop
bfd profile - Configure a static route for `` using gateway `
` - and use the gateway address as BFD peer destination address with - BFD profile ``. +.. start_vyoslinter + + Configure a static route for `` using gateway `
` and use the + gateway address as BFD peer destination address with BFD profile ``. .. cfgcmd:: set protocols static route next-hop
bfd multi-hop source-address @@ -155,15 +157,20 @@ IPv6 Unicast Routes .. note:: Routes with a distance of 255 are effectively disabled and not installed into the kernel. -.. cfgcmd:: set protocols static route6 next-hop
- segments +.. stop_vyoslinter - It is possible to specify a static route for ipv6 prefixes using - an SRv6 segments instruction. The `/` separator can be used to - specify multiple segment instructions. +.. cfgcmd:: set protocols static route6 next-hop
segments + +.. start_vyoslinter + + It is possible to specify a static route for ipv6 prefixes using an + SRv6 segments instruction. The ``/`` separator can be used to specify + multiple segment instructions. Example: +.. stop_vyoslinter + .. code-block:: none set protocols static route6 2001:db8:1000::/36 next-hop 2001:db8:201::ffff segments '2001:db8:aaaa::7/2002::4/2002::3/2002::2' @@ -180,6 +187,8 @@ IPv6 Unicast Routes C>* 2001:db8:201::/64 is directly connected, eth0.201, 00:00:46 S>* 2001:db8:1000::/36 [1/0] via 2001:db8:201::ffff, eth0.201, seg6 2001:db8:aaaa::7,2002::4,2002::3,2002::2, weight 1, 00:00:08 +.. start_vyoslinter + IPv6 Interface Routes ===================== @@ -206,16 +215,20 @@ IPv6 Interface Routes .. cfgcmd:: set protocols static route6 interface segments - It is possible to specify a static route for ipv6 prefixes using - an SRv6 segments instruction. The `/` separator can be used to - specify multiple segment instructions. + It is possible to specify a static route for ipv6 prefixes using an + SRv6 segments instruction. The ``/`` separator can be used to specify + multiple segment instructions. Example: +.. stop_vyoslinter + .. code-block:: none set protocols static route6 2001:db8:1000::/36 interface eth0 segments '2001:db8:aaaa::7/2002::4/2002::3/2002::2' +.. start_vyoslinter + IPv6 BFD ======== @@ -224,15 +237,21 @@ IPv6 BFD Configure a static route for `` using gateway `
` and use the gateway address as BFD peer destination address. -.. cfgcmd:: set protocols static route6 next-hop
- bfd profile +.. stop_vyoslinter - Configure a static route for `` using gateway `
` - and use the gateway address as BFD peer destination address with - BFD profile ``. +.. cfgcmd:: set protocols static route6 next-hop
bfd profile -.. cfgcmd:: set protocols static route6 next-hop
- bfd multi-hop source-address +.. start_vyoslinter + + Configure a static route for `` using gateway `
` and use the + gateway address as BFD peer destination address with BFD profile ``. + +.. stop_vyoslinter + +.. cfgcmd:: set protocols static route6 next-hop
bfd multi-hop + source-address + +.. start_vyoslinter Configure a static route for `` using gateway `
` and use the gateway address as BFD peer destination address with source address diff --git a/docs/configuration/service/eventhandler.rst b/docs/configuration/service/eventhandler.rst index 15f08239..9f4ebb04 100644 --- a/docs/configuration/service/eventhandler.rst +++ b/docs/configuration/service/eventhandler.rst @@ -8,8 +8,9 @@ Event Handler Event Handler Technology Overview ********************************* -Event handler allows you to execute scripts when a string that matches a regex or a regex with -a service name appears in journald logs. You can pass variables, arguments, and a full matching string to the script. +Event handler allows you to execute scripts when a string that matches +a regex or a regex with a service name appears in journald logs. You +can pass variables, arguments, and a full matching string to the script. ****************************** @@ -33,49 +34,76 @@ Event Handler Configuration Steps .. cfgcmd:: set service event-handler event - This is an optional command because the event handler will be automatically created after any of the next commands. + This is an optional command because the event handler will be + automatically created after any of the next commands. 2. Add regex to the script =========================================== - .. cfgcmd:: set service event-handler event filter pattern +.. stop_vyoslinter - This is a mandatory command. Sets regular expression to match against log string message. - - .. note:: The regular expression matches if and only if the entire string matches the pattern. + .. cfgcmd:: set service event-handler event filter pattern + +.. start_vyoslinter + + This is a mandatory command. Sets regular expression to match + against log string message. + + .. note:: The regular expression matches if and only if the entire + string matches the pattern. 3. Add a full path to the script ================================ +.. stop_vyoslinter + .. cfgcmd:: set service event-handler event script path - - This is a mandatory command. Sets the full path to the script. The script file must be executable. + +.. start_vyoslinter + + This is a mandatory command. Sets the full path to the script. + The script file must be executable. 4. Add optional parameters ========================== - .. cfgcmd:: set service event-handler event filter syslog-identifier +.. stop_vyoslinter + + .. cfgcmd:: set service event-handler event filter syslog-identifier + +.. start_vyoslinter This is an optional command. Filters log messages by syslog-identifier. +.. stop_vyoslinter + .. cfgcmd:: set service event-handler event script environment value - This is an optional command. Adds environment and its value to the script. Use separate commands for each environment. +.. start_vyoslinter + + This is an optional command. Adds environment and its value to the + script. Use separate commands for each environment. One implicit environment exists. * ``message``: Full message that has triggered the script. +.. stop_vyoslinter + .. cfgcmd:: set service event-handler event script arguments - This is an optional command. Adds arguments to the script. Arguments must be separated by spaces. +.. start_vyoslinter + + This is an optional command. Adds arguments to the script. + Arguments must be separated by spaces. - .. note:: We don't recomend to use arguments. Using environments is more preffereble. + .. note:: We don't recommend to use arguments. Using environments + is more preferable. ******* @@ -84,44 +112,48 @@ Example Event handler that monitors the state of interface eth0. +.. stop_vyoslinter + .. code-block:: none - set service event-handler event INTERFACE_STATE_DOWN filter pattern '.*eth0.*,RUNNING,.*->.*' - set service event-handler event INTERFACE_STATE_DOWN filter syslog-identifier 'netplugd' - set service event-handler event INTERFACE_STATE_DOWN script environment interface_action value 'down' - set service event-handler event INTERFACE_STATE_DOWN script environment interface_name value 'eth2' - set service event-handler event INTERFACE_STATE_DOWN script path '/config/scripts/eventhandler.py' + set service event-handler event INTERFACE_STATE_DOWN filter pattern '.*eth0.*,RUNNING,.*->.*' + set service event-handler event INTERFACE_STATE_DOWN filter syslog-identifier 'netplugd' + set service event-handler event INTERFACE_STATE_DOWN script environment interface_action value 'down' + set service event-handler event INTERFACE_STATE_DOWN script environment interface_name value 'eth0' + set service event-handler event INTERFACE_STATE_DOWN script path '/config/scripts/eventhandler.py' Event handler script .. code-block:: none - #!/usr/bin/env python3 - # - # VyOS event-handler script example - from os import environ - import subprocess - from sys import exit - - # Perform actions according to requirements - def process_event() -> None: - # Get variables - message_text = environ.get('message') - interface_name = environ.get('interface_name') - interface_action = environ.get('interface_action') - # Print the message that triggered this script - print(f'Logged message: {message_text}') - # Prepare a command to run - command = f'sudo ip link set {interface_name} {interface_action}'.split() - # Execute a command - subprocess.run(command) - - if __name__ == '__main__': - try: - # Run script actions and exit - process_event() - exit(0) - except Exception as err: - # Exit properly in case if something in the script goes wrong - print(f'Error running script: {err}') - exit(1) + #!/usr/bin/env python3 + # + # VyOS event-handler script example + from os import environ + import subprocess + from sys import exit + + # Perform actions according to requirements + def process_event() -> None: + # Get variables + message_text = environ.get('message') + interface_name = environ.get('interface_name') + interface_action = environ.get('interface_action') + # Print the message that triggered this script + print(f'Logged message: {message_text}') + # Prepare a command to run + command = f'sudo ip link set {interface_name} {interface_action}'.split() + # Execute a command + subprocess.run(command) + + if __name__ == '__main__': + try: + # Run script actions and exit + process_event() + exit(0) + except Exception as err: + # Exit properly in case if something in the script goes wrong + print(f'Error running script: {err}') + exit(1) + +.. start_vyoslinter diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index 9e91cc50..b444ab85 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -4,9 +4,6 @@ SNMP #### -.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd - directives for command coverage tracking. - :abbr:`SNMP (Simple Network Management Protocol)` is an Internet Standard protocol for collecting and organizing information about managed devices on IP networks and for modifying that information to change device behavior. diff --git a/docs/configuration/system/flow-accounting.rst b/docs/configuration/system/flow-accounting.rst index cb18839a..0664eac7 100644 --- a/docs/configuration/system/flow-accounting.rst +++ b/docs/configuration/system/flow-accounting.rst @@ -84,9 +84,9 @@ CLI command. You may disable using the local in-memory table with the command: .. cfgcmd:: set system flow-accounting syslog-facility - Configure the syslog facility used for flow-accounting log messages. - Available facilities follow standard syslog conventions (e.g., - ``daemon``, ``local0`` through ``local7``). + Set the syslog facility for flow-accounting log messages. Supported values + include ``daemon``, ``local0`` through ``local7``, and other standard syslog + facilities. Flow Export ----------- @@ -167,6 +167,8 @@ display captured network traffic information for all configured interfaces. Show flow accounting information for given ``. + .. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show flow-accounting interface eth0 @@ -180,11 +182,15 @@ display captured network traffic information for all configured interfaces. eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40006 22 tcp 16 146 1 9444 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 0 0 icmp 192 27 1 4455 + .. start_vyoslinter + .. opcmd:: show flow-accounting interface host
Show flow accounting information for given `` for a specific host only. + .. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show flow-accounting interface eth0 host 192.0.2.14 @@ -193,3 +199,5 @@ display captured network traffic information for all configured interfaces. eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40006 22 tcp 16 197 2 12940 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 40152 22 tcp 16 94 1 4924 eth0 00:53:01:b2:22:48 00:53:02:58:a2:92 192.0.2.100 192.0.2.14 0 0 icmp 192 36 1 5877 + + .. start_vyoslinter diff --git a/docs/configuration/system/sysctl.rst b/docs/configuration/system/sysctl.rst index d1398822..1fedb9bd 100644 --- a/docs/configuration/system/sysctl.rst +++ b/docs/configuration/system/sysctl.rst @@ -4,13 +4,11 @@ Sysctl ###### -.. note:: This page is a stub and needs expansion. - Contributions welcome via the - VyOS `documentation repository`_. +.. note:: This page is a stub and needs expansion. Contributions + welcome via the `VyOS documentation repository + `_. -.. _documentation repository: https://github.com/vyos/vyos-documentation - -This chapeter describes how to configure kernel parameters at runtime. +This chapter describes how to configure kernel parameters at runtime. ``sysctl`` is used to modify kernel parameters at runtime. The parameters available are those listed under /proc/sys/. diff --git a/docs/configuration/vpn/index.rst b/docs/configuration/vpn/index.rst index 228f83ca..6d38e5b5 100644 --- a/docs/configuration/vpn/index.rst +++ b/docs/configuration/vpn/index.rst @@ -7,10 +7,10 @@ VPN :maxdepth: 1 :includehidden: - dmvpn ipsec/index l2tp openconnect pptp rsa-keys sstp + dmvpn diff --git a/docs/configuration/vpn/ipsec/index.rst b/docs/configuration/vpn/ipsec/index.rst index 7647d8d2..973c76de 100644 --- a/docs/configuration/vpn/ipsec/index.rst +++ b/docs/configuration/vpn/ipsec/index.rst @@ -11,3 +11,5 @@ IPsec site2site_ipsec remoteaccess_ipsec troubleshooting_ipsec + + diff --git a/docs/configuration/vpn/ipsec/remoteaccess_ipsec.rst b/docs/configuration/vpn/ipsec/remoteaccess_ipsec.rst index 1a41d987..50499160 100644 --- a/docs/configuration/vpn/ipsec/remoteaccess_ipsec.rst +++ b/docs/configuration/vpn/ipsec/remoteaccess_ipsec.rst @@ -1,7 +1,11 @@ .. _remoteaccess_ipsec: +############################ IPSec IKEv2 Remote Access VPN -============================= +############################ + +.. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd + directives for command coverage tracking. Internet Key Exchange version 2 (IKEv2) is a tunneling protocol, based on IPsec, that establishes a secure VPN communication between VPN devices, and defines diff --git a/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst b/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst index 8494f0ea..f0f2e208 100644 --- a/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst +++ b/docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst @@ -29,6 +29,8 @@ Checking IKE SA Status The next command shows IKE SAs' statuses. +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show vpn ike sa @@ -289,8 +291,8 @@ The reason of this problem is showed on the responder side. Jun 23 08:16:12 charon-systemd[2440]: no acceptable proposal found Jun 23 08:16:12 charon[2440]: 01[IKE] failed to establish CHILD_SA, keeping IKE_SA -Encryption **AES_CBC_128** is configured in IKE policy on the -responder but **AES_CBC_256** is configured on the initiator side. +Encryption **AES_CBC_128** is configured in IKE policy on the responder but **AES_CBC_256** +is configured on the initiator side. Prefixes in Policies Mismatch ============================= @@ -320,6 +322,8 @@ The reason of this problem is showed on the responder side. Jun 23 14:13:19 charon[2440]: 01[ENC] generating IKE_AUTH response 1 [ IDr AUTH N(MOBIKE_SUP) N(NO_ADD_ADDR) N(TS_UNACCEPT) ] Jun 23 14:13:19 charon-systemd[2440]: generating IKE_AUTH response 1 [ IDr AUTH N(MOBIKE_SUP) N(NO_ADD_ADDR) N(TS_UNACCEPT) ] +.. start_vyoslinter + Traffic selectors **10.0.2.0/24 === 10.0.0.0/24** are unacceptable on the responder side. diff --git a/docs/configuration/vpn/openconnect.rst b/docs/configuration/vpn/openconnect.rst index d5c76e3e..0262b3f2 100644 --- a/docs/configuration/vpn/openconnect.rst +++ b/docs/configuration/vpn/openconnect.rst @@ -40,10 +40,14 @@ client that fetches a certificate from Let's Encrypt an open certificate authority launched by the EFF, Mozilla, and others and deploys it to a web server. +.. stop_vyoslinter + .. code-block:: none sudo certbot certonly --standalone --preferred-challenges http -d +.. start_vyoslinter + Server Configuration ==================== @@ -66,6 +70,8 @@ authentication + OTP key can be used. Alternatively, OTP authentication only, without a password, can be used. To do this, an OTP configuration must be added to the configuration above: +.. stop_vyoslinter + .. code-block:: none set vpn openconnect authentication mode local @@ -74,6 +80,8 @@ To do this, an OTP configuration must be added to the configuration above: set vpn openconnect authentication local-users username otp-length set vpn openconnect authentication local-users username token-type +.. start_vyoslinter + For generating an OTP key in VyOS, you can use the CLI command (operational mode): @@ -98,8 +106,7 @@ shortcuts for Common Name (OID 2.5.4.3) and User ID Otherwise a specific OID value must be provided. The user's certificate must be signed by the certificate authority -defined in the configuration for it to be validated for -authentication. +defined in the configuration for it to be validated for authentication. .. code-block:: none @@ -111,14 +118,17 @@ authentication. Verification ************ -.. code-block:: none +.. stop_vyoslinter +.. code-block:: none vyos@vyos:~$ sh openconnect-server sessions interface username ip remote IP RX TX state uptime ----------- ---------- ------------- ----------- ------- --------- --------- -------- sslvpn0 tst 172.20.20.198 192.168.6.1 0 bytes 152 bytes connected 3s +.. start_vyoslinter + .. note:: It is compatible with Cisco (R) AnyConnect (R) clients. ******* @@ -130,6 +140,8 @@ SSL Certificates generation Follow the instructions to generate CA cert (in configuration mode): +.. stop_vyoslinter + .. code-block:: none vyos@vyos# run generate pki ca install ca-ocserv @@ -167,6 +179,8 @@ Follow the instructions to generate server cert (in configuration mode): 2 value(s) installed. Use "compare" to see the pending changes, and "commit" to apply. [edit] +.. start_vyoslinter + Each of the install command should be applied to the configuration and commited before using under the openconnect configuration: @@ -184,6 +198,8 @@ Openconnect Configuration Simple setup with one user added and password authentication: +.. stop_vyoslinter + .. code-block:: none set vpn openconnect authentication local-users username tst password 'OC_bad_Secret' @@ -194,6 +210,8 @@ Simple setup with one user added and password authentication: set vpn openconnect ssl ca-certificate 'ca-ocserv' set vpn openconnect ssl certificate 'srv-ocserv' +.. start_vyoslinter + To enable the HTTP security headers in the configuration file, use the command: .. code-block:: none @@ -207,6 +225,8 @@ Adding a 2FA with an OTP-key First the OTP keys must be generated and sent to the user and to the configuration: +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ generate openconnect username tst otp-key hotp-time @@ -238,13 +258,19 @@ configuration: # To add this OTP key to configuration, run the following commands: set vpn openconnect authentication local-users username tst otp key 'ebc1c91b13848ce0bb67d9212934546e41803cfa' +.. start_vyoslinter + Next it is necessary to configure 2FA for OpenConnect: +.. stop_vyoslinter + .. code-block:: none set vpn openconnect authentication mode local password-otp set vpn openconnect authentication local-users username tst otp key 'ebc1c91b13848ce0bb67d9212934546e41803cfa' +.. start_vyoslinter + Now when connecting the user will first be asked for the password and then the OTP key. @@ -270,6 +296,8 @@ outlines the set of configuration options that are allowed. This can be leveraged to apply different sets of configs to different users or groups of users. +.. stop_vyoslinter + .. code-block:: none sudo mkdir -p /config/auth/ocserv/config-per-user @@ -279,6 +307,8 @@ users. set vpn openconnect authentication identity-based-config directory /config/auth/ocserv/config-per-user set vpn openconnect authentication identity-based-config default-config /config/auth/ocserv/default-user.conf +.. start_vyoslinter + .. warning:: The above directory and default-config must be a child directory of /config/auth, since files outside this directory are not persisted after an image upgrade. @@ -313,6 +343,8 @@ connect/disconnect, data transferred, and so on. Configure an accounting server and enable accounting with: +.. stop_vyoslinter + .. code-block:: none set vpn openconnect accounting mode radius @@ -320,12 +352,16 @@ Configure an accounting server and enable accounting with: set vpn openconnect accounting radius server 172.20.20.10 port 1813 set vpn openconnect accounting radius server 172.20.20.10 key your_radius_secret +.. start_vyoslinter + .. warning:: The RADIUS accounting feature must be used with the OpenConnect authentication mode RADIUS. It cannot be used with local authentication. You must configure the OpenConnect authentication mode to "radius". An example of the data captured by a FREERADIUS server with sql accounting: +.. stop_vyoslinter + .. code-block:: none mysql> SELECT username, nasipaddress, acctstarttime, acctstoptime, acctinputoctets, acctoutputoctets, callingstationid, framedipaddress, connectinfo_start FROM radacct; @@ -334,3 +370,5 @@ An example of the data captured by a FREERADIUS server with sql accounting: +----------+---------------+---------------------+---------------------+-----------------+------------------+-------------------+-----------------+-----------------------------------+ | test | 198.51.100.15 | 2023-01-13 00:59:15 | 2023-01-13 00:59:21 | 10606 | 152 | 192.168.6.1 | 172.20.20.198 | Open AnyConnect VPN Agent v8.05-1 | +----------+---------------+---------------------+---------------------+-----------------+------------------+-------------------+-----------------+-----------------------------------+ + +.. start_vyoslinter diff --git a/docs/configuration/vpn/rsa-keys.rst b/docs/configuration/vpn/rsa-keys.rst index ce9aa720..e7584563 100644 --- a/docs/configuration/vpn/rsa-keys.rst +++ b/docs/configuration/vpn/rsa-keys.rst @@ -13,6 +13,8 @@ RSA keys for authentication. They are very fast and easy to setup. First, on both routers run the operational command "generate pki key-pair install >". You may choose different length than 2048 of course. +.. stop_vyoslinter + .. code-block:: none vyos@left# run generate pki key-pair install ipsec-LEFT @@ -27,6 +29,8 @@ install >". You may choose different length than 2048 of course. set pki key-pair ipsec-LEFT private key 'MIIEvgIBADAN...' [edit] +.. start_vyoslinter + Configuration commands will display. Note the command with the public key (set pki key-pair ipsec-LEFT public key 'MIIBIjANBgkqh...'). @@ -66,6 +70,8 @@ Now you are ready to setup IPsec. The key points: On the LEFT (static address): +.. stop_vyoslinter + .. code-block:: none set vpn ipsec interface eth0 @@ -113,3 +119,5 @@ On the RIGHT (dynamic address): set vpn ipsec site-to-site peer 192.0.2.10 local-address any set vpn ipsec site-to-site peer 192.0.2.10 tunnel 1 local prefix 192.168.99.2/32 # Additional loopback address on the local set vpn ipsec site-to-site peer 192.0.2.10 tunnel 1 remote prefix 192.168.99.1/32 # Additional loopback address on the remote + +.. start_vyoslinter diff --git a/docs/installation/cloud/oracle.rst b/docs/installation/cloud/oracle.rst index f5e03329..d71d8039 100644 --- a/docs/installation/cloud/oracle.rst +++ b/docs/installation/cloud/oracle.rst @@ -4,11 +4,9 @@ Oracle ###### -.. note:: This page is a stub and needs expansion. - Contributions welcome via the - VyOS `documentation repository`_. - -.. _documentation repository: https://github.com/vyos/vyos-documentation +.. note:: This page is a stub and needs expansion. Contributions + welcome via the `VyOS documentation repository + `_. .. stop_vyoslinter References diff --git a/docs/installation/virtual/eve-ng.rst b/docs/installation/virtual/eve-ng.rst index 0dd07db8..f3db28fe 100644 --- a/docs/installation/virtual/eve-ng.rst +++ b/docs/installation/virtual/eve-ng.rst @@ -4,11 +4,9 @@ EVE-NG ###### -.. note:: This page is a stub and needs expansion. - Contributions welcome via the - VyOS `documentation repository`_. - -.. _documentation repository: https://github.com/vyos/vyos-documentation +.. note:: This page is a stub and needs expansion. Contributions + welcome via the `VyOS documentation repository + `_. References ========== diff --git a/docs/operation/information.rst b/docs/operation/information.rst index fbff53a3..1b3d876a 100644 --- a/docs/operation/information.rst +++ b/docs/operation/information.rst @@ -2,9 +2,9 @@ .. _information: -****************** +################## System Information -****************** +################## VyOS features a rich set of operational level commands to retrieve arbitrary information about your running system. For more information on the VyOS command @@ -42,6 +42,8 @@ recent Linux distributions. .. note:: If a device is unplugged and plugged in again, it is assigned a new ``Port``, ``Dev``, and ``If``. +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show hardware usb @@ -70,6 +72,8 @@ recent Linux distributions. |__ Port 4: Dev 7, If 2, Class=Vendor Specific Class, Driver=ftdi_sio, 480M |__ Port 4: Dev 7, If 0, Class=Vendor Specific Class, Driver=ftdi_sio, 480M +.. start_vyoslinter + .. opcmd:: show hardware usb serial @@ -77,6 +81,8 @@ recent Linux distributions. device name displayed, (for example ``usb0b2.4p1.0``), can be used directly when accessing the serial console as console-server device. +.. stop_vyoslinter + .. code-block:: none vyos@vyos$ show hardware usb serial @@ -99,6 +105,8 @@ recent Linux distributions. usb0b2.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd usb0b2.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd +.. start_vyoslinter + .. _information_version: ######## @@ -107,8 +115,9 @@ Version .. opcmd:: show version - Return the currently running VyOS version and build information. This includes - the name of the release train, e.g., ``sagitta`` on VyOS 1.4, and ``circinus`` on VyOS 1.5. + Return the currently running VyOS version and build information. This + includes the name of the release train, e.g., ``sagitta`` on VyOS 1.4, + and ``circinus`` on VyOS 1.5. .. code-block:: none diff --git a/docs/vpp/configuration/ipfix.rst b/docs/vpp/configuration/ipfix.rst index 2085740a..92c734be 100644 --- a/docs/vpp/configuration/ipfix.rst +++ b/docs/vpp/configuration/ipfix.rst @@ -1,5 +1,6 @@ +####################### VPP IPFIX Configuration -======================= +####################### VPP IPFIX in VyOS allows monitoring and exporting network traffic flows for analytics, security, and accounting. IPFIX works with the VPP @@ -18,7 +19,8 @@ Key IPFIX Concepts - **Active timeout**: Maximum time a flow is kept active before export. - **Inactive timeout**: Maximum time an idle flow is kept before export. - **Collector**: The remote host and port to which flow records are sent. -- **Flow layers**: Determines which layer information is included (`l2`, `l3`, `l4`). +- **Flow layers**: Determines which layer information is included + (``l2``, ``l3``, ``l4``). - **Interfaces**: Physical or virtual interfaces to monitor. - **Direction**: Which traffic to monitor (`rx`, `tx`, `both`). - **Flow variant**: Optional filter for IPv4 or IPv6 flows. @@ -26,12 +28,16 @@ Key IPFIX Concepts Configuration Options --------------------- -- **active-timeout**: Duration (in seconds) after which active flows are exported. -- **inactive-timeout**: Duration (in seconds) after which idle flows are exported. +- **active-timeout**: Duration (in seconds) after which active flows + are exported. +- **inactive-timeout**: Duration (in seconds) after which idle flows + are exported. - **collector `` port ``**: IP and UDP port of the IPFIX collector. - **collector `` source-address ``**: Source address for flow export. - **flowprobe-record ``**: Layers to include in flow records. -- **interface `` [direction ``] [flow-variant ``]**: Interfaces to monitor, direction of traffic, and optional flow variant filter. +- **interface** ```` **[direction** ````\ **]** + **[flow-variant** ````\ **]**: Interfaces to monitor, + direction of traffic, and optional flow variant filter. Example Configuration --------------------- -- cgit v1.2.3 From 3fab910622ef60a8fd68d5552ad104f46608df35 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 10 Apr 2026 21:48:08 +0300 Subject: docs: fix typos and prose in terraform, ansible, and config docs (#1829) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: fix typos and improve prose in terraform, ansible, and config docs Fix typos (VyoS→VyOS, respresent→represents), rewrap long prose lines for readability, restore correct YAML indentation in Ansible examples, and standardize heading hierarchy in affected files. Co-Authored-By: Claude Opus 4.6 (1M context) * docs: replace public DNS IP with RFC 5737 address in NMP example Use 198.51.100.1 (TEST-NET-2) instead of 8.8.8.8 to satisfy the documentation linter requirement for reserved addresses. Co-Authored-By: Claude Opus 4.6 (1M context) * docs: restore linter markers around NMP code block with 8.8.8.8 Restore stop/start_vyoslinter markers that were incorrectly removed. The DNS server address is intentional and should not be changed. Co-Authored-By: Claude Opus 4.6 (1M context) --------- Co-authored-by: Claude Opus 4.6 (1M context) --- docs/automation/terraform/terraformAWS.rst | 2 +- docs/configexamples/ansible.rst | 62 +++++++++--------- docs/configuration/index.rst | 2 +- docs/configuration/interfaces/openvpn-examples.rst | 74 ++++++++++++++++++---- 4 files changed, 96 insertions(+), 44 deletions(-) (limited to 'docs/configuration') diff --git a/docs/automation/terraform/terraformAWS.rst b/docs/automation/terraform/terraformAWS.rst index 057f3513..4bf0a7c9 100644 --- a/docs/automation/terraform/terraformAWS.rst +++ b/docs/automation/terraform/terraformAWS.rst @@ -446,7 +446,7 @@ File contents of Terraform for AWS } variable "host"{ description = "The IP of my Ansible" - type = string + type = string } variable "access" { description = "my access_key for AWS" diff --git a/docs/configexamples/ansible.rst b/docs/configexamples/ansible.rst index 4241c706..4d6561d0 100644 --- a/docs/configexamples/ansible.rst +++ b/docs/configexamples/ansible.rst @@ -51,6 +51,8 @@ Install Paramiko: Check the version: ================== +.. stop_vyoslinter + .. code-block:: none # ansible --version @@ -61,6 +63,8 @@ Check the version: executable location = /usr/bin/ansible python version = 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110] +.. start_vyoslinter + Basic configuration of ansible.cfg: ======================================= @@ -99,8 +103,6 @@ Add general variables: Add a simple playbook with the tasks for each router: ===================================================== -.. stop_vyoslinter - .. code-block:: none # nano /root/main.yml @@ -112,24 +114,24 @@ Add a simple playbook with the tasks for each router: - name: Configure general settings for the vyos hosts group vyos_config: lines: - - set system name-server 8.8.8.8 - - set interfaces ethernet eth0 description '#WAN#' - - set interfaces ethernet eth1 description '#LAN#' - - set interfaces ethernet eth2 disable - - set interfaces ethernet eth3 disable - - set system host-name {{ inventory_hostname }} + - set system name-server 192.0.2.1 + - set interfaces ethernet eth0 description '#WAN#' + - set interfaces ethernet eth1 description '#LAN#' + - set interfaces ethernet eth2 disable + - set interfaces ethernet eth3 disable + - set system host-name {{ inventory_hostname }} save: true - -.. start_vyoslinter - + Start the playbook: =================== +.. stop_vyoslinter + .. code-block:: none ansible-playbook -i hosts main.yml PLAY [vyos_hosts] ************************************************************** - + TASK [Configure general settings for the vyos hosts group] ********************* ok: [vyos9] ok: [vyos10] @@ -142,11 +144,11 @@ Start the playbook: vyos8 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 vyos9 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 +.. start_vyoslinter + Check the result on the vyos10 router: ====================================== -.. stop_vyoslinter - .. code-block:: none vyos@vyos10:~$ show interfaces @@ -159,17 +161,13 @@ Check the result on the vyos10 router: eth3 - A/D lo 127.0.0.1/8 u/u ::1/128 - - vyos@vyos10:~$ sh configuration commands | grep 8.8.8.8 - set system name-server '8.8.8.8' - -.. start_vyoslinter + + vyos@vyos10:~$ sh configuration commands | grep 192.0.2.1 + set system name-server '192.0.2.1' The simple way without configuration of the hostname (one task for all routers): ================================================================================ -.. stop_vyoslinter - .. code-block:: none # nano /root/hosts_v2 @@ -194,21 +192,22 @@ The simple way without configuration of the hostname (one task for all routers): - name: Configure remote vyos_hosts_group vyos_config: lines: - - set system name-server 8.8.8.8 - - set interfaces ethernet eth0 description WAN - - set interfaces ethernet eth1 description LAN - - set interfaces ethernet eth2 disable - - set interfaces ethernet eth3 disable + - set system name-server 192.0.2.1 + - set interfaces ethernet eth0 description WAN + - set interfaces ethernet eth1 description LAN + - set interfaces ethernet eth2 disable + - set interfaces ethernet eth3 disable save: true -.. start_vyoslinter + +.. stop_vyoslinter .. code-block:: none - + # ansible-playbook -i hosts_v2 main_v2.yml - + PLAY [vyos_hosts_group] ******************************************************** - + TASK [Configure remote vyos_hosts_group] *************************************** ok: [vyos8] ok: [vyos7] @@ -220,7 +219,8 @@ The simple way without configuration of the hostname (one task for all routers): vyos7 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 vyos8 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 vyos9 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 - + +.. start_vyoslinter In the next chapter of the example, we'll use Ansible with jinja2 templates and variables. diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst index f607d4d7..f86365a9 100644 --- a/docs/configuration/index.rst +++ b/docs/configuration/index.rst @@ -2,7 +2,7 @@ Configuration Guide ################### -The following structure respresent the cli structure. +The following structure represents the CLI structure. .. toctree:: :maxdepth: 1 diff --git a/docs/configuration/interfaces/openvpn-examples.rst b/docs/configuration/interfaces/openvpn-examples.rst index 34cabddf..4685e4df 100644 --- a/docs/configuration/interfaces/openvpn-examples.rst +++ b/docs/configuration/interfaces/openvpn-examples.rst @@ -1,6 +1,7 @@ +############ Site-to-site -============ +############ .. TODO:: Convert raw command blocks in this file to cfgcmd/opcmd directives for command coverage tracking. @@ -32,9 +33,9 @@ In both cases, we will use the following settings: * The ``persistent-tunnel`` directive allows us to configure tunnel-related attributes, such as firewall policy, as we would on any standard network interface. -* If known, the remote router's IP address can be configured using - the ``remote-host`` directive. If unknown, it can be omitted. - We assume the remote router has a dynamic IP address. +* If known, the remote router's IP address can be configured using the + ``remote-host`` directive. If unknown, it can be omitted. We assume + the remote router has a dynamic IP address. .. figure:: /_static/images/openvpn_site2site_diagram.jpg @@ -54,6 +55,8 @@ Elliptic Curve (EC) type. In configuration mode, run the following command: certificate to the configuration session's ``pki`` subtree. Review and commit the changes. +.. stop_vyoslinter + .. code-block:: none vyos@vyos# run generate pki certificate self-signed install openvpn-local @@ -85,6 +88,7 @@ the changes. vyos@vyos# commit +.. start_vyoslinter You do **not** need to copy the certificate to the other router. Instead, retrieve its SHA-256 fingerprint. Since OpenVPN currently supports only SHA-256 @@ -109,6 +113,8 @@ Set up site-to-site OpenVPN Local configuration: +.. stop_vyoslinter + .. code-block:: none Configure the tunnel: @@ -141,6 +147,8 @@ Remote configuration: set interfaces openvpn vtun1 tls peer-fingerprint # The output of 'run show pki certificate fingerprint sha256 on the local router set interfaces openvpn vtun1 tls role passive +.. start_vyoslinter + Set up pre-shared keys ---------------------- @@ -153,6 +161,8 @@ First, generate a key by running ``run generate pki openvpn shared-secret install `` in configuration mode. You can use any name; in this example, we use ``s2s``. +.. stop_vyoslinter + .. code-block:: none vyos@local# run generate pki openvpn shared-secret install s2s @@ -170,6 +180,8 @@ we use ``s2s``. vyos@local# commit [edit] +.. start_vyoslinter + Next, install the key on the remote router: .. code-block:: none @@ -188,6 +200,8 @@ Set up firewall exceptions To allow OpenVPN traffic to pass through the WAN interface, create a firewall exception: +.. stop_vyoslinter + .. code-block:: none set firewall ipv4 name OUTSIDE_LOCAL rule 10 action 'accept' @@ -200,6 +214,8 @@ exception: set firewall ipv4 name OUTSIDE_LOCAL rule 20 log set firewall ipv4 name OUTSIDE_LOCAL rule 20 protocol 'udp' +.. start_vyoslinter + Apply the OUTSIDE_LOCAL firewall group to the WAN interface and to the input filter for traffic destined for the router itself: @@ -236,6 +252,8 @@ unique ports to each tunnel. Verify OpenVPN status using the show openvpn operational commands. +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show openvpn site-to-site @@ -246,6 +264,7 @@ Verify OpenVPN status using the show openvpn operational commands. ----------- ----------------- ----------- ------------ ---------- ---------- ----------------- N/A 10.110.12.54:1195 N/A N/A 504.0 B 656.0 B N/A +.. start_vyoslinter Server-client ============= @@ -269,6 +288,8 @@ session's PKI subtree. Certificate Authority (CA): +.. stop_vyoslinter + .. code-block:: none vyos@vyos# run generate pki ca install ca-1 @@ -370,6 +391,8 @@ Client certificate: set pki certificate client1 certificate 'MIIDrjCCApagAwIBAgIUPvtffeYTdoOiHxu++wdrjHwwVX4wDQYJKoZIhvcNAQELBQAwVDELMAkGA1UEBhMCR0IxEzARBgNVBAgMClNvbWUtU3RhdGUxEjAQBgNVBAcMCVNvbWUtQ2l0eTENMAsGA1UECgwEVnlPUzENMAsGA1UEAwwEY2EtMTAeFw0yNTA2MTExMTQxMDlaFw0yNjA2MTExMTQxMDlaMFcxCzAJBgNVBAYTAkdCMRMwEQYDVQQIDApTb21lLVN0YXRlMRIwEAYDVQQHDAlTb21lLUNpdHkxDTALBgNVBAoMBFZ5T1MxEDAOBgNVBAMMB2NsaWVudDEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9H6E6gm0PfXO1n/WoA9xlg89/bnScLmfztVDn1uyNn8epE6zAi2GWBhtj4ixLllIwLdkJ7L2mF3yUZtA1Q0oYbGIqTbnaZ37JydCygVGnlLT7UX9zfRfS3KebCIvIte7OyCmnUfVfFzdIsp+4LI3S2wX/9Vyn4UBAR8QQNbezRB3XPMk9gzULnuLhmEDP6GVcPq7RzGXoXUMqsCxfEOJBjej0y4ANKH07HGVVrfVRiY+zlGkM4TFjVuZKnEA0BO6dhOA0E+7gsIXsC06UzzatkjsyWHpb2/DOECIifBoYej9DITu8VxyyZmgaINHEn2gGb0LRHO7rvQapc+XZ2z9DAgMBAAGjdTBzMAwGA1UdEwEB/wQCMAAwDgYDVR0PAQH/BAQDAgeAMBMGA1UdJQQMMAoGCCsGAQUFBwMCMB0GA1UdDgQWBBQnUyqEzG+AqZzsdSud5MDqsOxiXTAfBgNVHSMEGDAWgBQAb2W+vsDMn/Li9j9eVbFeu77qbTANBgkqhkiG9w0BAQsFAAOCAQEAplItvZpoX/joG3QREu9tHVKwDTmXB2lwUM5G8iKPgd6D6oOILZMe2KuvWt12dcdEzUCGfJwJJ8M8R2WD0OmcLdFqvM/8UM1hYzUP2BCnFCLtElVD+b4wMlQNpdHqNbdckw8J4MLQlhUgu9rZAZ0XjWCprr+U50bX++vYRw7Un3Ds6ETEvjflm5WAPb2e0V1hhISPl8K+VXO7RAwxy0DHcDuR+YaD+hnNgMsJV3/QwA17Iy8x86RpOgqmesbt0U7e9Rmo81aVgiy/V4OCV7u6bPX03fmZNS8UwwJuRUlxkjO+epHNYB2cnOcjSkUxaIJ9Hv3tMWHQEtbVZsNYSOZozw==' set pki certificate client1 private key 'MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC9H6E6gm0PfXO1n/WoA9xlg89/bnScLmfztVDn1uyNn8epE6zAi2GWBhtj4ixLllIwLdkJ7L2mF3yUZtA1Q0oYbGIqTbnaZ37JydCygVGnlLT7UX9zfRfS3KebCIvIte7OyCmnUfVfFzdIsp+4LI3S2wX/9Vyn4UBAR8QQNbezRB3XPMk9gzULnuLhmEDP6GVcPq7RzGXoXUMqsCxfEOJBjej0y4ANKH07HGVVrfVRiY+zlGkM4TFjVuZKnEA0BO6dhOA0E+7gsIXsC06UzzatkjsyWHpb2/DOECIifBoYej9DITu8VxyyZmgaINHEn2gGb0LRHO7rvQapc+XZ2z9DAgMBAAECggEAPS/Fhtt5k2BgFivZW3FcVc+OS0keGwV8hkFsGoXTZIKEIzSFWIn/mX0CUY90C0Rn9MRwiqB4PwssOAsHY6QQjdRK8irRbVK8l2ZeydHC7DfVUdXtKR0YnxTaePML3nTV/TqPF14Rx6EINtHrkLeBbu2DhGsKfhoHIoTVbvUiKLHa2TkGJOkhvjsyMSPKzUXa1AzLmu+UBIhRYpEPHj0SQUUJJnKgIb7mTR2fhJScHcKwsrPq6S8OpChvsYZ6zatgrTFz9tuhD4IjL7NBiYP45BwGaLIaQjph8yAJwwHWoOP+TTj5WYflkW6Uu8F9gC0ve6dPGPNEi2TUdirvAe4LYQKBgQD0UfAPm6tQg8pdkvfMBvYc21fk8zqmgcA4OtvDi60aXuv5jI5+faISvOG2JLuFhKIDOb5ZerzGvkN+LvWgzr9H7YdGZNNtwKgpS/MGqcuuHncTxWBAwYgKhf26a/tqFZRNurJ6GowxDiAcQEc1mWnmdngRa+dvvCwNbXvGVqfVEQKBgQDGKi447TqD76QfvRPn/fRSjM+QE1duk+XorEJ0HHIha5HV9kCrZdV/olGRjDLwPJO6JW7iE2FUsS9SsIrccFE/9P2ZUqfYP2wL5vNO5kAmoLLUl0gwqg1WnBTPJfXeKReTj2uGmOdEuuMPXpL/49hDuPViiE2Q4MGe2Z+oEYN/EwKBgHfQMuTEl2e9qaDn8OM6SrluC5V4fjunh6dLnfgwaCx1fk1702lOnQuJWzsiml9o4raoO6PP4AGqzphz2PsKSJ2ya1NnIJRDFXRjDYQoAn2Z7RViBsja36chfINObxXgDUFtHBdrK3LnFXIlR4aOfHOLh2grvWx7IDNZjIiAeH+xAoGAJlmFZnjqiRv4bDgAQTZRcSRVCvHjSsAOj0++8I+MutEBgSHN9B2aCsBT/tHeDcX7ZNvXsKLFhElh+iO2S+DkqHb2GRT47I2hkFAaqBtBMPiKgz/ftaNDP46nLEuRYHQdXu4zhfHTV+a/CHtqAWGLuddyjaYJNM96SQ6eqjzxcMcCgYAzdxOF2e27hIgo2ttjsROMGqW0/0r/HsKGKPnao7xHQNCAswTnBT+QGugPCe0NXjuxbySP7V1GeWMWF+WV5khtteWerT1/ELAC48NSDpaMxVa4GP8Q/0w6+ZyJty3UGbCYQzZZue81dU+42LUIaVJ4NAc2tYj3jD780udasawS6w==' +.. start_vyoslinter + Manually copy the CA, client certificate, and Diffie-Hellman key to the client device, then commit them before configuring the OpenVPN interface. @@ -415,7 +438,8 @@ connection resets or daemon reloads. Clients are identified by the CN attribute in their SSL certificates. To grant clients access to a specific network behind the router, use the -push-route option to automatically install the appropriate route on each client. +push-route option to automatically install the appropriate route on +each client. .. code-block:: none @@ -455,6 +479,8 @@ Verification Check the tunnel status: +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show openvpn server @@ -465,7 +491,7 @@ Check the tunnel status: ----------- ------------------ ----------- ---------------- ---------- ---------- ------------------- client1 172.16.12.54:33166 10.23.1.10 172.18.201.10:1194 3.4 KB 3.4 KB 2024-06-11 12:07:25 - +.. start_vyoslinter Server bridge ============= @@ -532,10 +558,14 @@ configuration file. **Best practice:** Store the configuration file in the ``/config`` directory to ensure it is preserved after image updates. +.. stop_vyoslinter + .. code-block:: none set interfaces openvpn vtun0 openvpn-option "--plugin /usr/lib/openvpn/openvpn-auth-ldap.so /config/auth/ldap-auth.config" +.. start_vyoslinter + A sample configuration file is shown below: .. code-block:: none @@ -565,6 +595,8 @@ Active Directory A sample configuration file is shown below: +.. stop_vyoslinter + .. code-block:: none @@ -596,8 +628,11 @@ A sample configuration file is shown below: -If you only want to check that the user account is enabled and can authenticate -(against the primary group), the following snippet is sufficient: +.. start_vyoslinter + +If you only want to check that the user account is enabled and can +authenticate (against the primary group), the following snippet is +sufficient: .. code-block:: none @@ -616,8 +651,10 @@ If you only want to check that the user account is enabled and can authenticate RequireGroup false -A complete example of an LDAP authentication configuration for OpenVPN is shown -below: +A complete example of an LDAP authentication configuration for OpenVPN +is shown below: + +.. stop_vyoslinter .. code-block:: none @@ -646,9 +683,12 @@ below: } } +.. start_vyoslinter + .. stop_vyoslinter -For a detailed example, refer to :doc:`OpenVPN with LDAP `. +For a detailed example, refer to +:doc:`OpenVPN with LDAP`. .. start_vyoslinter @@ -682,6 +722,8 @@ To display authentication information, use the following command: Example: +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ sh interfaces openvpn vtun20 user user1 mfa qrcode @@ -705,6 +747,8 @@ Example: █████████████████████████████████████ █████████████████████████████████████ +.. start_vyoslinter + Scan the QR code to add the user account to Google Authenticator. On the client side, use the generated OTP as the password. @@ -725,6 +769,8 @@ username and password. Server configuration -------------------- +.. stop_vyoslinter + .. code-block:: none set interfaces openvpn vtun10 local-port '1194' @@ -741,6 +787,8 @@ Server configuration set interfaces openvpn vtun10 tls certificate 'srv-1' set interfaces openvpn vtun10 tls dh-params 'dh-1' +.. start_vyoslinter + The /config/auth/check_user.sh example includes two test users: .. code-block:: none @@ -764,10 +812,14 @@ Client configuration Storing the client certificate locally lets you generate the OpenVPN client configuration file. Use the following command: +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ generate openvpn client-config interface vtun10 ca ca-1 certificate client1 +.. start_vyoslinter + Copy the output and save it as a .ovpn file. Add the ``auth-user-pass`` directive to the file. This instructs the OpenVPN client to prompt the user for a username and password, which are then sent to the server over the TLS -- cgit v1.2.3 From 15f7ceb4128c2ad0e3e8505281e3892975f8bf46 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Fri, 10 Apr 2026 22:37:45 +0300 Subject: docs: reformat wireless.rst for readability (#1826) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: reformat wireless.rst for readability and consistency Reformat wireless interface documentation: standardize heading hierarchy, rewrap long lines, fix code-block indentation, and improve overall structure for readability. Co-Authored-By: Claude Opus 4.6 (1M context) * docs: fix content regressions in wireless.rst reformat Restore original wording incorrectly changed during reformat: - Title: 'Wireless LAN / Wi-Fi' (not 'WLAN/WIFI') - lastproofread: 2026-03-23 (not 2024-07-04) - 'System-wide' (not 'System Wide') - 'may be rejected' (not 'maybe rejected') - '802.1X' (not '802.1x') - 'electromagnetic damping' (not 'electro-magnetic dampening') - Throughput units: '10 MB/s', '50 MB/s' (not '10MBytes/s') - Restore channel description with automatic selection (0) - Fix opcmd grammar Co-Authored-By: Claude Opus 4.6 (1M context) * docs: restore upstream prose wording in wireless.rst Address review feedback from @dmbaturin — restore original wording where prose was unnecessarily rewritten: - Restore intro paragraph (remove 'by means of compatible hardware') - Restore 'Resulting configuration:' (was changed to 'Resulting in') - Restore concise AP/Wi-Fi 6 setup text and section headers - Keep formatting improvements (line wrapping, heading hierarchy) Co-Authored-By: Claude Opus 4.6 (1M context) * docs: restore more upstream wording in wireless.rst Restore original text at three more locations: - Use backtick-quoted access-point mode (CLI token style) - Restore device type bullet formatting with colons and abbr - Restore HT40 channel availability note wording Co-Authored-By: Claude Opus 4.6 (1M context) --------- Co-authored-by: Claude Opus 4.6 (1M context) --- docs/configuration/interfaces/wireless.rst | 497 +++++++++++++---------------- 1 file changed, 221 insertions(+), 276 deletions(-) (limited to 'docs/configuration') diff --git a/docs/configuration/interfaces/wireless.rst b/docs/configuration/interfaces/wireless.rst index 5c003f15..728783b2 100644 --- a/docs/configuration/interfaces/wireless.rst +++ b/docs/configuration/interfaces/wireless.rst @@ -2,30 +2,25 @@ .. _wireless-interface: -######################## +#################### Wireless LAN / Wi-Fi -######################## +#################### -:abbr:`WLAN (Wireless LAN)` interfaces provide 802.11 (a/b/g/n/ac) wireless -connectivity, referred to as Wi-Fi, and operate in one of the following modes: +:abbr:`WLAN (Wireless LAN)` interfaces provide 802.11 (a/b/g/n/ac) wireless +connectivity, referred to as Wi-Fi, and operate in one of the following +modes: -* ``access-point``: Provide network access to connecting stations. +* :abbr:`WAP (Wireless Access-Point)` mode provides network access to connecting + stations if the physical hardware supports acting as a WAP -* ``station:`` Operate as Wi-Fi clients, connecting to the network via an - available :abbr:`AP (Access Point)`. +* Station mode acts as a Wi-Fi client accessing the network through an available + WAP -* ``monitor:`` Passively monitor wireless traffic. +* Monitor mode lets the system passively monitor wireless traffic -If the system detects an unconfigured wireless device, it automatically adds -the device to the configuration tree with the detected settings, such as the -MAC address, and sets it to ``monitor`` mode. - -.. note:: VyOS supports creating **multiple** WLAN interfaces on a single - physical device. - -.. note:: Wi-Fi connectivity, support for multiple WLAN interfaces on a single - physical device, and access point capabilities strictly depend on the - underlying hardware. +If the system detects an unconfigured wireless device, it will be automatically +added to the configuration tree, specifying any detected settings (for example, +its MAC address) and configured to run in monitor mode. ************* Configuration @@ -43,10 +38,9 @@ System-wide configuration .. cfgcmd:: set system wireless country-code - **Configure the system's ISO/IEC 3166-1 country code.** - - The country code indicates the region in which the device operates. This may - restrict available channels and transmit power. + 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 + channels and transmit power. .. note:: This option is mandatory in ``access-point`` mode. @@ -55,8 +49,7 @@ Wireless options .. cfgcmd:: set interfaces wireless channel - **Configure the IEEE 802.11 wireless radio channel for the interface.** - + Configure the IEEE 802.11 wireless radio channel for the interface. Channel allocation depends on the frequency band: * **2.4 GHz** (802.11b/g/n/ax): Channels range from 1 to 14. @@ -66,90 +59,83 @@ Wireless options .. cfgcmd:: set interfaces wireless disable-broadcast-ssid - **Configure the interface to broadcast an empty SSID in beacons and to ignore - probe requests that do not include the full SSID.** - - This requires client stations to be configured with the correct SSID to connect. + Send empty SSID in beacons and ignore probe request frames that do not specify + full SSID, i.e., require stations to know the SSID. .. cfgcmd:: set interfaces wireless expunge-failing-stations - **Configure the interface to disconnect client stations upon excessive - transmission failures or connection loss.** + Disassociate stations based on excessive transmission failures or other + indications of connection loss. - This feature depends on driver capabilities and may not work with some drivers. + This depends on the driver capabilities and may not be available with all + drivers. .. cfgcmd:: set interfaces wireless isolate-stations - **Enable client isolation on the interface.** - - This prevents low-level frame bridging between associated stations within the - BSS. + Client isolation can be used to prevent low-level bridging of frames between + associated stations in the BSS. By default, this bridging is allowed. -.. cfgcmd:: set interfaces wireless max-stations +.. cfgcmd:: set interfaces wireless max-stations - **Configure the number of allowed connecting clients for the interface.** + Maximum number of stations allowed in station table. New stations will be + rejected after the station table is full. IEEE 802.11 has a limit of 2007 + different association IDs, so this number should not be larger than that. - When this limit is reached, new client association requests are rejected. The - IEEE 802.11 standard allows up to 2007 distinct association IDs. Therefore, - this value should not exceed 2007. - - Default: 2007. + This defaults to 2007. .. cfgcmd:: set interfaces wireless mgmt-frame-protection - Enable :abbr:`MFP (Management Frame Protection)` on the interface according to - IEEE 802.11w. + Management Frame Protection (MFP) according to IEEE 802.11w .. note:: :abbr:`MFP (Management Frame Protection)` is required for WPA3. .. cfgcmd:: set interfaces wireless enable-bf-protection - Enable :abbr:`BF (Beacon Frame)` protection on the interface. + Beacon Protection: management frame protection for Beacon frames. .. note:: This option requires :abbr:`MFP (Management Frame Protection)` to be enabled. .. cfgcmd:: set interfaces wireless mode - Configure wireless radio mode for the interface. + Operation mode of wireless radio. - * ``a``: 802.11a (up to 54 Mbps). - * ``b``: 802.11b (up to 11 Mbps). - * ``g`` (default): 802.11g (up to 54 Mbps). - * ``n``: 802.11n (up to 600 Mbps). - * ``ac``: 802.11ac (up to 1300 Mbps). - * ``ax``: 802.11ax (exceeds 1 Gbps). + * ``a`` - 802.11a - 54 Mbits/sec + * ``b`` - 802.11b - 11 Mbits/sec + * ``g`` - 802.11g - 54 Mbits/sec (default) + * ``n`` - 802.11n - 600 Mbits/sec + * ``ac`` - 802.11ac - 1300 Mbits/sec + * ``ax`` - 802.11ax - exceeds 1GBit/sec - .. note:: In VyOS, 802.11ax is only implemented for 2.4 GHz and 6 GHz. + .. note:: In VyOS, 802.11ax is only implemented for 2.4GHz and 6GHz. .. cfgcmd:: set interfaces wireless physical-device - **Configure the underlying wireless physical device for the interface.** + Wireless hardware device used as underlay radio. - Default: ``phy0``. + This defaults to phy0. .. cfgcmd:: set interfaces wireless reduce-transmit-power - **Configure the interface to add the Power Constraint** :abbr:`IE (Information - Element)` **to Beacon and Probe Response frames.** - - The Power Constraint :abbr:`IE (Information Element)` is required by :abbr:`TPC - (Transmit Power Control)`. + Adds the Power Constraint information element to Beacon and Probe Response + frames. - Valid values: 0 to 255. + This option adds the Power Constraint information element when applicable + and the Country information element is configured. The Power Constraint + element is required by Transmit Power Control. - .. note:: You must configure the country code to use this option. + Valid values are 0..255. .. cfgcmd:: set interfaces wireless ssid - Configure the SSID to be used in IEEE 802.11 management frames. + SSID to be used in IEEE 802.11 management frames .. cfgcmd:: set interfaces wireless type - **Configure the wireless device type for the interface.** + Wireless device type for this interface * ``access-point``: Forwards packets between other nodes. * ``station``: Connects to another :abbr:`AP (Access Point)`. @@ -171,215 +157,177 @@ PPDU HT (High Throughput) capabilities (802.11n) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Configure **HT mode options** if you use 802.11n or 802.11ax at 2.4 GHz. + Configuring HT mode options is required when using 802.11n or + 802.11ax at 2.4GHz. .. cfgcmd:: set interfaces wireless capabilities ht 40mhz-incapable - **Configure the interface to operate at 20 MHz.** - - The command sets the ``[40-INTOLERANT]`` flag. + Device is incapable of 40 MHz, do not advertise. This sets ``[40-INTOLERANT]`` .. cfgcmd:: set interfaces wireless capabilities ht auto-powersave - Enable :abbr:`WMM-PS (Wi-Fi Multimedia Power Save)` (:abbr:`U-APSD (Unscheduled - Automatic Power Save Delivery)`) for the interface. + WMM-PS Unscheduled Automatic Power Save Delivery [U-APSD] .. cfgcmd:: set interfaces wireless capabilities ht channel-set-width - **Configure the supported channel width set for the interface.** + Supported channel width set. - * ``ht20``: Allows a 20 MHz channel width. - * ``ht40-``: Allows both 20 MHz and 40 MHz channel widths, with the secondary - channel **below** the primary channel. - * ``ht40+``: Allows both 20 MHz and 40 MHz channel widths, with the secondary - channel **above** the primary channel. - - .. note:: Channel availability for HT40- and HT40+ is limited. The following - table lists channels permitted for HT40- and HT40+ according to IEEE 802.11n - Annex J. Channel availability may vary by location. + * ``ht20`` - 20 MHz channel width + * ``ht40-`` - Both 20 MHz and 40 MHz with secondary channel below the primary + channel + * ``ht40+`` - Both 20 MHz and 40 MHz with secondary channel above the primary + channel - .. code-block:: none + .. note:: Channel availability for HT40- and HT40+ is limited. The following + table lists channels permitted for HT40- and HT40+ according to IEEE + 802.11n Annex J. Channel availability may vary by location. - freq HT40- HT40+ - 2.4 GHz 5-13 1-7 (1-9 in Europe/Japan) - 5 GHz 40,48,56,64 36,44,52,60 + .. code-block:: none - .. note:: 40 MHz channels may automatically switch their primary and secondary - assignments, or the creation of a 40 MHz channel may be rejected due to - :abbr:`OBSSs (Overlapping Basic Service Sets)`. ``hostapd`` performs these - adjustments automatically when setting up the channel. + freq HT40- HT40+ + 2.4 GHz 5-13 1-7 (1-9 in Europe/Japan) + 5 GHz 40,48,56,64 36,44,52,60 + + .. note:: 40 MHz channels may switch their primary and secondary channels if + needed or creation of 40 MHz channel may be rejected based on overlapping + BSSes. These changes are done automatically when hostapd is setting up the + 40 MHz channel. .. cfgcmd:: set interfaces wireless capabilities ht delayed-block-ack - **Enable HT-delayed** :abbr:`Block Ack (Block Acknowledgement)` **on the - interface.** - - This sets the ``[DELAYED-BA]`` flag. + Enable HT-delayed Block Ack ``[DELAYED-BA]`` .. cfgcmd:: set interfaces wireless capabilities ht dsss-cck-40 - **Enable** :abbr:`DSSS (Direct Sequence Spread Spectrum)`/:abbr:`CCK - (Complementary Code Keying)` **mode in 40 MHz channels.** - - This sets the ``[DSSS_CCK-40]`` flag. + DSSS/CCK Mode in 40 MHz, this sets ``[DSSS_CCK-40]`` .. cfgcmd:: set interfaces wireless capabilities ht greenfield - **Enable HT Greenfield mode on the interface.** - - This sets the ``[GF]`` flag. + This enables the greenfield option which sets the ``[GF]`` option .. cfgcmd:: set interfaces wireless capabilities ht ldpc - Enable :abbr:`LDPC (Low-Density Parity-Check)` coding on the interface. + Enable LDPC coding capability .. cfgcmd:: set interfaces wireless capabilities ht lsig-protection - Enable :abbr:`L-SIG TXOP (Legacy Signal Transmission Opportunity)` protection - on the interface. + Enable L-SIG TXOP protection capability .. cfgcmd:: set interfaces wireless capabilities ht max-amsdu <3839 | 7935> - Configure the maximum :abbr:`A-MSDU (Aggregate MAC Service Data Unit)` length - to either 3839 octets (default) or 7935 octets. + Maximum A-MSDU length 3839 (default) or 7935 octets .. cfgcmd:: set interfaces wireless capabilities ht short-gi <20 | 40> - **Configure** :abbr:`Short GI (Short Guard Interval)` **capabilities for 20 MHz - or 40 MHz channels.** - - * ``20``: Enables Short GI for 20 MHz channels. - * ``40``: Enables Short GI for 40 MHz channels. + Short GI capabilities for 20 and 40 MHz .. cfgcmd:: set interfaces wireless capabilities ht smps - **Configure** :abbr:`SMPS (Spatial Multiplexing Power Save)` **mode for the - interface.** - - * ``static``: Enables static SMPS mode. - * ``dynamic``: Enables dynamic SMPS mode. + Spatial Multiplexing Power Save (SMPS) settings .. cfgcmd:: set interfaces wireless capabilities ht stbc rx - Enable receiving :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC - (Space-Time Block Coding)`. + Enable receiving PPDU using STBC (Space Time Block Coding) .. cfgcmd:: set interfaces wireless capabilities ht stbc tx - Enable transmitting :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC - (Space-Time Block Coding)`. - + Enable sending PPDU using STBC (Space Time Block Coding) VHT (Very High Throughput) capabilities (802.11ac) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. cfgcmd:: set interfaces wireless capabilities vht antenna-count +.. stop_vyoslinter + +.. cfgcmd:: set interfaces wireless capabilities vht antenna-count - **Configure the number of antennas for the interface.** +.. start_vyoslinter - Valid values: 1 to 8. + Number of antennas on this card .. cfgcmd:: set interfaces wireless capabilities vht antenna-pattern-fixed - **Enable the fixed antenna pattern capability on the interface.** - - Use this option if the antenna pattern does not change during the lifetime of - an association. + Set if antenna pattern does not change during the lifetime of an association .. cfgcmd:: set interfaces wireless capabilities vht beamform - Configure VHT beamforming capabilities for the interface. + Beamforming capabilities: - * ``single-user-beamformer``: Supports operation as a Single-User (SU) - beamformer. - * ``single-user-beamformee``: Supports operation as a Single-User (SU) - beamformee. - * ``multi-user-beamformer``: Supports operation as a Multi-User (MU) beamformer. - * ``multi-user-beamformee``: Supports operation as a Multi-User (MU) beamformee. + * ``single-user-beamformer`` - Support for operation as + single user beamformer + * ``single-user-beamformee`` - Support for operation as + single user beamformee + * ``multi-user-beamformer`` - Support for operation as + multi user beamformer + * ``multi-user-beamformee`` - Support for operation as + multi user beamformee .. cfgcmd:: set interfaces wireless capabilities vht center-channel-freq - **Configure the VHT operating channel center frequency for the interface.** - - * ``freq-1``: Specifies the center frequency for 80 MHz, 160 MHz, and 80+80 MHz - channels. + VHT operating channel center frequency - center freq 1 + (for use with 80, 80+80 and 160 modes) - * ``freq-2:`` Specifies the center frequency for 80+80 MHz channels. + VHT operating channel center frequency - center freq 2 + (for use with the 80+80 mode) - * ````: Ranges from 34 to 173. For 80 MHz channels, the center - frequency is typically the channel number plus 6. + must be from 34 - 173. For 80 MHz channels it should be channel + 6. .. cfgcmd:: set interfaces wireless capabilities vht channel-set-width <0 | 1 | 2 | 3> - **Configure the VHT operating channel width for the interface.** - - * ``0`` (default): 20 MHz or 40 MHz channel width. - * ``1``: 80 MHz channel width. - * ``2``: 160 MHz channel width. - * ``3``: 80+80 MHz channel width. + * ``0`` - 20 or 40 MHz channel width (default) + * ``1`` - 80 MHz channel width + * ``2`` - 160 MHz channel width + * ``3`` - 80+80 MHz channel width .. cfgcmd:: set interfaces wireless capabilities vht ldpc - Enable :abbr:`LDPC (Low-Density Parity Check)` coding for the interface. + Enable LDPC (Low Density Parity Check) coding capability .. cfgcmd:: set interfaces wireless capabilities vht link-adaptation - Enable VHT link adaptation on the interface. + VHT link adaptation capabilities .. cfgcmd:: set interfaces wireless capabilities vht max-mpdu - **Increase the maximum** :abbr:`MPDU (MAC Protocol Data Unit)` **length to - 7991 or 11454 octets.** - - Default: 3895 octets. + Increase Maximum MPDU length to 7991 or 11454 octets (default 3895 octets) .. cfgcmd:: set interfaces wireless capabilities vht max-mpdu-exp - Configure the maximum length of :abbr:`A-MPDU (Aggregated MAC Protocol Data - Unit)` :abbr:`pre-EOF (pre-End of Frame)` padding that the interface can - receive. + Set the maximum length of A-MPDU pre-EOF padding that the station can + receive .. cfgcmd:: set interfaces wireless capabilities vht short-gi <80 | 160> - **Configure** :abbr:`Short GI (Short Guard Interval)` **capabilities for 80 MHz - or 160 MHz channels.** - - * ``80``: Enables Short GI for 80 MHz channels. - * ``160``: Enables Short GI for 160 MHz channels. - + Short GI capabilities .. cfgcmd:: set interfaces wireless capabilities vht stbc rx - Enable receiving :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC - (Space-Time Block Coding)`. + Enable receiving PPDU using STBC (Space Time Block Coding) .. cfgcmd:: set interfaces wireless capabilities vht stbc tx - Enable transmitting :abbr:`PPDUs (PLCP Protocol Data Units)` using :abbr:`STBC - (Space-Time Block Coding)`. + Enable sending PPDU using STBC (Space Time Block Coding) .. cfgcmd:: set interfaces wireless capabilities vht tx-powersave - Enable VHT :abbr:`TXOP (Transmit Opportunity)` Power Save mode for the - interface. + Enable VHT TXOP Power Save Mode .. cfgcmd:: set interfaces wireless capabilities vht vht-cf - Enable receiving the VHT variant HT Control field on the interface. + Station supports receiving VHT variant HT Control field HE (High Efficiency) capabilities (802.11ax) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -387,89 +335,84 @@ HE (High Efficiency) capabilities (802.11ax) .. cfgcmd:: set interfaces wireless capabilities he antenna-pattern-fixed - Notify the :abbr:`AP (Access Point)` that antenna positions are fixed and do not change during the lifetime of an association. + Tell the AP that antenna positions are fixed and will not change + during the lifetime of an association. .. cfgcmd:: set interfaces wireless capabilities he beamform - **Configure HE beamforming capabilities for the interface.** + Beamforming capabilities: - * ``single-user-beamformer``: Supports operation as a Single-User (SU) - beamformer. - * ``single-user-beamformee``: Supports operation as a Single-User (SU) - beamformee. - * ``multi-user-beamformer``: Supports operation as a Multi-User (MU) beamformer. + * ``single-user-beamformer`` - Support for operation as + single user beamformer + * ``single-user-beamformee`` - Support for operation as + single user beamformee + * ``multi-user-beamformer`` - Support for operation as multi + user beamformer .. cfgcmd:: set interfaces wireless capabilities he bss-color - **Configure the** :abbr:`BSS (Basic Service Set)` **color for the interface.** - - BSS coloring helps prevent channel jamming when multiple :abbr:`APs (Access - Points)` use the same channels. + BSS coloring helps to prevent channel jamming when multiple APs use + the same channels. Valid values are 1..63 .. cfgcmd:: set interfaces wireless capabilities he center-channel-freq - **Configure the HE operating channel center frequency for the interface.** - - * ``freq-1``: Specifies the center frequency for 80 MHz, 160 MHz, and 80+80 MHz - channels. + HE operating channel center frequency - center freq 1 + (for use with 80, 80+80 and 160 modes) - * ``freq-2``: Specifies the center frequency for 80+80 MHz channels. + HE operating channel center frequency - center freq 2 + (for use with the 80+80 mode) - * ````: Ranges from 34 to 173. For 80 MHz channels, the center - frequency is typically the primary channel number plus 6. + must be within 1..233. For 80 MHz channels it should be + channel + 6 and for 160 MHz channels, it should be channel + 14. .. cfgcmd:: set interfaces wireless capabilities he channel-set-width - **Configure the HE operating channel width for the interface.** - - For the 2.4 GHz band: + must be one of: - * ``81``: 20 MHz channel width. - * ``83``: 40 MHz channel width, secondary 20 MHz channel above primary. - * ``84``: 40 MHz channel width, secondary 20 MHz channel below primary. - - For the 6 GHz band: - - * ``131``: 20 MHz channel width. - * ``132``: 40 MHz channel width. - * ``133``: 80 MHz channel width. - * ``134``: 160 MHz channel width. - * ``135``: 80+80 MHz channel width. + * ``81`` - 20 MHz channel width (2.4GHz) + * ``83`` - 40 MHz channel width, secondary 20MHz channel above primary + channel (2.4GHz) + * ``84`` - 40 MHz channel width, secondary 20MHz channel below primary + channel (2.4GHz) + * ``131`` - 20 MHz channel width (6GHz) + * ``132`` - 40 MHz channel width (6GHz) + * ``133`` - 80 MHz channel width (6GHz) + * ``134`` - 160 MHz channel width (6GHz) + * ``135`` - 80+80 MHz channel width (6GHz) .. cfgcmd:: set interfaces wireless capabilities he coding-scheme - - **Configure** :abbr:`SS (Spatial Stream)` **and** :abbr:`HE-MCS (High - Efficiency Modulation and Coding Scheme)` **settings for the interface.** - Explicit configuration of these settings is typically unnecessary. + This setting configures Spatial Stream and Modulation Coding Scheme + settings for HE mode (HE-MCS). It is usually not needed to set this + explicitly, but it might help with some WiFi adapters. - The ```` defines the supported MCS range and must be one of the following: + must be one of: - * ``0``: Allows HE-MCS 0-7. - * ``1``: Allows HE-MCS 0-9. - * ``2``: Allows HE-MCS 0-11. - * ``3``: Disables HE-MCS. + * ``0`` - HE-MCS 0-7 + * ``1`` - HE-MCS 0-9 + * ``2`` - HE-MCS 0-11 + * ``3`` - HE-MCS is not supported -Wireless options (station/client) +Wireless options (Station/Client) ================================= -The following example configures a wireless station (Wi-Fi client) that -connects to the network through an :abbr:`AP (Access Point)`, using the default -physical interface ``phy0``. +The example creates a wireless station (commonly referred to as Wi-Fi client) +that accesses the network through the WAP defined in the above example. The +default physical device (``phy0``) is used. .. code-block:: none set system wireless country-code de set interfaces wireless wlan0 type station set interfaces wireless wlan0 address dhcp - set interfaces wireless wlan0 ssid Test + set interfaces wireless wlan0 ssid 'TEST' set interfaces wireless wlan0 security wpa passphrase '12345678' Resulting configuration: @@ -493,32 +436,28 @@ Resulting configuration: type station } -Wireless security -================= - -:abbr:`WPA (Wi-Fi Protected Access)`, WPA2, and WPA3 Enterprise, combined with -802.1X-based authentication, enable user or computer authentication within a -domain. - -The authentication process involves the following three participants: +Security +======== -* **Supplicant**: The wireless client authenticates against the RADIUS server - using an EAP method. -* **Authenticator**: The Access Point (AP) sends authentication messages - between the supplicant and the RADIUS server. -* **Authentication server**: The RADIUS server authenticates users. +:abbr:`WPA (Wi-Fi Protected Access)`, WPA2 Enterprise and WPA3 Enterprise in +combination with 802.1X based authentication can be used to authenticate +users or computers in a domain. -The following example configures an :abbr:`AP (Access Point)` to use WPA2 -Enterprise security and authenticate connecting clients against an external -RADIUS server. +The wireless client (supplicant) authenticates against the RADIUS server +(authentication server) using an :abbr:`EAP (Extensible Authentication +Protocol)` method configured on the RADIUS server. The WAP (also referred +to as authenticator) role is to send all authentication messages between the +supplicant and the configured authentication server, thus the RADIUS server +is responsible for authenticating the users. -Configuration parameters: +The WAP in this example has the following characteristics: -* **IP address:** ``192.168.2.1/24`` -* **Network ID (SSID):** ``Enterprise-TEST`` -* **Protocol:** 802.11n -* **Wireless channel:** ``1`` -* **RADIUS server:** ``192.168.3.10`` with shared-secret ``VyOSPassword`` +* IP address ``192.168.2.1/24`` +* Network ID (SSID) ``Enterprise-TEST`` +* WPA passphrase ``12345678`` +* Use 802.11n protocol +* Wireless channel ``1`` +* RADIUS server at ``192.168.3.10`` with shared-secret ``VyOSPassword`` .. stop_vyoslinter .. code-block:: none @@ -586,13 +525,13 @@ QinQ (802.1ad) :var1: wlan0 ********* -Operation +Operation ********* .. opcmd:: show interfaces wireless info -Show the operational status and wireless-specific information about all -wireless interfaces. +Use this command to view operational status and wireless-specific information +about all wireless interfaces. .. code-block:: none @@ -602,8 +541,8 @@ wireless interfaces. .. opcmd:: show interfaces wireless detail -Show the operational status and detailed wireless-specific information about -all wireless interfaces. +Show the operational status and detailed wireless-specific +information about all wireless interfaces. .. stop_vyoslinter .. code-block:: none @@ -637,8 +576,8 @@ all wireless interfaces. .. opcmd:: show interfaces wireless -Show the operational status and statistics for the specified wireless -interface. Interface identifiers range from ``wlan0`` to ``wlan999``. +This command shows both status and statistics on the specified wireless +interface. The wireless interface identifier can range from wlan0 to wlan999. .. stop_vyoslinter .. code-block:: none @@ -661,8 +600,8 @@ interface. Interface identifiers range from ``wlan0`` to ``wlan999``. .. opcmd:: show interfaces wireless brief -Show a brief operational status summary for the specified wireless interface. -Interface identifiers range from ``wlan0`` to ``wlan999``. +This command gives a brief status overview of a specified wireless interface. +The wireless interface identifier can range from wlan0 to wlan999. .. code-block:: none @@ -675,8 +614,8 @@ Interface identifiers range from ``wlan0`` to ``wlan999``. .. opcmd:: show interfaces wireless queue -Show queue information for the specified wireless interface. Interface -identifiers range from ``wlan0`` to ``wlan999``. +Use this command to view wireless interface queue information. +The wireless interface identifier can range from wlan0 to wlan999. .. code-block:: none @@ -688,12 +627,13 @@ identifiers range from ``wlan0`` to ``wlan999``. .. opcmd:: show interfaces wireless scan -Show information about :abbr:`APs (Access Points)` within the range of the -specified wireless interface. You can use this data when configuring wireless -interfaces in ``station`` mode. +This command is used to retrieve information about WAP within the range of your +wireless interface. This command is useful on wireless interfaces configured +in station mode. -.. note:: Some wireless drivers or hardware may not support such scanning. - Refer to your driver and hardware documentation for more information. +.. note:: Scanning is not supported on all wireless drivers and wireless + hardware. Refer to your driver and wireless hardware documentation for + further details. .. code-block:: none @@ -719,17 +659,17 @@ interfaces in ``station`` mode. Examples ******** -The following example configures an :abbr:`AP (Access Point)` with the -following parameters: +The following example creates a WAP. When configuring multiple WAP interfaces, +you must specify unique IP addresses, channels, Network IDs commonly referred +to as :abbr:`SSID (Service Set Identifier)`, and MAC addresses. -* IP address: ``192.168.2.1/24`` -* Network ID (SSID): ``TEST`` -* WPA passphrase: ``12345678`` -* Protocol: 802.11n -* Wireless channel: ``1`` +The WAP in this example has the following characteristics: -.. note:: When setting up multiple WAP interfaces, ensure each has a unique IP - address, channel, network ID (SSID), and MAC address. +* IP address ``192.168.2.1/24`` +* Network ID (SSID) ``TEST`` +* WPA passphrase ``12345678`` +* Use 802.11n protocol +* Wireless channel ``1`` .. code-block:: none @@ -770,28 +710,30 @@ Resulting configuration: } } -To enable access point functionality, configure a DHCP server for this -interface's network, or add the interface to an existing local bridge. +To enable access point functionality, configure a DHCP server for this +interface's network, or add the interface to an existing local bridge (see :ref:`bridge-interface` for details). Wi-Fi 6/6E (802.11ax) ===================== -The following examples configure Wi-Fi 6 (2.4 GHz) and Wi-Fi 6E (6 GHz) +The following examples configure Wi-Fi 6 (2.4 GHz) and Wi-Fi 6E (6 GHz) :abbr:`APs (Access Points)` with the following parameters: * Network ID (SSID): ``test.ax`` * WPA passphrase: ``super-dooper-secure-passphrase`` * Protocol: 802.11ax -* Wireless channel for 2.4 GHz: ``11`` -* Wireless channel for 6 GHz: ``5`` +* Wireless channel for 2.4 GHz: ``11`` +* Wireless channel for 6 GHz: ``5`` Example configuration: Wi-Fi 6 at 2.4 GHz ------------------------------------------ +------------------------------------------ You may expect real throughput around 10 MB/s or higher in crowded areas. +.. stop_vyoslinter + .. code-block:: none set system wireless country-code de @@ -822,6 +764,8 @@ You may expect real throughput around 10 MB/s or higher in crowded areas. set interfaces wireless wlan0 type access-point commit +.. start_vyoslinter + Resulting configuration: .. code-block:: none @@ -879,13 +823,14 @@ Resulting configuration: } Example configuration: Wi-Fi 6E at 6 GHz ----------------------------------------- +----------------------------------------- -You may expect real throughput between 50 MB/s and 150 MB/s, depending on -obstructions from walls, water, metal, or other materials with high -electromagnetic damping at 6 GHz. +You may expect real throughput between 50 MB/s and 150 MB/s, depending on +obstructions from walls, water, metal, or other materials +with high electromagnetic damping at 6 GHz. Best results are achieved +with the AP being in the same room and in line-of-sight. -Best results are achieved when the AP is in the same room and in line of sight. +.. stop_vyoslinter .. code-block:: none @@ -913,6 +858,8 @@ Best results are achieved when the AP is in the same room and in line of sight. set interfaces wireless wlan0 stationary-ap commit +.. start_vyoslinter + Resulting configuration: .. code-block:: none @@ -968,10 +915,8 @@ Resulting configuration: Intel AX200 =========== -The Intel AX200 card does not operate out of the box in ``access-point`` mode. - -You can still enable :abbr:`AP (Access Point)` functionality on this hardware -by applying the following configuration: +The Intel AX200 card does not work out of the box in AP mode. You can +still put this card into AP mode using the following configuration: .. stop_vyoslinter .. code-block:: none -- cgit v1.2.3