From 5d6fa52b8985f8068314aba26878a1d7d5cb84e5 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Wed, 6 May 2026 20:42:32 +0300 Subject: feat: flip swap mechanism — MD as primary, RST as override (Phase 1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-.md to docs/**/.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/.rst to docs/**/rst-.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io --- docs/configuration/protocols/static.rst | 301 -------------------------------- 1 file changed, 301 deletions(-) delete mode 100644 docs/configuration/protocols/static.rst (limited to 'docs/configuration/protocols/static.rst') diff --git a/docs/configuration/protocols/static.rst b/docs/configuration/protocols/static.rst deleted file mode 100644 index eb5a439c..00000000 --- a/docs/configuration/protocols/static.rst +++ /dev/null @@ -1,301 +0,0 @@ -.. _routing-static: - -###### -Static -###### - -Static routes are manually configured routes, which, in general, cannot be -updated dynamically from information VyOS learns about the network topology from -other routing protocols. However, if a link fails, the router will remove -routes, including static routes, from the :abbr:`RIPB (Routing Information -Base)` that used this interface to reach the next hop. In general, static -routes should only be used for very simple network topologies, or to override -the behavior of a dynamic routing protocol for a small number of routes. The -collection of all routes the router has learned from its configuration or from -its dynamic routing protocols is stored in the RIB. Unicast routes are directly -used to determine the forwarding table used for unicast packet forwarding. - -******************* -IPv4 Unicast Routes -******************* - -.. cfgcmd:: set protocols static route next-hop
- - Configure next-hop `
` for an IPv4 static route. Multiple static - routes can be created. - -.. cfgcmd:: set protocols static route next-hop
disable - - Disable this IPv4 static route entry. - -.. cfgcmd:: set protocols static route next-hop
- distance - - Defines next-hop distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - - Range is 1 to 255, default is 1. - - .. note:: Routes with a distance of 255 are effectively disabled and not - installed into the kernel. - -IPv4 Interface Routes -===================== - -.. cfgcmd:: set protocols static route interface - - - Allows you to configure the next-hop interface for an interface-based IPv4 - static route. `` will be the next-hop interface where traffic is - routed for the given ``. - -.. cfgcmd:: set protocols static route interface - disable - - Disables interface-based IPv4 static route. - -.. cfgcmd:: set protocols static route interface - distance - - Defines next-hop distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - - Range is 1 to 255, default is 1. - -IPv4 BFD -======== - -.. cfgcmd:: set protocols static route next-hop
bfd - - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address. - -.. stop_vyoslinter - -.. cfgcmd:: set protocols static route next-hop
bfd profile - -.. start_vyoslinter - - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address with BFD profile ``. - -.. cfgcmd:: set protocols static route next-hop
bfd multi-hop - source-address - - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address with source address - `` but initiate a multi-hop session. - -DHCP Interface Routes -===================== - -.. cfgcmd:: set protocols static route dhcp-interface - - Defines route with DHCP interface supplying next-hop IP address. - -IPv4 Reject Routes -================== - -.. cfgcmd:: set protocol static route reject - - Defines route which emits an ICMP unreachable when matched. - -.. cfgcmd:: set protocols static route reject distance - - Defines distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - -.. cfgcmd:: set protocols static route reject tag - - Sets a tag for this route. - -.. cfgcmd:: set protocol static route6 reject - - Defines route which emits an ICMP unreachable when matched. - -IPv4 Blackhole Routes -===================== - -.. cfgcmd:: set protocols static route blackhole - - Use this command to configure a "black-hole" route on the router. A - black-hole route is a route for which the system silently discard packets - that are matched. This prevents networks leaking out public interfaces, but - it does not prevent them from being used as a more specific route inside your - network. - -.. cfgcmd:: set protocols static route blackhole distance - - Defines blackhole distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - -.. cfgcmd:: set protocols static route blackhole tag - - Sets a tag for this route. - -******************* -IPv6 Unicast Routes -******************* - -.. cfgcmd:: set protocols static route6 next-hop
- - Configure next-hop `
` for an IPv6 static route. Multiple static - routes can be created. - -.. cfgcmd:: set protocols static route6 next-hop
disable - - Disable this IPv6 static route entry. - -.. cfgcmd:: set protocols static route6 next-hop
- distance - - Defines next-hop distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - - Range is 1 to 255, default is 1. - - .. note:: Routes with a distance of 255 are effectively disabled and not - installed into the kernel. - -.. stop_vyoslinter - -.. cfgcmd:: set protocols static route6 next-hop
segments - -.. start_vyoslinter - - It is possible to specify a static route for ipv6 prefixes using an - SRv6 segments instruction. The ``/`` separator can be used to specify - multiple segment instructions. - - Example: - -.. stop_vyoslinter - - .. code-block:: none - - set protocols static route6 2001:db8:1000::/36 next-hop 2001:db8:201::ffff segments '2001:db8:aaaa::7/2002::4/2002::3/2002::2' - - .. code-block:: none - - vyos@vyos:~$ show ipv6 route - Codes: K - kernel route, C - connected, S - static, R - RIPng, - O - OSPFv3, I - IS-IS, B - BGP, N - NHRP, T - Table, - v - VNC, V - VNC-Direct, A - Babel, F - PBR, - f - OpenFabric, - > - selected route, * - FIB route, q - queued, r - rejected, b - backup - t - trapped, o - offload failure - C>* 2001:db8:201::/64 is directly connected, eth0.201, 00:00:46 - S>* 2001:db8:1000::/36 [1/0] via 2001:db8:201::ffff, eth0.201, seg6 2001:db8:aaaa::7,2002::4,2002::3,2002::2, weight 1, 00:00:08 - -.. start_vyoslinter - -IPv6 Interface Routes -===================== - -.. cfgcmd:: set protocols static route6 interface - - - Allows you to configure the next-hop interface for an interface-based IPv6 - static route. `` will be the next-hop interface where traffic is - routed for the given ``. - -.. cfgcmd:: set protocols static route6 interface - disable - - Disables interface-based IPv6 static route. - -.. cfgcmd:: set protocols static route6 interface - distance - - Defines next-hop distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - - Range is 1 to 255, default is 1. - -.. cfgcmd:: set protocols static route6 interface - segments - - It is possible to specify a static route for ipv6 prefixes using an - SRv6 segments instruction. The ``/`` separator can be used to specify - multiple segment instructions. - - Example: - -.. stop_vyoslinter - - .. code-block:: none - - set protocols static route6 2001:db8:1000::/36 interface eth0 segments '2001:db8:aaaa::7/2002::4/2002::3/2002::2' - -.. start_vyoslinter - -IPv6 BFD -======== - -.. cfgcmd:: set protocols static route6 next-hop
bfd - - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address. - -.. stop_vyoslinter - -.. cfgcmd:: set protocols static route6 next-hop
bfd profile - -.. start_vyoslinter - - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address with BFD profile ``. - -.. stop_vyoslinter - -.. cfgcmd:: set protocols static route6 next-hop
bfd multi-hop - source-address - -.. start_vyoslinter - - Configure a static route for `` using gateway `
` and use the - gateway address as BFD peer destination address with source address - `` but initiate a multi-hop session. - -IPv6 Reject Routes -================== - -.. cfgcmd:: set protocol static route6 reject - - Defines route which emits an ICMP unreachable when matched. - -.. cfgcmd:: set protocols static route6 reject distance - - Defines distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - -.. cfgcmd:: set protocols static route6 reject tag - - Sets a tag for this route. - -IPv6 Blackhole Routes -===================== - -.. cfgcmd:: set protocols static route6 blackhole - - Use this command to configure a "black-hole" route on the router. A - black-hole route is a route for which the system silently discard packets - that are matched. This prevents networks leaking out public interfaces, but - it does not prevent them from being used as a more specific route inside your - network. - -.. cfgcmd:: set protocols static route6 blackhole distance - - Defines blackhole distance for this route, routes with smaller administrative - distance are elected prior to those with a higher distance. - -.. cfgcmd:: set protocols static route6 blackhole tag - - Sets a tag for this route. - -************************ -Alternate Routing Tables -************************ - -Alternate routing tables are used with policy based routing by utilizing -:ref:`vrf`. -- cgit v1.2.3