YANG Data Model for Protocol Independent Multicast (PIM)

Prefix	YANG Module	Reference
yang	ietf-yang-types
inet	ietf-inet-types
if	ietf-interfaces
rt	ietf-routing
rt-types	ietf-routing-types
bfd-types	ietf-bfd-types

YANG Node	PIM-STD-MIB Object
address-family	pimInterfaceAddressType
ipv4/address	pimInterfaceAddress
ipv6/address
gen-id	pimInterfaceGenerationIDValue
ipv4/dr-address	pimInterfaceDR
ipv6/dr-address
dr-priority	pimInterfaceDRPriority
hello-interval	pimInterfaceHelloInterval
hello-holdtime	pimInterfaceHelloHoldtime
jp-interval	pimInterfaceJoinPruneInterval
jp-holdtime	pimInterfaceJoinPruneHoldtime
bidir/offer-multiplier	pimInterfaceDFElectionRobustness
propagation-delay	pimInterfacePropagationDelay
override-interval	pimInterfaceOverrideInterval

YANG Node	PIM-STD-MIB Object
ipv4-neighbor	pimNeighborAddressType
ipv6-neighbor
address	pimNeighborAddress
gen-id	pimNeighborGenerationIDValue
up-time	pimNeighborUpTime
expiration	pimNeighborExpiryTime
dr-priority	pimNeighborDRPriority
lan-prune-delay/present	pimNeighborLanPruneDelayPresent
lan-prune-delay/t-bit	pimNeighborTBit
lan-prune-delay/propagation-delay	pimNeighborPropagationDelay
lan-prune-delay/override-interval	pimNeighborOverrideInterval
ietf-pim-bidir:bidir-capable	pimNeighborBidirCapable

YANG Node	PIM-STD-MIB Object
ipv4-route	pimStarGAddressType
ipv6-route
group	pimStarGGrpAddress
up-time	pimStarGUpTime
mode	pimStarGPimMode
rp-address	pimStarGRPAddressType
pimStarGRPAddress
rpf-neighbor	pimStarGUpstreamNeighborType
pimStarGUpstreamNeighbor
incoming-interface	pimStarGRPFIfIndex

YANG Node	PIM-STD-MIB Object
ipv4-route	pimSGAddressType
ipv6-route
group	pimSGGrpAddress
source-address	pimSGSrcAddress
up-time	pimSGUpTime
mode	pimSGPimMode
rpf-neighbor	pimStarGUpstreamNeighbor
incoming-interface	pimStarGRPFIfIndex
is-spt	pimSGSPTBit
expiration	pimSGKeepaliveTimer

YANG Node	PIM-STD-MIB Object
ipv4-route	pimStarGAddressType
ipv6-route
group	pimStarGGrpAddress
source-address	pimSGRptSrcAddress
up-time	pimSGRptUpTime

YANG Node	PIM-STD-MIB Object
ipv4-rp	pimBidirDFElectionAddressType
ipv6-rp
rp-address	pimBidirDFElectionRPAddress
df-address	pimBidirDFElectionWinnerAddressType
pimBidirDFElectionWinnerAddress
up-time	pimBidirDFElectionWinnerUpTime
winner-metric-preference	pimBidirDFElectionWinnerMetricPref
pimBidirDFElectionWinnerMetric
interface-state	pimBidirDFElectionState

YANG Node	PIM-STD-MIB Object
ipv4-rp	pimStaticRPAddressType
ipv6-rp
rp-address	pimStaticRPRPAddress
bidir	pimStaticRPPimMode
sm
bidir/override	pimStaticRPOverrideDynamic
sm/override

YANG Node	PIM-STD-MIB Object
ipv4-anycast-rp	pimAnycastRPSetAddressType
ipv6-anycast-rp
anycast-address	pimAnycastRPSetAnycastAddress
rp-address	pimAnycastRPSetRouterAddress

YANG Node	PIM-STD-MIB Object
ipv4-rp	pimGroupMappingAddressType
ipv6-rp
group	pimGroupMappingGrpAddress
pimGroupMappingGrpPrefixLength
ipv4-rp	pimGroupMappingRPAddressType
ipv6-rp
rp-address	pimGroupMappingRPAddress
pimGroupMappingPimMode

PIM YANG Modules

