From 4d0ead82fd8276f2606009e2665f672885e3e793 Mon Sep 17 00:00:00 2001 From: Mobashshera Rasool Date: Wed, 2 Feb 2022 10:07:34 -0800 Subject: [PATCH] doc: Correcting the documentation for pimd While going through the doc, found some commands are missing in the doc. Also correcting few mistakes. Signed-off-by: Mobashshera Rasool --- doc/user/pim.rst | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/user/pim.rst b/doc/user/pim.rst index 899a6b0078..1b418a4349 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -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. -- 2.39.5