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.";
116 grouping per-af-global-pim-config-attributes {
118 "A grouping defining per address family pim global attributes";
120 leaf send-v6-secondary {
121 when "../frr-pim:address-family = 'frr-rt:ipv4'" {
123 "Only applicable to IPv4 address family.";
128 "Send v6 secondary addresses.";
131 container spt-switchover {
137 enum "PIM_SPT_IMMEDIATE" {
140 "Immediate switch to SPT Tree.";
142 enum "PIM_SPT_INFINITY" {
145 "Never switch to SPT Tree.";
148 default "PIM_SPT_IMMEDIATE";
150 "SPT-Switchover action";
153 leaf spt-infinity-prefix-list {
154 when "../spt-action = 'PIM_SPT_INFINITY'" {
156 "This leaf is only valid when the spt action
157 is PIM_SPT_INFINITY.";
161 "Prefix-List to control which groups to switch.";
165 leaf ssm-prefix-list {
168 "Prefix-list used to define Source-Specific Multicast address range.";
171 leaf-list ssm-pingd-source-ip {
172 type inet:ip-address;
174 "Enable ssmpingd operation.";
177 list msdp-mesh-groups {
180 "RFC 3618 Section 10.2. MSDP mesh-group semantics
182 Groups multiple MSDP peers to reduce SA flooding typically used
183 in intra-domain settings.";
190 "The mesh group name.";
194 type inet:ip-address;
196 "Source IP address for the TCP connections.";
203 type inet:ip-address;
205 "Peer member IP address.";
213 "Configure MSDP peer.";
216 type inet:ip-address;
218 "MSDP peer IP address.";
223 type inet:ip-address;
225 "MSDP source IP address.";
231 "Multi-chassis link aggregation.";
234 type frr-interface:interface-ref;
236 "Outgoing interface name.";
240 type inet:ip-address;
247 enum "MLAG_ROLE_NONE" {
252 enum "MLAG_ROLE_PRIMARY" {
255 "MLAG role primary.";
258 enum "MLAG_ROLE_SECONDARY" {
261 "MLAG role secondary.";
264 default "MLAG_ROLE_NONE";
277 leaf register-accept-list {
280 "Only accept registers from a specific source prefix list.";
282 } // per-af-global-pim-config-attributes
284 grouping interface-pim-config-attributes {
286 "A grouping defining pim interface attributes.";
292 "Enable PIM flag on the interface.";
295 leaf hello-interval {
304 leaf hello-holdtime {
308 must ". > ./../hello-interval" {
309 error-message "HoldTime must be greater than Hello";
317 "Enable BFD support on the interface.";
319 leaf min-rx-interval {
325 "Required min receive interval";
328 leaf min-tx-interval {
334 "Desired min transmit interval";
349 "Use a preconfigure BFD profile.";
357 "Enables BSM support on the interface.";
364 "Accept/Send unicast BSM on the interface.";
371 "Mark interface as Active-Active for MLAG operations.";
376 range "1..4294967295";
380 "DR (Designated Router) priority";
382 } // interface-pim-config-attributes
384 grouping per-af-interface-pim-config-attributes {
386 "A grouping defining pim interface attributes per address family.";
389 type inet:ip-address;
391 "Primary address of the interface set by user.";
394 leaf multicast-boundary-oil {
397 "Prefix-List to define multicast boundary";
401 key "source-addr group-addr";
403 "Add multicast route.";
406 type frr-interface:interface-ref;
408 "Outgoing interface name.";
412 type inet:ip-address;
414 "Multicast source address.";
418 type rt-types:ip-multicast-group-address;
420 "Multicast group address.";
423 } // per-af-interface-pim-config-attributes
426 * Global Configuration data nodes
428 augment "/frr-rt:routing/frr-rt:control-plane-protocols/"
429 + "frr-rt:control-plane-protocol" {
431 when "../frr-rt:type = 'frr-pim:pimd'" {
433 "This container is only valid for the 'pim' routing
437 "PIM configuration data.";
439 uses global-pim-config-attributes;
441 list address-family {
442 key "address-family";
444 "Each list entry for one address family.";
445 uses frr-rt:address-family;
446 uses per-af-global-pim-config-attributes;
453 * Per-interface configuration data
455 augment "/frr-interface:lib/frr-interface:interface" {
458 "Configure PIM on an interface.";
459 uses interface-pim-config-attributes;
460 list address-family {
461 key "address-family";
463 "Each list entry for one address family.";
464 uses frr-rt:address-family;
465 uses per-af-interface-pim-config-attributes;
472 "PIM router parameters.";
479 "Number of packets to process at one time per fd.";
481 leaf join-prune-interval {
487 "Join Prune Send Interval in seconds.";
489 leaf register-suppress-time {
495 "Register Suppress Timer.";