PIM Base Module This module references , , , , , , , , , and . WG List: Editor: Xufeng Liu Editor: Pete McAllister Editor: Anish Peter Editor: Mahesh Sivakumar Editor: Yisong Liu Editor: Fangwei Hu "; description "This module defines a collection of YANG definitions common for all PIM (Protocol Independent Multicast) modes. Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 9128; see the RFC itself for full legal notices."; revision 2022-10-19 { description "Initial revision."; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } /* * Features */ feature bfd { description "Supports BFD (Bidirectional Forwarding Detection)."; reference "RFC 5880: Bidirectional Forwarding Detection (BFD)"; } feature global-graceful-restart { description "Global configuration for graceful restart support as per RFC 8706."; reference "RFC 8706: Restart Signaling for IS-IS"; } feature intf-dr-priority { description "Supports configuration of an interface DR (Designated Router) priority."; reference "RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.3.2"; } feature intf-hello-holdtime { description "Supports configuration of the interface Hello Holdtime."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.3.3 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature intf-hello-interval { description "Supports configuration of the interface Hello interval."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature intf-hello-multiplier { description "Supports configuration of the interface Hello multiplier (the number by which the Hello interval is multiplied to obtain the Hello Holdtime)."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature intf-jp-interval { description "Supports configuration of the interface Join/Prune interval."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature intf-jp-holdtime { description "Supports configuration of the interface Join/Prune Holdtime."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature intf-jp-multiplier { description "Supports configuration of the interface Join/Prune multiplier (the number by which the Join/Prune interval is multiplied to obtain the Join/Prune Holdtime)."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature intf-propagation-delay { description "Supports configuration of interface propagation delay."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.3.5 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.3.3"; } feature intf-override-interval { description "Supports configuration of the interface override interval."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Sections 4.1.1 and 4.8 RFC 5015: Bidirectional Protocol Independent Multicast (BIDIR-PIM), Section 3.6 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } feature per-af-graceful-restart { description "Per address family configuration for graceful restart support as per RFC 8706."; reference "RFC 8706: Restart Signaling for IS-IS"; } /* * Typedefs */ typedef interface-event-type { type enumeration { enum up { description "Neighbor status changed to 'up'."; } enum down { description "Neighbor status changed to 'down'."; } enum new-dr { description "A new DR (Designated Router) was elected on the connected network."; } enum new-df { description "A new DF (Designated Forwarder) was elected on the connected network."; } } description "Operational status event type for notifications."; } typedef neighbor-event-type { type enumeration { enum up { description "Neighbor status changed to 'up'."; } enum down { description "Neighbor status changed to 'down'."; } } description "Operational status event type for notifications."; } /* * Identities */ identity pim-mode { description "The PIM mode in which a group is operating."; } identity pim-none { base pim-mode; description "PIM is not operating."; } identity pim-bidir { base pim-mode; description "PIM is operating in Bidirectional Mode."; } identity pim-dm { base pim-mode; description "PIM is operating in Dense Mode (DM)."; } identity pim-sm { base pim-mode; description "PIM is operating in Sparse Mode (SM)."; } identity pim-asm { base pim-sm; description "PIM is operating in Sparse Mode with Any-Source Multicast (ASM)."; } identity pim-ssm { base pim-sm; description "PIM is operating in Sparse Mode with Source-Specific Multicast (SSM)."; } /* * Groupings */ grouping graceful-restart-container { description "A grouping defining a container of graceful restart attributes."; container graceful-restart { leaf enabled { type boolean; default "false"; description "Enables or disables graceful restart."; } leaf duration { type uint16; units "seconds"; default "60"; description "Maximum time for graceful restart to finish."; } description "Container of graceful restart attributes."; } } // graceful-restart-container grouping multicast-route-attributes { description "A grouping defining multicast route attributes."; leaf expiration { type rt-types:timer-value-seconds16; description "When the route will expire."; } leaf incoming-interface { type if:interface-ref; description "Reference to an entry in the global interface list."; } leaf is-spt { type boolean; description "'true' if the SPTbit (Shortest Path Tree bit) is set to indicate that forwarding is taking place on the (S,G) SPT."; reference "RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.1.3"; } leaf mode { type identityref { base pim-mode; } description "PIM mode."; } leaf msdp-learned { type boolean; description "'true' if the route is learned from MSDP (the Multicast Source Discovery Protocol)."; } leaf rp-address { type inet:ip-address; description "RP (Rendezvous Point) address."; } leaf rpf-neighbor { type inet:ip-address; description "RPF (Reverse Path Forwarding) neighbor address."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the route last transitioned into the active state."; } list outgoing-interface { key "name"; description "A list of outgoing interfaces."; leaf name { type if:interface-ref; description "Interface name."; } leaf expiration { type rt-types:timer-value-seconds16; description "Expiration time."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the 'oper-status' setting of the interface was last changed to 'up'."; } leaf jp-state { type enumeration { enum no-info { description "The interface has no (*,G) Join state and no timers running."; } enum join { description "The interface has Join state."; } enum prune-pending { description "The router has received a Prune on this interface from a downstream neighbor and is waiting to see whether the Prune will be overridden by another downstream router. For forwarding purposes, the Prune-Pending state functions exactly like the Join state."; } } description "Join/Prune state."; } } } // multicast-route-attributes grouping neighbor-state-af-attributes { description "A grouping defining neighbor per address family attributes."; leaf bfd-state { type bfd-types:state; description "BFD (Bidirectional Forwarding Detection) status."; } leaf expiration { type rt-types:timer-value-seconds16; description "Neighbor expiration time."; } leaf dr-priority { type uint32; description "DR (Designated Router) priority as the preference in the DR election process."; } leaf gen-id { type uint32; description "The value of the Generation ID in the last Hello message from the neighbor."; } container lan-prune-delay { description "The information of the LAN Prune Delay option in the Hello message from the neighbor."; leaf present { type boolean; description "'true' if the LAN Prune Delay option is present in the last Hello message from the neighbor."; } leaf override-interval { when "../present = 'true'" { description "Available only when 'leaf present' is 'true'."; } type uint16; units "milliseconds"; description "The value of the Override_Interval field of the LAN Prune Delay option in the last Hello message from the neighbor. The neighbor uses this value to indicate a short period after a Join or Prune to allow other routers on the LAN to override the Join or Prune."; } leaf propagation-delay { when "../present = 'true'" { description "Available only when 'leaf present' is 'true'."; } type uint16; units "milliseconds"; description "The value of the Propagation_Delay field of the LAN Prune Delay option in the last Hello message from the neighbor. The value is the propagation delay over the local link expected by the neighbor."; } leaf t-bit { when "../present = 'true'" { description "Available only when 'leaf present' is 'true'."; } type boolean; description "'true' if the T bit is set in the LAN Prune Delay option in the last Hello message from the neighbor. This flag indicates the neighbor's ability to disable Join message suppression."; } } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the neighbor relationship has been formed as reachable without being timed out."; } } // neighbor-state-af-attributes grouping pim-instance-af-state-ref { description "An absolute reference to a PIM instance address family."; leaf instance-af-ref { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family/" + "pim-base:address-family"; } description "Reference to a PIM instance address family."; } } // pim-instance-af-state-ref grouping pim-interface-state-ref { description "An absolute reference to a PIM interface state."; leaf interface-ref { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:name"; } description "Reference to a PIM interface."; } } // pim-interface-state-ref grouping statistics-sent-received { description "A grouping defining sent and received statistics on PIM messages."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.7.1 RFC 5015: Bidirectional Protocol Independent Multicast (BIDIR-PIM), Section 3.7 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.9"; leaf assert { type yang:counter64; description "The number of Assert messages, with the message Type of 5 (RFCs 3973 and 7761)."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised) RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised)"; } leaf bsr { type yang:counter64; description "The number of Bootstrap messages, with the message Type of 4 (RFCs 3973 and 7761)."; } leaf candidate-rp-advertisement { type yang:counter64; description "The number of Candidate RP Advertisement messages, with the message Type of 8 (RFCs 3973 and 7761)."; } leaf df-election { type yang:counter64; description "The number of DF (Designated Forwarder) election messages, with the message Type of 10 (RFC 5015)."; reference "RFC 5015: Bidirectional Protocol Independent Multicast (BIDIR-PIM)"; } leaf graft { type yang:counter64; description "The number of Graft messages, with the message Type of 6 (RFCs 3973 and 7761)."; } leaf graft-ack { type yang:counter64; description "The number of Graft-Ack messages, with the message Type of 7 (RFCs 3973 and 7761)."; } leaf hello { type yang:counter64; description "The number of Hello messages, with the message Type of 0 (RFCs 3973 and 7761)."; } leaf join-prune { type yang:counter64; description "The number of Join/Prune messages, with the message Type of 3 (RFCs 3973 and 7761)."; } leaf register { type yang:counter64; description "The number of Register messages, with the message Type of 1 (RFCs 3973 and 7761)."; } leaf register-stop { type yang:counter64; description "The number of Register-Stop messages, with the message Type of 2 (RFCs 3973 and 7761)."; } leaf state-refresh { type yang:counter64; description "The number of State Refresh messages, with the message Type of 9 (RFC 3973)."; } } // statistics-sent-received /* * Data nodes */ augment "/rt:routing/rt:control-plane-protocols" { description "PIM augmentation to the routing instance model."; container pim { presence "Enables the PIM protocol."; description "PIM configuration data and operational state data."; uses graceful-restart-container { if-feature "global-graceful-restart"; } list address-family { key "address-family"; description "Each list entry for one address family."; uses rt:address-family; uses graceful-restart-container { if-feature "per-af-graceful-restart"; } container statistics { config false; description "A container defining statistics attributes."; leaf discontinuity-time { type yang:date-and-time; description "The time of the most recent occasion at which any one or more of the statistics counters suffered a discontinuity. If no such discontinuities have occurred since the last reinitialization of the local management subsystem, then this node contains the time the local management subsystem reinitialized itself."; } container error { description "Contains error statistics."; uses statistics-sent-received { description "Statistics counters on the PIM messages per PIM message Type. Each leaf attribute counts the number of PIM messages that were of a particular Type (such as Hello) and contained errors preventing them from being processed by PIM. Such messages are also counted by the corresponding counter of the same Type (such as Hello) in the 'received' container."; } leaf checksum { type yang:counter64; description "The number of PIM messages that were passed to PIM and contained checksum errors."; } leaf format { type yang:counter64; description "The number of PIM messages that passed checksum validation but contained format errors, including errors related to PIM Version, Type, and message length."; } } container queue { description "Contains queue statistics."; leaf size { type uint32; description "The size of the input queue."; } leaf overflow { type yang:counter32; description "The number of input queue overflows."; } } container received { description "Contains statistics of received messages."; uses statistics-sent-received; } container sent { description "Contains statistics of sent messages."; uses statistics-sent-received; } } container topology-tree-info { config false; description "Contains topology tree information."; list ipv4-route { when "../../address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "group source-address is-rpt"; description "A list of IPv4 routes."; leaf group { type rt-types:ipv4-multicast-group-address; description "Group address."; } leaf source-address { type rt-types:ipv4-multicast-source-address; description "Source address."; } leaf is-rpt { type boolean; description "'true' if the tree is an RPT (Rendezvous Point Tree)."; } uses multicast-route-attributes; } // ipv4-route list ipv6-route { when "../../address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "group source-address is-rpt"; description "A list of IPv6 routes."; leaf group { type rt-types:ipv6-multicast-group-address; description "Group address."; } leaf source-address { type rt-types:ipv6-multicast-source-address; description "Source address."; } leaf is-rpt { type boolean; description "'true' if the tree is an RPT."; } uses multicast-route-attributes; } // ipv6-route } // topology-tree-info } // address-family container interfaces { description "Contains a list of interfaces."; list interface { key "name"; description "List of PIM interfaces."; leaf name { type if:interface-ref; description "Reference to an entry in the global interface list."; } list address-family { key "address-family"; description "Each list entry for one address family."; uses rt:address-family; container bfd { if-feature "bfd"; description "BFD (Bidirectional Forwarding Detection) operation."; uses bfd-types:client-cfg-parms; } leaf dr-priority { if-feature "intf-dr-priority"; type uint32; default "1"; description "DR (Designated Router) priority as the preference in the DR election process."; } leaf hello-interval { if-feature "intf-hello-interval"; type rt-types:timer-value-seconds16; default "30"; description "Periodic interval for Hello messages. If 'infinity' or 'not-set' is used, no periodic Hello messages are sent."; reference "RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.11"; } choice hello-holdtime-or-multiplier { description "The Holdtime is the timer value to time out the neighbor state when the timer expires. The Holdtime value can be specified by either (1) the given Holdtime value or (2) the calculation of the Hello interval multiplied by the given value of the multiplier."; case holdtime { if-feature "intf-hello-holdtime"; leaf hello-holdtime { type rt-types:timer-value-seconds16; default "105"; description "The Hello Holdtime is the amount of time to keep the neighbor reachable until a new Hello message is received."; } } case multiplier { if-feature "intf-hello-multiplier"; leaf hello-multiplier { type rt-types:timer-multiplier; default "3"; description "The Hello multiplier is the number by which the Hello interval is multiplied to obtain the Hello Holdtime. The value of the Hello Holdtime is calculated as: hello-holdtime = (multiplier + 0.5) * (hello-interval)."; } } } leaf jp-interval { if-feature "intf-jp-interval"; type rt-types:timer-value-seconds16; default "60"; description "Periodic interval between Join/Prune messages. If 'infinity' or 'not-set' is used, no periodic Join/Prune messages are sent."; } choice jp-holdtime-or-multiplier { description "The Join/Prune Holdtime is the amount of time a receiver must keep the Join/Prune state alive. The Holdtime value can be specified by either (1) the given Holdtime value or (2) the calculation of 'jp-interval' multiplied by the given value of the multiplier."; case holdtime { if-feature "intf-jp-holdtime"; leaf jp-holdtime { type rt-types:timer-value-seconds16; default "210"; description "The Join/Prune Holdtime is the amount of time a receiver must keep the Join/Prune state alive."; } } case multiplier { if-feature "intf-jp-multiplier"; leaf jp-multiplier { type rt-types:timer-multiplier; default "3"; description "The Join/Prune multiplier is the number by which the Join/Prune interval is multiplied to obtain the Join/Prune Holdtime. The value of the Join/Prune Holdtime is calculated as: jp-holdtime = (multiplier + 0.5) * (jp-interval)."; } } } leaf override-interval { if-feature "intf-override-interval"; type uint16; units "milliseconds"; default "2500"; description "A short period after a Join or Prune to allow other routers on the LAN to override the Join or Prune."; } leaf propagation-delay { if-feature "intf-propagation-delay"; type uint16; units "milliseconds"; default "500"; description "Expected propagation delay over the local link."; } // Interface state attributes leaf oper-status { type enumeration { enum up { description "The interface is ready to pass PIM messages."; } enum down { description "The interface does not pass PIM messages."; } } config false; description "PIM operational status on the interface. This status is PIM specific and separate from the operational status of the underlying interface."; } leaf gen-id { type uint32; config false; description "The value of the Generation ID this router uses to insert into the PIM Hello message sent on this interface."; } leaf hello-expiration { type rt-types:timer-value-seconds16; config false; description "Hello interval expiration time."; } container ipv4 { when "../address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } config false; description "Interface state attributes for IPv4."; leaf-list address { type inet:ipv4-address; description "List of addresses on which PIM is operating."; } leaf dr-address { type inet:ipv4-address; description "DR (Designated Router) address."; } } container ipv6 { when "../address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } config false; description "Interface state attributes for IPv6."; leaf-list address { type inet:ipv6-address; description "List of addresses on which PIM is operating."; } leaf dr-address { type inet:ipv6-address; description "DR address."; } } container neighbors { config false; description "Information learned from neighbors through this interface."; list ipv4-neighbor { when "../../address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "address"; description "Neighbor state information."; leaf address { type inet:ipv4-address; description "Neighbor address."; } uses neighbor-state-af-attributes; } // list ipv4-neighbor list ipv6-neighbor { when "../../address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "address"; description "Neighbor state information."; leaf address { type inet:ipv6-address; description "Neighbor address."; } uses neighbor-state-af-attributes; } // list ipv6-neighbor } // neighbors } // address-family } // interface } // interfaces } // pim } // augment /* * Notifications */ notification pim-neighbor-event { description "Notification event for a neighbor."; leaf event-type { type neighbor-event-type; description "Event type."; } uses pim-interface-state-ref; leaf interface-af-ref { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface" + "[pim-base:name = current()/../interface-ref]/" + "pim-base:address-family/pim-base:address-family"; } description "Reference to a PIM interface address family."; } leaf neighbor-ipv4-ref { when "../interface-af-ref = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } type leafref { path "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface" + "[pim-base:name = current()/../interface-ref]/" + "pim-base:address-family" + "[pim-base:address-family = " + "current()/../interface-af-ref]/" + "pim-base:neighbors/pim-base:ipv4-neighbor/" + "pim-base:address"; } description "Reference to a PIM IPv4 neighbor."; } leaf neighbor-ipv6-ref { when "../interface-af-ref = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } type leafref { path "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface" + "[pim-base:name = current()/../interface-ref]/" + "pim-base:address-family" + "[pim-base:address-family = " + "current()/../interface-af-ref]/" + "pim-base:neighbors/pim-base:ipv6-neighbor/" + "pim-base:address"; } description "Reference to a PIM IPv6 neighbor."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the neighbor relationship has been formed as reachable without being timed out."; } } notification pim-interface-event { description "Notification event for an interface."; leaf event-type { type interface-event-type; description "Event type."; } uses pim-interface-state-ref; container ipv4 { description "Contains IPv4 information."; leaf-list address { type inet:ipv4-address; description "List of addresses."; } leaf dr-address { type inet:ipv4-address; description "DR (Designated Router) address."; } } container ipv6 { description "Contains IPv6 information."; leaf-list address { type inet:ipv6-address; description "List of addresses."; } leaf dr-address { type inet:ipv6-address; description "DR address."; } } } } ]]>

