summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/interfaces')
-rw-r--r--docs/configuration/interfaces/bridge.md8
-rw-r--r--docs/configuration/interfaces/ethernet.md10
-rw-r--r--docs/configuration/interfaces/geneve.md2
-rw-r--r--docs/configuration/interfaces/macsec.md10
-rw-r--r--docs/configuration/interfaces/pppoe.md4
-rw-r--r--docs/configuration/interfaces/sstp-client.md2
-rw-r--r--docs/configuration/interfaces/vxlan.md4
-rw-r--r--docs/configuration/interfaces/wwan.md2
8 files changed, 21 insertions, 21 deletions
diff --git a/docs/configuration/interfaces/bridge.md b/docs/configuration/interfaces/bridge.md
index 409412c1..d224bb2f 100644
--- a/docs/configuration/interfaces/bridge.md
+++ b/docs/configuration/interfaces/bridge.md
@@ -35,10 +35,10 @@ Spanning Tree Protocol is not enabled by default in VyOS.
Assign `<member>` interface to bridge `<interface>`. A completion
helper will help you with all allowed interfaces which can be
- bridged. This includes {ref}`ethernet-interface`,
- {ref}`bond-interface`, {ref}`l2tpv3-interface`, {ref}`openvpn`,
- {ref}`vxlan-interface`, {ref}`wireless-interface`,
- {ref}`tunnel-interface` and {ref}`geneve-interface`.
+ bridged. This includes :ref:`ethernet-interface`,
+ :ref:`bond-interface`, :ref:`l2tpv3-interface`, :ref:`openvpn`,
+ :ref:`vxlan-interface`, :ref:`wireless-interface`,
+ :ref:`tunnel-interface` and :ref:`geneve-interface`.
```
diff --git a/docs/configuration/interfaces/ethernet.md b/docs/configuration/interfaces/ethernet.md
index 66d388ea..b1b09045 100644
--- a/docs/configuration/interfaces/ethernet.md
+++ b/docs/configuration/interfaces/ethernet.md
@@ -76,7 +76,7 @@ real world.
Enable different types of hardware offloading on the given NIC.
- {abbr}`LRO (Large Receive Offload)` is a technique designed to boost the
+ :abbr:`LRO (Large Receive Offload)` is a technique designed to boost the
efficiency of how your computer's network interface card (NIC) processes
incoming network traffic. Typically, network data arrives in smaller chunks
called packets. Processing each packet individually consumes CPU (central
@@ -92,7 +92,7 @@ real world.
(Generic Receive Offload) where possible. More information on the
limitations of LRO can be found here: https://lwn.net/Articles/358910/
- {abbr}`GSO (Generic Segmentation Offload)` is a pure software offload that is
+ :abbr:`GSO (Generic Segmentation Offload)` is a pure software offload that is
meant to deal with cases where device drivers cannot perform the offloads
described above. What occurs in GSO is that a given skbuff will have its data
broken out over multiple skbuffs that have been resized to match the MSS
@@ -102,7 +102,7 @@ real world.
offload is required in GSO. Otherwise it becomes possible for a frame to be
re-routed between devices and end up being unable to be transmitted.
- {abbr}`GRO (Generic receive offload)` is the complement to GSO. Ideally any
+ :abbr:`GRO (Generic receive offload)` is the complement to GSO. Ideally any
frame assembled by GRO should be segmented to create an identical sequence of
frames using GSO, and any sequence of frames segmented by GSO should be able
to be reassembled back to the original by GRO. The only exception to this is
@@ -110,8 +110,8 @@ real world.
value of the IPv4 ID is not sequentially incrementing it will be altered so
that it is when a frame assembled via GRO is segmented via GSO.
- {abbr}`RPS (Receive Packet Steering)` is logically a software implementation
- of {abbr}`RSS (Receive Side Scaling)`. Being in software, it is necessarily
+ :abbr:`RPS (Receive Packet Steering)` is logically a software implementation
+ of :abbr:`RSS (Receive Side Scaling)`. Being in software, it is necessarily
called later in the datapath. Whereas RSS selects the queue and hence CPU that
will run the hardware interrupt handler, RPS selects the CPU to perform
protocol processing above the interrupt handler. This is accomplished by
diff --git a/docs/configuration/interfaces/geneve.md b/docs/configuration/interfaces/geneve.md
index 5c561fb8..24fd1625 100644
--- a/docs/configuration/interfaces/geneve.md
+++ b/docs/configuration/interfaces/geneve.md
@@ -91,7 +91,7 @@ Geneve Header:
```{eval-rst}
.. cfgcmd:: set interfaces geneve gnv0 vni <vni>
- {abbr}`VNI (Virtual Network Identifier)` is an identifier for a unique
+ :abbr:`VNI (Virtual Network Identifier)` is an identifier for a unique
element of a virtual network. In many situations this may represent an L2
segment, however, the control plane defines the forwarding semantics of
decapsulated packets. The VNI MAY be used as part of ECMP forwarding
diff --git a/docs/configuration/interfaces/macsec.md b/docs/configuration/interfaces/macsec.md
index c3cd2595..8cde047d 100644
--- a/docs/configuration/interfaces/macsec.md
+++ b/docs/configuration/interfaces/macsec.md
@@ -89,14 +89,14 @@ individual peers.
.. cfgcmd:: set interfaces macsec <interface> security mka cak <key>
IEEE 802.1X/MACsec pre-shared key mode. This allows configuring MACsec with
- a pre-shared key using a {abbr}`CAK (MACsec connectivity association key)` and
- {abbr}`CKN (MACsec connectivity association name)` pair.
+ a pre-shared key using a :abbr:`CAK (MACsec connectivity association key)` and
+ :abbr:`CKN (MACsec connectivity association name)` pair.
```
```{eval-rst}
.. cfgcmd:: set interfaces macsec <interface> security mka ckn <key>
- {abbr}`CKN (MACsec connectivity association name)` key
+ :abbr:`CKN (MACsec connectivity association name)` key
```
```{eval-rst}
@@ -124,7 +124,7 @@ individual peers.
```{eval-rst}
.. opcmd:: run generate macsec mka cak <gcm-aes-128|gcm-aes-256>
- Generate {abbr}`MKA (MACsec Key Agreement protocol)` CAK key 128 or 256 bits.
+ Generate :abbr:`MKA (MACsec Key Agreement protocol)` CAK key 128 or 256 bits.
.. code-block:: none
@@ -135,7 +135,7 @@ individual peers.
```{eval-rst}
.. opcmd:: run generate macsec mka ckn
- Generate {abbr}`MKA (MACsec Key Agreement protocol)` CAK key.
+ Generate :abbr:`MKA (MACsec Key Agreement protocol)` CAK key.
.. code-block:: none
diff --git a/docs/configuration/interfaces/pppoe.md b/docs/configuration/interfaces/pppoe.md
index 25e017f4..edf82343 100644
--- a/docs/configuration/interfaces/pppoe.md
+++ b/docs/configuration/interfaces/pppoe.md
@@ -158,7 +158,7 @@ vDSL/aDSL understands.
```{eval-rst}
.. cfgcmd:: set interfaces pppoe <interface> mru <mru>
- Set the {abbr}`MRU (Maximum Receive Unit)` to `mru`. PPPd will ask the peer to
+ Set the :abbr:`MRU (Maximum Receive Unit)` to `mru`. PPPd will ask the peer to
send packets of no more than `mru` bytes. The value of `mru` must be between 128
and 16384.
@@ -259,7 +259,7 @@ vDSL/aDSL understands.
.. cfgcmd:: set interfaces pppoe <interface> ip source-validation <strict | loose | disable>
Enable policy for source validation by reversed path, as specified in
- {rfc}`3704`. Current recommended practice in {rfc}`3704` is to enable strict
+ :rfc:`3704`. Current recommended practice in :rfc:`3704` is to enable strict
mode to prevent IP spoofing from DDos attacks. If using asymmetric routing
or other complicated routing, then loose mode is recommended.
diff --git a/docs/configuration/interfaces/sstp-client.md b/docs/configuration/interfaces/sstp-client.md
index b2c79537..88a6bc4f 100644
--- a/docs/configuration/interfaces/sstp-client.md
+++ b/docs/configuration/interfaces/sstp-client.md
@@ -117,7 +117,7 @@ VyOS also comes with a build in SSTP server, see {ref}`sstp`.
.. cfgcmd:: set interfaces sstpc <interface> ip source-validation <strict | loose | disable>
Enable policy for source validation by reversed path, as specified in
- {rfc}`3704`. Current recommended practice in {rfc}`3704` is to enable strict
+ :rfc:`3704`. Current recommended practice in :rfc:`3704` is to enable strict
mode to prevent IP spoofing from DDos attacks. If using asymmetric routing
or other complicated routing, then loose mode is recommended.
diff --git a/docs/configuration/interfaces/vxlan.md b/docs/configuration/interfaces/vxlan.md
index 0eff152c..d5b4f9c7 100644
--- a/docs/configuration/interfaces/vxlan.md
+++ b/docs/configuration/interfaces/vxlan.md
@@ -47,7 +47,7 @@ may be blocked by the hypervisor.
.. cfgcmd:: set interfaces vxlan <interface> vni <number>
Each VXLAN segment is identified through a 24-bit segment ID, termed the
- {abbr}`VNI (VXLAN Network Identifier (or VXLAN Segment ID))`, This allows
+ :abbr:`VNI (VXLAN Network Identifier (or VXLAN Segment ID))`, This allows
up to 16M VXLAN segments to coexist within the same administrative domain.
```
@@ -82,7 +82,7 @@ may be blocked by the hypervisor.
.. cfgcmd:: set interfaces vxlan <interface> parameters neighbor-suppress
In order to minimize the flooding of ARP and ND messages in the VXLAN network,
- EVPN includes provisions {rfc}`7432#section-10` that allow participating VTEPs
+ EVPN includes provisions :rfc:`7432#section-10` that allow participating VTEPs
to suppress such messages in case they know the MAC-IP binding and can reply
on behalf of the remote host.
```
diff --git a/docs/configuration/interfaces/wwan.md b/docs/configuration/interfaces/wwan.md
index ac096259..9371e333 100644
--- a/docs/configuration/interfaces/wwan.md
+++ b/docs/configuration/interfaces/wwan.md
@@ -88,7 +88,7 @@ VyOS uses the `interfaces wwan` subsystem for configuration.
```{eval-rst}
.. cfgcmd:: set interfaces wwan <interface> apn <apn>
- Every WWAN connection requires an {abbr}`APN (Access Point Name)` which is
+ Every WWAN connection requires an :abbr:`APN (Access Point Name)` which is
used by the client to dial into the ISPs network. This is a mandatory
parameter. Contact your Service Provider for correct APN.