diff options
Diffstat (limited to 'docs/configuration/interfaces')
| -rw-r--r-- | docs/configuration/interfaces/bonding.rst | 20 | ||||
| -rw-r--r-- | docs/configuration/interfaces/bridge.rst | 12 | ||||
| -rw-r--r-- | docs/configuration/interfaces/dummy.rst | 4 | ||||
| -rw-r--r-- | docs/configuration/interfaces/ethernet.rst | 3 | ||||
| -rw-r--r-- | docs/configuration/interfaces/geneve.rst | 2 | ||||
| -rw-r--r-- | docs/configuration/interfaces/l2tpv3.rst | 16 | ||||
| -rw-r--r-- | docs/configuration/interfaces/loopback.rst | 4 | ||||
| -rw-r--r-- | docs/configuration/interfaces/macsec.rst | 6 |
8 files changed, 41 insertions, 26 deletions
diff --git a/docs/configuration/interfaces/bonding.rst b/docs/configuration/interfaces/bonding.rst index d19ecb59..13203d15 100644 --- a/docs/configuration/interfaces/bonding.rst +++ b/docs/configuration/interfaces/bonding.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. _bond-interface: ####################### @@ -47,7 +49,7 @@ Bond options the :cfgcmd:`hash-policy` option, documented below. .. note:: Not all transmit policies may be 802.3ad compliant, particularly - in regards to the packet mis-ordering requirements of section 43.2.4 + in regards to the packet misordering requirements of section 43.2.4 of the 802.3ad standard. * ``active-backup`` - Active-backup policy: Only one slave in the bond is @@ -133,9 +135,9 @@ Bond options This option only affects 802.3ad mode. - The default value is 0. This will cause carrier to be asserted (for 802.3ad - mode) whenever there is an active aggregator, regardless of the number of - available links in that aggregator. + The default value is 0. This will cause the carrier to be asserted + (for 802.3ad mode) whenever there is an active aggregator, + regardless of the number of available links in that aggregator. .. note:: Because an aggregator cannot be active without at least one available link, setting this option to 0 or to 1 has the exact same @@ -222,7 +224,7 @@ Bond options This algorithm is not fully 802.3ad compliant. A single TCP or UDP conversation containing both fragmented and unfragmented packets will see packets striped across two interfaces. This may result in out of order - delivery. Most traffic types will not meet this criteria, as TCP rarely + delivery. Most traffic types will not meet these criteria, as TCP rarely fragments traffic, and most UDP traffic is not involved in extended conversations. Other implementations of 802.3ad may or may not tolerate this noncompliance. @@ -267,7 +269,7 @@ Bond options be given for ARP monitoring to function. The maximum number of targets that can be specified is 16. The default value - is no IP addresses. + is no IP address. Offloading ---------- @@ -498,9 +500,9 @@ Lets assume the following topology: ! .. note:: When using EVE-NG to lab this environment ensure you are using e1000 - as the desired driver for your VyOS network interfaces. When using the regular - virtio network driver no LACP PDUs will be sent by VyOS thus the port-channel - will never become active! + as the desired driver for your VyOS network interfaces. When using the + regular virtio network driver no LACP PDUs will be sent by VyOS thus the + port-channel will never become active! ********* Operation diff --git a/docs/configuration/interfaces/bridge.rst b/docs/configuration/interfaces/bridge.rst index 7f49f9a8..2374da4d 100644 --- a/docs/configuration/interfaces/bridge.rst +++ b/docs/configuration/interfaces/bridge.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. _bridge-interface: ###### @@ -48,7 +50,7 @@ Member Interfaces and a cost, that is used to decide which is the shortest path to forward a packet. The lowest cost path is always used unless the other path is down. If you have multiple bridges and interfaces then - you may need to adjust the priorities to achieve optimium + you may need to adjust the priorities to achieve optimum performance. @@ -71,7 +73,7 @@ Bridge Options Bridge maximum aging `<time>` in seconds (default: 20). - If a another bridge in the spanning tree does not send out a hello + If an another bridge in the spanning tree does not send out a hello packet for a long period of time, it is assumed to be dead. .. cfgcmd:: set interfaces bridge <interface> igmp querier @@ -98,8 +100,8 @@ links providing fault tolerance if an active link fails. Spanning Tree Protocol forwarding `<delay>` in seconds (default: 15). - Forwarding delay time is the time spent in each of the Listening and - Learning states before the Forwarding state is entered. This delay is + The forwarding delay time is the time spent in each of the listening and + learning states before the Forwarding state is entered. This delay is so that when a new bridge comes onto a busy network it looks at some traffic before participating. @@ -183,7 +185,7 @@ Examples Create a basic bridge ===================== -Creating a bridge interface is very simple. In this example we will +Creating a bridge interface is very simple. In this example, we will have: * A bridge named `br100` diff --git a/docs/configuration/interfaces/dummy.rst b/docs/configuration/interfaces/dummy.rst index f5b72e0c..8440feca 100644 --- a/docs/configuration/interfaces/dummy.rst +++ b/docs/configuration/interfaces/dummy.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. _dummy-interface: ##### @@ -50,7 +52,7 @@ Operation .. opcmd:: show interfaces dummy - Show brief interface information.information + Show brief interface information. .. code-block:: none diff --git a/docs/configuration/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst index 1d99019c..dcc9e529 100644 --- a/docs/configuration/interfaces/ethernet.rst +++ b/docs/configuration/interfaces/ethernet.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. _ethernet-interface: ######## @@ -312,4 +314,3 @@ Operation XDP_PASS 0 pkts ( 0 pps) 0 Kbytes ( 0 Mbits/s) period:2.000414 XDP_TX 0 pkts ( 0 pps) 0 Kbytes ( 0 Mbits/s) period:2.000414 XDP_REDIRECT 0 pkts ( 0 pps) 0 Kbytes ( 0 Mbits/s) period:2.000414 - diff --git a/docs/configuration/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst index 9e00d621..b13e2ece 100644 --- a/docs/configuration/interfaces/geneve.rst +++ b/docs/configuration/interfaces/geneve.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. _geneve-interface: ###### diff --git a/docs/configuration/interfaces/l2tpv3.rst b/docs/configuration/interfaces/l2tpv3.rst index 8fe905a1..ca0ce2c9 100644 --- a/docs/configuration/interfaces/l2tpv3.rst +++ b/docs/configuration/interfaces/l2tpv3.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. include:: /_include/need_improvement.txt .. _l2tpv3-interface: @@ -9,7 +11,7 @@ L2TPv3 Layer 2 Tunnelling Protocol Version 3 is an IETF standard related to L2TP that can be used as an alternative protocol to :ref:`mpls` for encapsulation of multiprotocol Layer 2 communications traffic over IP networks. Like L2TP, -L2TPv3 provides a pseudo-wire service, but scaled to fit carrier requirements. +L2TPv3 provides a pseudo-wire service but is scaled to fit carrier requirements. L2TPv3 can be regarded as being to MPLS what IP is to ATM: a simplified version of the same concept, with much of the same benefit achieved at a fraction of the @@ -49,13 +51,13 @@ L2TPv3 options Set the IP address of the local interface to be used for the tunnel. - This address must be the address of a local interface. May be specified as an - IPv4 address or an IPv6 address. + This address must be the address of a local interface. It may be specified as + an IPv4 address or an IPv6 address. .. cfgcmd:: set interfaces l2tpv3 <interface> remote <address> - Set the IP address of the remote peer. May be specified as an IPv4 address or - an IPv6 address. + Set the IP address of the remote peer. It may be specified as + an IPv4 address or an IPv6 address. .. cfgcmd:: set interfaces l2tpv3 <interface> session-id <id> @@ -65,7 +67,7 @@ L2TPv3 options .. cfgcmd:: set interfaces l2tpv3 <interface> peer-session-id <id> - Set the peer session id, which is a 32-bit integer value assigned to the + Set the peer-session-id, which is a 32-bit integer value assigned to the session by the peer. The value used must match the session_id value being used at the peer. @@ -100,7 +102,7 @@ Over IP tunnel-id 200 } -Inverse configuration has to be applied to the remote side. +The inverse configuration has to be applied to the remote side. Over UDP ======== diff --git a/docs/configuration/interfaces/loopback.rst b/docs/configuration/interfaces/loopback.rst index 4d0c8fb6..ec2976b6 100644 --- a/docs/configuration/interfaces/loopback.rst +++ b/docs/configuration/interfaces/loopback.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-06-30 + .. _loopback-interface: ######## @@ -53,7 +55,7 @@ Operation .. opcmd:: show interfaces loopback lo - Show detailed information on given loopback interface `lo`. + Show detailed information on the given loopback interface `lo`. .. code-block:: none diff --git a/docs/configuration/interfaces/macsec.rst b/docs/configuration/interfaces/macsec.rst index 9a20c425..544bd4fc 100644 --- a/docs/configuration/interfaces/macsec.rst +++ b/docs/configuration/interfaces/macsec.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-07-05 + .. _macsec-interface: ###### @@ -40,7 +42,7 @@ MACsec options .. cfgcmd:: set interfaces macsec <interface> source-interface <physical-source> A physical interface is required to connect this MACsec instance to. Traffic - leaving this interfac will now be authenticated/encrypted. + leaving this interface will now be authenticated/encrypted. Key Management -------------- @@ -50,7 +52,7 @@ individual peers. .. cfgcmd:: set interfaces macsec <interface> security mka cak <key> - IEEE 802.1X/MACsec pre-shared key mode. This allows to configure MACsec with + IEEE 802.1X/MACsec pre-shared key mode. This allows configuring MACsec with a pre-shared key using a (CAK,CKN) pair. .. cfgcmd:: set interfaces macsec <interface> security mka ckn <key> |