summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/addresses.rst22
-rw-r--r--docs/interfaces/bonding.rst14
-rw-r--r--docs/interfaces/bridging.rst14
-rw-r--r--docs/interfaces/dummy.rst2
-rw-r--r--docs/interfaces/ethernet.rst6
-rw-r--r--docs/interfaces/index.rst4
-rw-r--r--docs/interfaces/l2tpv3.rst10
-rw-r--r--docs/interfaces/pppoe.rst12
-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.rst6
13 files changed, 75 insertions, 75 deletions
diff --git a/docs/interfaces/addresses.rst b/docs/interfaces/addresses.rst
index 51d2e7e5..188d1c00 100644
--- a/docs/interfaces/addresses.rst
+++ b/docs/interfaces/addresses.rst
@@ -13,7 +13,7 @@ addresses might be:
An interface description is assigned using the following command:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 description 'OUTSIDE'
@@ -29,7 +29,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
@@ -45,7 +45,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
@@ -63,7 +63,7 @@ except :ref:`interfaces-tunnel`.
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
@@ -79,7 +79,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
@@ -93,7 +93,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
@@ -111,7 +111,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
@@ -124,14 +124,14 @@ Router advertisements are described in `RFC4861 section 4.2`_. They are part of
To enable or disable, use:
-.. code-block:: sh
+.. code-block:: console
set interfaces <interface> ipv6 router-advert send-advert <true or 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 @@ To set the options described in "Router Advertisement Message Format":
Prefix information is described in `RFC4861 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:
@@ -167,7 +167,7 @@ Prefix information is described in `RFC4861 section 4.6.2`_
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 name>.accept_ra value 2
diff --git a/docs/interfaces/bonding.rst b/docs/interfaces/bonding.rst
index d865eb78..19d78e4e 100644
--- a/docs/interfaces/bonding.rst
+++ b/docs/interfaces/bonding.rst
@@ -6,13 +6,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:
@@ -22,20 +22,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:
@@ -52,7 +52,7 @@ or some other modes:
Now bond some physical interfaces into bond0:
-.. code-block:: sh
+.. code-block:: console
set interfaces ethernet eth0 bond-group 'bond0'
set interfaces ethernet eth0 description 'member of bond0'
@@ -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/bridging.rst b/docs/interfaces/bridging.rst
index e42d76ad..3c11a64b 100644
--- a/docs/interfaces/bridging.rst
+++ b/docs/interfaces/bridging.rst
@@ -7,7 +7,7 @@ Layer-2 traffic.
A bridge is created when a bridge interface is defined. In the example below
we will be creating a bridge for VLAN 100 and assigning a VIF to the bridge.
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge 'br100'
~~set interfaces ethernet eth1 vif 100 bridge-group bridge br100~~
@@ -17,14 +17,14 @@ Interfaces assigned to a bridge-group 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
@@ -49,7 +49,7 @@ Spanning-Tree Protocol. STP is disabled by default.
To enable spanning-tree use the
`set interfaces bridge <name> stp true` command:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br100 stp true
@@ -63,7 +63,7 @@ configured.
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
@@ -72,7 +72,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
@@ -98,7 +98,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 dc46a4cb..0479cf5e 100644
--- a/docs/interfaces/dummy.rst
+++ b/docs/interfaces/dummy.rst
@@ -8,7 +8,7 @@ Dummy interfaces can be used as interfaces that always stay up (in the same fash
Configuration commands:
-.. code-block:: sh
+.. code-block:: console
interfaces
dummy <dum[0-999]>
diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 075b3836..34260fc2 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -6,7 +6,7 @@ Ethernet Interfaces
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/index.rst b/docs/interfaces/index.rst
index 2de0b6ab..5d7caf1c 100644
--- a/docs/interfaces/index.rst
+++ b/docs/interfaces/index.rst
@@ -6,7 +6,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 2238c970..a3fe3cd8 100644
--- a/docs/interfaces/l2tpv3.rst
+++ b/docs/interfaces/l2tpv3.rst
@@ -11,7 +11,7 @@ L2TPv3 can transport any traffic including ethernet frames. L2TPv2 is limited to
L2TPv3 over IP
^^^^^^^^^^^^^^
-.. code-block:: sh
+.. code-block:: console
# show interfaces l2tpv3
l2tpv3 l2tpeth10 {
@@ -35,7 +35,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 {
@@ -61,7 +61,7 @@ This is the LAN extension use case. The eth0 port of the distant VPN peers will
IPSec:
-.. code-block:: sh
+.. code-block:: console
set vpn ipsec ipsec-interfaces <VPN-interface>
set vpn ipsec esp-group test-ESP-1 compression 'disable'
@@ -89,7 +89,7 @@ IPSec:
Bridge:
-.. code-block:: sh
+.. code-block:: console
set interfaces bridge br0 description 'L2 VPN Bridge'
# remote side in this example:
@@ -100,7 +100,7 @@ Bridge:
L2TPv3:
-.. code-block:: sh
+.. code-block:: console
set interfaces l2tpv3 l2tpeth0 bridge-group bridge 'br0'
set interfaces l2tpv3 l2tpeth0 description 'L2 VPN Tunnel'
diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst
index c4eb2d8f..803b43fb 100644
--- a/docs/interfaces/pppoe.rst
+++ b/docs/interfaces/pppoe.rst
@@ -22,7 +22,7 @@ Once you have an Ethernet device connected, i.e. eth0, then you can configure it
**Here is an example configuration:**
-.. code-block:: sh
+.. code-block:: console
set interface ethernet eth0 description "DSL Modem"
set interface ethernet eth0 duplex auto
@@ -37,7 +37,7 @@ Once you have an Ethernet device connected, i.e. eth0, then you can configure it
* 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 interface ethernet eth0 pppoe 0 firewall in name NET-IN
set interface ethernet eth0 pppoe 0 firewall local name NET-LOCAL
@@ -52,7 +52,7 @@ Handling and troubleshooting
You can test connecting and disconnecting with the below commands:
-.. code-block:: sh
+.. code-block:: console
disconnect interface 0
connect interface 0
@@ -62,20 +62,20 @@ You can check the PPPoE connection logs with the following:
This command shows the current statistics, status and some of the settings (i.e. MTU) for the current connection on pppoe0.
-.. code-block:: sh
+.. code-block:: console
show interfaces pppoe 0
This command shows the entire log for the PPPoE connection starting with the oldest data. Scroll down with the <space> key to reach the end where the current data is.
-.. code-block:: sh
+.. code-block:: console
show interfaces pppoe 0 log
This command shows the same log as without the 'tail' option but only starts with the last few lines and continues to show added lines until you exit with ``Ctrl + x``
-.. code-block:: sh
+.. code-block:: console
show interfaces pppoe 0 log tail
diff --git a/docs/interfaces/qinq.rst b/docs/interfaces/qinq.rst
index 12fbd47d..f94ccda4 100644
--- a/docs/interfaces/qinq.rst
+++ b/docs/interfaces/qinq.rst
@@ -14,7 +14,7 @@ The outer tag is the one closer/closest to the Ethernet header; its name is S-TA
Configuration commands:
-.. code-block:: sh
+.. code-block:: console
interfaces
ethernet <eth[0-999]>
@@ -48,7 +48,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 7103e5a2..2f884270 100644
--- a/docs/interfaces/tunnel.rst
+++ b/docs/interfaces/tunnel.rst
@@ -18,7 +18,7 @@ It takes an IPv4 packet and sends it as a payload of another IPv4 packet. For th
An example:
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun0 encapsulation ipip
set interfaces tunnel tun0 local-ip 192.0.2.10
@@ -34,7 +34,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
@@ -50,7 +50,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
@@ -68,7 +68,7 @@ The encapsulation overhead is the size of the IPv4 header of 20 bytes, therefore
An example:
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun0 encapsulation sit
set interfaces tunnel tun0 local-ip 192.0.2.10
@@ -96,7 +96,7 @@ The Cisco router defaults to 'gre ip' otherwise it would have to be configured a
**VyOS Router:**
-.. code-block:: sh
+.. code-block:: console
set interfaces tunnel tun100 address '10.0.0.1/30'
set interfaces tunnel tun100 encapsulation 'gre'
@@ -105,7 +105,7 @@ The Cisco router defaults to 'gre ip' otherwise it would have to be configured a
**Cisco IOS Router:**
-.. code-block:: sh
+.. code-block:: console
interface Tunnel100
ip address 10.0.0.2 255.255.255.252
@@ -122,7 +122,7 @@ configurations that are discarding IP protocol 47 or blocking your source/desint
**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.
@@ -137,7 +137,7 @@ configurations that are discarding IP protocol 47 or blocking your source/desint
**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
@@ -154,7 +154,7 @@ configurations that are discarding IP protocol 47 or blocking your source/desint
**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.
@@ -172,14 +172,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 76fadd3c..cbab0a80 100644
--- a/docs/interfaces/vlan.rst
+++ b/docs/interfaces/vlan.rst
@@ -7,7 +7,7 @@ term used for this is `vif`. Configuration of a tagged sub-interface is
accomplished using the configuration command
`set interfaces ethernet <name> vif <vlan-id>`.
-.. 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'
@@ -15,7 +15,7 @@ accomplished using the configuration command
Resulting in:
-.. code-block:: sh
+.. code-block:: console
ethernet eth1 {
address 192.168.100.1/24
@@ -33,7 +33,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 75628953..a4de5766 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -44,7 +44,7 @@ support this.
Configuration commands
^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: sh
+.. code-block:: console
interfaces
vxlan <vxlan[0-16777215]>
@@ -74,7 +74,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
@@ -90,7 +90,7 @@ Topology:
Spine1 Configuration:
-.. code-block:: sh
+.. code-block:: console
conf t
ip multicast-routing
@@ -113,7 +113,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'
@@ -136,7 +136,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'
@@ -161,7 +161,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'
@@ -173,7 +173,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 ethernet eth1 vif 241 bridge-group bridge 'br241'
set interfaces vxlan vxlan241 bridge-group bridge 'br241'
@@ -181,28 +181,28 @@ advertised.
Binds eth1 vif 241 and vxlan241 to each other by putting them in the same
bridge-group. Internal VyOS requirement.
-.. 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
@@ -217,7 +217,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 {
@@ -248,7 +248,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-group to create a gateway.
-.. code-block:: sh
+.. code-block:: console
interfaces {
bridge br0 {
@@ -284,7 +284,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 46c038af..8bc5d434 100644
--- a/docs/interfaces/wireless.rst
+++ b/docs/interfaces/wireless.rst
@@ -9,13 +9,13 @@ If your device is configurable it will appear as `wlan` in `show interfaces`.
To be able to use the wireless interfaces you will first need to set a
regulatory domain with the country code of your locaion.
-.. code-block:: sh
+.. code-block:: console
set system wifi-regulatory-domain SE
An example on how to set it up as an access point:
-.. code-block:: sh
+.. code-block:: console
set interfaces wireless wlan0 address '192.168.99.1/24'
set interfaces wireless wlan0 type access-point
@@ -27,7 +27,7 @@ An example on how to set it up as an access point:
Resulting in
-.. code-block:: sh
+.. code-block:: console
interfaces {
[...]