summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols
diff options
context:
space:
mode:
authorLiudmylaNad <l.nadolina@vyos.io>2026-08-04 11:54:54 +0200
committerGitHub <noreply@github.com>2026-08-04 10:54:54 +0100
commit873a388fdb5faeb869881cc780de16c96385e433 (patch)
treea45874674c10ef5611e39b040ecc01ec48f8911b /docs/configuration/protocols
parent2ea0928fc0277eacb208765ab119055908b8e184 (diff)
downloadvyos-documentation-873a388fdb5faeb869881cc780de16c96385e433.tar.gz
vyos-documentation-873a388fdb5faeb869881cc780de16c96385e433.zip
docs: fix MyST roles used inside eval-rst blocks (#2125)sagitta
* docs: fix MyST roles used inside eval-rst blocks * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/configuration/protocols')
-rw-r--r--docs/configuration/protocols/bgp.md14
-rw-r--r--docs/configuration/protocols/isis.md26
-rw-r--r--docs/configuration/protocols/ospf.md20
-rw-r--r--docs/configuration/protocols/pim.md18
4 files changed, 39 insertions, 39 deletions
diff --git a/docs/configuration/protocols/bgp.md b/docs/configuration/protocols/bgp.md
index c8f77a6a..faf2d9e3 100644
--- a/docs/configuration/protocols/bgp.md
+++ b/docs/configuration/protocols/bgp.md
@@ -35,7 +35,7 @@ provides distance vector metric and loop detection to BGP.
```{eval-rst}
.. cfgcmd:: set protocols bgp system-as <asn>
- Set local {abbr}`ASN (Autonomous System Number)` that this router represents.
+ Set local :abbr:`ASN (Autonomous System Number)` that this router represents.
This is a a mandatory option!
```
@@ -207,7 +207,7 @@ process. The BGP process starts when the first neighbor is configured.
.. cfgcmd:: set protocols bgp neighbor <address|interface> local-role
<role> [strict]
- BGP roles are defined in RFC {rfc}`9234` and provide an easy way to
+ BGP roles are defined in RFC :rfc:`9234` and provide an easy way to
add route leak prevention, detection and mitigation. The local Role
value is negotiated with the new BGP Role capability which has a
built-in check of the corresponding value. In case of a mismatch the
@@ -222,7 +222,7 @@ process. The BGP process starts when the first neighbor is configured.
If {cfgcmd}`strict` is set the BGP session won’t become established
until the BGP neighbor sets local Role on its side. This
- configuration parameter is defined in RFC {rfc}`9234` and is used to
+ configuration parameter is defined in RFC :rfc:`9234` and is used to
enforce the corresponding configuration at your counter-parts side.
Routes that are sent from provider, rs-server, or the peer local-role
@@ -509,7 +509,7 @@ process. The BGP process starts when the first neighbor is configured.
hops <number>
This command enforces Generalized TTL Security Mechanism (GTSM),
- as specified in {rfc}`5082`. With this command, only neighbors
+ as specified in :rfc:`5082`. With this command, only neighbors
that are specified number of hops away will be allowed to
become neighbors. The number of hops range is 1 to 254. This
command is mutually exclusive with {cfgcmd}`ebgp-multihop`.
@@ -738,12 +738,12 @@ are treated as belonging to a default peer group, and will share updates.
.. cfgcmd:: set protocols bgp parameters ebgp-requires-policy
This command changes the eBGP behavior of FRR. By default FRR enables
- {rfc}`8212` functionality which affects how eBGP routes are advertised,
+ :rfc:`8212` functionality which affects how eBGP routes are advertised,
namely no routes are advertised across eBGP sessions without some
sort of egress route-map/policy in place. In VyOS however we have this
RFC functionality disabled by default so that we can preserve backwards
compatibility with older versions of VyOS. With this option one can
- enable {rfc}`8212` functionality to operate.
+ enable :rfc:`8212` functionality to operate.
```
```{eval-rst}
@@ -1029,7 +1029,7 @@ For outbound updates the order of preference is:
.. cfgcmd:: set protocols bgp neighbor <address|interface> address-family
<ipv4-unicast|ipv6-unicast> capability orf <receive|send>
- This command enables the ORF capability (described in {rfc}`5291`) on the
+ This command enables the ORF capability (described in :rfc:`5291`) on the
local router, and enables ORF capability advertisement to the specified BGP
peer. The {cfgcmd}`receive` keyword configures a router to advertise ORF
receive capabilities. The {cfgcmd}`send` keyword configures a router to
diff --git a/docs/configuration/protocols/isis.md b/docs/configuration/protocols/isis.md
index 07ffd827..4831cac3 100644
--- a/docs/configuration/protocols/isis.md
+++ b/docs/configuration/protocols/isis.md
@@ -36,7 +36,7 @@ occur within IS-IS when it comes to said duplication.
This commad sets network entity title (NET) provided in ISO format.
- Here is an example {abbr}`NET (Network Entity Title)` value:
+ Here is an example :abbr:`NET (Network Entity Title)` value:
.. code-block:: none
@@ -44,7 +44,7 @@ occur within IS-IS when it comes to said duplication.
The CLNS address consists of the following parts:
- * {abbr}`AFI (Address family authority identifier)` - ``49`` The AFI value
+ * :abbr:`AFI (Address family authority identifier)` - ``49`` The AFI value
49 is what IS-IS uses for private addressing.
* Area identifier: ``0001`` IS-IS area number (numberical area ``1``)
@@ -57,7 +57,7 @@ occur within IS-IS when it comes to said duplication.
into ``192.168.001.002``. Then all one has to do is move the dots to have
four numbers instead of three. This gives us ``1921.6800.1002``.
- * {abbr}`NET (Network Entity Title)` selector: ``00`` Must always be 00. This
+ * :abbr:`NET (Network Entity Title)` selector: ``00`` Must always be 00. This
setting indicates "this system" or "local system."
```
@@ -75,7 +75,7 @@ occur within IS-IS when it comes to said duplication.
.. cfgcmd:: set protocols isis dynamic-hostname
This command enables support for dynamic hostname TLV. Dynamic hostname
- mapping determined as described in {rfc}`2763`, Dynamic Hostname
+ mapping determined as described in :rfc:`2763`, Dynamic Hostname
Exchange Mechanism for IS-IS.
```
@@ -93,7 +93,7 @@ occur within IS-IS when it comes to said duplication.
.. cfgcmd:: set protocols isis lsp-mtu <size>
This command configures the maximum size of generated
- {abbr}`LSPs (Link State PDUs)`, in bytes. The size range is 128 to 4352.
+ :abbr:`LSPs (Link State PDUs)`, in bytes. The size range is 128 to 4352.
```
```{eval-rst}
@@ -109,7 +109,7 @@ occur within IS-IS when it comes to said duplication.
```{eval-rst}
.. cfgcmd:: set protocols isis purge-originator
- This command enables {rfc}`6232` purge originator identification. Enable
+ This command enables :rfc:`6232` purge originator identification. Enable
purge originator identification (POI) by adding the type, length and value
(TLV) with the Intermediate System (IS) identification to the LSPs that do
not contain POI information. If an IS generates a purge, VyOS adds this TLV
@@ -119,14 +119,14 @@ occur within IS-IS when it comes to said duplication.
```{eval-rst}
.. cfgcmd:: set protocols isis set-attached-bit
- This command sets ATT bit to 1 in Level1 LSPs. It is described in {rfc}`3787`.
+ This command sets ATT bit to 1 in Level1 LSPs. It is described in :rfc:`3787`.
```
```{eval-rst}
.. cfgcmd:: set protocols isis set-overload-bit
This command sets overload bit to avoid any transit traffic through this
- router. It is described in {rfc}`3787`.
+ router. It is described in :rfc:`3787`.
```
```{eval-rst}
@@ -148,7 +148,7 @@ occur within IS-IS when it comes to said duplication.
.. cfgcmd:: set protocols isis ldp-sync
This command will enable IGP-LDP synchronization globally for ISIS. This
- requires for LDP to be functional. This is described in {rfc}`5443`. By
+ requires for LDP to be functional. This is described in :rfc:`5443`. By
default all interfaces operational in IS-IS are enabled for synchronization.
Loopbacks are exempt.
```
@@ -195,7 +195,7 @@ occur within IS-IS when it comes to said duplication.
This command configures padding on hello packets to accommodate asymmetrical
maximum transfer units (MTUs) from different hosts as described in
- {rfc}`3719`. This helps to prevent a premature adjacency Up state when one
+ :rfc:`3719`. This helps to prevent a premature adjacency Up state when one
routing devices MTU does not meet the requirements to establish the adjacency.
```
@@ -233,7 +233,7 @@ occur within IS-IS when it comes to said duplication.
.. cfgcmd:: set protocols isis interface <interface> priority <number>
This command sets priority for the interface for
- {abbr}`DIS (Designated Intermediate System)` election. The priority
+ :abbr:`DIS (Designated Intermediate System)` election. The priority
range is 0 to 127.
```
@@ -250,7 +250,7 @@ occur within IS-IS when it comes to said duplication.
no-three-way-handshake
This command disables Three-Way Handshake for P2P adjacencies which
- described in {rfc}`5303`. Three-Way Handshake is enabled by default.
+ described in :rfc:`5303`. Three-Way Handshake is enabled by default.
```
```{eval-rst}
@@ -367,7 +367,7 @@ occur within IS-IS when it comes to said duplication.
This commands specifies the Finite State Machine (FSM) intended to
control the timing of the execution of SPF calculations in response
- to IGP events. The process described in {rfc}`8405`.
+ to IGP events. The process described in :rfc:`8405`.
```
diff --git a/docs/configuration/protocols/ospf.md b/docs/configuration/protocols/ospf.md
index adc62520..8b432a2c 100644
--- a/docs/configuration/protocols/ospf.md
+++ b/docs/configuration/protocols/ospf.md
@@ -109,7 +109,7 @@ starts when the first ospf enabled interface is configured.
.. cfgcmd:: set protocols ospf max-metric router-lsa
<administrative|on-shutdown <seconds>|on-startup <seconds>>
- This enables {rfc}`3137` support, where the OSPF process describes its
+ This enables :rfc:`3137` support, where the OSPF process describes its
transit links in its router-LSA as having infinite distance so that other
routers will avoid calculating transit paths through the router while
still being able to reach networks through the router.
@@ -139,7 +139,7 @@ starts when the first ospf enabled interface is configured.
area for inter-area connections.
Detailed information about "cisco" and "ibm" models differences can be
- found in {rfc}`3509`. A "shortcut" model allows ABR to create routes
+ found in :rfc:`3509`. A "shortcut" model allows ABR to create routes
between areas based on the topology of the areas connected to this router
but not using a backbone area in case if non-backbone route will be
cheaper. For more information about "shortcut" model,
@@ -149,7 +149,7 @@ starts when the first ospf enabled interface is configured.
```{eval-rst}
.. cfgcmd:: set protocols ospf parameters rfc1583-compatibility
- {rfc}`2328`, the successor to {rfc}`1583`, suggests according to section
+ :rfc:`2328`, the successor to :rfc:`1583`, suggests according to section
G.2 (changes) in section 16.4.1 a change to the path preference algorithm
that prevents possible routing loops that were possible in the old version
of OSPFv2. More specifically it demands that inter-area paths and
@@ -217,7 +217,7 @@ starts when the first ospf enabled interface is configured.
.. cfgcmd:: set protocols ospf ldp-sync
This command will enable IGP-LDP synchronization globally for OSPF. This
- requires for LDP to be functional. This is described in {rfc}`5443`. By
+ requires for LDP to be functional. This is described in :rfc:`5443`. By
default all interfaces operational in OSPF are enabled for synchronization.
Loopbacks are exempt.
```
@@ -232,7 +232,7 @@ starts when the first ospf enabled interface is configured.
```{eval-rst}
.. cfgcmd:: set protocols ospf capability opaque
- ospfd supports Opaque LSA {rfc}`2370` as partial support for MPLS Traffic
+ ospfd supports Opaque LSA :rfc:`2370` as partial support for MPLS Traffic
Engineering LSAs. The opaque-lsa capability must be enabled in the
configuration.
@@ -494,7 +494,7 @@ starts when the first ospf enabled interface is configured.
```{eval-rst}
.. cfgcmd:: set protocols ospf interface <interface> bfd
- This command enables {abbr}`BFD (Bidirectional Forwarding Detection)` on
+ This command enables :abbr:`BFD (Bidirectional Forwarding Detection)` on
this OSPF link interface.
```
@@ -595,7 +595,7 @@ Route will be originated on-behalf of all matched external LSAs.
```{eval-rst}
.. cfgcmd:: set protocols ospf graceful-restart [grace-period (1-1800)]
- Configure Graceful Restart {rfc}`3623` restarting support. When enabled,
+ Configure Graceful Restart :rfc:`3623` restarting support. When enabled,
the default grace period is 120 seconds.
To perform a graceful shutdown, the FRR ``graceful-restart prepare ip
@@ -606,7 +606,7 @@ Route will be originated on-behalf of all matched external LSAs.
```{eval-rst}
.. cfgcmd:: set protocols ospf graceful-restart helper enable [router-id A.B.C.D]
- Configure Graceful Restart {rfc}`3623` helper support. By default, helper support
+ Configure Graceful Restart :rfc:`3623` helper support. By default, helper support
is disabled for all neighbours. This config enables/disables helper support
on this router for all neighbours.
@@ -1351,7 +1351,7 @@ process starts when the first ospf enabled interface is configured.
```{eval-rst}
.. cfgcmd:: set protocols ospfv3 graceful-restart [grace-period (1-1800)]
- Configure Graceful Restart {rfc}`3623` restarting support. When enabled,
+ Configure Graceful Restart :rfc:`3623` restarting support. When enabled,
the default grace period is 120 seconds.
To perform a graceful shutdown, the FRR ``graceful-restart prepare ip
@@ -1362,7 +1362,7 @@ process starts when the first ospf enabled interface is configured.
```{eval-rst}
.. cfgcmd:: set protocols ospfv3 graceful-restart helper enable [router-id A.B.C.D]
- Configure Graceful Restart {rfc}`3623` helper support. By default, helper support
+ Configure Graceful Restart :rfc:`3623` helper support. By default, helper support
is disabled for all neighbours. This config enables/disables helper support
on this router for all neighbours.
diff --git a/docs/configuration/protocols/pim.md b/docs/configuration/protocols/pim.md
index 30f3d49b..8a96691a 100644
--- a/docs/configuration/protocols/pim.md
+++ b/docs/configuration/protocols/pim.md
@@ -32,7 +32,7 @@ source-specific multicast).
.. cfgcmd:: set protocols pim ecmp
If PIM has the a choice of ECMP nexthops for a particular
- {abbr}`RPF (Reverse Path Forwarding)`, PIM will cause S,G flows to be
+ :abbr:`RPF (Reverse Path Forwarding)`, PIM will cause S,G flows to be
spread out amongst the nexthops. If this command is not specified then
the first nexthop found will be used.
```
@@ -97,7 +97,7 @@ source-specific multicast).
```{eval-rst}
.. cfgcmd:: set protocols pim rp <address> group <group>
- In order to use PIM, it is necessary to configure a {abbr}`RP (Rendezvous Point)`
+ In order to use PIM, it is necessary to configure a :abbr:`RP (Rendezvous Point)`
for join messages to be sent to. Currently the only methodology to do this is
via static rendezvous point commands.
@@ -111,8 +111,8 @@ source-specific multicast).
.. cfgcmd:: set protocols pim rp keep-alive-timer <n>
Modify the time out value for a S,G flow from 1-65535 seconds at
- {abbr}`RP (Rendezvous Point)`. The normal keepalive period for the KAT(S,G)
- defaults to 210 seconds. However, at the {abbr}`RP (Rendezvous Point)`, the
+ :abbr:`RP (Rendezvous Point)`. The normal keepalive period for the KAT(S,G)
+ defaults to 210 seconds. However, at the :abbr:`RP (Rendezvous Point)`, the
keepalive period must be at least the Register_Suppression_Time, or the RP
may time out the (S,G) state before the next Null-Register arrives.
Thus, the KAT(S,G) is set to max(Keepalive_Period, RP_Keepalive_Period)
@@ -121,7 +121,7 @@ source-specific multicast).
If choosing a value below 31 seconds be aware that some hardware platforms
cannot see data flowing in better than 30 second chunks.
- See {rfc}`7761#section-4.1` for details.
+ See :rfc:`7761#section-4.1` for details.
```
```{eval-rst}
@@ -129,7 +129,7 @@ source-specific multicast).
When sending PIM hello packets tell PIM to not send any v6 secondary
addresses on the interface. This information is used to allow PIM to use v6
- nexthops in it's decision for {abbr}`RPF (Reverse Path Forwarding)` lookup
+ nexthops in it's decision for :abbr:`RPF (Reverse Path Forwarding)` lookup
if this option is not set (default).
```
@@ -148,7 +148,7 @@ source-specific multicast).
.. cfgcmd:: set protocols pim ssm prefix-list <list>
Specify a range of group addresses via a prefix-list that forces PIM to never
- do {abbr}`SSM (Source-Specific Multicast)` over.
+ do :abbr:`SSM (Source-Specific Multicast)` over.
```
### Interface specific commands
@@ -168,7 +168,7 @@ source-specific multicast).
```{eval-rst}
.. cfgcmd:: set protocols pim interface <interface> dr-priority <n>
- Set the {abbr}`DR (Designated Router)` Priority for the interface.
+ Set the :abbr:`DR (Designated Router)` Priority for the interface.
This command is useful to allow the user to influence what node becomes
the DR for a LAN segment.
```
@@ -241,7 +241,7 @@ source-specific multicast).
Use this command to configure in the selected interface the IGMP
query response timeout value (10-250) in deciseconds. If a report is
not returned in the specified time, it will be assumed the (S,G) or
- (\*,G) state {rfc}`7761#section-4.1` has timed out.
+ (\*,G) state :rfc:`7761#section-4.1` has timed out.
```
```{eval-rst}