Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

static: T6746: document BFD for static routes #1577

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/configuration/protocols/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Protocols
igmp-proxy
isis
mpls
multicast
segment-routing
openfabric
ospf
Expand Down
34 changes: 34 additions & 0 deletions docs/configuration/protocols/multicast.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _routing-static:

#########
Multicast
#########

In order to influence Multicast :abbr:`RPF (Reverse Path Forwarding)` lookup,
it is possible to insert into zebra routes for the Multicast
:abbr:`RIB (Routing Information Base)`. These routes are only used for RPF
lookup and will not be used by ZEBRA for insertion into the kernel or for
normal RIB processing. As such it is possible to create weird states with
these commands.

Use with caution. Most of the time this will not be necessary.

.. cfgcmd:: set protocols static mroute <subnet> next-hop <address>
[distance <distance>]

Insert into the Multicast RIB Route `<subnet>` with specified next-hop.
The distance can be specified as well if desired.

.. cfgcmd:: set protocols static mroute <subnet> next-hop <address> disable

Do not install route for `<subnet>` into the Multicast RIB.

.. cfgcmd:: set protocols static mroute <subnet> interface <interface>
[distance <distance>]

Insert into the Multicast RIB Route `<subnet>` with specified `<interface>`.
The distance can be specified as well if desired.

.. cfgcmd:: set protocols static mroute <subnet> interface <interface> disable

Do not install route for `<subnet>` into the Multicast RIB.
40 changes: 40 additions & 0 deletions docs/configuration/protocols/static.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@ IPv4 Interface Routes

Range is 1 to 255, default is 1.

IPv4 BFD
========

.. cfgcmd:: set protocols static route <subnet> next-hop <address> bfd

Configure a static route for `<subnet>` using gateway `<address>` and use the
gateway address as BFD peer destination address.

.. cfgcmd:: set protocols static route <subnet> next-hop <address> bfd profile <profile>

Configure a static route for `<subnet>` using gateway `<address>` and use the
gateway address as BFD peer destination address with BFD profile `<profile>`.

.. cfgcmd:: set protocols static route <subnet> next-hop <address> bfd multi-hop
source-address <source-address>

Configure a static route for `<subnet>` using gateway `<address>` and use the
gateway address as BFD peer destination address with source address
`<source>` but initiate a multi-hop session.

DHCP Interface Routes
=====================

Expand Down Expand Up @@ -191,6 +211,26 @@ IPv6 Interface Routes

set protocols static route6 2001:db8:1000::/36 interface eth0 segments '2001:db8:aaaa::7/2002::4/2002::3/2002::2'

IPv6 BFD
========

.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> bfd

Configure a static route for `<subnet>` using gateway `<address>` and use the
gateway address as BFD peer destination address.

.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> bfd profile <profile>

Configure a static route for `<subnet>` using gateway `<address>` and use the
gateway address as BFD peer destination address with BFD profile `<profile>`.

.. cfgcmd:: set protocols static route6 <subnet> next-hop <address> bfd multi-hop
source-address <source>

Configure a static route for `<subnet>` using gateway `<address>` and use the
gateway address as BFD peer destination address with source address
`<source>` but initiate a multi-hop session.

IPv6 Reject Routes
==================

Expand Down
Loading