summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:36 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:38 +0100
commit6aa3cbb611f74bdf8e44d5527f5138f3122a7497 (patch)
tree009a1fe9447bdd980d5017d49f102e7ccdace03b /docs/interfaces
parent76bbe2744d7184ee50626d9d7b65f21dad1c7e99 (diff)
downloadvyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.tar.gz
vyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.zip
Refactor "code-block:: sh" to "code-block:: console"
This will add proper new-lines into the rendered PDF. Before if it has been a long line, not all content was preserved in the PDF.
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/addresses.rst20
-rw-r--r--docs/interfaces/bond.rst14
-rw-r--r--docs/interfaces/bridge.rst16
-rw-r--r--docs/interfaces/dummy.rst2
-rw-r--r--docs/interfaces/ethernet.rst6
-rw-r--r--docs/interfaces/geneve.rst2
-rw-r--r--docs/interfaces/index.rst4
-rw-r--r--docs/interfaces/l2tpv3.rst10
-rw-r--r--docs/interfaces/pppoe.rst6
-rw-r--r--docs/interfaces/qinq.rst4
-rw-r--r--docs/interfaces/tunnel.rst22
-rw-r--r--docs/interfaces/vlan.rst6
-rw-r--r--docs/interfaces/vxlan.rst28
-rw-r--r--docs/interfaces/wireless.rst24
14 files changed, 82 insertions, 82 deletions
diff --git a/docs/interfaces/addresses.rst b/docs/interfaces/addresses.rst
index 92d1a73b..476de02d 100644
--- a/docs/interfaces/addresses.rst
+++ b/docs/interfaces/addresses.rst
@@ -27,7 +27,7 @@ PPP.
The command is ``set interfaces $type $name address $address``. Examples:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 address 192.0.2.1/24
set interfaces tunnel tun0 address 10.0.0.1/30
@@ -43,7 +43,7 @@ Pseudo-ethernet, Wireless).
The command is ``set interfaces $type $name address dhcp``. Examples:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 vif 90 address dhcp
set interfaces bridge br0 address dhcp
@@ -61,7 +61,7 @@ except :ref:`tunnel-interface`.
The command is ``set interfaces $type $name address $address``. Examples:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 address 2001:db8:100::ffff/64
set interfaces tunnel tun0 address 2001:db8::1/64
@@ -77,7 +77,7 @@ Pseudo-ethernet, Wireless).
The command is `set interfaces $type $name address dhcpv6`. Examples:
-.. code-block:: sh
+.. code-block:: console
set interfaces bonding bond1 address dhcpv6
set interfaces bridge br0 vif 56 address dhcpv6
@@ -91,7 +91,7 @@ interfaces, and those that are directly connected to a physical interface
The command is ``set interfaces $type $name ipv6 address autoconf``. Examples:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 vif 90 ipv6 address autoconf
set interfaces bridge br0 ipv6 address autoconf
@@ -109,7 +109,7 @@ MAC address, if you specify the prefix.
The command is `set interfaces $type $name ipv6 address eui64 $prefix`.
Examples:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br0 ipv6 address eui64 2001:db8:beef::/64
set interfaces pseudo-ethernet peth0 ipv6 address eui64 2001:db8:aa::/64
@@ -123,14 +123,14 @@ of what is known as SLAAC (Stateless Address Autoconfiguration).
To enable or disable, use:
-.. code-block:: sh
+.. code-block:: console
set interfaces <interface> ipv6 router-advert send-advert <true|false>
To set the options described in "Router Advertisement Message Format":
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# set interfaces <interface> ipv6 router-advert
Possible completions:
@@ -154,7 +154,7 @@ Prefix Information
Prefix information is described in :rfc:`4861#section-4.6.2`.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# set interfaces <interface> ipv6 router-advert prefix <h:h:h:h:h:h:h:h/x>
Possible completions:
@@ -169,7 +169,7 @@ Receiving Router Advertisements
To receive and accept RAs on an interface, you need to enable it with the
following configuration command
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# set system sysctl custom net.ipv6.conf.<interface>.accept_ra value 2
diff --git a/docs/interfaces/bond.rst b/docs/interfaces/bond.rst
index 05ed32c6..2de753d5 100644
--- a/docs/interfaces/bond.rst
+++ b/docs/interfaces/bond.rst
@@ -8,13 +8,13 @@ logical one. It's called bonding, or LAG, or ether-channel, or port-channel.
Create interface bondX, where X is just a number:
-.. code-block:: sh
+.. code-block:: console
set interfaces bonding bond0 description 'my-sw1 int 23 and 24'
You are able to choose a hash policy:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# set interfaces bonding bond0 hash-policy
Possible completions:
@@ -24,20 +24,20 @@ You are able to choose a hash policy:
For example:
-.. code-block:: sh
+.. code-block:: console
set interfaces bonding bond0 hash-policy 'layer2'
You may want to set IEEE 802.3ad Dynamic link aggregation (802.3ad) AKA LACP
(don't forget to setup it on the other end of these links):
-.. code-block:: sh
+.. code-block:: console
set interfaces bonding bond0 mode '802.3ad'
or some other modes:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# set interfaces bonding bond0 mode
Possible completions:
@@ -54,7 +54,7 @@ or some other modes:
Now bond some physical interfaces into bond0:
-.. code-block:: sh
+.. code-block:: console
set interfaces bonding bond0 member interface eth0
set interfaces bonding bond0 member interface eth1
@@ -64,7 +64,7 @@ change its` duplex, for example) and assign IPs or VIFs on it.
You may check the result:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# run sh interfaces bonding
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
diff --git a/docs/interfaces/bridge.rst b/docs/interfaces/bridge.rst
index 6c8510b5..77049597 100644
--- a/docs/interfaces/bridge.rst
+++ b/docs/interfaces/bridge.rst
@@ -9,7 +9,7 @@ Layer-2 traffic.
A bridge is created when a bridge interface is defined. In the example below
we create a bridge named br100 with eth1 and eth2 as the bridge member ports.
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge 'br100'
set interfaces bridge br100 member interface eth1
@@ -18,7 +18,7 @@ we create a bridge named br100 with eth1 and eth2 as the bridge member ports.
Each bridge member can be assiged a port cost and priority using the following
commands:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br100 member interface eth1 cost 10
set interfaces bridge br100 member interface eth1 priority 1024
@@ -27,14 +27,14 @@ Interfaces assigned to a bridge do not have address configuration. An IP
address can be assigned to the bridge interface itself, however, like any
normal interface.
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br100 address '192.168.100.1/24'
set interfaces bridge br100 address '2001:db8:100::1/64'
Example Result:
-.. code-block:: sh
+.. code-block:: console
bridge br100 {
address 192.168.100.1/24
@@ -59,7 +59,7 @@ Spanning-Tree Protocol. STP is disabled by default.
To enable spanning-tree use the `set interfaces bridge <name> stp` command:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br100 stp
@@ -70,7 +70,7 @@ using the `aging` directive.
The `show bridge` operational command can be used to display configured
bridges:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show bridge
bridge name bridge id STP enabled interfaces
@@ -79,7 +79,7 @@ bridges:
If spanning-tree is enabled, the `show bridge <name> spanning-tree` command
can be used to show STP configuration:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show bridge br100 spanning-tree
br100
@@ -105,7 +105,7 @@ can be used to show STP configuration:
The MAC address-table for a bridge can be displayed using the
`show bridge <name> macs` command:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show bridge br100 macs
port no mac addr is local? ageing timer
diff --git a/docs/interfaces/dummy.rst b/docs/interfaces/dummy.rst
index 8a24d4db..c3d58ff1 100644
--- a/docs/interfaces/dummy.rst
+++ b/docs/interfaces/dummy.rst
@@ -10,7 +10,7 @@ purposes.
Configuration commands:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# set interfaces dummy dum0
Possible completions:
diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 625f2eed..c55f1c1c 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -6,7 +6,7 @@ Ethernet
Ethernet interfaces allow for the configuration of speed, duplex, and hw-id
(MAC address). Below is an example configuration:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth1 address '192.168.0.1/24'
set interfaces ethernet eth1 address '2001:db8:1::ffff/64'
@@ -16,7 +16,7 @@ Ethernet interfaces allow for the configuration of speed, duplex, and hw-id
Resulting in:
-.. code-block:: sh
+.. code-block:: console
ethernet eth1 {
address 192.168.0.1/24
@@ -35,7 +35,7 @@ In addition, Ethernet interfaces provide the extended operational commands:
Statistics available are driver dependent.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces ethernet eth0 physical
Settings for eth0:
diff --git a/docs/interfaces/geneve.rst b/docs/interfaces/geneve.rst
index 4090b2e5..4f41c4e6 100644
--- a/docs/interfaces/geneve.rst
+++ b/docs/interfaces/geneve.rst
@@ -20,7 +20,7 @@ fabric. Sometimes termed "leaf and spine" or "fat tree" topologies.
Geneve Header:
-.. code-block:: sh
+.. code-block:: console
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|Ver| Opt Len |O|C| Rsvd. | Protocol Type |
diff --git a/docs/interfaces/index.rst b/docs/interfaces/index.rst
index 35cee4df..7a97019d 100644
--- a/docs/interfaces/index.rst
+++ b/docs/interfaces/index.rst
@@ -7,7 +7,7 @@ Network Interfaces
Configured interfaces on a VyOS system can be displayed using the
``show interfaces`` command.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
@@ -21,7 +21,7 @@ Configured interfaces on a VyOS system can be displayed using the
A specific interface can be shown using the ``show interfaces <type> <name>``
command.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces ethernet eth0
eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
diff --git a/docs/interfaces/l2tpv3.rst b/docs/interfaces/l2tpv3.rst
index d5788c35..f3cdd467 100644
--- a/docs/interfaces/l2tpv3.rst
+++ b/docs/interfaces/l2tpv3.rst
@@ -12,7 +12,7 @@ to PPP.
Over IP
^^^^^^^
-.. code-block:: sh
+.. code-block:: console
# show interfaces l2tpv3
l2tpv3 l2tpeth10 {
@@ -36,7 +36,7 @@ UDP mode works better with NAT:
* Set local-ip to your local IP (LAN).
* Add a forwarding rule matching UDP port on your internet router.
-.. code-block:: sh
+.. code-block:: console
# show interfaces l2tpv3
l2tpv3 l2tpeth10 {
@@ -63,7 +63,7 @@ will be directly connected like if there was a switch between them.
IPSec:
-.. code-block:: sh
+.. code-block:: console
set vpn ipsec ipsec-interfaces <VPN-interface>
set vpn ipsec esp-group test-ESP-1 compression 'disable'
@@ -91,7 +91,7 @@ IPSec:
Bridge:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br0 description 'L2 VPN Bridge'
# remote side in this example:
@@ -102,7 +102,7 @@ Bridge:
L2TPv3:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br0 member interface 'l2tpeth0'
set interfaces l2tpv3 l2tpeth0 description 'L2 VPN Tunnel'
diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst
index eca9a5f4..eee795ae 100644
--- a/docs/interfaces/pppoe.rst
+++ b/docs/interfaces/pppoe.rst
@@ -72,7 +72,7 @@ Requirements:
nameservers your ISP sens you and thus you can fully rely on the ones you
have configured statically.
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 description "DSL Modem"
set interfaces ethernet eth0 duplex auto
@@ -88,7 +88,7 @@ Requirements:
You should add a firewall to your configuration above as well by
assigning it to the pppoe0 itself as shown here:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 pppoe 0 firewall in name NET-IN
set interfaces ethernet eth0 pppoe 0 firewall local name NET-LOCAL
@@ -103,7 +103,7 @@ can easily create a PPPoE session through an encapsulated VLAN interface.
The following configuration will run your PPPoE connection through VLAN7
which is the default VLAN for Deutsche Telekom:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 description "DSL Modem"
set interfaces ethernet eth0 duplex auto
diff --git a/docs/interfaces/qinq.rst b/docs/interfaces/qinq.rst
index cc1812d0..5632d6f4 100644
--- a/docs/interfaces/qinq.rst
+++ b/docs/interfaces/qinq.rst
@@ -31,7 +31,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
Configuration commands:
-.. code-block:: sh
+.. code-block:: console
interfaces
ethernet <eth[0-999]>
@@ -65,7 +65,7 @@ Configuration commands:
Example:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 vif-s 333
set interfaces ethernet eth0 vif-s 333 address 192.0.2.10/32
diff --git a/docs/interfaces/tunnel.rst b/docs/interfaces/tunnel.rst
index 259e0d6b..774a18aa 100644
--- a/docs/interfaces/tunnel.rst
+++ b/docs/interfaces/tunnel.rst
@@ -22,7 +22,7 @@ this reason, there are no other configuration options for this kind of tunnel.
An example:
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun0 encapsulation ipip
set interfaces tunnel tun0 local-ip 192.0.2.10
@@ -40,7 +40,7 @@ It's not likely that anyone will need it any time soon, but it does exist.
An example:
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun0 encapsulation ipip
set interfaces tunnel tun0 local-ip 2001:db8:aa::1/64
@@ -57,7 +57,7 @@ As the name implies, it's IPv4 encapsulated in IPv6, as simple as that.
An example:
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun0 encapsulation ipip6
set interfaces tunnel tun0 local-ip 2001:db8:aa::1/64
@@ -79,7 +79,7 @@ Electric`_.
An example:
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun0 encapsulation sit
set interfaces tunnel tun0 local-ip 192.0.2.10
@@ -108,7 +108,7 @@ ip otherwise it would have to be configured as well.
**VyOS Router:**
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun100 address '10.0.0.1/30'
set interfaces tunnel tun100 encapsulation 'gre'
@@ -117,7 +117,7 @@ ip otherwise it would have to be configured as well.
**Cisco IOS Router:**
-.. code-block:: sh
+.. code-block:: console
interface Tunnel100
ip address 10.0.0.2 255.255.255.252
@@ -135,7 +135,7 @@ that are discarding IP protocol 47 or blocking your source/desintation traffic.
**1. Confirm IP connectivity between tunnel local-ip and remote-ip:**
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ ping 203.0.113.10 interface 198.51.100.2 count 4
PING 203.0.113.10 (203.0.113.10) from 198.51.100.2 : 56(84) bytes of data.
@@ -150,7 +150,7 @@ that are discarding IP protocol 47 or blocking your source/desintation traffic.
**2. Confirm the link type has been set to GRE:**
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces tunnel tun100
tun100@NONE: <POINTOPOINT,NOARP,UP,LOWER_UP> mtu 1476 qdisc noqueue state UNKNOWN group default qlen 1000
@@ -167,7 +167,7 @@ that are discarding IP protocol 47 or blocking your source/desintation traffic.
**3. Confirm IP connectivity across the tunnel:**
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ ping 10.0.0.2 interface 10.0.0.1 count 4
PING 10.0.0.2 (10.0.0.2) from 10.0.0.1 : 56(84) bytes of data.
@@ -185,14 +185,14 @@ Virtual Tunnel Interface (VTI)
Set Virtual Tunnel Interface
-.. code-block:: sh
+.. code-block:: console
set interfaces vti vti0 address 192.168.2.249/30
set interfaces vti vti0 address 2001:db8:2::249/64
Results in:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# show interfaces vti
vti vti0 {
diff --git a/docs/interfaces/vlan.rst b/docs/interfaces/vlan.rst
index 2c2a7ea6..5f7013b6 100644
--- a/docs/interfaces/vlan.rst
+++ b/docs/interfaces/vlan.rst
@@ -30,7 +30,7 @@ accomplished using the configuration command:
To assign a vif 100 using the VLAN 100 tag to physical interface eth1 use:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth1 vif 100 description 'VLAN 100'
set interfaces ethernet eth1 vif 100 address '192.168.100.1/24'
@@ -38,7 +38,7 @@ To assign a vif 100 using the VLAN 100 tag to physical interface eth1 use:
Resulting in:
-.. code-block:: sh
+.. code-block:: console
ethernet eth1 {
address 192.168.100.1/24
@@ -56,7 +56,7 @@ Resulting in:
VLAN interfaces are shown as `<name>.<vlan-id>`, e.g. `eth1.100`:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst
index ac818fcc..4b97c9e0 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -68,7 +68,7 @@ support this.
Configuration commands
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: sh
+.. code-block:: console
interfaces
vxlan <vxlan[0-16777215]>
@@ -97,7 +97,7 @@ This topology was built using GNS3.
Topology:
-.. code-block:: sh
+.. code-block:: console
Spine1:
fa0/2 towards Leaf2, IP-address: 10.1.2.1/24
@@ -113,7 +113,7 @@ Topology:
Spine1 Configuration:
-.. code-block:: sh
+.. code-block:: console
conf t
ip multicast-routing
@@ -136,7 +136,7 @@ from.
Leaf2 configuration:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 address '10.1.2.2/24'
set protocols ospf area 0 network '10.0.0.0/8'
@@ -161,7 +161,7 @@ Leaf2 configuration:
Leaf3 configuration:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 address '10.1.3.3/24'
set protocols ospf area 0 network '10.0.0.0/8'
@@ -188,7 +188,7 @@ As you can see, Leaf2 and Leaf3 configuration is almost identical. There are
lots of commands above, I'll try to into more detail below, command
descriptions are placed under the command boxes:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br241 address '172.16.241.1/24'
@@ -200,7 +200,7 @@ so that the Spine will learn how to reach it. To do this you need to change the
OSPF network from '10.0.0.0/8' to '0.0.0.0/0' to allow 172.16/12-networks to be
advertised.
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br241 member interface 'eth1.241'
set interfaces bridge br241 member interface 'vxlan241'
@@ -208,28 +208,28 @@ advertised.
Binds eth1.241 and vxlan241 to each other by making them both member interfaces of
the same bridge.
-.. code-block:: sh
+.. code-block:: console
set interfaces vxlan vxlan241 group '239.0.0.241'
The multicast-group used by all Leafs for this vlan extension. Has to be the
same on all Leafs that has this interface.
-.. code-block:: sh
+.. code-block:: console
set interfaces vxlan vxlan241 link 'eth0'
Sets the interface to listen for multicast packets on. Could be a loopback, not
yet tested.
-.. code-block:: sh
+.. code-block:: console
set interfaces vxlan vxlan241 vni '241'
Sets the unique id for this vxlan-interface. Not sure how it correlates with
multicast-address.
-.. code-block:: sh
+.. code-block:: console
set interfaces vxlan vxlan241 remote-port 12345
@@ -244,7 +244,7 @@ Older Examples
Example for bridging normal L2 segment and vxlan overlay network, and using a
vxlan interface as routing interface.
-.. code-block:: sh
+.. code-block:: console
interfaces {
bridge br0 {
@@ -276,7 +276,7 @@ router has a VLAN interface (26) facing the client devices and a VLAN interface
can flow between both routers' VLAN 26, but can't escape since there is no L3
gateway. You can add an IP to a bridge to create a gateway.
-.. code-block:: sh
+.. code-block:: console
interfaces {
bridge br0 {
@@ -310,7 +310,7 @@ Alternative to multicast, the remote IPv4 address of the VXLAN tunnel can set di
Let's change the Multicast example from above:
-.. code-block:: sh
+.. code-block:: console
# leaf2 and leaf3
delete interfaces vxlan vxlan241 group '239.0.0.241'
diff --git a/docs/interfaces/wireless.rst b/docs/interfaces/wireless.rst
index 1ae64644..f1f9ae80 100644
--- a/docs/interfaces/wireless.rst
+++ b/docs/interfaces/wireless.rst
@@ -45,7 +45,7 @@ The WAP in this example has the following characteristics:
* Use 802.11n protocol
* Wireless channel ``1``
-.. code-block:: sh
+.. code-block:: console
set interfaces wireless wlan0 address '192.0.2.1/24'
set interfaces wireless wlan0 type access-point
@@ -58,7 +58,7 @@ The WAP in this example has the following characteristics:
Resulting in
-.. code-block:: sh
+.. code-block:: console
interfaces {
[...]
@@ -110,7 +110,7 @@ The WAP in this example has the following characteristics:
* Wireless channel ``1``
* RADIUS server at ``192.0.3.10`` with shared-secret ``VyOSPassword``
-.. code-block:: sh
+.. code-block:: console
set interfaces wireless wlan0 address '192.0.2.1/24'
set interfaces wireless wlan0 type access-point
@@ -124,7 +124,7 @@ The WAP in this example has the following characteristics:
Resulting in
-.. code-block:: sh
+.. code-block:: console
interfaces {
[...]
@@ -161,7 +161,7 @@ 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:: sh
+.. code-block:: console
set interfaces wireless wlan0 type station
set interfaces wireless wlan0 address dhcp
@@ -170,7 +170,7 @@ default physical device (``phy0``) is used.
Resulting in
-.. code-block:: sh
+.. code-block:: console
interfaces {
[...]
@@ -193,7 +193,7 @@ Operational Commands
Use this command to view operational status and wireless-specific information
about all wireless interfaces.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces wireless info
Interface Type SSID Channel
@@ -204,7 +204,7 @@ about all wireless interfaces.
Use this command to view operational status and detailes wireless-specific
information about all wireless interfaces.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces wireless detail
wlan0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000
@@ -236,7 +236,7 @@ information about all wireless interfaces.
This command shows both status and statistics on the specified wireless interface.
The wireless interface identifier can range from wlan0 to wlan999.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces wireless wlan0
wlan0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000
@@ -257,7 +257,7 @@ The wireless interface identifier can 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:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces wireless wlan0 brief
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
@@ -271,7 +271,7 @@ The wireless interface identifier can 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:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces wireless wlan0 queue
qdisc pfifo_fast 0: root bands 3 priomap 1 2 2 2 1 2 0 0 1 1 1 1 1 1 1 1
@@ -289,7 +289,7 @@ in station mode.
hardware. Refer to your driver and wireless hardware documentation for
further details.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ show interfaces wireless wlan0 scan
Address SSID Channel Signal (dbm)