diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-04-10 22:37:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-04-10 20:37:45 +0100 |
| commit | 15f7ceb4128c2ad0e3e8505281e3892975f8bf46 (patch) | |
| tree | 5962929b8098449f9cc4554eda64eab9d487258f /docs/configuration/interfaces | |
| parent | ce3bb378d3e58c7023088d92ef9042e5a2d61235 (diff) | |
| download | vyos-documentation-15f7ceb4128c2ad0e3e8505281e3892975f8bf46.tar.gz vyos-documentation-15f7ceb4128c2ad0e3e8505281e3892975f8bf46.zip | |
docs: reformat wireless.rst for readability (#1826)
* 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) <noreply@anthropic.com>
* 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) <noreply@anthropic.com>
* 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) <noreply@anthropic.com>
* 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) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs/configuration/interfaces')
| -rw-r--r-- | docs/configuration/interfaces/wireless.rst | 497 |
1 files changed, 221 insertions, 276 deletions
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 <cc> - **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 <interface> channel <number> - **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 <interface> 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 <interface> 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 <interface> 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 <interface> max-stations <number> +.. cfgcmd:: set interfaces wireless <interface> max-stations <count> - **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 <interface> 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 <interface> 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 <interface> mode <a | b | g | n | ac | ax> - 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 <interface> physical-device <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 <interface> reduce-transmit-power <number> - **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 <interface> ssid <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 <interface> type <access-point | station | monitor> - **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 <interface> 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 <interface> 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 <interface> capabilities ht channel-set-width <ht20 | ht40+ | ht40-> - **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 <interface> 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 <interface> 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 <interface> 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 <interface> capabilities ht ldpc - Enable :abbr:`LDPC (Low-Density Parity-Check)` coding on the interface. + Enable LDPC coding capability .. cfgcmd:: set interfaces wireless <interface> 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 <interface> 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 <interface> 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 <interface> capabilities ht smps <static | dynamic> - **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 <interface> capabilities ht stbc rx <num> - 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 <interface> 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 <interface> capabilities vht antenna-count <num> +.. stop_vyoslinter + +.. cfgcmd:: set interfaces wireless <interface> capabilities vht antenna-count <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 <interface> 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 <interface> capabilities vht beamform <single-user-beamformer | single-user-beamformee | multi-user-beamformer | multi-user-beamformee> - 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 <interface> capabilities vht center-channel-freq <freq-1 | freq-2> <number> - **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) - * ``<number>``: Ranges from 34 to 173. For 80 MHz channels, the center - frequency is typically the channel number plus 6. + <number> must be from 34 - 173. For 80 MHz channels it should be channel + 6. .. cfgcmd:: set interfaces wireless <interface> 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 <interface> 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 <interface> capabilities vht link-adaptation - Enable VHT link adaptation on the interface. + VHT link adaptation capabilities .. cfgcmd:: set interfaces wireless <interface> capabilities vht max-mpdu <value> - **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 <interface> capabilities vht max-mpdu-exp <value> - 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 <interface> 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 <interface> capabilities vht stbc rx <num> - 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 <interface> 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 <interface> 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 <interface> 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 <interface> 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 <interface> capabilities he beamform <single-user-beamformer | single-user-beamformee | multi-user-beamformer> - **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 <interface> capabilities he bss-color <number> - **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 <interface> capabilities he center-channel-freq <freq-1 | freq-2> <number> - **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) - * ``<number>``: Ranges from 34 to 173. For 80 MHz channels, the center - frequency is typically the primary channel number plus 6. + <number> 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 <interface> capabilities he channel-set-width <number> - **Configure the HE operating channel width for the interface.** - - For the 2.4 GHz band: + <number> 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 <interface> capabilities he coding-scheme <number> - - **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 ``<number>`` defines the supported MCS range and must be one of the following: + <number> 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 <wlanX> -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 <wlanX> 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 <wlanX> 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 <wlanX> 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 |
