From d20c299b9dff3226e886a10a0e7223704fac32a0 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Fri, 13 Nov 2020 14:46:04 +0100 Subject: interfaces: use common toc and chapter style --- docs/interfaces/advanced-index.rst | 7 ++-- docs/interfaces/bond.rst | 41 +++++++++++--------- docs/interfaces/bridge.rst | 52 ++++++++++++------------- docs/interfaces/dummy.rst | 9 +++-- docs/interfaces/ethernet.rst | 22 +++++------ docs/interfaces/geneve.rst | 9 +++-- docs/interfaces/l2tpv3.rst | 75 +++++++++++++++++++++++++++++++++---- docs/interfaces/loopback.rst | 8 ++-- docs/interfaces/macsec.rst | 19 ++++++---- docs/interfaces/pppoe.rst | 24 +++++++----- docs/interfaces/pseudo-ethernet.rst | 9 +++-- docs/interfaces/wirelessmodem.rst | 57 +++++++++++++++------------- docs/routing/mpls.rst | 6 +-- 13 files changed, 210 insertions(+), 128 deletions(-) diff --git a/docs/interfaces/advanced-index.rst b/docs/interfaces/advanced-index.rst index f955c6b1..6e35dac2 100644 --- a/docs/interfaces/advanced-index.rst +++ b/docs/interfaces/advanced-index.rst @@ -1,8 +1,8 @@ .. _advanced_network-interfaces: -########################### -Advanced Network Interfaces -########################### +################## +Network Interfaces +################## .. toctree:: :maxdepth: 1 @@ -15,6 +15,7 @@ Advanced Network Interfaces loopback l2tpv3 macsec + pppoe pseudo-ethernet qinq tunnel diff --git a/docs/interfaces/bond.rst b/docs/interfaces/bond.rst index 859c25c3..21088c02 100644 --- a/docs/interfaces/bond.rst +++ b/docs/interfaces/bond.rst @@ -10,32 +10,35 @@ or port-channel. The behavior of the bonded interfaces depends upon the mode; generally speaking, modes provide either hot standby or load balancing services. Additionally, link integrity monitoring may be performed. +************* Configuration -############# +************* Common interface configuration ------------------------------- +============================== .. cmdinclude:: ../_include/interface-common-with-dhcp.txt :var0: bond :var1: bond0 Member Interfaces ------------------ +================= .. cfgcmd:: set interfaces bonding member interface Enslave `` interface to bond ``. Bond options ------------- +============ -.. cfgcmd:: set interfaces bonding mode +.. cfgcmd:: set interfaces bonding mode <802.3ad | active-backup | + broadcast | round-robin | transmit-load-balance | adaptive-load-balance | + xor-hash> Specifies one of the bonding policies. The default is 802.3ad. Possible values are: - * **802.3ad** - IEEE 802.3ad Dynamic link aggregation. Creates aggregation + * ``802.3ad`` - IEEE 802.3ad Dynamic link aggregation. Creates aggregation groups that share the same speed and duplex settings. Utilizes all slaves in the active aggregator according to the 802.3ad specification. @@ -47,7 +50,7 @@ Bond options in regards to the packet mis-ordering requirements of section 43.2.4 of the 802.3ad standard. - * **active-backup** - Active-backup policy: Only one slave in the bond is + * ``active-backup`` - Active-backup policy: Only one slave in the bond is active. A different slave becomes active if, and only if, the active slave fails. The bond's MAC address is externally visible on only one port (network adapter) to avoid confusing the switch. @@ -62,24 +65,24 @@ Bond options This mode provides fault tolerance. The :cfgcmd:`primary` option, documented below, affects the behavior of this mode. - * **broadcast** - Broadcast policy: transmits everything on all slave + * ``broadcast`` - Broadcast policy: transmits everything on all slave interfaces. This mode provides fault tolerance. - * **round-robin** - Round-robin policy: Transmit packets in sequential + * ``round-robin`` - Round-robin policy: Transmit packets in sequential order from the first available slave through the last. This mode provides load balancing and fault tolerance. - * **transmit-load-balance** - Adaptive transmit load balancing: channel + * ``transmit-load-balance`` - Adaptive transmit load balancing: channel bonding that does not require any special switch support. Incoming traffic is received by the current slave. If the receiving slave fails, another slave takes over the MAC address of the failed receiving slave. - * **adaptive-load-balance** - Adaptive load balancing: includes + * ``adaptive-load-balance`` - Adaptive load balancing: includes transmit-load-balance plus receive load balancing for IPV4 traffic, and does not require any special switch support. The receive load balancing is achieved by ARP negotiation. The bonding driver intercepts the ARP @@ -111,7 +114,7 @@ Bond options than the switch's forwarding delay so that the ARP Replies sent to the peers will not be blocked by the switch. - * **xor-hash** - XOR policy: Transmit based on the selected transmit + * ``xor-hash`` - XOR policy: Transmit based on the selected transmit hash policy. The default policy is a simple [(source MAC address XOR'd with destination MAC address XOR packet type ID) modulo slave count]. Alternate transmit policies may be selected via the :cfgcmd:`hash-policy` @@ -253,8 +256,9 @@ Bond options The maximum number of targets that can be specified is 16. The default value is no IP addresses. +******* Example -------- +******* The following configuration on VyOS applies to all following 3rd party vendors. It creates a bond with two links and VLAN 10, 100 on the bonded interfaces with @@ -275,7 +279,7 @@ a per VIF IPv4 address. set interfaces bonding bond0 member interface eth2 Cisco Catalyst -^^^^^^^^^^^^^^ +============== Assign member interfaces to PortChannel @@ -305,7 +309,7 @@ allowed VLAN interfaces, STP will happen here. Juniper EX Switch -^^^^^^^^^^^^^^^^^ +================= For a headstart you can use the below example on how to build a bond with two interfaces from VyOS to a Juniper EX Switch system. @@ -334,7 +338,7 @@ interfaces from VyOS to a Juniper EX Switch system. set interfaces xe-1/1/0 ether-options 802.3ad ae0 Aruba/HP -^^^^^^^^ +======== For a headstart you can use the below example on how to build a bond,port-channel with two interfaces from VyOS to a Aruba/HP 2510G switch. @@ -349,7 +353,7 @@ with two interfaces from VyOS to a Aruba/HP 2510G switch. vlan 100 tagged Trk1 Arista EOS -^^^^^^^^^^ +========== When utilizing VyOS in an environment with Arista gear you can use this blue print as an initial setup to get an LACP bond / port-channel operational between @@ -463,8 +467,9 @@ Lets assume the following topology: virtio network driver no LACP PDUs will be sent by VyOS thus the port-channel will never become active! +********* Operation -######### +********* .. opcmd:: show interfaces bonding diff --git a/docs/interfaces/bridge.rst b/docs/interfaces/bridge.rst index 144e5f6d..ba6d70fb 100644 --- a/docs/interfaces/bridge.rst +++ b/docs/interfaces/bridge.rst @@ -14,18 +14,19 @@ standard. .. note:: Spanning Tree Protocol is not enabled by default in VyOS. :ref:`stp` can be easily enabled if needed. +************* Configuration -############# +************* Common interface configuration ------------------------------- +============================== .. cmdinclude:: ../_include/interface-common-with-dhcp.txt :var0: bridge :var1: br0 Member Interfaces ------------------ +================= .. cfgcmd:: set interfaces bridge member interface @@ -59,6 +60,24 @@ Member Interfaces deciding which link to use. Faster interfaces should have lower costs. +Bridge Options +============== + +.. cfgcmd:: set interfaces bridge aging