From ccfd681d98978dae6532c98e9e7a8050bc64ab7d Mon Sep 17 00:00:00 2001 From: Rafael Zalamena Date: Mon, 3 May 2021 13:38:21 -0300 Subject: [PATCH] doc: improve PIM documentation Remove duplicates and explain MSDP better. Signed-off-by: Rafael Zalamena --- doc/user/pim.rst | 58 +++++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/doc/user/pim.rst b/doc/user/pim.rst index 6b7cae2c5d..103760933c 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -154,20 +154,6 @@ Certain signals have special meanings to *pimd*. urib-only Lookup in the Unicast Rib only. -.. clicmd:: ip msdp mesh-group [WORD] - - Create or Delete a multicast source discovery protocol mesh-group using - [WORD] as the group name. - -.. clicmd:: ip msdp mesh-group WORD member A.B.C.D - - Attach or Delete A.B.C.D to the MSDP mesh group WORD specified. - -.. clicmd:: ip msdp mesh-group WORD source A.B.C.D - - For the address specified A.B.C.D use that as the source address for - mesh group packets being sent. - .. clicmd:: ip igmp generate-query-once [version (2-3)] Generate IGMP query (v2/v3) on user requirement. This will not depend on @@ -308,28 +294,44 @@ caution. Most of the time this will not be necessary. Multicast Source Discovery Protocol (MSDP) Configuration ======================================================== -.. clicmd:: ip msdp mesh-group [WORD] member A.B.C.D +MSDP can be setup in different ways: - Include a MSDP peer as a member of a MSDP mesh-group. +* MSDP meshed-group: where all peers are connected with each other creating + a fully meshed network. SAs (source active) messages are not forwarded in + this mode because the origin is able to send SAs to all members. -.. clicmd:: ip msdp mesh-group [WORD] source A.B.C.D + This setup is commonly used with anycast. - Create a MSDP mesh-group, defining a name for it and an associated local source - address. +* MSDP peering: when there is one or more peers that are not fully meshed. SAs + may be forwarded depending on the result of filtering and RPF checks. + + This setup is commonly consistent with BGP peerings (for RPF checks). + +* MSDP default peer: there is only one peer and all SAs will be forwarded + there. + +.. note:: + + MSDP default peer and SA filtering is not implemented. + + +Commands available for MSDP: + + +.. clicmd:: ip msdp mesh-group WORD member A.B.C.D + + Create or update a mesh group to include the specified MSDP peer. + +.. clicmd:: ip msdp mesh-group WORD source A.B.C.D + + Create or update a mesh group to set the source address used to connect to + peers. .. clicmd:: ip msdp peer A.B.C.D source A.B.C.D - Establish a MSDP connection with a peer. + Create a regular MSDP session with peer using the specified source address. - Remove a MSDP peer member from a MSDP mesh-group. - - - Delete a MSDP mesh-group. - - - Delete a MSDP peer connection. - .. _show-pim-information: Show PIM Information