PIM RP Module This module references , , , , , and . WG List: Editor: Xufeng Liu Editor: Pete McAllister Editor: Anish Peter Editor: Mahesh Sivakumar Editor: Yisong Liu Editor: Fangwei Hu "; description "This YANG module defines a PIM (Protocol Independent Multicast) RP (Rendezvous Point) model. Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 9128; see the RFC itself for full legal notices."; revision 2022-10-19 { description "Initial revision."; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } /* * Features */ feature bsr { description "This feature indicates that the system supports BSRs (Bootstrap Routers)."; reference "RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM)"; } feature bsr-election-state { if-feature "bsr"; description "This feature indicates that the system supports providing BSR election state."; reference "RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM)"; } feature static-rp-override { description "This feature indicates that the system supports configuration of the static RP (Rendezvous Point) that overrides the RP discoveries from other mechanisms."; reference "RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 3.7"; } feature candidate-interface { description "This feature indicates that the system supports using an interface to configure a BSR or RP candidate."; } feature candidate-ipv4 { description "This feature indicates that the system supports using an IPv4 address to configure a BSR or RP candidate."; } feature candidate-ipv6 { description "This feature indicates that the system supports using an IPv6 address to configure a BSR or RP candidate."; } /* * Typedefs */ typedef rp-event-type { type enumeration { enum invalid-jp { description "An invalid Join/Prune message has been received."; } enum invalid-register { description "An invalid Register message has been received."; } enum mapping-created { description "A new mapping has been created."; } enum mapping-deleted { description "A mapping has been deleted."; } } description "Operational status event type for notifications."; } /* * Identities */ identity rp-mode { description "The mode of an RP, which can be SM (Sparse Mode) or BIDIR (Bidirectional)."; } identity rp-info-source-type { description "The information source of an RP."; } identity static { base rp-info-source-type; description "The RP is statically configured."; } identity bootstrap { base rp-info-source-type; description "The RP is learned from a Bootstrap."; } /* * Groupings */ grouping rp-mapping-state-attributes { description "Grouping of RP mapping attributes."; leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the RP mapping or the RP became actively available."; } leaf expiration { type rt-types:timer-value-seconds16; description "Expiration time."; } } // rp-mapping-state-attributes grouping rp-state-attributes { description "Grouping of RP state attributes."; leaf info-source-type { type identityref { base rp-info-source-type; } description "The information source of an RP."; } // info-source-type leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the RP became actively available."; } leaf expiration { type rt-types:timer-value-seconds16; description "Expiration time."; } } // rp-state-attributes grouping static-rp-attributes { description "Grouping of static RP attributes, used in augmenting modules."; leaf policy-name { type string; description "The string value is the name to uniquely identify a policy that contains one or more policy rules used to determine which multicast group addresses are mapped to this statically configured RP address. If a policy is not specified, the entire multicast address space is mapped. The definition of such a policy is outside the scope of this document."; } leaf override { if-feature "static-rp-override"; type boolean; default "false"; description "When there is a conflict between static RPs and dynamic RPs, setting this attribute to 'true' will ask the system to use static RPs."; } } // static-rp-attributes grouping rp-candidate-attributes { description "Grouping of RP candidate attributes."; leaf policy-name { type string; description "The string value is the name to uniquely identify a policy that contains one or more policy rules used to accept or reject certain multicast groups. If a policy is not specified, the entire multicast address space is accepted. The definition of such a policy is outside the scope of this document."; } leaf mode { type identityref { base rp-mode; } description "The mode of an RP, which can be SM (Sparse Mode) or BIDIR (Bidirectional). Each of these modes is defined in a separate YANG module. If a system supports an RP mode, the corresponding YANG module is implemented. When the value of this leaf is not specified, the default value is the supported mode if only one mode is implemented, or the default value is SM if both SM and BIDIR are implemented."; } } // rp-candidate-attributes /* * Configuration data nodes */ augment "/rt:routing/rt:control-plane-protocols/pim-base:pim/" + "pim-base:address-family" { description "PIM RP augmentation."; container rp { description "PIM RP configuration data."; container static-rp { description "Contains static RP attributes."; list ipv4-rp { when "../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "rp-address"; description "A list of IPv4 RP addresses."; leaf rp-address { type inet:ipv4-address; description "Specifies a static RP address."; } } list ipv6-rp { when "../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "rp-address"; description "A list of IPv6 RP addresses."; leaf rp-address { type inet:ipv6-address; description "Specifies a static RP address."; } } } // static-rp container bsr { if-feature "bsr"; description "Contains BSR (Bootstrap Router) attributes."; container bsr-candidate { presence "Present to serve as a BSR candidate."; description "BSR candidate attributes."; choice interface-or-address { description "Use either an interface or an IP address."; case interface { if-feature "candidate-interface"; leaf interface { type if:interface-ref; mandatory true; description "Interface to be used by a BSR."; } } case ipv4-address { when "../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } if-feature "candidate-ipv4"; leaf ipv4-address { type inet:ipv4-address; mandatory true; description "IP address to be used by a BSR."; } } case ipv6-address { when "../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } if-feature "candidate-ipv6"; leaf ipv6-address { type inet:ipv6-address; mandatory true; description "IP address to be used by a BSR."; } } } leaf hash-mask-length { type uint8 { range "0..128"; } mandatory true; description "Value contained in BSR messages used by all routers to hash (map) to an RP."; } leaf priority { type uint8 { range "0..255"; } default "64"; description "BSR election priority among different candidate BSRs. A larger value has a higher priority over a smaller value."; } } // bsr-candidate container rp-candidate { description "Contains RP candidate attributes."; list interface { if-feature "candidate-interface"; key "name"; description "A list of RP candidates."; leaf name { type if:interface-ref; description "Interface that the RP candidate uses."; } uses rp-candidate-attributes; } list ipv4-address { when "../../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } if-feature "candidate-ipv4"; key "address"; description "A list of RP candidate addresses."; leaf address { type inet:ipv4-address; description "IPv4 address that the RP candidate uses."; } uses rp-candidate-attributes; } list ipv6-address { when "../../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } if-feature "candidate-ipv6"; key "address"; description "A list of RP candidate addresses."; leaf address { type inet:ipv6-address; description "IPv6 address that the RP candidate uses."; } uses rp-candidate-attributes; } } // BSR state attributes container bsr { config false; description "BSR information."; leaf address { type inet:ip-address; description "BSR address."; } leaf hash-mask-length { type uint8 { range "0..128"; } description "Hash mask length."; } leaf priority { type uint8 { range "0..255"; } description "Priority."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the BSR came up."; } } choice election-state { if-feature "bsr-election-state"; config false; description "BSR election state."; case candidate { leaf candidate-bsr-state { type enumeration { enum candidate { description "The router is a candidate to be the BSR for the scope zone, but currently another router is the preferred BSR."; } enum pending { description "The router is a candidate to be the BSR for the scope zone. Currently, no other router is the preferred BSR, but this router is not yet the elected BSR. This is a temporary state that prevents rapid thrashing of the choice of BSR during BSR election."; } enum elected { description "The router is the elected BSR for the scope zone, and it must perform all of the BSR functions."; } } description "Candidate-BSR (C-BSR) state."; reference "RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM), Section 3.1.1"; } } case non-candidate { leaf non-candidate-bsr-state { type enumeration { enum no-info { description "The router has no information about this scope zone."; } enum accept-any { description "The router does not know of an active BSR and will accept the first Bootstrap message it sees that provides the new BSR's identity and the RP-Set."; } enum accept { description "The router knows the identity of the current BSR and is using the RP-Set provided by that BSR. Only Bootstrap messages from that BSR or from a Candidate-BSR (C-BSR) with higher weight than the current BSR will be accepted."; } } description "Non-Candidate-BSR state."; reference "RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM), Section 3.1.2"; } } } // election-state leaf bsr-next-bootstrap { type uint16; units "seconds"; config false; description "The remaining time interval in seconds until the next Bootstrap will be sent."; } container rp { config false; description "State information of the RP."; leaf rp-address { type inet:ip-address; description "RP address."; } leaf policy-name { type string; description "The string value is the name to uniquely identify a policy that contains one or more policy rules used to accept or reject certain multicast groups. If a policy is not specified, the entire multicast address space is accepted. The definition of such a policy is outside the scope of this document."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the RP became actively available."; } } leaf rp-candidate-next-advertisement { type uint16; units "seconds"; config false; description "The remaining time interval in seconds until the next RP candidate advertisement will be sent."; } } // bsr container rp-list { config false; description "Contains a list of RPs."; list ipv4-rp { when "../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "rp-address mode"; description "A list of IPv4 RP addresses."; leaf rp-address { type inet:ipv4-address; description "RP address."; } leaf mode { type identityref { base rp-mode; } description "RP mode."; } leaf info-source-address { type inet:ipv4-address; description "The address where RP information is learned."; } uses rp-state-attributes; } list ipv6-rp { when "../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "rp-address mode"; description "A list of IPv6 RP addresses."; leaf rp-address { type inet:ipv6-address; description "RP address."; } leaf mode { type identityref { base rp-mode; } description "RP mode."; } leaf info-source-address { type inet:ipv6-address; description "The address where RP information is learned."; } uses rp-state-attributes; } } // rp-list container rp-mappings { config false; description "Contains a list of group-to-RP mappings."; list ipv4-rp { when "../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "group-range rp-address"; description "A list of group-to-RP mappings."; leaf group-range { type inet:ipv4-prefix; description "Group range presented in the format of a prefix."; } leaf rp-address { type inet:ipv4-address; description "RP address."; } uses rp-mapping-state-attributes; } list ipv6-rp { when "../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "group-range rp-address"; description "A list of IPv6 RP addresses."; leaf group-range { type inet:ipv6-prefix; description "Group range presented in the format of a prefix."; } leaf rp-address { type inet:ipv6-address; description "RP address."; } uses rp-mapping-state-attributes; } } // rp-mappings } // rp } // augment /* * Notifications */ notification pim-rp-event { description "Notification event for an RP."; leaf event-type { type rp-event-type; description "Event type."; } uses pim-base:pim-instance-af-state-ref; leaf group { type rt-types:ip-multicast-group-address; description "Group address."; } leaf rp-address { type inet:ip-address; description "RP address."; } leaf is-rpt { type boolean; description "'true' if the tree is an RPT (Rendezvous Point Tree)."; } leaf mode { type identityref { base pim-base:pim-mode; } description "PIM mode."; } leaf message-origin { type inet:ip-address; description "Where the message originated."; } } } ]]>

