Service Multicast Feature

This feature enables Multicast routing within service VPN segments, multicast overlay routing allows the transport of multicast traffic across the SD-WAN fabric.

Diagram

Diagram

Classes

sdwan

Name	Type	Constraint	Mandatory	Default Value
feature_profiles	Class	feature_profiles	No

feature_profiles (sdwan)

Name	Type	Constraint	Mandatory	Default Value
service_profiles	List	service_profiles	No

service_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
multicast_features	List	multicast_features	No

multicast_features (sdwan.feature_profiles.service_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[^&<>! "]{1,128}$	Yes
description	String		No
auto_rp_announces	List	auto_rp_announces	No
auto_rp_discoveries	List	auto_rp_discoveries	No
auto_rp	Boolean	true, false	No
auto_rp_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
igmp_interfaces	List	igmp_interfaces	No
local_replicator	Boolean	true, false	No
local_replicator_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
threshold	Integer	min: 0, max: 131072	No
threshold_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
msdp_connection_retry_interval	Integer	min: 1, max: 60	No
msdp_connection_retry_interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
msdp_mesh_groups	List	msdp_mesh_groups	No
msdp_originator_id	String	Regex: (ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
msdp_originator_id_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
pim_bsr_candidates	List	pim_bsr_candidates	No
pim_bsr_rp_candidates	List	pim_bsr_rp_candidates	No
pim_interfaces	List	pim_interfaces	No
pim_source_specific_multicast	Boolean	true, false	Yes
pim_source_specific_multicast_access_list	Any	Integer or String[min: 1, max: 32]	No
pim_source_specific_multicast_access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
pim_spt_threshold	Choice	0, infinity	No
pim_spt_threshold_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
spt_only	Boolean	true, false	No
spt_only_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
static_rp_addresses	List	static_rp_addresses	No

auto_rp_announces (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
access_list	Any	Integer or String[min: 1, max: 32]	No
access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Port-channel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
interval	Integer	min: 1, max: 16383	No
interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
scope	Integer	min: 1, max: 255	No
scope_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

auto_rp_announces (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
scope	Integer	min: 1, max: 255	No
scope_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

auto_rp_discoveries (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Port-channel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
scope	Integer	min: 1, max: 255	No
scope_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

auto_rp_discoveries (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
scope	Integer	min: 1, max: 255	No
scope_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

igmp_interfaces (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Port-channel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
join_groups	List	join_groups	No
version	Integer	min: 1, max: 3	No

igmp_interfaces (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
join_groups	List	join_groups	No
version	Integer	min: 1, max: 3	No

msdp_mesh_groups (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[^<! ]{1,}$	No
name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
peers	List	peers	No

pim_bsr_candidates (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Port-channel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
accept_candidate_access_list	Any	Integer or String[min: 1, max: 32]	No
accept_candidate_access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
hash_mask_length	Integer	min: 0, max: 32	No
hash_mask_length_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
priority	Integer	min: 0, max: 255	No
priority_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

pim_bsr_candidates (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
accept_candidate_access_list	Any	Integer or String[min: 1, max: 32]	No
accept_candidate_access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
hash_mask_length	Integer	min: 0, max: 32	No
hash_mask_length_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
priority	Integer	min: 0, max: 255	No
priority_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

pim_bsr_rp_candidates (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Port-channel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
access_list	Any	Integer or String[min: 1, max: 32]	No
access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
interval	Integer	min: 1, max: 16383	No
interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
priority	Integer	min: 0, max: 255	No
priority_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

pim_bsr_rp_candidates (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
access_list	Any	Integer or String[min: 1, max: 32]	No
access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
interval	Integer	min: 1, max: 16383	No
interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
priority	Integer	min: 0, max: 255	No
priority_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

pim_interfaces (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Port-channel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
join_prune_interval	Integer	min: 10, max: 600	No
join_prune_interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
query_interval	Integer	min: 1, max: 18725	No
query_interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

pim_interfaces (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
interface_name	String	Regex: (GigabitEthernet|TwoGigabitEthernet|TenGigabitEthernet|TwentyFiveGigE|TwentyFiveGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan|Tunnel|Loopback)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)	No
interface_name_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
join_prune_interval	Integer	min: 10, max: 600	No
join_prune_interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
query_interval	Integer	min: 1, max: 18725	No
query_interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

static_rp_addresses (sdwan.feature_profiles.service_profiles.multicast_features)

Name	Type	Constraint	Mandatory	Default Value
ip_address	IP		No
ip_address_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
access_list	Any	Integer or String[min: 1, max: 32]	No
access_list_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
override	Boolean	true, false	No
override_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

join_groups (sdwan.feature_profiles.service_profiles.multicast_features.igmp_interfaces)

Name	Type	Constraint	Mandatory	Default Value
group_address	IP		No
group_address_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
source_address	IP		No
source_address_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

peers (sdwan.feature_profiles.service_profiles.multicast_features.msdp_mesh_groups)

Name	Type	Constraint	Mandatory	Default Value
connection_source_interface	String	Regex: ^(ATM|ATM-ACR|AppGigabitEthernet|AppNav-Compress|AppNav-UnCompress|Async|BD-VIF|BDI|CEM|CEM-ACR|Cellular|Dialer|Embedded-Service-Engine|Ethernet|Ethernet-Internal|FastEthernet|FiftyGigabitEthernet|FiveGigabitEthernet|FortyGigabitEthernet|FourHundredGigE|GMPLS|GigabitEthernet|Group-Async|HundredGigE|L2LISP|LISP|Loopback|MFR|Multilink|Port-channel|SM|Serial|Service-Engine|TenGigabitEthernet|Tunnel|TwentyFiveGigE|TwentyFiveGigabitEthernet|TwoGigabitEthernet|TwoHundredGigE|Vif|Virtual-PPP|Virtual-Template|VirtualPortGroup|Vlan|Wlan-GigabitEthernet|nat64|nat66|ntp|nve|ospfv3|overlay|pseudowire|ucse|vasileft|vasiright|vmi)([0-9]*(. ?[1-9][0-9]*)*|[0-9/]+|[0-9]+/[0-9]+/[0-9]+:[0-9]+|[0-9]+/[0-9]+/[0-9]+|[0-9]+/[0-9]+|[0-9]+)$	No
connection_source_interface_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
default_peer	Boolean	true, false	No
keepalive_hold_time	Integer	min: 1, max: 75	No
keepalive_hold_time_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
keepalive_interval	Integer	min: 1, max: 60	No
keepalive_interval_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
peer_authentication_password	String	min: 1, max: 25	No
peer_authentication_password_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
peer_ip	IP		No
peer_ip_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
prefix_list	String	Regex: ^[A-Za-z0-9-_]{1,128}$	No
remote_as	Integer	min: 1, max: 65535	No
remote_as_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No
sa_limit	Integer	min: 1, max: 2147483646	No
sa_limit_variable	String	Regex: ^[./\[\]a-zA-Z0-9_-]{1,128}$	No

Examples

Example-1: The example below demonstrates how to configure a service Multicast feature with local_replicator, threshold, auto_rp_announces, igmp_interfaces, msdp_mesh_groups, pim_bsr_candidates, pim_bsr_rp_candidates, pim_interfaces, static_rp_addresses and so on.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        multicast_features:
          - name: service_multicast_full
            description: service multicast full feature
            pim_source_specific_multicast: true
            auto_rp: true
            auto_rp_announces:
              - interface_name: GigabitEthernet1
                scope: 20
                access_list: 25
                interval: 30
            igmp_interfaces:
              - interface_name: GigabitEthernet1
                version: 3
                join_groups:
                  - group_address: 224.0.0.0
                    source_address: 1.2.3.4
                  - group_address: 239.1.1.5
                    source_address: 10.0.0.2
            local_replicator: true
            threshold: 10
            msdp_connection_retry_interval: 30
            msdp_mesh_groups:
              - name: mesh_grp1
                peers:
                  - peer_ip: 1.2.3.4
                    connection_source_interface: GigabitEthernet1
                    default_peer: true
                    keepalive_hold_time: 50
                    keepalive_interval: 10
                    peer_authentication_password_variable: peer_auth_password
                    prefix_list: ipv4_pl_service
                    remote_as: 65001
                    sa_limit: 1000
            msdp_originator_id: GigabitEthernet1
            pim_bsr_candidates:
              - interface_name: GigabitEthernet1
                accept_candidate_access_list: 25
                hash_mask_length: 30
                priority: 120
            pim_bsr_rp_candidates:
              - interface_name: GigabitEthernet1
                access_list: 25
                interval: 30
                priority: 1
            pim_interfaces:
              - interface_name: GigabitEthernet1
                join_prune_interval: 60
                query_interval: 30
            pim_source_specific_multicast_access_list: 25
            pim_spt_threshold: infinity
            spt_only: false
            static_rp_addresses:
              - ip_address: 1.2.3.4
                access_list: 25
                override: false

Examples

Example-1: The example below demonstrates how to configure a service Multicast feature with local_replicator, threshold, igmp_interfaces, msdp_mesh_groups, pim_bsr_candidates, pim_bsr_rp_candidates, pim_interfaces, static_rp_addresses and so on.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        multicast_features:
          - name: service_multicast_full
            description: service multicast full feature
            pim_source_specific_multicast: true
            auto_rp: true
            igmp_interfaces:
              - interface_name: GigabitEthernet1
                version: 3
                join_groups:
                  - group_address: 224.0.0.0
                    source_address: 1.2.3.4
                  - group_address: 239.1.1.5
                    source_address: 10.0.0.2
            local_replicator: true
            threshold: 10
            msdp_connection_retry_interval: 30
            msdp_mesh_groups:
              - name: mesh_grp1
                peers:
                  - peer_ip: 1.2.3.4
                    connection_source_interface: GigabitEthernet1
                    default_peer: true
                    keepalive_hold_time: 50
                    keepalive_interval: 10
                    peer_authentication_password_variable: peer_auth_password
                    prefix_list: ipv4_pl_service
                    remote_as: 65001
                    sa_limit: 1000
            msdp_originator_id: GigabitEthernet1
            pim_bsr_candidates:
              - interface_name: GigabitEthernet1
                accept_candidate_access_list: 25
                hash_mask_length: 30
                priority: 120
            pim_bsr_rp_candidates:
              - interface_name: GigabitEthernet1
                access_list: 25
                interval: 30
                priority: 1
            pim_interfaces:
              - interface_name: GigabitEthernet1
                join_prune_interval: 60
                query_interval: 30
            pim_source_specific_multicast_access_list: 25
            pim_spt_threshold: infinity
            spt_only: false
            static_rp_addresses:
              - ip_address: 1.2.3.4
                access_list: 25
                override: false