3 namespace "http://frrouting.org/yang/pim";
15 import ietf-routing-types {
19 import ietf-inet-types {
27 "FRR Users List: <mailto:frog@lists.frrouting.org>
28 FRR Development List: <mailto:dev@lists.frrouting.org>";
31 "The module defines a collection of YANG definitions common for
32 PIM (Protocol Independent Multicast) model.
34 Copyright 2020 FRRouting
36 Redistribution and use in source and binary forms, with or without
37 modification, are permitted provided that the following conditions
40 1. Redistributions of source code must retain the above copyright notice,
41 this list of conditions and the following disclaimer.
43 2. Redistributions in binary form must reproduce the above copyright
44 notice, this list of conditions and the following disclaimer in the
45 documentation and/or other materials provided with the distribution.
47 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
48 \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
49 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
50 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
51 HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
52 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
53 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
54 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
55 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
57 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.";
63 "RFC XXXX: A YANG Data Model for PIM";
67 base frr-rt:routing-protocol;
69 "'Pim' routing pseudo-protocol.";
80 grouping global-pim-config-attributes {
82 "A grouping defining pim global attributes.";
95 "Enable PIM ECMP Rebalance.";
98 leaf keep-alive-timer {
104 "Keep alive Timer in seconds.";
107 leaf rp-keep-alive-timer {
113 "RP keep alive Timer in seconds.";
117 grouping msdp-timers {
125 "Hold period is started at the MSDP peer connection establishment
126 and is reset every new message. When the period expires the
127 connection is closed.
129 This value needs to be greater than `keep-alive-period`.";
139 "To maintain a connection established it is necessary to send
140 keep alive messages in a certain frequency and this allows its
143 This value needs to be lesser than `hold-time-period`.";
146 leaf connection-retry {
153 "This period is used in the MSDP peer with the highest IP value
154 in the pair and configures the interval between TCP connection
159 grouping per-af-global-pim-config-attributes {
161 "A grouping defining per address family pim global attributes";
163 leaf send-v6-secondary {
164 when "../frr-pim:address-family = 'frr-rt:ipv4'" {
166 "Only applicable to IPv4 address family.";
171 "Send v6 secondary addresses.";
174 container spt-switchover {
180 enum "PIM_SPT_IMMEDIATE" {
183 "Immediate switch to SPT Tree.";
185 enum "PIM_SPT_INFINITY" {
188 "Never switch to SPT Tree.";
191 default "PIM_SPT_IMMEDIATE";
193 "SPT-Switchover action";
196 leaf spt-infinity-prefix-list {
197 when "../spt-action = 'PIM_SPT_INFINITY'" {
199 "This leaf is only valid when the spt action
200 is PIM_SPT_INFINITY.";
204 "Prefix-List to control which groups to switch.";
208 leaf ssm-prefix-list {
211 "Prefix-list used to define Source-Specific Multicast address range.";
214 leaf-list ssm-pingd-source-ip {
215 type inet:ip-address;
217 "Enable ssmpingd operation.";
220 /* Global timers configuration. */
222 description "Global MSDP configuration.";
226 list msdp-mesh-groups {
229 "RFC 3618 Section 10.2. MSDP mesh-group semantics
231 Groups multiple MSDP peers to reduce SA flooding typically used
232 in intra-domain settings.";
239 "The mesh group name.";
243 type inet:ip-address;
245 "Source IP address for the TCP connections.";
252 type inet:ip-address;
254 "Peer member IP address.";
262 "Configure MSDP peer.";
265 type inet:ip-address;
267 "MSDP peer IP address.";
272 type inet:ip-address;
274 "MSDP source IP address.";
280 "Multi-chassis link aggregation.";
283 type frr-interface:interface-ref;
285 "Outgoing interface name.";
289 type inet:ip-address;
296 enum "MLAG_ROLE_NONE" {
301 enum "MLAG_ROLE_PRIMARY" {
304 "MLAG role primary.";
307 enum "MLAG_ROLE_SECONDARY" {
310 "MLAG role secondary.";
313 default "MLAG_ROLE_NONE";
326 leaf register-accept-list {
329 "Only accept registers from a specific source prefix list.";
331 } // per-af-global-pim-config-attributes
333 grouping interface-pim-config-attributes {
335 "A grouping defining pim interface attributes.";
341 "Enable PIM flag on the interface.";
344 leaf hello-interval {
353 leaf hello-holdtime {
357 must ". > ./../hello-interval" {
358 error-message "HoldTime must be greater than Hello";
366 "Enable BFD support on the interface.";
368 leaf min-rx-interval {
374 "Required min receive interval";
377 leaf min-tx-interval {
383 "Desired min transmit interval";
398 "Use a preconfigure BFD profile.";
406 "Enables BSM support on the interface.";
413 "Accept/Send unicast BSM on the interface.";
420 "Mark interface as Active-Active for MLAG operations.";
425 range "1..4294967295";
429 "DR (Designated Router) priority";
431 } // interface-pim-config-attributes
433 grouping per-af-interface-pim-config-attributes {
435 "A grouping defining pim interface attributes per address family.";
438 type inet:ip-address;
440 "Primary address of the interface set by user.";
443 leaf multicast-boundary-oil {
446 "Prefix-List to define multicast boundary";
450 key "source-addr group-addr";
452 "Add multicast route.";
455 type frr-interface:interface-ref;
457 "Outgoing interface name.";
461 type inet:ip-address;
463 "Multicast source address.";
467 type rt-types:ip-multicast-group-address;
469 "Multicast group address.";
472 } // per-af-interface-pim-config-attributes
475 * Global Configuration data nodes
477 augment "/frr-rt:routing/frr-rt:control-plane-protocols/"
478 + "frr-rt:control-plane-protocol" {
480 when "../frr-rt:type = 'frr-pim:pimd'" {
482 "This container is only valid for the 'pim' routing
486 "PIM configuration data.";
488 uses global-pim-config-attributes;
490 list address-family {
491 key "address-family";
493 "Each list entry for one address family.";
494 uses frr-rt:address-family;
495 uses per-af-global-pim-config-attributes;
502 * Per-interface configuration data
504 augment "/frr-interface:lib/frr-interface:interface" {
507 "Configure PIM on an interface.";
508 uses interface-pim-config-attributes;
509 list address-family {
510 key "address-family";
512 "Each list entry for one address family.";
513 uses frr-rt:address-family;
514 uses per-af-interface-pim-config-attributes;
521 "PIM router parameters.";
528 "Number of packets to process at one time per fd.";
530 leaf join-prune-interval {
536 "Join Prune Send Interval in seconds.";
538 leaf register-suppress-time {
544 "Register Suppress Timer.";