PIM

PIM (Protocol Independent Multicast) is a family of multicast routing protocols that enables efficient delivery of multicast traffic by building distribution trees independent of the underlying unicast routing protocol, supporting various operational modes including Dense Mode, Sparse Mode, and Source-Specific Multicast (SSM). It uses Rendezvous Points (RPs) in Sparse Mode to establish shared trees and supports features like Auto-RP and Bootstrap Router (BSR) for dynamic RP discovery and election. PIM provides scalable multicast forwarding for applications such as video streaming, software distribution, and real-time communications while optimizing bandwidth utilization through intelligent tree pruning and grafting mechanisms.

Diagram

Classes

configuration (iosxe.devices)

Name	Type	Constraint	Mandatory	Default Value
pim	Class	`[pim]`	No

pim (iosxe.devices.configuration)

Name	Type	Constraint	Mandatory
autorp	Boolean	`true`, `false`	No
autorp_listener	Boolean	`true`, `false`	No
bsr_candidate_interface_type	Choice	`Loopback`	No
bsr_candidate_interface_id	String		No
bsr_candidate_mask	Integer	min: `0`, max: `32`	No
bsr_candidate_priority	Integer	min: `0`, max: `255`	No
bsr_candidate_accept_rp_candidate	String		No
ssm_range	String		No
ssm_default	Boolean	`true`, `false`	No
rp_address	String		No
rp_address_override	Boolean	`true`, `false`	No
rp_address_bidir	Boolean	`true`, `false`	No
rp_addresses	List	`[rp_addresses]`	No
rp_candidates	List	`[rp_candidates]`	No
vrfs	List	`[vrfs]`	No

rp_addresses (iosxe.devices.configuration.pim)

Name	Type	Constraint	Mandatory
access_list	String		Yes
rp_address	IP		No
override	Boolean	`true`, `false`	No
bidir	Boolean	`true`, `false`	No

rp_candidates (iosxe.devices.configuration.pim)

Name	Type	Constraint	Mandatory
interface	String		Yes
group_list	String		No
interval	Integer	min: `1`, max: `16383`	No
priority	Integer	min: `0`, max: `255`	No
bidir	Boolean	`true`, `false`	No

vrfs (iosxe.devices.configuration.pim)

Name	Type	Constraint	Mandatory
vrf	String		Yes
autorp	Boolean	`true`, `false`	No
autorp_listener	Boolean	`true`, `false`	No
bsr_candidate_interface_type	Choice	`Loopback`	No
bsr_candidate_interface_id	String		No
bsr_candidate_mask	Integer	min: `0`, max: `32`	No
bsr_candidate_priority	Integer	min: `0`, max: `255`	No
bsr_candidate_accept_rp_candidate	String		No
cache_rpf_oif	Boolean	`true`, `false`	No
ssm_range	String		No
ssm_default	Boolean	`true`, `false`	No
rp_address	String		No
rp_address_override	Boolean	`true`, `false`	No
rp_address_bidir	Boolean	`true`, `false`	No
rp_addresses	List	`[rp_addresses]`	No
rp_candidates	List	`[rp_candidates]`	No

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        pim:
          autorp: true
          autorp_listener: true
          bsr_candidate_interface_type: Loopback
          bsr_candidate_interface_id: "0"
          bsr_candidate_mask: 30
          bsr_candidate_priority: 100
          bsr_candidate_accept_rp_candidate: ACCEPT-RP-ACL
          ssm_range: 232.0.0.0/8
          ssm_default: false
          rp_address: 192.168.1.100
          rp_address_override: true
          rp_address_bidir: false
          rp_addresses:
            - access_list: MULTICAST-GROUPS
              rp_address: 10.1.1.1
              override: false
              bidir: false
            - access_list: BIDIR-GROUPS
              rp_address: 10.2.2.2
              override: true
              bidir: true
          rp_candidates:
            - interface: Loopback0
              group_list: 224.0.0.0
              interval: 60
              priority: 100
              bidir: false
          vrfs:
            - vrf: MULTICAST-VRF
              autorp: true
              ssm_range: 232.0.0.0/8
              rp_address: 172.16.1.1
              rp_addresses:
                - access_list: VRF-GROUPS
                  rp_address: 172.16.2.2