summaryrefslogtreecommitdiff
path: root/doc/user/pim.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/pim.rst')
-rw-r--r--doc/user/pim.rst34
1 files changed, 29 insertions, 5 deletions
diff --git a/doc/user/pim.rst b/doc/user/pim.rst
index f4611c520b..17bf44fdba 100644
--- a/doc/user/pim.rst
+++ b/doc/user/pim.rst
@@ -8,7 +8,8 @@ PIM -- Protocol Independent Multicast
*pimd* supports pim-sm as well as igmp v2 and v3. pim is
vrf aware and can work within the context of vrf's in order to
-do S,G mrouting.
+do S,G mrouting. Additionally PIM can be used in the EVPN underlay
+network for optimizing forwarding of overlay BUM traffic.
.. _starting-and-stopping-pimd:
@@ -333,10 +334,12 @@ cause great confusion.
Display information about interfaces PIM is using.
-.. index:: show ip pim join
+.. index:: show ip pim [vrf NAME] join [A.B.C.D [A.B.C.D]] [json]
.. clicmd:: show ip pim join
- Display information about PIM joins received.
+ Display information about PIM joins received. If one address is specified
+ then we assume it is the Group we are interested in displaying data on.
+ If the second address is specified then it is Source Group.
.. index:: show ip pim local-membership
.. clicmd:: show ip pim local-membership
@@ -383,10 +386,11 @@ cause great confusion.
Display information about known S,G's and incoming interface as well as the
OIL and how they were chosen.
-.. index:: show ip pim upstream
+.. index:: show ip pim [vrf NAME] upstream [A.B.C.D [A.B.C.D]] [json]
.. clicmd:: show ip pim upstream
- Display upstream information about a S,G mroute.
+ Display upstream information about a S,G mroute. Allow the user to
+ specify sub Source and Groups that we are only interested in.
.. index:: show ip pim upstream-join-desired
.. clicmd:: show ip pim upstream-join-desired
@@ -495,3 +499,23 @@ Clear commands reset various variables.
.. clicmd:: clear ip pim oil
Rescan PIM OIL (output interface list).
+
+PIM EVPN configuration
+======================
+To use PIM in the underlay for overlay BUM forwarding associate a
+multicast group with the L2 VNI. The actual configuration is based
+on your distribution. Here is an ifupdown2 example -
+auto vx-10100
+iface vx-10100
+ vxlan-id 10100
+ bridge-access 100
+ vxlan-local-tunnelip 27.0.0.11
+ vxlan-mcastgrp 239.1.1.100 >>>>>>>>
+PIM will see the vxlan configuration and auto configure state to properly
+forward BUM traffic.
+
+PIM also needs to be configured in the underlay to allow the BUM MDT to
+be setup. This is existing PIM configuration -
+- Enable pim on the underlay L3 interface via the "ip pim" command.
+- Configure RPs for the BUM multicast group range.
+- Ensure the PIM is enabled on the lo of the VTEPs and the RP.