Skip to content

Commit

Permalink
doc: Add AutoRP advertisement documentation
Browse files Browse the repository at this point in the history
Document the extra CLI for configuring AutoRP candidate RP advertisement

Signed-off-by: Nathan Bahr <[email protected]>
  • Loading branch information
nabahr committed Aug 23, 2024
1 parent 409b271 commit f6bd605
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/user/pim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,20 @@ PIM Routers
This command is vrf aware, to configure for a vrf, specify the vrf in the
router pim block.

.. clicmd:: autorp announce A.B.C.D [A.B.C.D/M | group-list PREFIX_LIST]

Configure the router to advertise itself as a candidate PIM-SM RP via AutoRP.
The supported groups can be defined as a single group range, or multiple
group ranges can be defined via a prefix list.

.. clicmd:: autorp announce {scope (1-255) | interval (1-65535) | holdtime (0-65535)}

Configure the AutoRP advertise messages. The scope defines the TTL value in the
messages to limit the scope, defaults to 31. Interval defines the number of
seconds elapsed between advertise messages sent, defaults to 60. Hold time defines
how long the AutoRP mapping agent will consider the information valid, setting to
0 will disable expiration of the candidate RP information, defaults to 3 * interval.

.. clicmd:: rp keep-alive-timer (1-65535)

Modify the time out value for a S,G flow from 1-65535 seconds at RP.
Expand Down Expand Up @@ -581,6 +595,11 @@ cause great confusion.
192.168.10.123 239.0.0.0/8 eth2 yes Static ASM
192.168.10.123 239.4.0.0/24 eth2 yes Static SSM
.. clicmd:: show ip pim [vrf NAME] autorp [json]

Display information about AutoRP. Including state of AutoRP Discovery parsing
and configured AutoRP candidate RP information.

.. clicmd:: show ip pim rpf

Display information about currently being used S,G's and their RPF lookup
Expand Down

0 comments on commit f6bd605

Please sign in to comment.