]> git.puffer.fish Git - matthieu/frr.git/commitdiff
doc: Correcting the documentation for pimd
authorMobashshera Rasool <mrasool@vmware.com>
Wed, 2 Feb 2022 18:07:34 +0000 (10:07 -0800)
committerMobashshera Rasool <mrasool@vmware.com>
Wed, 2 Feb 2022 19:18:11 +0000 (11:18 -0800)
While going through the doc, found some commands are missing in the doc.
Also correcting few mistakes.

Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>
doc/user/pim.rst

index 899a6b007874aea3fc9288b59207b8672cc88e4c..1b418a434929c4fba12b76ba10cf70faf959f457 100644 (file)
@@ -65,6 +65,18 @@ Certain signals have special meanings to *pimd*.
    prefix of group ranges covered. This command is vrf aware, to configure for
    a vrf, enter the vrf submode.
 
+.. clicmd:: ip pim rp keep-alive-timer (1-65535)
+
+   Modify the time out value for a S,G flow from 1-65535 seconds at RP.
+   The normal keepalive period for the KAT(S,G) defaults to 210 seconds.
+   However, at the RP, 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) when a Register-Stop is sent.
+   If choosing a value below 31 seconds be aware that some hardware platforms
+   cannot see data flowing in better than 30 second chunks. This command is
+   vrf aware, to configure for a vrf, enter the vrf submode.
+
 .. clicmd:: ip pim register-accept-list PLIST
 
    When pim receives a register packet the source of the packet will be compared
@@ -72,10 +84,14 @@ Certain signals have special meanings to *pimd*.
    processing continues.  If a deny is returned for the source address of the
    register packet a register stop message is sent to the source.
 
-.. clicmd:: ip pim spt-switchover infinity-and-beyond
+.. clicmd:: ip pim spt-switchover infinity-and-beyond [prefix-list PLIST]
 
-   On the last hop router if it is desired to not switch over to the SPT tree.
-   Configure this command. This command is vrf aware, to configure for a vrf,
+   On the last hop router if it is desired to not switch over to the SPT tree
+   configure this command. Optional parameter prefix-list can be use to control
+   which groups to switch or not switch. If a group is PERMIT as per the
+   PLIST, then the SPT switchover does not happen for it and if it is DENY,
+   then the SPT switchover happens.
+   This command is vrf aware, to configure for a vrf,
    enter the vrf submode.
 
 .. clicmd:: ip pim ecmp
@@ -103,7 +119,7 @@ Certain signals have special meanings to *pimd*.
 
 .. clicmd:: ip pim keep-alive-timer (1-65535)
 
-   Modify the time out value for a S,G flow from 1-60000 seconds. If choosing
+   Modify the time out value for a S,G flow from 1-65535 seconds. If choosing
    a value below 31 seconds be aware that some hardware platforms cannot see data
    flowing in better than 30 second chunks. This command is vrf aware, to
    configure for a vrf, enter the vrf submode.