PIM-SM Module This module references , , , and . WG List: Editor: Xufeng Liu Editor: Pete McAllister Editor: Anish Peter Editor: Mahesh Sivakumar Editor: Yisong Liu Editor: Fangwei Hu "; description "This YANG module defines a PIM (Protocol Independent Multicast) SM (Sparse Mode) model. Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 9128; see the RFC itself for full legal notices."; revision 2022-10-19 { description "Initial revision."; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } /* * Features */ feature spt-switch-infinity { description "This feature indicates that the system supports the configuration choice of whether to trigger switchover from the RPT (Rendezvous Point Tree) to the SPT (Shortest Path Tree)."; reference "RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.2"; } feature spt-switch-policy { description "This feature indicates that the system supports configuring the policy for switchover from the RPT to the SPT."; reference "RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), Section 4.2"; } /* * Identities */ identity rp-sm { base pim-rp:rp-mode; description "SM (Sparse Mode)."; } /* * Groupings */ grouping static-rp-sm-container { description "Grouping that contains SM attributes for static RPs."; container sm { presence "Indicates support for PIM-SM."; description "PIM-SM configuration data."; uses pim-rp:static-rp-attributes; } // sm } // static-rp-sm-container /* * Configuration data nodes */ augment "/rt:routing/rt:control-plane-protocols/pim-base:pim/" + "pim-base:address-family" { description "PIM-SM augmentation."; container sm { description "PIM-SM configuration data."; container asm { description "ASM (Any-Source Multicast) attributes."; container anycast-rp { presence "Present to enable an Anycast-RP (Rendezvous Point)."; description "Anycast-RP attributes."; list ipv4-anycast-rp { when "../../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "anycast-address rp-address"; description "A list of IPv4 Anycast-RP settings. Only applicable when 'pim-base:address-family' is IPv4."; leaf anycast-address { type inet:ipv4-address; description "IP address of the Anycast-RP set. This IP address is used by the multicast groups or sources to join or register."; } leaf rp-address { type inet:ipv4-address; description "IP address of the router configured with an Anycast-RP. This is the IP address where the Register messages are forwarded."; } } list ipv6-anycast-rp { when "../../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "anycast-address rp-address"; description "A list of IPv6 Anycast-RP settings. Only applicable when 'pim-base:address-family' is IPv6."; leaf anycast-address { type inet:ipv6-address; description "IP address of the Anycast-RP set. This IP address is used by the multicast groups or sources to join or register."; } leaf rp-address { type inet:ipv6-address; description "IP address of the router configured with an Anycast-RP. This is the IP address where the Register messages are forwarded."; } } } container spt-switch { description "SPT (Shortest Path Tree) switching attributes."; container infinity { if-feature "spt-switch-infinity"; presence "Present if the SPT switchover threshold is set to infinity, according to the policy specified below."; description "The receiver's DR (Designated Router) never triggers switchover from the RPT to the SPT."; leaf policy-name { if-feature "spt-switch-policy"; type string; description "The string value is the name to uniquely identify a policy that contains one or more policy rules used to accept or reject certain multicast groups. The groups accepted by this policy have the SPT switchover threshold set to infinity, meaning that they will stay on the shared tree forever. If a policy is not specified, the entire multicast address space is accepted. The definition of such a policy is outside the scope of this document."; } } // infinity } } // asm container ssm { presence "Present to enable SSM (Source-Specific Multicast)."; description "SSM attributes."; leaf range-policy { type string; description "The string value is the name to uniquely identify a policy that contains one or more policy rules used to accept or reject certain multicast groups. The groups accepted by this policy define the multicast group range used by SSM. If a policy is not specified, the default SSM multicast group range is used. The default SSM multicast group range is 232.0.0.0/8 for IPv4 and ff3x::/96 for IPv6, where x represents any valid scope identifier. The definition of such a policy is outside the scope of this document."; reference "RFC 4607: Source-Specific Multicast for IP"; } } // ssm } // sm } // augment augment "/rt:routing/rt:control-plane-protocols/pim-base:pim/" + "pim-base:interfaces/pim-base:interface/" + "pim-base:address-family" { description "PIM-SM augmentation."; container sm { presence "Present to enable PIM-SM."; description "PIM-SM configuration data."; leaf passive { type empty; description "Specifies that no PIM messages are sent or accepted on this PIM interface, but the interface can be included in a multicast forwarding entry."; } } // sm } // augment augment "/rt:routing/rt:control-plane-protocols/pim-base:pim/" + "pim-base:address-family/pim-rp:rp/" + "pim-rp:static-rp/pim-rp:ipv4-rp" { description "PIM-SM augmentation."; uses static-rp-sm-container; } // augment augment "/rt:routing/rt:control-plane-protocols/pim-base:pim/" + "pim-base:address-family/pim-rp:rp/" + "pim-rp:static-rp/pim-rp:ipv6-rp" { description "PIM-SM augmentation."; uses static-rp-sm-container; } // augment } ]]>

PIM-DM Module This module references and . WG List: Editor: Xufeng Liu Editor: Pete McAllister Editor: Anish Peter Editor: Mahesh Sivakumar Editor: Yisong Liu Editor: Fangwei Hu "; description "This YANG module defines a PIM (Protocol Independent Multicast) DM (Dense Mode) model. Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 9128; see the RFC itself for full legal notices."; revision 2022-10-19 { description "Initial revision."; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } /* * Configuration data nodes */ augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family" { description "PIM-DM augmentation."; container dm { presence "Present to enable PIM-DM."; description "PIM-DM configuration data."; } // dm } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:address-family" { description "PIM-DM augmentation to 'pim-base:interface'."; container dm { presence "Present to enable PIM-DM."; description "PIM-DM configuration data."; } // dm } // augment } ]]>

BIDIR-PIM Module This module references , , , , and . WG List: Editor: Xufeng Liu Editor: Pete McAllister Editor: Anish Peter Editor: Mahesh Sivakumar Editor: Yisong Liu Editor: Fangwei Hu "; description "This YANG module defines a PIM (Protocol Independent Multicast) BIDIR (Bidirectional) mode model. Copyright (c) 2022 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 9128; see the RFC itself for full legal notices."; revision 2022-10-19 { description "Initial revision."; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } /* * Features */ feature intf-df-election { description "Supports configuration of interface DF election."; reference "RFC 5015: Bidirectional Protocol Independent Multicast (BIDIR-PIM), Section 3.5"; } /* * Identities */ identity rp-bidir { base pim-rp:rp-mode; description "BIDIR mode."; } identity df-state { description "DF (Designated Forwarder) election state type."; reference "RFC 5015: Bidirectional Protocol Independent Multicast (BIDIR-PIM)"; } identity df-state-offer { base df-state; description "Initial election state. When in the Offer state, a router thinks it can eventually become the winner and periodically generates Offer messages."; } identity df-state-lose { base df-state; description "Either (1) there is a different election winner or (2) no router on the link has a path to the RPA (Rendezvous Point Address)."; } identity df-state-win { base df-state; description "The router is the acting DF without any contest."; } identity df-state-backoff { base df-state; description "The router is the acting DF, but another router has made a bid to take over."; } /* * Groupings */ grouping static-rp-bidir-container { description "Grouping that contains BIDIR attributes for a static RP (Rendezvous Point)."; container bidir { presence "Indicates support for BIDIR mode."; description "PIM-BIDIR configuration data."; uses pim-rp:static-rp-attributes; } // bidir } // static-rp-bidir-container grouping interface-df-election-state-attributes { description "Grouping that contains the state attributes of a DF election on an interface."; leaf interface-state { type identityref { base df-state; } description "Interface state with respect to the DF election."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since the current DF has been elected as the winner."; } leaf winner-metric { type uint32; description "The unicast routing metric used by the DF to reach the RP. The value is announced by the DF."; } leaf winner-metric-preference { type uint32; description "The preference value assigned to the unicast routing protocol that the DF used to obtain the route to the RP. The value is announced by the DF."; } } // interface-df-election-state-attributes /* * Configuration data and operational state data nodes */ augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family" { description "PIM-BIDIR augmentation."; container bidir { presence "Present to enable BIDIR mode."; description "PIM-BIDIR configuration data."; } // bidir } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:address-family" { description "PIM-BIDIR augmentation."; container bidir { presence "Present to enable BIDIR mode."; description "PIM-BIDIR configuration data."; container df-election { if-feature "intf-df-election"; description "DF election attributes."; leaf offer-interval { type uint16; units "milliseconds"; default "100"; description "Offer interval. Specifies the interval between repeated DF election messages."; } leaf backoff-interval { type uint16; units "milliseconds"; default "1000"; description "This is the interval that the acting DF waits between receiving a better DF Offer and sending the Pass message to transfer DF responsibility."; } leaf offer-multiplier { type uint8; default "3"; description "This is the number of transmission attempts for DF election messages. When a DF election Offer or Winner message fails to be received, the message is retransmitted. 'offer-multiplier' sets the minimum number of DF election messages that must fail to be received for DF election to fail. If a router receives from a neighbor a better offer than its own, the router stops participating in the election for a period of 'offer-multiplier' * 'offer-interval'. Eventually, all routers except the best candidate stop sending Offer messages."; } } // df-election } // bidir } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family/pim-rp:rp/" + "pim-rp:static-rp/pim-rp:ipv4-rp" { description "PIM-BIDIR augmentation."; uses static-rp-bidir-container; } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family/pim-rp:rp/" + "pim-rp:static-rp/pim-rp:ipv6-rp" { description "PIM-BIDIR augmentation."; uses static-rp-bidir-container; } // augment /* * Operational state data nodes */ augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family/pim-rp:rp" { description "PIM-BIDIR augmentation to RP state data."; container bidir { config false; description "PIM-BIDIR state data."; container df-election { description "DF election data."; list ipv4-rp { when "../../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "rp-address"; description "A list of IPv4 RP addresses."; leaf rp-address { type inet:ipv4-address; description "The address of the RP."; } } // ipv4-rp list ipv6-rp { when "../../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "rp-address"; description "A list of IPv6 RP addresses."; leaf rp-address { type inet:ipv6-address; description "The address of the RP."; } } // ipv6-rp } // df-election container interface-df-election { description "Interface DF election data."; list ipv4-rp { when "../../../../pim-base:address-family = 'rt:ipv4'" { description "Only applicable to an IPv4 address family."; } key "rp-address interface-name"; description "A list of IPv4 RP addresses."; leaf rp-address { type inet:ipv4-address; description "The address of the RP."; } leaf interface-name { type if:interface-ref; description "The name of the interface for which the DF state is being maintained."; } leaf df-address { type inet:ipv4-address; description "The address of the elected DF, which is the winner of the DF election process."; } uses interface-df-election-state-attributes; } // ipv4-rp list ipv6-rp { when "../../../../pim-base:address-family = 'rt:ipv6'" { description "Only applicable to an IPv6 address family."; } key "rp-address interface-name"; description "A list of IPv6 RP addresses."; leaf rp-address { type inet:ipv6-address; description "The address of the RP."; } leaf interface-name { type if:interface-ref; description "The name of the interface for which the DF state is being maintained."; } leaf df-address { type inet:ipv6-address; description "DF address."; } uses interface-df-election-state-attributes; } // ipv6-rp } // interface-df-election } } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:address-family/pim-base:neighbors/" + "pim-base:ipv4-neighbor" { description "PIM-BIDIR augmentation to the IPv4 neighbor state data."; leaf bidir-capable { type boolean; description "'true' if the neighbor is using the Bidirectional Capable option in the last Hello message."; } } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:address-family/pim-base:neighbors/" + "pim-base:ipv6-neighbor" { description "PIM-BIDIR augmentation to the IPv6 neighbor state data."; leaf bidir-capable { type boolean; description "'true' if the neighbor is using the Bidirectional Capable option in the last Hello message."; } } // augment } ]]>