Skip to content

Commit

Permalink
doc: document and explain PIM embedded RP
Browse files Browse the repository at this point in the history
Let user know about PIM embedded RP configuration commands.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
  • Loading branch information
rzalamena committed Sep 28, 2024
1 parent 0735078 commit 710f1a6
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions doc/user/pim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,37 @@ PIM Routers
prefix of group ranges covered. This command is vrf aware, to configure for
a vrf, specify the vrf in the router pim block.

.. clicmd:: embedded-rp

Learn the RP via embedded RP address in multicast group.

.. note::

Example: FF75:0130:2001:DB8:FFFF::100

- First byte is always 0xFF
- Second byte high nibble is always 7 (signifies RPT bits set)
- Second byte low nibble is address scope
- Third byte high nibble is zero (reserved)
- Third byte low nibble is the RP interface ID (RIID)
- Fourth byte is the RP prefix length (must be between 1 and 64)
- Fifth byte + RP prefix length is the RP address prefix
- Last four bytes are the group ID.

The RP in the above multicast address sample is:
2001:DB8:FFFF::1

.. clicmd:: embedded-rp group-list PREFIX_LIST_NAME

Restrict the embedded RP prefix range using only the permitted groups
provided by the prefix-list.

This is useful to restrict what RP addresses can be used.

.. clicmd:: embedded-rp limit (1-4294967295)

Restrict the maximum amount of embedded RPs to learn at same time.

.. clicmd:: no autorp discovery

In order to use pim, it is necessary to configure a RP for join messages to
Expand Down

0 comments on commit 710f1a6

Please sign in to comment.