Edge PIM Feature Template
The SD-WAN PIM feature template enables scalable multicast routing across the SD-WAN fabric by integrating Protocol Independent Multicast (PIM) configuration within customer VPNs. It supports both PIM Sparse Mode (PIM-SM) and Source-Specific Multicast (PIM-SSM), allowing for flexible RP (Rendezvous Point) management using Auto-RP or BSR mechanisms. The template facilitates efficient multicast group distribution, secure overlay tree construction, and native multicast extension with IGMPv2 and IGMPv3 support, ensuring optimized and reliable multicast delivery throughout the SD-WAN environment.
Diagram
Section titled “Diagram”
Classes
Section titled “Classes”edge_feature_templates (sdwan)
Section titled “edge_feature_templates (sdwan)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| pim_templates | List | [pim_templates] | No |
pim_templates (sdwan.edge_feature_templates)
Section titled “pim_templates (sdwan.edge_feature_templates)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^<>!&" ]{1,128}$ | Yes | |
| description | String | Yes | ||
| device_types | List | Choice[ASR-1001-HX, ASR-1001-X, ASR-1002-HX, ASR-1002-X, ASR-1006-X, C1101-4P, C1101-4PLTEP, C1101-4PLTEPW, C1109-2PLTEGB, C1109-2PLTEUS, C1109-2PLTEVZ, C1109-4PLTE2P, C1109-4PLTE2PW, C1111-4P, C1111-4PLTEEA, C1111-4PLTELA, C1111-4PW, C1111-8P, C1111-8PLTEEA, C1111-8PLTEEAW, C1111-8PLTELA, C1111-8PLTELAW, C1111-8PW, C1111X-8P, C1112-8P, C1112-8PLTEEA, C1112-8PLTEEAWE, C1112-8PWE, C1113-8P, C1113-8PLTEEA, C1113-8PLTEEAW, C1113-8PLTELA, C1113-8PLTELAWZ, C1113-8PLTEW, C1113-8PM, C1113-8PMLTEEA, C1113-8PMWE, C1113-8PW, C1116-4P, C1116-4PLTEEA, C1116-4PLTEEAWE, C1116-4PWE, C1117-4P, C1117-4PLTEEA, C1117-4PLTEEAW, C1117-4PLTELA, C1117-4PLTELAWZ, C1117-4PM, C1117-4PMLTEEA, C1117-4PMLTEEAWE, C1117-4PMWE, C1117-4PW, C1118-8P, C1121-4P, C1121-4PLTEP, C1121-8P, C1121-8PLTEP, C1121-8PLTEPW, C1121X-8P, C1121X-8PLTEP, C1121X-8PLTEPW, C1126-8PLTEP, C1126X-8PLTEP, C1127-8PLTEP, C1127-8PMLTEP, C1127X-8PLTEP, C1127X-8PMLTEP, C1128-8PLTEP, C1131-8PLTEPW, C1131-8PW, C1131X-8PLTEPW, C1131X-8PW, C1161-8P, C1161-8PLTEP, C1161X-8P, C1161X-8PLTEP, C8000V, C8200-1N-4T, C8200L-1N-4T, C8300-1N1S-4T2X, C8300-1N1S-6T, C8300-2N2S-4T2X, C8300-2N2S-6T, C8500-12X, C8500-12X4QC, C8500-20X6C, C8500L-8S4X, IR-1101, IR-1821, IR-1831, IR-1833, IR-1835, IR-8140H, IR-8140H-P, IR-8340, ISR-4221, ISR-4221X, ISR-4321, ISR-4331, ISR-4351, ISR-4431, ISR-4451-X, ISR-4461, ISR1100-4G-XE, ISR1100-4GLTEGB-XE, ISR1100-4GLTENA-XE, ISR1100-6G-XE, ISR1100X-4G-XE, ISR1100X-6G-XE] | No | |
| auto_rp | Boolean | true, false | No | |
| auto_rp_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| bsr_candidate_interface | String | No | ||
| bsr_candidate_interface_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| bsr_candidate_hash_mask_length | Integer | min: 0, max: 32 | No | |
| bsr_candidate_hash_mask_length_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| bsr_candidate_priority | Integer | min: 1, max: 255 | No | |
| bsr_candidate_priority_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| bsr_candidate_rp_access_list | String | No | ||
| bsr_candidate_rp_access_list_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| interfaces | List | [interfaces] | No | |
| rp_addresses | List | [rp_addresses] | No | |
| rp_announces | List | [rp_announces] | No | |
| rp_candidates | List | [rp_candidates] | No | |
| rp_discovery_interface | String | No | ||
| rp_discovery_interface_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| rp_discovery_scope | Integer | min: 0, max: 255 | No | |
| rp_discovery_scope_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| spt_threshold | Choice | 0, infinity | No | |
| spt_threshold_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| ssm_access_list_range | String | No | ||
| ssm_access_list_range_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| ssm_default | Boolean | true, false | No | |
| ssm_default_variable | String | Regex: ^[^"~$&+,]255$` | No |
interfaces (sdwan.edge_feature_templates.pim_templates)
Section titled “interfaces (sdwan.edge_feature_templates.pim_templates)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_name | String | No | ||
| interface_name_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| join_prune_interval | Integer | min: 10, max: 600 | No | |
| join_prune_interval_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| optional | Boolean | true, false | No | |
| query_interval | Integer | min: 1, max: 18725 | No | |
| query_interval_variable | String | Regex: ^[^"~$&+,]255$` | No |
rp_addresses (sdwan.edge_feature_templates.pim_templates)
Section titled “rp_addresses (sdwan.edge_feature_templates.pim_templates)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| access_list | String | No | ||
| access_list_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| ip_address | IP | No | ||
| ip_address_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| optional | Boolean | true, false | No | |
| override | Boolean | true, false | No | |
| override_variable | String | Regex: ^[^"~$&+,]255$` | No |
rp_announces (sdwan.edge_feature_templates.pim_templates)
Section titled “rp_announces (sdwan.edge_feature_templates.pim_templates)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| interface_name | String | No | ||
| interface_name_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| optional | Boolean | true, false | No | |
| scope | Integer | min: 0, max: 255 | No | |
| scope_variable | String | Regex: ^[^"~$&+,]255$` | No |
rp_candidates (sdwan.edge_feature_templates.pim_templates)
Section titled “rp_candidates (sdwan.edge_feature_templates.pim_templates)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| access_list | String | No | ||
| access_list_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| interface_name | String | No | ||
| interface_name_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| interval | Integer | min: 1, max: 16383 | No | |
| interval_variable | String | Regex: ^[^"~$&+,]255$` | No | |
| optional | Boolean | true, false | No | |
| priority | Integer | min: 1, max: 255 | No | |
| priority_variable | String | Regex: ^[^"~$&+,]255$` | No |
Examples
Section titled “Examples”Example-1: This example demonstrates a cEdge PIM feature template configured with Auto RP enabled. It specifies supported device types, sets up PIM interfaces, and defines RP addresses and candidates using Loopback511. The template includes RP announces and RP discovery settings, as well as SPT threshold and SSM access-list configuration. This setup enables automated RP management and multicast group distribution for the listed devices within the SD-WAN fabric.
sdwan: edge_feature_templates: pim_templates: - name: FT-CEDGE-PIM-01 description: The cEdge PIM Feature Template with Auto RP and RP announces and discovery included device_types: - C8000V - C8200-1N-4T - C8200L-1N-4T - C8300-1N1S-4T2X - C8300-1N1S-6T - C8300-2N2S-4T2X - C8300-2N2S-6T - C8500-12X - C8500-12X4QC - C8500-20X6C - C8500L-8S4X auto_rp: true interfaces: - interface_name: Loopback511 join_prune_interval: 60 query_interval: 30 rp_addresses: - ip_address: 10.0.0.2 access_list: "27" override: false rp_candidates: - interface_name: Loopback511 rp_announces: - interface_name: Loopback511 scope: 1 rp_discovery_interface: Loopback511 rp_discovery_scope: 1 spt_threshold: "0" ssm_access_list_range: "27" ssm_default: TrueExample-2: This example illustrates a cEdge PIM feature template configured with Auto RP disabled and BSR (Bootstrap Router) enabled. It specifies the supported device type, sets up the BSR candidate interface and related parameters, and defines PIM interfaces, RP addresses, and RP candidates using GigabitEthernet6. The template includes SPT threshold and SSM access-list configuration, enabling multicast group management and RP election through BSR for the device within the SD-WAN fabric.
sdwan: edge_feature_templates: pim_templates: - name: FT-CEDGE-PIM-02 description: The cEdge PIM Feature Template with no auto RP and BSR included device_types: - C8000V auto_rp: false bsr_candidate_interface: GigabitEthernet6 bsr_candidate_hash_mask_length: 32 bsr_candidate_priority: 1 bsr_candidate_rp_access_list: "10" interfaces: - interface_name: GigabitEthernet6 join_prune_interval: 60 query_interval: 30 rp_addresses: - ip_address: 10.0.0.1 access_list: "10" override: false rp_candidates: - interface_name: GigabitEthernet6 access_list: "10" priority: 2 interval: 100 spt_threshold: "0" ssm_access_list_range: "10" ssm_default: True