<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE rfcSYSTEM "rfc2629.dtd"[ <!ENTITY nbsp " "> <!ENTITY zwsp "​"> <!ENTITY nbhy "‑"> <!ENTITY wj "⁠"> ]><!-- may be omitted for very short documents --> <?rfc toc="yes"?> <?rfc sortrefs="no"?> <?rfc symrefs="yes"?> <?rfc strict="no"?> <?rfc rfcedstyle="yes"?> <?rfc comments="yes"?> <?rfc inline="yes"?> <!-- these two save paper: start new sections from the same page etc. --> <?rfc compact="yes"?> <?rfc subcompact="no"?> <!-- other categories: bcp, exp, historic, std --><rfc xmlns:xi="http://www.w3.org/2001/XInclude" ipr="trust200902" docName="draft-ietf-pim-yang-17" number="9128" obsoletes="" updates="" submissionType="IETF" category="std"docName="draft-ietf-pim-yang-17">consensus="true" xml:lang="en" tocInclude="true" sortRefs="true" symRefs="true" version="3"> <!-- xml2rfc v2v3 conversion 2.47.0 --> <front> <titleabbrev='PIM YANG'> Aabbrev="PIM YANG"> YANG Data Model for Protocol Independent Multicast (PIM) </title> <seriesInfo name="RFC" value="9128"/> <author fullname="Xufeng Liu" initials="X." surname="Liu"><organization>Volta Networks</organization><organization>IBM Corporation</organization> <address> <postal> <street>2300 Dulles Station Blvd.</street> <city>Herndon</city> <region>VA</region> <code>20171</code> <country>United States of America</country> </postal> <email>xufeng.liu.ietf@gmail.com</email> </address> </author> <author fullname="Pete McAllister" initials="P." surname="McAllister"> <organization>Metaswitch Networks</organization> <address> <postal> <street>100 Church Street</street> <city>Enfield</city> <code>EN2 6BQ</code><country>UK</country><country>United Kingdom</country> </postal> <email> pete.mcallister@metaswitch.com</email> </address> </author> <author fullname="Anish Peter" initials="A." surname="Peter"> <organization>Individual</organization> <address> <email>anish.ietf@gmail.com</email> </address> </author> <author fullname="Mahesh Sivakumar" initials="M." surname="Sivakumar"> <organization>Juniper Networks</organization> <address> <postal> <street>1133 Innovation Way</street> <city>Sunnyvale</city> <region>California</region><country>USA</country><country>United States of America</country> </postal> <email>sivakumar.mahesh@gmail.com</email> </address> </author> <author fullname="Yisong Liu" initials="Y." surname="Liu"><organization>Huawei Technologies</organization><organization>China Mobile</organization> <address> <postal><street>Huawei Administration<street>China Mobile Innovation Building</street><city>Longgang</city> <region>Guangdong</region> <code>518129</code><street>32 Xuanwumen West Street</street> <city>Beijing</city> <code>100053</code> <country>China</country> </postal><email>liuyisong@huawei.com</email><email>liuyisong@chinamobile.com</email> </address> </author> <author fullname="Fangwei Hu" initials="F." surname="Hu"><organization>ZTE Corporation</organization><organization>Individual Contributor</organization> <address> <postal><street>889 Bibo<street>86 Bohang Road</street> <city>Shanghai</city> <region>Shanghai</region><code>201203</code><code>200126</code> <country>China</country> </postal><email>hu.fangwei@zte.com.cn</email><email>hufwei@gmail.com</email> </address> </author> <dateyear="2018"/> <area>Routing</area> <workgroup>PIM Working Group</workgroup>year="2022" month="October" /> <keyword>Network Management</keyword> <keyword>PIM</keyword> <keyword>YANG</keyword> <abstract> <t> This document defines a YANG data model that can be used to configure and manage devices supporting Protocol Independent Multicast (PIM). The model covers the PIM protocol configuration, operational state, and event notifications data. </t> </abstract> </front> <middle> <sectiontitle="Introduction">numbered="true" toc="default"> <name>Introduction</name> <t> YANG <xreftarget="RFC7950"/>target="RFC7950" format="default"/> is a data modeling language that was introduced to model the configuration and operational state of a device managed using network management protocols such asNETCONFthe Network Configuration Protocol (NETCONF) <xreftarget="RFC6241"/>target="RFC6241" format="default"/> or RESTCONF <xreftarget="RFC8040"/>.target="RFC8040" format="default"/>. YANG is now also being used as a component of other management interfaces, such asCLIs. </t>command-line interfaces (CLIs).</t> <t> This document defines a YANG data model that can be used to configure and manage devices supporting Protocol Independent Multicast (PIM). This model supports the core PIM protocol, as well as many otherfeatures described in Section 2.1.features; see <xref target="scope"/>. Non-core features are defined as optional in the provided data model. </t> <sectiontitle="Terminology">numbered="true" toc="default"> <name>Terminology</name> <t> The terminology for describing YANG data models is found in <xreftarget="RFC7950"/>.target="RFC7950" format="default"/>. </t> <t> The following abbreviations are used in this document and the defined model:<list style="hanging"> <t hangText="ASM:"><vspace blankLines="0" /> Any-Source</t> <dl newline="false" spacing="normal" indent="13"> <dt>ASM:</dt> <dd>Any-Source Multicast service model <xreftarget="RFC3569"/>target="RFC3569" format="default"/> <xreftarget="RFC4607"/>. </t> <t hangText="BFD:"><vspace blankLines="0" /> Bidirectionaltarget="RFC4607" format="default"/> </dd> <dt>BFD:</dt> <dd>Bidirectional Forwarding Detection <xreftarget="RFC5880"/>. </t> <t hangText="BSR:"><vspace blankLines="0" /> Bootstraptarget="RFC5880" format="default"/> </dd> <dt>BIDIR-PIM:</dt> <dd>Protocol Independent Multicast - Bidirectional Mode <xref target="RFC5015" format="default"/> </dd> <dt>BSR:</dt> <dd>Bootstrap Router <xreftarget="RFC5059"/>. </t> <t hangText="DF:"><vspace blankLines="0" /> Designatedtarget="RFC5059" format="default"/> </dd> <dt>DF:</dt> <dd>Designated Forwarder <xreftarget="RFC5015"/>. </t> <t hangText="DR:"><vspace blankLines="0" /> Designatedtarget="RFC5015" format="default"/> </dd> <dt>DR:</dt> <dd>Designated Router <xreftarget="RFC7761"/>. </t> <t hangText="IGMP:"><vspace blankLines="0" /> Internettarget="RFC7761" format="default"/> </dd> <dt>IGMP:</dt> <dd>Internet Group Management Protocol <xreftarget="RFC3376"/>. </t> <t hangText="MLD:"><vspace blankLines="0" /> Multicasttarget="RFC3376" format="default"/> </dd> <dt>MLD:</dt> <dd>Multicast Listener Discovery <xreftarget="RFC3810"/>. </t> <t hangText="MSDP:"><vspace blankLines="0" /> Multicast Source Discovery Protocol <xref target="RFC3618"/>. </t> <t hangText="mLDP:"><vspace blankLines="0" /> Multipointtarget="RFC3810" format="default"/> </dd> <dt>mLDP:</dt> <dd>Multipoint extensions for LDP <xreftarget="RFC6388"/>. </t> <t hangText="MRIB:"><vspace blankLines="0" /> Multicasttarget="RFC6388" format="default"/> </dd> <dt>MRIB:</dt> <dd>Multicast Routing Information Base <xreftarget="RFC3973"/>target="RFC3973" format="default"/> <xreftarget="RFC5015"/>target="RFC5015" format="default"/> <xreftarget="RFC7761"/>. </t> <t hangText="mVPN:"><vspace blankLines="0" /> Multicast VPN. </t> <t hangText="PIM:"><vspace blankLines="0" />target="RFC7761" format="default"/> </dd> <dt>MSDP:</dt> <dd>Multicast Source Discovery ProtocolIndependent Multicast. <xref target="RFC3973"/><xreftarget="RFC5015"/> <xref target="RFC7761"/>. </t> <t hangText="PIM-BIDIR:"><vspace blankLines="0" /> Protocoltarget="RFC3618" format="default"/> </dd> <dt>mVPN:</dt> <dd>Multicast VPN </dd> <dt>PIM:</dt> <dd>Protocol Independent Multicast- Bidirectional Mode<xreftarget="RFC5015"/>. </t> <t hangText="PIM-DM:"><vspace blankLines="0" /> Protocoltarget="RFC3973" format="default"/> <xref target="RFC5015" format="default"/> <xref target="RFC7761" format="default"/> </dd> <dt>PIM-DM:</dt> <dd>Protocol Independent Multicast - Dense Mode <xreftarget="RFC3973"/>. </t> <t hangText="PIM-SM:"><vspace blankLines="0" /> Protocoltarget="RFC3973" format="default"/> </dd> <dt>PIM-SM:</dt> <dd>Protocol Independent Multicast - Sparse Mode <xreftarget="RFC7761"/>. </t> <t hangText="RP:"><vspace blankLines="0" /> Rendezvous Point.target="RFC7761" format="default"/> </dd> <dt>RP:</dt> <dd>Rendezvous Point <xreftarget="RFC7761"/>. </t> <t hangText="RPA:"><vspace blankLines="0" /> Rendezvoustarget="RFC7761" format="default"/> </dd> <dt>RPA:</dt> <dd>Rendezvous PointAddress.Address <xreftarget="RFC5015"/>. </t> <t hangText="RPF:"><vspace blankLines="0" /> Reversetarget="RFC5015" format="default"/> </dd> <dt>RPF:</dt> <dd>Reverse PathForwarding.Forwarding <xreftarget="RFC3973"/>target="RFC3973" format="default"/> <xreftarget="RFC5015"/>target="RFC5015" format="default"/> <xreftarget="RFC7761"/>. </t> <t hangText="RPT:"><vspace blankLines="0" /> Rendezvous-Point Tree.target="RFC7761" format="default"/> </dd> <dt>RPT:</dt> <dd>Rendezvous Point Tree <xreftarget="RFC7761"/>. </t> <t hangText="SPT:"><vspace blankLines="0" /> Shortesttarget="RFC7761" format="default"/> </dd> <dt>SPT:</dt> <dd>Shortest PathTree.Tree <xreftarget="RFC7761"/>. </t> <t hangText="SSM:"><vspace blankLines="0" /> Source-Specifictarget="RFC7761" format="default"/> </dd> <dt>SSM:</dt> <dd>Source-Specific Multicast service model <xreftarget="RFC3569"/>target="RFC3569" format="default"/> <xreftarget="RFC4607"/>. </t> <t hangText="VRF:"><vspace blankLines="0" /> Virtualtarget="RFC4607" format="default"/> </dd> <dt>VRF:</dt> <dd>Virtual Routing andForwarding. </t> </list> </t>Forwarding </dd> </dl> </section> <sectiontitle="Tree Diagrams">numbered="true" toc="default"> <name>Tree Diagrams</name> <t> Tree diagrams used in this document follow the notation defined in <xreftarget="RFC8340"/>.target="RFC8340" format="default"/>. </t> <t> In addition, the following notation is used as a placeholder at the location of the name of a tree node, to represent a section of nodes: </t> <t> <summary description of a section of nodes> </t> </section> <sectiontitle="Prefixesnumbered="true" toc="default"> <name>Prefixes in Data NodeNames">Names</name> <t> In this document, names of data nodes, actions, and other data model objects are often used without a prefix, as long asit is clear fromthe contextin whichclearly indicates the YANG module in which each name is defined. Otherwise, names are prefixed using the standard prefix associated with the corresponding YANG module, as shown inTable 1.<xref target="table_prefixes"/>. </t><texttable anchor='table_prefixes' title="Prefixes<table anchor="table_prefixes" align="center"> <name>Prefixes and Corresponding YANGModules"> <ttcol>Prefix</ttcol> <ttcol>YANG module</ttcol> <ttcol>Reference</ttcol> <c>yang</c> <c>ietf-yang-types</c> <c><xref target="RFC6991"/></c> <c>inet</c> <c>ietf-inet-types</c> <c><xref target="RFC6991"/></c> <c>if</c> <c>ietf-interfaces</c> <c><xref target="RFC8343"/></c> <c>rt</c> <c>ietf-routing</c> <c><xref target="RFC8349"/></c> <c>rt-types</c> <c>ietf-routing-types</c> <c><xref target="RFC8294"/></c> <c>bfd-types</c> <c>ietf-bfd-types</c> <c><xref target="I-D.ietf-bfd-yang"/></c> </texttable> </section> </section> <section title="DesignModules</name> <thead> <tr> <th align="left">Prefix</th> <th align="left">YANG Module</th> <th align="left">Reference</th> </tr> </thead> <tbody> <tr> <td align="left">yang</td> <td align="left">ietf-yang-types</td> <td align="left"> <xref target="RFC6991" format="default"/></td> </tr> <tr> <td align="left">inet</td> <td align="left">ietf-inet-types</td> <td align="left"> <xref target="RFC6991" format="default"/></td> </tr> <tr> <td align="left">if</td> <td align="left">ietf-interfaces</td> <td align="left"> <xref target="RFC8343" format="default"/></td> </tr> <tr> <td align="left">rt</td> <td align="left">ietf-routing</td> <td align="left"> <xref target="RFC8349" format="default"/></td> </tr> <tr> <td align="left">rt-types</td> <td align="left">ietf-routing-types</td> <td align="left"> <xref target="RFC8294" format="default"/></td> </tr> <tr> <td align="left">bfd-types</td> <td align="left">ietf-bfd-types</td> <td align="left"> <xref target="RFC9314" format="default"/></td> </tr> </tbody> </table> </section> </section> <section numbered="true" toc="default"> <name>Design of DataModel">Model</name> <sectiontitle="Scopeanchor="scope" numbered="true" toc="default"> <name>Scope ofModel">Model</name> <t> The model covers PIM Sparse Mode <xreftarget="RFC7761"/>, includingtarget="RFC7761" format="default"/> (including the Source-Specific subset <xreftarget="RFC3569"/>target="RFC3569" format="default"/> <xreftarget="RFC4607"/>,target="RFC4607" format="default"/>), Dense Mode <xreftarget="RFC3973"/>,target="RFC3973" format="default"/>, andBi-directionalBidirectional PIM <xreftarget="RFC5015"/>.target="RFC5015" format="default"/>. </t> <t> The PIM extensions represented in the model includeBSRBSRs <xreftarget="RFC5059"/>target="RFC5059" format="default"/> andAnycast-RPAnycast-RPs <xreftarget="RFC4610"/>.target="RFC4610" format="default"/>. </t> <t> The data model can be used to configure and manage these protocol features. The operational state data and statistics can be retrieved by this model. Theprotocol specificprotocol-specific notifications are also defined in the model. </t> <t> This model does not cover other multicast protocols such as IGMP/MLD, MSDP, mVPN, or mLDP in-bandsignalling.signaling. It does not cover any configuration required to generate the MRIB. These will be specified in separate documents. </t> </section> <sectiontitle="Optional Capabilities">numbered="true" toc="default"> <name>Optional Capabilities</name> <t> This model is designed to represent the capabilities of devices supporting PIM with various specifications, including some with basic subsets of the PIM protocol. The main design goals of this document are that any majornow-existingcurrently existing implementation may be said to support the basemodel,model and that the configuration of all implementations meeting the specification is easy to express through some combination of the features in the base model and simple vendor augmentations. </t> <t> There is also value inwidely-supportedwidely supported features being standardized, to save work for individual vendors, and so that mapping between different vendors'configurationconfigurations is not needlessly complicated. Therefore, these modules declare a number of features representing capabilities that not all deployed devices support. </t> <t> The extensive use of feature declarations should also substantially simplify the capability negotiation process for a vendor's PIM implementation. </t> <t> On the other hand, operational state parameters are not so widely designated as features, as there are many cases where the defaulting of an operational state parameter would not cause any harm to the system, and it is much more likely that an implementation withoutnativeintrinsic support for a piece of operational state would be able to derive a suitable value for a state variable that is notnativelyintrinsically supported. </t> <t> For the same reason, wide constant ranges (for example, timer maxima and minima) are used in the model. It is expected that vendors will augment the model with any specific extensions and restrictions needed to adapt it to their vendor-specificimplementation.implementations. </t> </section> <sectiontitle="Datastore Applicability">numbered="true" toc="default"> <name>Datastore Applicability</name> <t> This model conforms to the Network Management Datastore Architecture (NMDA) <xreftarget="RFC8342"/>.target="RFC8342" format="default"/>. The operational state data is combined with the associated configuration data in the same hierarchy <xreftarget="I-D.ietf-netmod-rfc6087bis"/>.target="RFC8407" format="default"/>. </t> </section> <sectiontitle="Modulenumbered="true" toc="default"> <name>Module and HierarchyOrganization">Organization</name> <t> This model defines several separate modules formodellingmodeling PIMconfiguration, defined below.configuration. Again, this separation makes it easier to express the specific capabilities of a PIM device. The module organization, along with the usage of the YANG extensible features such as identity, allows the model to be easily augmented for new capabilities. </t> <t> The hierarchy of PIM configuration is designed so that objects that are only relevant for one situation or feature are collected in a container for that feature. For example,thea configuration for PIM-SM that is not relevant for an SSM-only implementation is collected in an ASM container. </t> <t> Where fields are not genuinely essential to protocol operation, they are marked as optional. Some fields are essential but have a default specified, so they need not be explicitly configured. </t> <t> This module structure also applies, where applicable, to the operational state and notifications of the model. </t> </section> <sectiontitle="Positionnumbered="true" toc="default"> <name>Position of Address Family inHierarchy">Hierarchy</name> <t> This document containsaddress-family"address-family" as a node in the hierarchy multiple times:bothunder both the interfacelist,list andunderthe PIM instance. </t> <t> The reasoning for this is to make it easier for implementations in which configuration options are not supported for specific address families. </t> <t> For these implementations, the restriction that interface configuration must be address-family independent mayeitherbe expressedaseither (1) as a vendor augmentation of an address-family-independent parameter above the address-familylevel,level orby(2) by a constraint on the base model objects of a form similarto:to the following: </t><figure><artwork> <![CDATA[<sourcecode type="yang"><![CDATA[ deviation "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:address-family" { deviate add { must "(address-family = 'rt:ipv4' and dr-priority = " + "../address-family[address-family = 'rt:ipv6']/" + "dr-priority) or " + "(address-family = 'rt:ipv6' and dr-priority = " + "../address-family[address-family = 'rt:ipv4']/" + "dr-priority)" { error-message "Error: The IPv6 DR priority must matchIPv4the " + "IPv4 DR priority."; error-app-tag "dr-priority-mismatch"; } } }]]> </artwork></figure>]]></sourcecode> </section> </section> <sectiontitle="Module Structure">numbered="true" toc="default"> <name>Module Structure</name> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM BaseModule">Module</name> <t> The PIM base module defines the base framework not specific to any PIMmode,mode and is imported by the other modules. The base module by itself does not provide sufficient data for any PIM mode to operate. Othermode specificmode-specific andfeature specificfeature-specific modules need to be implemented in addition to this module, depending on the feature set required by the implementation. </t> <t> This model augments the core routing data model "ietf-routing" specified in <xreftarget="RFC8349"/>.target="RFC8349" format="default"/>. The PIM base model augments"/rt:routing/rt:control-plane-protocols”"/rt:routing/rt:control-plane-protocols" as opposed to augmenting"/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol”,"/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol", as the latter would allow multiple protocol instances, while the PIM protocol is designed to be enabled or disabled as a single protocol instance on a network instance or a logical network element. </t> <sectiontitle="High-Level Structure">numbered="true" toc="default"> <name>High-Level Structure</name> <t> The high-level structure of the model is shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-base augment /rt:routing/rt:control-plane-protocols: +--rw pim! +--rw <global configuration> +--ro <global operational state> +--rw address-family* [address-family] | +--rw address-family identityref | +--rw<per address family<per-address-family configuration> | +--ro<per address family<per-address-family operational state> +--rw interfaces +--rw interface* [name] +--rw name if:interface-ref +--rw address-family* [address-family] +--rw address-family identityref +--rw <per interface configuration> +--ro <per interface operational state> +--ro neighbors +--ro ipv4-neighbor* [address] | +--ro address inet:ipv4-address | +--ro <IPv4per neighborper-neighbor operational state> +--ro ipv6-neighbor* [address] +--ro address inet:ipv6-address +--ro <IPv4per neighborper-neighbor operational state>]]> </artwork></figure>]]></sourcecode> <t> The presence of the top-level container "pim" enables the PIM protocols. </t> </section> <sectiontitle="Global Data">numbered="true" toc="default"> <name>Global Data</name> <t> The global configuration data and operational state datacovers thecover support for graceful restart in the PIM base model. Additional features can be added by augmentation if required by an implementation. </t> </section> <sectiontitle="Per Address Family Data">numbered="true" toc="default"> <name>Per-Address-Family Data</name> <t>The supportSupport forper address familyper-address-family data is shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw pim! +--rw address-family* [address-family] | +--rw address-family identityref | +--rw graceful-restart ... | +--ro statistics | | +--ro discontinuity-time? yang:date-and-time | | +--ro error | | | +--ro assert? yang:counter32 ... | | +--ro queue | | | +--ro size? uint32 | | | +--ro overflow? yang:counter32 | | +--ro received | | | +--ro assert? yang:counter32 ... | | +--ro sent | | +--ro assert? yang:counter32 ... | +--ro topology-tree-info | | +--ro ipv4-route* [group source-address is-rpt] | | | +--ro group | | | | rt-types:ipv4-multicast-group-address | | | +--ro source-address | | | | rt-types:ipv4-multicast-source-address | | | +--ro is-rpt boolean | | +--ro ipv6-route* [group source-address is-rpt] | | +--ro group | | | rt-types:ipv6-multicast-group-address | | +--ro source-address | | | rt-types:ipv6-multicast-source-address | | +--ro is-rpt boolean ... | | +--ro incoming-interface? if:interface-ref ... | | +--ro outgoing-interface* [name] | | +--ro name if:interface-ref | | +--ro expiration? rt-types:timer-value-seconds16 | | +--ro up-time? rt-types:timeticks64 | | +--ro jp-state? enumeration]]> </artwork></figure>]]></sourcecode> <t> This is the location that most of the PIM RP module (ietf-pim-rp) augments. Each of themode specificmode-specific modules also augments this schema tree. </t> </section> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM InterfaceModeling">Modeling</name> <t> The configuration data and operational state data of PIM interfacesisare modeled as shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw pim! +--rw interfaces +--rw interface* [name] +--rw name if:interface-ref +--rw address-family* [address-family] +--rw address-family identityref +--rw bfd {bfd}? ... +--rw dr-priority? uint32 {intf-dr-priority}? +--rw hello-interval? rt-types:timer-value-seconds16 | {intf-hello-interval}? +--rw (hello-holdtime-or-multiplier)? | +--:(holdtime) {intf-hello-holdtime}? | | +--rw hello-holdtime? | | rt-types:timer-value-seconds16 | +--:(multiplier) {intf-hello-multiplier}? | +--rw hello-multiplier? | rt-types:timer-multiplier +--rw jp-interval? rt-types:timer-value-seconds16 | {intf-jp-interval}? +--rw (jp-holdtime-or-multiplier)? | +--:(holdtime) {intf-jp-holdtime}? | | +--rw jp-holdtime? | | rt-types:timer-value-seconds16 | +--:(multiplier) {intf-jp-multiplier}? | +--rw jp-multiplier? | rt-types:timer-multiplier +--rw override-interval? uint16 | {intf-override-interval}? +--rw propagation-delay? uint16 | {intf-propagation-delay}? +--ro oper-status? enumeration +--ro gen-id? uint32 +--ro hello-expiration? rt-types:timer-value-seconds16 +--ro ipv4 | +--ro address* inet:ipv4-address | +--ro dr-address? inet:ipv4-address +--ro ipv6 | +--ro address* inet:ipv6-address | +--ro dr-address? inet:ipv6-address]]> </artwork></figure>]]></sourcecode> <t>The supportSupport forbfdBFD client configuration is achieved by using a grouping provided by an externalmodule ietf-bfd-types,module, "ietf-bfd-types", as defined in <xreftarget="I-D.ietf-bfd-yang"/>.target="RFC9314" format="default"/>. </t> </section> <sectiontitle="Neighbor Modeling">numbered="true" toc="default"> <name>Neighbor Modeling</name> <t> For each PIM interface, there can be a list ofneighbors, which containneighbors that contains operational statedata.data for each neighbor. To model such data, the following structure is specified: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw pim! +--rw interfaces +--rw interface* [name] +--rw address-family* [address-family] +--ro neighbors +--ro ipv4-neighbor* [address] | +--ro address inet:ipv4-address | +--ro bfd-status? enumeration | +--ro expiration? | | rt-types:timer-value-seconds16 | +--ro dr-priority? uint32 | +--ro gen-id? uint32 | +--ro lan-prune-delay | | +--ro present? boolean | | +--ro override-interval? uint16 | | +--ro propagation-delay? uint16 | | +--ro t-bit? boolean | +--ro up-time? rt-types:timeticks64 +--ro ipv6-neighbor* [address] +--ro address inet:ipv6-address +--ro bfd-status? enumeration +--ro expiration? | rt-types:timer-value-seconds16 +--ro dr-priority? uint32 +--ro gen-id? uint32 +--ro lan-prune-delay | +--ro present? boolean | +--ro override-interval? uint16 | +--ro propagation-delay? uint16 | +--ro t-bit? boolean +--ro up-time? rt-types:timeticks64]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="Notifications">numbered="true" toc="default"> <name>Notifications</name> <t> The PIM base module also defines the notifications for PIM interface and neighbor events, as shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ notifications: +---n pim-neighbor-event | +--ro event-type? neighbor-event-type | +--ro interface-ref? leafref | +--ro interface-af-ref? leafref | +--ro neighbor-ipv4-ref? leafref | +--ro neighbor-ipv6-ref? leafref | +--ro up-time? rt-types:timeticks64 +---n pim-interface-event +--ro event-type? interface-event-type +--ro interface-ref? leafref +--ro ipv4 | +--ro address* inet:ipv4-address | +--ro dr-address? inet:ipv4-address +--ro ipv6 +--ro address* inet:ipv6-address +--ro dr-address? inet:ipv6-address]]> </artwork></figure>]]></sourcecode> </section> </section> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM RPModule">Module</name> <t> The PIM RP module augments the PIM base module to define the configuration and operational state information scoped toRP relatedRP-related features: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-rp augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw rp +--rw static-rp ... +--rw bsr {bsr}? ... +--ro rp-list ... +--ro rp-mappings ...]]> </artwork></figure>]]></sourcecode> <t> This module is shared bythePIM-SMmodeandthe PIM-BIDIR mode,BIDIR-PIM mode but is not shared bythe PIM-DM mode.PIM-DM. The PIM-SM module andPIM-BIDIRthe BIDIR-PIM module augment this module to covermode specificmode-specific data. </t> <t> The following sections describe the features and capabilities covered in this module. </t> <sectiontitle="Static RP">numbered="true" toc="default"> <name>Static RPs</name> <t> Static RPs can be configured by using the following portion of the module: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw rp +--rw static-rp | +--rw ipv4-rp* [rp-address] | | +--rw rp-address inet:ipv4-address | +--rw ipv6-rp* [rp-address] | +--rw rp-address inet:ipv6-address]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="BSR">numbered="true" toc="default"> <name>BSRs</name> <t>The supportSupport forBSRBSRs includes both configuration data and operational state data, as shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw rp +--rw bsr {bsr}? | +--rw bsr-candidate! | | +--rw (interface-or-address)? | | | +--:(interface) {candidate-interface}? | | | | +--rw interface if:interface-ref | | | +--:(ipv4-address) {candidate-ipv4}? | | | | +--rw ipv4-address inet:ipv4-address | | | +--:(ipv6-address) {candidate-ipv6}? | | | +--rw ipv6-address inet:ipv6-address | | +--rw hash-mask-length uint8 | | +--rw priority? uint8 | +--rw rp-candidate | | +--rw interface* [name] {candidate-interface}? | | | +--rw name if:interface-ref | | | +--rw policy-name? string | | | +--rw mode? identityref | | +--rw ipv4-address* [address] {candidate-ipv4}? | | | +--rw address inet:ipv4-address | | | +--rw policy-name? string | | | +--rw mode? identityref | | +--rw ipv6-address* [address] {candidate-ipv6}? | | +--rw address inet:ipv6-address | | +--rw policy-name? string | | +--rw mode? identityref | +--ro bsr | | +--ro address? inet:ip-address | | +--ro hash-mask-length? uint8 | | +--ro priority? uint8 | | +--ro up-time? rt-types:timeticks64 | +--ro (election-state)? {bsr-election-state}? | | +--:(candidate) | | | +--ro candidate-bsr-state? enumeration | | +--:(non-candidate) | | +--ro non-candidate-bsr-state? enumeration | +--ro bsr-next-bootstrap? uint16 | +--ro rp | | +--ro rp-address? inet:ip-address | | +--ro policy-name? string | | +--ro up-time? rt-types:timeticks64 | +--ro rp-candidate-next-advertisement? uint16]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="RPnumbered="true" toc="default"> <name>RP StateData">Data</name> <t> This portion of the model provides the operational state information for all RPs on the router, including the statically configured RPs and theBSR electedBSR-elected RPs. </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw rp +--ro rp-list | +--ro ipv4-rp* [rp-address mode] | | +--ro rp-address inet:ipv4-address | | +--ro mode identityref | | +--ro info-source-address? inet:ipv4-address | | +--ro info-source-type? identityref | | +--ro up-time? rt-types:timeticks64 | | +--ro expiration? rt-types:timer-value-seconds16 | +--ro ipv6-rp* [rp-address mode] | +--ro rp-address inet:ipv6-address | +--ro mode identityref | +--ro info-source-address? inet:ipv6-address | +--ro info-source-type? identityref | +--ro up-time? rt-types:timeticks64 | +--ro expiration? rt-types:timer-value-seconds16]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="RP to Group Mappings">numbered="true" toc="default"> <name>RP-to-Group Mappings</name> <t> The operational state data of the mappings between RPs and multicast groups is modeled as follows: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ +--rw rp +--ro rp-mappings +--ro ipv4-rp* [group rp-address] | +--ro group inet:ipv4-prefix | +--ro rp-address inet:ipv4-address | +--ro up-time? rt-types:timeticks64 | +--ro expiration? rt-types:timer-value-seconds16 +--ro ipv6-rp* [group rp-address] +--ro group inet:ipv6-prefix +--ro rp-address inet:ipv6-address +--ro up-time? rt-types:timeticks64 +--ro expiration? rt-types:timer-value-seconds16]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="Notifications">numbered="true" toc="default"> <name>Notifications</name> <t> The PIM RP module also defines the notifications forRP relatedRP-related events, as shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ notifications: +---n pim-rp-event +--ro event-type? rp-event-type +--ro instance-af-ref? leafref +--ro group? rt-types:ip-multicast-group-address +--ro rp-address? inet:ip-address +--ro is-rpt? boolean +--ro mode? pim-base:pim-mode +--ro message-origin? inet:ip-address]]> </artwork></figure>]]></sourcecode> </section> </section> <sectiontitle="PIM-SM Module">numbered="true" toc="default"> <name>PIM-SM Module</name> <t> The PIM-SM module covers Sparse Mode modeling, includingPIM-ASMPIM Any-Source Multicast (PIM-ASM) andPIM-SSM.PIM Source-Specific Multicast (PIM-SSM). This module has dependencies on the PIM base module and the PIM RP module, both of which are augmented by this module. </t> <t> The augmentation to theaddress-family"address-family" branch of the PIM base module is shown below: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-sm augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw sm +--rw asm | +--rw anycast-rp! | | +--rw ipv4-anycast-rp* [anycast-address rp-address] | | | +--rw anycast-address inet:ipv4-address | | | +--rw rp-address inet:ipv4-address | | +--rw ipv6-anycast-rp* [anycast-address rp-address] | | +--rw anycast-address inet:ipv6-address | | +--rw rp-address inet:ipv6-address | +--rw spt-switch | +--rw infinity! {spt-switch-infinity}? | +--rw policy-name? string {spt-switch-policy}? +--rw ssm! +--rw range-policy? string]]> </artwork></figure>]]></sourcecode> <t> To supportSM modePIM-SM on an interface, this module augments theinterface"interface" branch of the PIM base module, as follows: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-sm augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:interfaces/pim-base:interface/pim-base:address-family: +--rw sm! +--rw passive? empty]]> </artwork></figure>]]></sourcecode> <t> This module also augments the PIM RP module to allow an RP to be configured inthe PIM-SM mode:PIM-SM: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-sm 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: +--rw sm! +--rw policy-name? string +--rw override? boolean {static-rp-override}? 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: +--rw sm! +--rw policy-name? string +--rw override? boolean {static-rp-override}?]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-DM Module">numbered="true" toc="default"> <name>PIM-DM Module</name> <t> The PIM-DM module covers Dense Mode modeling. This module augments the PIM base module, but it has no dependency on the PIM RP module. </t><figure><artwork><sourcecode type="yangtree"><![CDATA[ module: ietf-pim-dm augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw dm! augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:interfaces/pim-base:interface /pim-base:address-family: +--rw dm!</artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-BIDIR Module">numbered="true" toc="default"> <name>BIDIR-PIM Module</name> <t> ThePIM-BIDIRBIDIR-PIM module covers Bidirectional PIM modeling. Like PIM-SM, this module augments both the PIM base module and the PIM RP module. </t> <t> Thefollowings are theaugmentations to the PIM base module, on theaddress-family, the interface,"address-family", "interface", andthe neighbor branches:"neighbor" branches, are as follows: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-bidir augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw bidir! augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:interfaces/pim-base:interface/pim-base:address-family: +--rw bidir! +--rw df-election {intf-df-election}? +--rw offer-interval? uint16 +--rw backoff-interval? uint16 +--rw offer-multiplier? uint8 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: +--ro bidir-capable? boolean 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: +--ro bidir-capable? boolean]]> </artwork></figure>]]></sourcecode> <t> This module also augments the PIM RP module to extend the capabilities ofRPRPs forthe PIM-BIDIRBIDIR-PIM mode: </t><figure><artwork> <![CDATA[<sourcecode type="yangtree"><![CDATA[ module: ietf-pim-bidir 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: +--rw bidir! +--rw policy-name? string +--rw override? boolean {static-rp-override}? 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: +--rw bidir! +--rw policy-name? string +--rw override? boolean {static-rp-override}? augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family/pim-rp:rp: +--ro bidir +--ro df-election | +--ro ipv4-rp* [rp-address] | | +--ro rp-address inet:ipv4-address | +--ro ipv6-rp* [rp-address] | +--ro rp-address inet:ipv6-address +--ro interface-df-election +--ro ipv4-rp* [rp-address interface-name] | +--ro rp-address inet:ipv4-address | +--ro interface-name if:interface-ref | +--ro df-address? inet:ipv4-address | +--ro interface-state? identityref | +--ro up-time? rt-types:timeticks64 | +--ro winner-metric? uint32 | +--ro winner-metric-preference? uint32 +--ro ipv6-rp* [rp-address interface-name] +--ro rp-address inet:ipv6-address +--ro interface-name if:interface-ref +--ro df-address? inet:ipv6-address +--ro interface-state? identityref +--ro up-time? rt-types:timeticks64 +--ro winner-metric? uint32 +--ro winner-metric-preference? uint32]]> </artwork></figure>]]></sourcecode> </section> </section> <sectiontitle="Completenumbered="true" toc="default"> <name>Complete TreeStructure">Structure</name> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM BaseModule"> <figure><artwork>Module</name> <sourcecode type="yangtree"><![CDATA[ module: ietf-pim-base augment /rt:routing/rt:control-plane-protocols: +--rw pim! +--rw graceful-restart | +--rw enabled? boolean | +--rw duration? uint16 +--rw address-family* [address-family] | +--rw address-family identityref | +--rw graceful-restart | | +--rw enabled? boolean | | +--rw duration? uint16 | +--ro statistics | | +--ro discontinuity-time? yang:date-and-time | | +--ro error | | | +--ro assert? yang:counter64 | | | +--ro bsr? yang:counter64 | | | +--ro candidate-rp-advertisement? yang:counter64 | | | +--ro df-election? yang:counter64 | | | +--ro graft? yang:counter64 | | | +--ro graft-ack? yang:counter64 | | | +--ro hello? yang:counter64 | | | +--ro join-prune? yang:counter64 | | | +--ro register? yang:counter64 | | | +--ro register-stop? yang:counter64 | | | +--ro state-refresh? yang:counter64 | | | +--ro checksum? yang:counter64 | | | +--ro format? yang:counter64 | | +--ro queue | | | +--ro size? uint32 | | | +--ro overflow? yang:counter32 | | +--ro received | | | +--ro assert? yang:counter64 | | | +--ro bsr? yang:counter64 | | | +--ro candidate-rp-advertisement? yang:counter64 | | | +--ro df-election? yang:counter64 | | | +--ro graft? yang:counter64 | | | +--ro graft-ack? yang:counter64 | | | +--ro hello? yang:counter64 | | | +--ro join-prune? yang:counter64 | | | +--ro register? yang:counter64 | | | +--ro register-stop? yang:counter64 | | | +--ro state-refresh? yang:counter64 | | +--ro sent | | +--ro assert? yang:counter64 | | +--ro bsr? yang:counter64 | | +--ro candidate-rp-advertisement? yang:counter64 | | +--ro df-election? yang:counter64 | | +--ro graft? yang:counter64 | | +--ro graft-ack? yang:counter64 | | +--ro hello? yang:counter64 | | +--ro join-prune? yang:counter64 | | +--ro register? yang:counter64 | | +--ro register-stop? yang:counter64 | | +--ro state-refresh? yang:counter64 | +--ro topology-tree-info | +--ro ipv4-route* [group source-address is-rpt] | | +--ro group | | | rt-types:ipv4-multicast-group-address | | +--ro source-address | | | rt-types:ipv4-multicast-source-address | | +--ro is-rpt boolean | | +--ro expiration? | | | rt-types:timer-value-seconds16 | | +--ro incoming-interface? if:interface-ref | | +--ro is-spt? boolean | | +--ro mode? identityref | | +--ro msdp-learned? boolean | | +--ro rp-address? inet:ip-address | | +--ro rpf-neighbor? inet:ip-address | | +--ro up-time? rt-types:timeticks64 | | +--ro outgoing-interface* [name] | | +--ro name if:interface-ref | | +--ro expiration? rt-types:timer-value-seconds16 | | +--ro up-time? rt-types:timeticks64 | | +--ro jp-state? enumeration | +--ro ipv6-route* [group source-address is-rpt] | +--ro group | | rt-types:ipv6-multicast-group-address | +--ro source-address | | rt-types:ipv6-multicast-source-address | +--ro is-rpt boolean | +--ro expiration? | | rt-types:timer-value-seconds16 | +--ro incoming-interface? if:interface-ref | +--ro is-spt? boolean | +--ro mode? identityref | +--ro msdp-learned? boolean | +--ro rp-address? inet:ip-address | +--ro rpf-neighbor? inet:ip-address | +--ro up-time? rt-types:timeticks64 | +--ro outgoing-interface* [name] | +--ro name if:interface-ref | +--ro expiration? rt-types:timer-value-seconds16 | +--ro up-time? rt-types:timeticks64 | +--ro jp-state? enumeration +--rw interfaces +--rw interface* [name] +--rw name if:interface-ref +--rw address-family* [address-family] +--rw address-family identityref +--rw bfd {bfd}? | +--rwenable?enabled? boolean | +--rw local-multiplier? multiplier | +--rw (interval-config-type)? | +--:(tx-rx-intervals) | | +--rwdesired-min-tx-intervaldesired-min-tx-interval? uint32 | | +--rwrequired-min-rx-intervalrequired-min-rx-interval? uint32 | +--:(single-interval) | {single-minimum-interval}? | +--rwmin-intervalmin-interval? uint32 +--rw dr-priority? uint32 | {intf-dr-priority}? +--rw hello-interval? | rt-types:timer-value-seconds16 | {intf-hello-interval}? +--rw (hello-holdtime-or-multiplier)? | +--:(holdtime) {intf-hello-holdtime}? | | +--rw hello-holdtime? | | rt-types:timer-value-seconds16 | +--:(multiplier) {intf-hello-multiplier}? | +--rw hello-multiplier? | rt-types:timer-multiplier +--rw jp-interval? | rt-types:timer-value-seconds16 | {intf-jp-interval}? +--rw (jp-holdtime-or-multiplier)? | +--:(holdtime) {intf-jp-holdtime}? | | +--rw jp-holdtime? | | rt-types:timer-value-seconds16 | +--:(multiplier) {intf-jp-multiplier}? | +--rw jp-multiplier? | rt-types:timer-multiplier +--rw override-interval? uint16 | {intf-override-interval}? +--rw propagation-delay? uint16 | {intf-propagation-delay}? +--ro oper-status? enumeration +--ro gen-id? uint32 +--ro hello-expiration? | rt-types:timer-value-seconds16 +--ro ipv4 | +--ro address* inet:ipv4-address | +--ro dr-address? inet:ipv4-address +--ro ipv6 | +--ro address* inet:ipv6-address | +--ro dr-address? inet:ipv6-address +--ro neighbors +--ro ipv4-neighbor* [address] | +--ro address inet:ipv4-address | +--ro bfd-state? bfd-types:state | +--ro expiration? | | rt-types:timer-value-seconds16 | +--ro dr-priority? uint32 | +--ro gen-id? uint32 | +--ro lan-prune-delay | | +--ro present? boolean | | +--ro override-interval? uint16 | | +--ro propagation-delay? uint16 | | +--ro t-bit? boolean | +--ro up-time? rt-types:timeticks64 +--ro ipv6-neighbor* [address] +--ro address inet:ipv6-address +--ro bfd-state? bfd-types:state +--ro expiration? | rt-types:timer-value-seconds16 +--ro dr-priority? uint32 +--ro gen-id? uint32 +--ro lan-prune-delay | +--ro present? boolean | +--ro override-interval? uint16 | +--ro propagation-delay? uint16 | +--ro t-bit? boolean +--ro up-time? rt-types:timeticks64 notifications: +---n pim-neighbor-event | +--ro event-type? neighbor-event-type | +--ro interface-ref? leafref | +--ro interface-af-ref? leafref | +--ro neighbor-ipv4-ref? leafref | +--ro neighbor-ipv6-ref? leafref | +--ro up-time? rt-types:timeticks64 +---n pim-interface-event +--ro event-type? interface-event-type +--ro interface-ref? leafref +--ro ipv4 | +--ro address* inet:ipv4-address | +--ro dr-address? inet:ipv4-address +--ro ipv6 +--ro address* inet:ipv6-address +--ro dr-address? inet:ipv6-address</artwork></figure>]]></sourcecode> </section> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM RPModule"> <figure><artwork>Module</name> <sourcecode type="yangtree"><![CDATA[ module: ietf-pim-rp augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw rp +--rw static-rp | +--rw ipv4-rp* [rp-address] | | +--rw rp-address inet:ipv4-address | +--rw ipv6-rp* [rp-address] | +--rw rp-address inet:ipv6-address +--rw bsr {bsr}? | +--rw bsr-candidate! | | +--rw (interface-or-address)? | | | +--:(interface) {candidate-interface}? | | | | +--rw interface if:interface-ref | | | +--:(ipv4-address) {candidate-ipv4}? | | | | +--rw ipv4-address inet:ipv4-address | | | +--:(ipv6-address) {candidate-ipv6}? | | | +--rw ipv6-address inet:ipv6-address | | +--rw hash-mask-length uint8 | | +--rw priority? uint8 | +--rw rp-candidate | | +--rw interface* [name] {candidate-interface}? | | | +--rw name if:interface-ref | | | +--rw policy-name? string | | | +--rw mode? identityref | | +--rw ipv4-address* [address] {candidate-ipv4}? | | | +--rw address inet:ipv4-address | | | +--rw policy-name? string | | | +--rw mode? identityref | | +--rw ipv6-address* [address] {candidate-ipv6}? | | +--rw address inet:ipv6-address | | +--rw policy-name? string | | +--rw mode? identityref | +--ro bsr | | +--ro address? inet:ip-address | | +--ro hash-mask-length? uint8 | | +--ro priority? uint8 | | +--ro up-time? rt-types:timeticks64 | +--ro (election-state)? {bsr-election-state}? | | +--:(candidate) | | | +--ro candidate-bsr-state? enumeration | | +--:(non-candidate) | | +--ro non-candidate-bsr-state? enumeration | +--ro bsr-next-bootstrap? uint16 | +--ro rp | | +--ro rp-address? inet:ip-address | | +--ro policy-name? string | | +--ro up-time? rt-types:timeticks64 | +--ro rp-candidate-next-advertisement? uint16 +--ro rp-list | +--ro ipv4-rp* [rp-address mode] | | +--ro rp-address inet:ipv4-address | | +--ro mode identityref | | +--ro info-source-address? inet:ipv4-address | | +--ro info-source-type? identityref | | +--ro up-time? rt-types:timeticks64 | | +--ro expiration? | | rt-types:timer-value-seconds16 | +--ro ipv6-rp* [rp-address mode] | +--ro rp-address inet:ipv6-address | +--ro mode identityref | +--ro info-source-address? inet:ipv6-address | +--ro info-source-type? identityref | +--ro up-time? rt-types:timeticks64 | +--ro expiration? | rt-types:timer-value-seconds16 +--ro rp-mappings +--ro ipv4-rp* [group-range rp-address] | +--ro group-range inet:ipv4-prefix | +--ro rp-address inet:ipv4-address | +--ro up-time? rt-types:timeticks64 | +--ro expiration? rt-types:timer-value-seconds16 +--ro ipv6-rp* [group-range rp-address] +--ro group-range inet:ipv6-prefix +--ro rp-address inet:ipv6-address +--ro up-time? rt-types:timeticks64 +--ro expiration? rt-types:timer-value-seconds16 notifications: +---n pim-rp-event +--ro event-type? rp-event-type +--ro instance-af-ref? leafref +--ro group? rt-types:ip-multicast-group-address +--ro rp-address? inet:ip-address +--ro is-rpt? boolean +--ro mode? identityref +--ro message-origin? inet:ip-address</artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-SM Module"> <figure><artwork>numbered="true" toc="default"> <name>PIM-SM Module</name> <sourcecode type="yangtree"><![CDATA[ module: ietf-pim-sm augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw sm +--rw asm | +--rw anycast-rp! | | +--rw ipv4-anycast-rp* [anycast-address rp-address] | | | +--rw anycast-address inet:ipv4-address | | | +--rw rp-address inet:ipv4-address | | +--rw ipv6-anycast-rp* [anycast-address rp-address] | | +--rw anycast-address inet:ipv6-address | | +--rw rp-address inet:ipv6-address | +--rw spt-switch | +--rw infinity! {spt-switch-infinity}? | +--rw policy-name? string {spt-switch-policy}? +--rw ssm! +--rw range-policy? string augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:interfaces/pim-base:interface /pim-base:address-family: +--rw sm! +--rw passive? empty 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: +--rw sm! +--rw policy-name? string +--rw override? boolean {static-rp-override}? 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: +--rw sm! +--rw policy-name? string +--rw override? boolean {static-rp-override}?</artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-DM Module"> <figure><artwork>numbered="true" toc="default"> <name>PIM-DM Module</name> <sourcecode type="yangtree"><![CDATA[ module: ietf-pim-dm augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw dm! augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:interfaces/pim-base:interface /pim-base:address-family: +--rw dm!</artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-BIDIR Module"> <figure><artwork>numbered="true" toc="default"> <name>BIDIR-PIM Module</name> <sourcecode type="yangtree"><![CDATA[ module: ietf-pim-bidir augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family: +--rw bidir! augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:interfaces/pim-base:interface /pim-base:address-family: +--rw bidir! +--rw df-election {intf-df-election}? +--rw offer-interval? uint16 +--rw backoff-interval? uint16 +--rw offer-multiplier? uint8 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: +--rw bidir! +--rw policy-name? string +--rw override? boolean {static-rp-override}? 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: +--rw bidir! +--rw policy-name? string +--rw override? boolean {static-rp-override}? augment /rt:routing/rt:control-plane-protocols/pim-base:pim /pim-base:address-family/pim-rp:rp: +--ro bidir +--ro df-election | +--ro ipv4-rp* [rp-address] | | +--ro rp-address inet:ipv4-address | +--ro ipv6-rp* [rp-address] | +--ro rp-address inet:ipv6-address +--ro interface-df-election +--ro ipv4-rp* [rp-address interface-name] | +--ro rp-address inet:ipv4-address | +--ro interface-name if:interface-ref | +--ro df-address? inet:ipv4-address | +--ro interface-state? identityref | +--ro up-time? rt-types:timeticks64 | +--ro winner-metric? uint32 | +--ro winner-metric-preference? uint32 +--ro ipv6-rp* [rp-address interface-name] +--ro rp-address inet:ipv6-address +--ro interface-name if:interface-ref +--ro df-address? inet:ipv6-address +--ro interface-state? identityref +--ro up-time? rt-types:timeticks64 +--ro winner-metric? uint32 +--ro winner-metric-preference? uint32 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: +--ro bidir-capable? boolean 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: +--ro bidir-capable? boolean</artwork></figure>]]></sourcecode> </section> </section> <sectiontitle="Relationshipnumbered="true" toc="default"> <name>Relationship to thePIM-STD-MIB">PIM-STD-MIB</name> <t> The following sections describe the mappings between the objects in the PIM-STD-MIB defined in <xreftarget="RFC5060"/>target="RFC5060" format="default"/> and the YANG data nodes defined in this document. </t> <sectiontitle="pimInterfaceTable">numbered="true" toc="default"> <name>pimInterfaceTable</name> <t> pimInterfaceTable is mapped to pim/interfaces/interface. The key of pimInterfaceTable is pimInterfaceIfIndex and pimInterfaceIPVersion, while the key of the "interface" list in YANG is the node "name". For each value of pimInterfaceIPVersion, the "interface" list contains a corresponding sublist whose key is the node "address-family". </t> <t>The following table<xref target="table_yang_and_mib"/> lists the YANG data nodes with corresponding objects of pimInterfaceTable in the PIM-STD-MIB. </t><texttable anchor='table_yang_and_mib' title="YANG<table anchor="table_yang_and_mib" align="center"> <name>YANG Nodes and pimInterfaceTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>address-family</c> <c>pimInterfaceAddressType</c> <c>ipv4/address</c> <c>pimInterfaceAddress</c> <c>ipv6/address</c> <c></c> <c>gen-id</c> <c>pimInterfaceGenerationIDValue</c> <c>ipv4/dr-address</c> <c>pimInterfaceDR</c> <c>ipv6/dr-address</c> <c></c> <c>dr-priority</c> <c>pimInterfaceDRPriority</c> <c>hello-interval</c> <c>pimInterfaceHelloInterval</c> <c>hello-holdtime</c> <c>pimInterfaceHelloHoldtime</c> <c>jp-interval</c> <c>pimInterfaceJoinPruneInterval</c> <c>jp-holdtime</c> <c>pimInterfaceJoinPruneHoldtime</c> <c>bidir/offer-multiplier</c> <c>pimInterfaceDFElectionRobustness</c> <c>propagation-delay</c> <c>pimInterfacePropagationDelay</c> <c>override-interval</c> <c>pimInterfaceOverrideInterval</c> </texttable> </section> <section title="pimNeighborTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">address-family</td> <td align="left">pimInterfaceAddressType</td> </tr> <tr> <td align="left">ipv4/address</td> <td rowspan="2" align="left">pimInterfaceAddress</td> </tr> <tr> <td align="left">ipv6/address</td> </tr> <tr> <td align="left">gen-id</td> <td align="left">pimInterfaceGenerationIDValue</td> </tr> <tr> <td align="left">ipv4/dr-address</td> <td rowspan="2" align="left">pimInterfaceDR</td> </tr> <tr> <td align="left">ipv6/dr-address</td> </tr> <tr> <td align="left">dr-priority</td> <td align="left">pimInterfaceDRPriority</td> </tr> <tr> <td align="left">hello-interval</td> <td align="left">pimInterfaceHelloInterval</td> </tr> <tr> <td align="left">hello-holdtime</td> <td align="left">pimInterfaceHelloHoldtime</td> </tr> <tr> <td align="left">jp-interval</td> <td align="left">pimInterfaceJoinPruneInterval</td> </tr> <tr> <td align="left">jp-holdtime</td> <td align="left">pimInterfaceJoinPruneHoldtime</td> </tr> <tr> <td align="left">bidir/offer-multiplier</td> <td align="left">pimInterfaceDFElectionRobustness</td> </tr> <tr> <td align="left">propagation-delay</td> <td align="left">pimInterfacePropagationDelay</td> </tr> <tr> <td align="left">override-interval</td> <td align="left">pimInterfaceOverrideInterval</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimNeighborTable</name> <t> pimNeighborTable is mapped to pim/interfaces/interface/neighbors/ipv4-neighbor and pim/interfaces/interface/neighbors/ipv6-neighbor. </t> <t>The following table<xref target="table_mib_pimNeighborTable"/> lists the YANG data nodes with corresponding objects of pimNeighborTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimNeighborTable' title="YANG<table anchor="table_mib_pimNeighborTable" align="center"> <name>YANG Nodes and pimNeighborTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-neighbor</c> <c>pimNeighborAddressType</c> <c>ipv6-neighbor</c> <c></c> <c>address</c> <c>pimNeighborAddress</c> <c>gen-id</c> <c>pimNeighborGenerationIDValue</c> <c>up-time</c> <c>pimNeighborUpTime</c> <c>expiration</c> <c>pimNeighborExpiryTime</c> <c>dr-priority</c> <c>pimNeighborDRPriority</c> <c>lan-prune-delay/present</c> <c>pimNeighborLanPruneDelayPresent</c> <c>lan-prune-delay/t-bit</c> <c>pimNeighborTBit</c> <c>lan-prune-delay/</c> <c>pimNeighborPropagationDelay</c> <c>propagation-delay</c> <c></c> <c>lan-prune-delay/</c> <c>pimNeighborOverrideInterval</c> <c>override-interval</c> <c></c> <c>ietf-pim-bidir:bidir-capable</c> <c>pimNeighborBidirCapable</c> </texttable> </section> <section title="pimStarGTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-neighbor</td> <td rowspan="2" align="left">pimNeighborAddressType</td> </tr> <tr> <td align="left">ipv6-neighbor</td> </tr> <tr> <td align="left">address</td> <td align="left">pimNeighborAddress</td> </tr> <tr> <td align="left">gen-id</td> <td align="left">pimNeighborGenerationIDValue</td> </tr> <tr> <td align="left">up-time</td> <td align="left">pimNeighborUpTime</td> </tr> <tr> <td align="left">expiration</td> <td align="left">pimNeighborExpiryTime</td> </tr> <tr> <td align="left">dr-priority</td> <td align="left">pimNeighborDRPriority</td> </tr> <tr> <td align="left">lan-prune-delay/present</td> <td align="left">pimNeighborLanPruneDelayPresent</td> </tr> <tr> <td align="left">lan-prune-delay/t-bit</td> <td align="left">pimNeighborTBit</td> </tr> <tr> <td align="left">lan-prune-delay/propagation-delay</td> <td align="left">pimNeighborPropagationDelay</td> </tr> <tr> <td align="left">lan-prune-delay/override-interval</td> <td align="left">pimNeighborOverrideInterval</td> </tr> <tr> <td align="left">ietf-pim-bidir:bidir-capable</td> <td align="left">pimNeighborBidirCapable</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimStarGTable</name> <t> pimStarGTable is mapped to pim/address-family/topology-tree-info/ipv4-route and pim/address-family/topology-tree-info/ipv6-route, when the value ofsource-addressthe "source-address" leaf is "ietf-routing-types:*" and the value ofis-rptthe "is-rpt" leaf is "false". </t> <t>The following table<xref target="table_mib_pimStarGTable"/> lists the YANG data nodes with corresponding objects of pimStarGTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimStarGTable' title="YANG<table anchor="table_mib_pimStarGTable" align="center"> <name>YANG Nodes and pimStarGTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-route</c> <c>pimStarGAddressType</c> <c>ipv6-route</c> <c></c> <c>group</c> <c>pimStarGGrpAddress</c> <c>up-time</c> <c>pimStarGUpTime</c> <c>mode</c> <c>pimStarGPimMode</c> <c>rp-address</c> <c>pimStarGRPAddressType</c> <c>rp-address</c> <c>pimStarGRPAddress</c> <c>rpf-neighbor</c> <c>pimStarGUpstreamNeighborType</c> <c>rpf-neighbor</c> <c>pimStarGUpstreamNeighbor</c> <c>incoming-interface</c> <c>pimStarGRPFIfIndex</c> </texttable>Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-route</td> <td rowspan="2" align="left">pimStarGAddressType</td> </tr> <tr> <td align="left">ipv6-route</td> </tr> <tr> <td align="left">group</td> <td align="left">pimStarGGrpAddress</td> </tr> <tr> <td align="left">up-time</td> <td align="left">pimStarGUpTime</td> </tr> <tr> <td align="left">mode</td> <td align="left">pimStarGPimMode</td> </tr> <tr> <td rowspan="2" align="left">rp-address</td> <td align="left">pimStarGRPAddressType</td> </tr> <tr> <td align="left">pimStarGRPAddress</td> </tr> <tr> <td rowspan="2" align="left">rpf-neighbor</td> <td align="left">pimStarGUpstreamNeighborType</td> </tr> <tr> <td align="left">pimStarGUpstreamNeighbor</td> </tr> <tr> <td align="left">incoming-interface</td> <td align="left">pimStarGRPFIfIndex</td> </tr> </tbody> </table> <t> Inaddtion,addition, the objectpimStarGPimModeOrigin"pimStarGPimModeOrigin" in pimStarGTable is mapped to the noderp/rp-list/ipv4-rp/info-source-type"rp/rp-list/ipv4-rp/info-source-type" or the noderp/rp-list/ipv6-rp/info-source-type"rp/rp-list/ipv6-rp/info-source-type" in the YANG moduleietf-pim-rp."ietf&nbhy;pim&nbhy;rp". </t> </section> <sectiontitle="pimSGTable">numbered="true" toc="default"> <name>pimSGTable</name> <t> pimSGTable is mapped to pim/address-family/topology-tree-info/ipv4-route and pim/address-family/topology-tree-info/ipv6-route, when the value ofsource-addressthe "source-address" leaf is not "ietf-routing-types:*" and the value ofis-rptthe "is-rpt" leaf is "false". </t> <t>The following table<xref target="table_mib_pimSGTable"/> lists the YANG data nodes with corresponding objects of pimSGTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimSGTable' title="YANG<table anchor="table_mib_pimSGTable" align="center"> <name>YANG Nodes and pimSGTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-route</c> <c>pimSGAddressType</c> <c>ipv6-route</c> <c></c> <c>group</c> <c>pimSGGrpAddress</c> <c>source-address</c> <c>pimSGSrcAddress</c> <c>up-time</c> <c>pimSGUpTime</c> <c>mode</c> <c>pimSGPimMode</c> <c>rpf-neighbor</c> <c>pimStarGUpstreamNeighbor</c> <c>incoming-interface</c> <c>pimStarGRPFIfIndex</c> <c>is-spt</c> <c>pimSGSPTBit</c> <c>expiration</c> <c>pimSGKeepaliveTimer</c> </texttable> </section> <section title="pimSGRptTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-route</td> <td rowspan="2" align="left">pimSGAddressType</td> </tr> <tr> <td align="left">ipv6-route</td> </tr> <tr> <td align="left">group</td> <td align="left">pimSGGrpAddress</td> </tr> <tr> <td align="left">source-address</td> <td align="left">pimSGSrcAddress</td> </tr> <tr> <td align="left">up-time</td> <td align="left">pimSGUpTime</td> </tr> <tr> <td align="left">mode</td> <td align="left">pimSGPimMode</td> </tr> <tr> <td align="left">rpf-neighbor</td> <td align="left">pimStarGUpstreamNeighbor</td> </tr> <tr> <td align="left">incoming-interface</td> <td align="left">pimStarGRPFIfIndex</td> </tr> <tr> <td align="left">is-spt</td> <td align="left">pimSGSPTBit</td> </tr> <tr> <td align="left">expiration</td> <td align="left">pimSGKeepaliveTimer</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimSGRptTable</name> <t> pimSGRptTable is mapped to pim/address-family/topology-tree-info/ipv4-route and pim/address-family/topology-tree-info/ipv6-route, when the value ofis-rptthe "is-rpt" leaf is "true". </t> <t>The following table<xref target="table_mib_pimSGRptTable"/> lists the YANG data nodes with corresponding objects of pimSGRptTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimSGRptTable' title="YANG<table anchor="table_mib_pimSGRptTable" align="center"> <name>YANG Nodes and pimSGRptTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-route</c> <c>pimStarGAddressType</c> <c>ipv6-route</c> <c></c> <c>group</c> <c>pimStarGGrpAddress</c> <c>source-address</c> <c>pimSGRptSrcAddress</c> <c>up-time</c> <c>pimSGRptUpTime</c> </texttable> </section> <section title="pimBidirDFElectionTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-route</td> <td rowspan="2" align="left">pimStarGAddressType</td> </tr> <tr> <td align="left">ipv6-route</td> </tr> <tr> <td align="left">group</td> <td align="left">pimStarGGrpAddress</td> </tr> <tr> <td align="left">source-address</td> <td align="left">pimSGRptSrcAddress</td> </tr> <tr> <td align="left">up-time</td> <td align="left">pimSGRptUpTime</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimBidirDFElectionTable</name> <t> pimBidirDFElectionTable is mapped to pim/address-family/rp/bidir/interface-df-election/ipv4-rp and pim/address-family/rp/bidir/interface-df-election/ipv6-rp. The key of pimBidirDFElectionTable includespimBidirDFElectionIfIndexpimBidirDFElectionIfIndex, whose type is InterfaceIndex, while the YANG lists use a node "name" with the type string instead. </t> <t>The following table<xref target="table_mib_pimBidirDFElectionTable"/> lists the YANG data nodes with corresponding objects of pimBidirDFElectionTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimBidirDFElectionTable' title="YANG<table anchor="table_mib_pimBidirDFElectionTable" align="center"> <name>YANG Nodes and pimBidirDFElectionTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-rp</c> <c>pimBidirDFElectionAddressType</c> <c>ipv6-rp</c> <c></c> <c>rp-address</c> <c>pimBidirDFElectionRPAddress</c> <c>df-address</c> <c>pimBidirDFElectionWinnerAddressType</c> <c></c> <c>pimBidirDFElectionWinnerAddress</c> <c>up-time</c> <c>pimBidirDFElectionWinnerUpTime</c> <c>winner-metric-preference</c> <c>pimBidirDFElectionWinnerMetricPref</c> <c>winner-metric-preference</c> <c>pimBidirDFElectionWinnerMetric</c> <c>interface-state</c> <c>pimBidirDFElectionState</c> </texttable> </section> <section title="pimStaticRPTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-rp</td> <td rowspan="2" align="left">pimBidirDFElectionAddressType</td> </tr> <tr> <td align="left">ipv6-rp</td> </tr> <tr> <td align="left">rp-address</td> <td align="left">pimBidirDFElectionRPAddress</td> </tr> <tr> <td rowspan="2" align="left">df-address</td> <td align="left">pimBidirDFElectionWinnerAddressType</td> </tr> <tr> <td align="left">pimBidirDFElectionWinnerAddress</td> </tr> <tr> <td align="left">up-time</td> <td align="left">pimBidirDFElectionWinnerUpTime</td> </tr> <tr> <td rowspan="2" align="left">winner-metric-preference</td> <td align="left">pimBidirDFElectionWinnerMetricPref</td> </tr> <tr> <td align="left">pimBidirDFElectionWinnerMetric</td> </tr> <tr> <td align="left">interface-state</td> <td align="left">pimBidirDFElectionState</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimStaticRPTable</name> <t> pimStaticRPTable is mapped to pim/address-family/rp/static-rp/ipv4-rp and pim/address-family/rp/static-rp/ipv6-rp. </t> <t>The following table<xref target="table_mib_pimStaticRPTable"/> lists the YANG data nodes with corresponding objects of pimStaticRPTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimStaticRPTable' title="YANG<table anchor="table_mib_pimStaticRPTable" align="center"> <name>YANG Nodes and pimStaticRPTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-rp</c> <c>pimStaticRPAddressType</c> <c>ipv6-rp</c> <c></c> <c>rp-address</c> <c>pimStaticRPRPAddress</c> <c>bidir</c> <c>pimStaticRPPimMode</c> <c>sm</c> <c></c> <c>bidir/override</c> <c>pimStaticRPOverrideDynamic</c> <c>sm/override</c> <c></c> </texttable> </section> <section title="pimAnycastRPSetTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-rp</td> <td rowspan="2" align="left">pimStaticRPAddressType</td> </tr> <tr> <td align="left">ipv6-rp</td> </tr> <tr> <td align="left">rp-address</td> <td align="left">pimStaticRPRPAddress</td> </tr> <tr> <td align="left">bidir</td> <td rowspan="2" align="left">pimStaticRPPimMode</td> </tr> <tr> <td align="left">sm</td> </tr> <tr> <td align="left">bidir/override</td> <td rowspan="2" align="left">pimStaticRPOverrideDynamic</td> </tr> <tr> <td align="left">sm/override</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimAnycastRPSetTable</name> <t> pimAnycastRPSetTable is mapped to pim/address-family/sm/asm/anycast-rp/ipv4-anycast-rp and pim/address-family/sm/asm/anycast-rp/ipv6-anycast-rp. </t> <t>The following table<xref target="table_mib_pimAnycastRPSetTable"/> lists the YANG data nodes with corresponding objects of pimAnycastRPSetTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimAnycastRPSetTable' title="YANG<table anchor="table_mib_pimAnycastRPSetTable" align="center"> <name>YANG Nodes and pimAnycastRPSetTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-anycast-rp</c> <c>pimAnycastRPSetAddressType</c> <c>ipv6-anycast-rp</c> <c></c> <c>anycast-address</c> <c>pimAnycastRPSetAnycastAddress</c> <c>rp-address</c> <c>pimAnycastRPSetRouterAddress</c> </texttable> </section> <section title="pimGroupMappingTable">Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-anycast-rp</td> <td rowspan="2" align="left">pimAnycastRPSetAddressType</td> </tr> <tr> <td align="left">ipv6-anycast-rp</td> </tr> <tr> <td align="left">anycast-address</td> <td align="left">pimAnycastRPSetAnycastAddress</td> </tr> <tr> <td align="left">rp-address</td> <td align="left">pimAnycastRPSetRouterAddress</td> </tr> </tbody> </table> </section> <section numbered="true" toc="default"> <name>pimGroupMappingTable</name> <t> pimGroupMappingTable is mapped to pim/address-family/rp/rp-mappings/ipv4-rp and pim/address-family/rp/rp-mappings/ipv6-rp. </t> <t>The following table<xref target="table_mib_pimGroupMappingTable"/> lists the YANG data nodes with corresponding objects of pimGroupMappingTable in the PIM-STD-MIB. </t><texttable anchor='table_mib_pimGroupMappingTable' title="YANG<table anchor="table_mib_pimGroupMappingTable" align="center"> <name>YANG Nodes and pimGroupMappingTableObjects"> <ttcol>YANG node</ttcol> <ttcol>PIM-STD-MIB object</ttcol> <c>ipv4-rp</c> <c>pimGroupMappingAddressType</c> <c>ipv6-rp</c> <c></c> <c>group</c> <c>pimGroupMappingGrpAddress</c> <c></c> <c>pimGroupMappingGrpPrefixLength</c> <c>ipv4-rp</c> <c>pimGroupMappingRPAddressType</c> <c>ipv6-rp</c> <c></c> <c>rp-address</c> <c>pimGroupMappingRPAddress</c> <c></c> <c>pimGroupMappingPimMode</c> </texttable>Objects</name> <thead> <tr> <th align="left">YANG Node</th> <th align="left">PIM-STD-MIB Object</th> </tr> </thead> <tbody> <tr> <td align="left">ipv4-rp</td> <td rowspan="2" align="left">pimGroupMappingAddressType</td> </tr> <tr> <td align="left">ipv6-rp</td> </tr> <tr> <td rowspan="2" align="left">group</td> <td align="left">pimGroupMappingGrpAddress</td> </tr> <tr> <td align="left">pimGroupMappingGrpPrefixLength</td> </tr> <tr> <td align="left">ipv4-rp</td> <td rowspan="2" align="left">pimGroupMappingRPAddressType</td> </tr> <tr> <td align="left">ipv6-rp</td> </tr> <tr> <td rowspan="2" align="left">rp-address</td> <td align="left">pimGroupMappingRPAddress</td> </tr> <tr> <td align="left">pimGroupMappingPimMode</td> </tr> </tbody> </table> <t> Inaddtion,addition, the objectpimGroupMappingPimMode"pimGroupMappingPimMode" in pimGroupMappingTable is mapped to the noderp/rp-list/ipv4-rp/mode"rp/rp-list/ipv4-rp/mode" or the noderp/rp-list/ipv6-rp/mode"rp/rp-list/ipv6-rp/mode" in the YANG moduleietf-pim-rp."ietf&nbhy;pim&nbhy;rp". </t> </section> </section> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM YANGModules">Modules</name> <sectiontitle="PIM base module">numbered="true" toc="default"> <name>PIM Base Module</name> <t> This module references <xreftarget="RFC3973"/>,target="RFC3973" format="default"/>, <xref target="RFC5015" format="default"/>, <xref target="RFC5880" format="default"/>, <xreftarget="RFC5015"/>,target="RFC6991"/>, <xreftarget="RFC5306"/>,target="RFC7761" format="default"/>, <xreftarget="RFC5880"/>,target="RFC8294"/>, <xref target="RFC8343"/>, <xref target="RFC8349"/>, <xref target="RFC8706" format="default"/>, and <xreftarget="RFC7761"/>.target="RFC9314"/>. </t><figure><artwork> <![CDATA[ <CODE BEGINS> file "ietf-pim-base@2018-04-16.yang"<sourcecode name="ietf-pim-base@2021-09-03.yang" type="yang" markers="true"><![CDATA[ module ietf-pim-base { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-pim-base"; prefix pim-base; import ietf-inet-types { prefix"inet";inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-yang-types { prefix"yang";yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-routing-types { prefix"rt-types";rt-types; reference "RFC 8294: Common YANG Data Types for the Routing Area"; } import ietf-interfaces { prefix"if";if; reference "RFC 8343: A YANG Data Model for Interface Management"; } import ietf-routing { prefix"rt";rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-bfd-types { prefix"bfd-types";bfd-types; reference "RFC 9314: YANG Data Model for Bidirectional Forwarding Detection (BFD)"; } organization "IETF PIM Working Group"; contact "WG Web:<http://tools.ietf.org/wg/pim/><https://datatracker.ietf.org/wg/pim/> WG List: <mailto:pim@ietf.org> Editor: Xufeng Liu <mailto:xufeng.liu.ietf@gmail.com> Editor: Pete McAllister <mailto:pete.mcallister@metaswitch.com> Editor: Anish Peter <mailto:anish.ietf@gmail.com> Editor: Mahesh Sivakumar <mailto:sivakumar.mahesh@gmail.com> Editor: Yisong Liu<mailto:liuyisong@huawei.com><mailto:liuyisong@chinamobile.com> Editor: Fangwei Hu<mailto:hu.fangwei@zte.com.cn>";<mailto:hufwei@gmail.com>"; description"The"This module defines a collection of YANG definitions common for all PIM (Protocol Independent Multicast) modes. Copyright (c)20182022 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, theSimplifiedRevised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents(http://trustee.ietf.org/license-info).(https://trustee.ietf.org/license-info). This version of this YANG module is part of RFCXXXX;9128; see the RFC itself for full legal notices."; revision2018-04-162021-09-03 { description "Initial revision."; reference "RFCXXXX:9128: A YANG Data Model forPIM";Protocol Independent Multicast (PIM)"; } /* * Features */ feature bfd { description"Support"Supports BFD (Bidirectional Forwarding Detection)."; reference"RFC5880:"RFC 5880: Bidirectional Forwarding Detection (BFD)"; } feature global-graceful-restart { description "Global configuration for graceful restart support as perRFC5306.";RFC 8706."; reference "RFC 8706: Restart Signaling for IS-IS"; } feature intf-dr-priority { description"Support"Supports configuration of an interface DR (Designated Router) priority."; reference"RFC7761:"RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.3.2.";(Revised), Section 4.3.2"; } feature intf-hello-holdtime { description"Support"Supports configuration of the interfacehello holdtime.";Hello Holdtime."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.3.3. RFC7761:(Revised), Section 4.3.3 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature intf-hello-interval { description"Support"Supports configuration of the interfacehelloHello interval."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.8. RFC7761:(Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature intf-hello-multiplier { description"Support"Supports configuration of the interfacehello multiplier.";Hello multiplier (the number by which the Hello interval is multiplied to obtain the Hello Holdtime)."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.8. RFC7761:(Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature intf-jp-interval { description"Support"Supports configuration of the interfacejoin pruneJoin/Prune interval."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.8. RFC7761:(Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature intf-jp-holdtime { description"Support"Supports configuration of the interfacejoin prune holdtime.";Join/Prune Holdtime."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.8. RFC7761:(Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature intf-jp-multiplier { description"Support"Supports configuration of the interfacejoin prune multiplier.";Join/Prune multiplier (the number by which the Join/Prune interval is multiplied to obtain the Join/Prune Holdtime)."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.8. RFC7761:(Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature intf-propagation-delay { description"Support"Supports configuration of interface propagation delay."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.3.5. RFC7761:(Revised), Section 4.3.5 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.3.3.";(Revised), Section 4.3.3"; } feature intf-override-interval { description"Support"Supports configuration of the interface override interval."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.3.3. RFC5015:(Revised), Sections 4.1.1 and 4.8 RFC 5015: Bidirectional Protocol Independent Multicast(BIDIR-PIM). Sec. 3.6. RFC7761:(BIDIR-PIM), Section 3.6 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } feature per-af-graceful-restart { description "Per address family configuration for graceful restart support as perRFC5306.";RFC 8706."; reference "RFC 8706: Restart Signaling for IS-IS"; } /* * Typedefs */ typedef interface-event-type { type enumeration { enum up { description "Neighbor status changed toup.";'up'."; } enum down { description "Neighbor status changed todown.";'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 toup.";'up'."; } enum down { description "Neighbor status changed todown.";'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 "PIMoperatesis operating intheBidirectional Mode."; } identity pim-dm { base pim-mode; description "PIMoperatesis operating intheDense Mode (DM)."; } identity pim-sm { base pim-mode; description "PIMoperatesis operating intheSparse Mode (SM)."; } identity pim-asm { base pim-sm; description "PIMoperatesis operating intheSparse Mode withAny SourceAny-Source Multicast (ASM)."; } identity pim-ssm { base pim-sm; description "PIMoperatesis operating intheSparse 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; defaultfalse;"false"; description"Enable"Enables ordisabledisables graceful restart."; } leaf duration { type uint16; unitsseconds;"seconds"; default60;"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' ifSPTthe SPTbit (Shortest PathTree) bitTree bit) is set to indicate that forwarding is taking place on the (S,G)Shortest Path Tree (SPT).";SPT."; reference"RFC7761:"RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.1.3.";(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(Multicast(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"Expiring"Expiration time."; } leaf up-time { type rt-types:timeticks64; description "The number of time ticks (hundredths of a second) since theoper-status'oper-status' setting of the interface was last changed to 'up'."; } leaf jp-state { type enumeration { enum"no-info"no-info { description "The interface has no (*,G) Join state and no timers running."; } enum"join"join { description "The interface has Join state."; } enum"prune-pending"prune-pending { description "The router has received a Prune on this interface from a downstream neighbor and is waiting to see whether theprunePrune will be overridden by another downstream router. For forwarding purposes, the Prune-Pending state functions exactly like the Join state."; } } description"Join-prune"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 "Neighborexpiringexpiration 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 whenthe leaf present'leaf present' is 'true'."; } type uint16; unitsmilliseconds;"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 whenthe leaf present'leaf present' is 'true'."; } type uint16; unitsmilliseconds;"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 whenthe leaf present'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'scapabilityability 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 withoutbeeingbeing 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"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.7.1. RFC5015:(Revised), Section 4.7.1 RFC 5015: Bidirectional Protocol Independent Multicast(BIDIR-PIM). Sec. 3.7. RFC7761:(BIDIR-PIM), Section 3.7 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.9.";(Revised), Section 4.9"; leaf assert { type yang:counter64; description "The number of Assert messages, with the message Type of 5in RFC3973(RFCs 3973 andRFC7761.";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 4in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf candidate-rp-advertisement { type yang:counter64; description "The number of Candidate RP Advertisement messages, with the message Type of 8in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf df-election { type yang:counter64; description "The number of DF (Designated Forwarder)Electionelection messages, with the message Type of 10in RFC5015.";(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 6in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf graft-ack { type yang:counter64; description "The number of Graft-Ack messages, with the message Type of 7in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf hello { type yang:counter64; description "The number of Hello messages, with the message Type of 0in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf join-prune { type yang:counter64; description "The number of Join/Prune messages, with the message Type of 3in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf register { type yang:counter64; description "The number of Register messages, with the message Type of 1in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf register-stop { type yang:counter64; description "The number ofRegister StopRegister-Stop messages, with the message Type of 2in RFC3973(RFCs 3973 andRFC7761.";7761)."; } leaf state-refresh { type yang:counter64; description "The number of State Refresh messages, with the message Type of 9in RFC3973.";(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-featureglobal-graceful-restart;"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-featureper-af-graceful-restart;"per-af-graceful-restart"; } container statistics { config false; description "A container defining statistics attributes."; leaf discontinuity-time { type yang:date-and-time; description "The timeonof the most recent occasion at which any one or more of thestatisticstatistics counters suffered a discontinuity. If no such discontinuities have occurred since the lastre-initializationreinitialization of the local management subsystem, then this node contains the time the local management subsystemre-initializedreinitialized itself."; } container error { description"Containing"Contains error statistics."; uses statistics-sent-received { description"Statistic"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, includingtheerrorssuch asrelated to PIM Version, Type, and message length."; } } container queue { description"Containing"Contains queue statistics."; leaf size { type uint32; description "The size of the input queue."; } leaf overflow { type yang:counter32; description "The number oftheinput queue overflows."; } } container received { description"Containing"Contains statistics of received messages."; uses statistics-sent-received; } container sent { description"Containing"Contains statistics of sent messages."; uses statistics-sent-received; } } container topology-tree-info { config false; description"Containing"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(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 isRPT (Rendezvous-Point Tree).";an RPT."; } uses multicast-route-attributes; } // ipv6-route } // topology-tree-info } // address-family container interfaces { description"Containing"Contains a list of interfaces."; list interface { key "name"; description "List ofpimPIM 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-featurebfd;"bfd"; description "BFD (Bidirectional Forwarding Detection) operation."; uses bfd-types:client-cfg-parms; } leaf dr-priority { if-featureintf-dr-priority;"intf-dr-priority"; type uint32; default1;"1"; description "DR (Designated Router) priority as the preference in the DR election process."; } leaf hello-interval { if-featureintf-hello-interval;"intf-hello-interval"; type rt-types:timer-value-seconds16; default30;"30"; description "Periodic interval for Hello messages. If 'infinity' or 'not-set' is used, no periodic Hello messages are sent."; reference"RFC3973:"RFC 3973: Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification(Revised). Sec. 4.8. RFC7761:(Revised), Section 4.8 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.11.";(Revised), Section 4.11"; } choice hello-holdtime-or-multiplier { description"Holdtime"The Holdtime is the timer value to time out the neighbor state when the timer expires. TheholdtimeHoldtime value can be specifiedeitherby either (1) the givenholdtimeHoldtime value orby(2) the calculation of thehello-intervalHello interval multiplied by the given value of the multiplier."; case holdtime { if-featureintf-hello-holdtime;"intf-hello-holdtime"; leaf hello-holdtime { type rt-types:timer-value-seconds16; default105;"105"; description"Hello holdtime"The Hello Holdtime is the amount of time to keep the neighbor reachable until a new Hello message is received."; } } case multiplier { if-featureintf-hello-multiplier;"intf-hello-multiplier"; leaf hello-multiplier { type rt-types:timer-multiplier; default3;"3"; description"Hello"The Hello multiplier is the number by which thehelloHello interval ismultpliedmultiplied to obtain the Helloholdtime.Holdtime. The value of the HelloholdtimeHoldtime is calculated as: hello-holdtime = (multiplier + 0.5) *(hello-interval)";(hello-interval)."; } } } leaf jp-interval { if-featureintf-jp-interval;"intf-jp-interval"; type rt-types:timer-value-seconds16; default60;"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"Join/Prune holdtime"The Join/Prune Holdtime is the amount of time a receiver must keep the Join/Prune state alive. TheholdtimeHoldtime value can be specifiedeitherby either (1) the givenholdtimeHoldtime value orby(2) the calculation ofthe jp-interval'jp-interval' multiplied by the given value of the multiplier."; case holdtime { if-featureintf-jp-holdtime;"intf-jp-holdtime"; leaf jp-holdtime { type rt-types:timer-value-seconds16; default210;"210"; description"Join/Prune holdtime"The Join/Prune Holdtime is the amount of time a receiver must keep the Join/Prune state alive."; } } case multiplier { if-featureintf-jp-multiplier;"intf-jp-multiplier"; leaf jp-multiplier { type rt-types:timer-multiplier; default3;"3"; description"Join prune"The Join/Prune multiplier is the number by which thejoin pruneJoin/Prune interval ismultpliedmultiplied to obtain the Join/Pruneholdtime.Holdtime. The value of the Join/PruneholdtimeHoldtime is calculated as: jp-holdtime = (multiplier + 0.5) *(jp-interval)";(jp-interval)."; } } } leaf override-interval { if-featureintf-override-interval;"intf-override-interval"; type uint16; unitsmilliseconds;"milliseconds"; default2500;"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-featureintf-propagation-delay;"intf-propagation-delay"; type uint16; unitsmilliseconds;"milliseconds"; default500;"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 insertininto 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(Designated Router)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 withoutbeeingbeing 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"Containing"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"Containing"Contains IPv6 information."; leaf-list address { type inet:ipv6-address; description "List of addresses."; } leaf dr-address { type inet:ipv6-address; description "DR(Designated Router)address."; } } } }<CODE ENDS> ]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="PIMnumbered="true" toc="default"> <name>PIM RPModule">Module</name> <t> This module references <xreftarget="RFC5059"/>target="RFC5059" format="default"/>, <xref target="RFC6991"/>, <xref target="RFC7761" format="default"/>, <xref target="RFC8294"/>, <xref target="RFC8343"/>, and <xreftarget="RFC7761"/>.target="RFC8349"/>. </t><figure><artwork> <![CDATA[ <CODE BEGINS> file "ietf-pim-rp@2018-04-16.yang"<sourcecode name="ietf-pim-rp@2021-09-03.yang" type="yang" markers="true"><![CDATA[ module ietf-pim-rp { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-pim-rp"; prefix pim-rp; import ietf-inet-types { prefix"inet";inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-routing-types { prefix"rt-types";rt-types; reference "RFC 8294: Common YANG Data Types for the Routing Area"; } import ietf-interfaces { prefix"if";if; reference "RFC 8343: A YANG Data Model for Interface Management"; } import ietf-routing { prefix"rt";rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-pim-base { prefix"pim-base";pim-base; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } organization "IETF PIM Working Group"; contact "WG Web:<http://tools.ietf.org/wg/pim/><https://datatracker.ietf.org/wg/pim/> WG List: <mailto:pim@ietf.org> Editor: Xufeng Liu <mailto:xufeng.liu.ietf@gmail.com> Editor: Pete McAllister <mailto:pete.mcallister@metaswitch.com> Editor: Anish Peter <mailto:anish.ietf@gmail.com> Editor: Mahesh Sivakumar <mailto:sivakumar.mahesh@gmail.com> Editor: Yisong Liu<mailto:liuyisong@huawei.com><mailto:liuyisong@chinamobile.com> Editor: Fangwei Hu<mailto:hu.fangwei@zte.com.cn>";<mailto:hufwei@gmail.com>"; description"The"This YANG module defines a PIM (Protocol Independent Multicast) RP (Rendezvous Point) model. Copyright (c)20182022 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, theSimplifiedRevised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents(http://trustee.ietf.org/license-info).(https://trustee.ietf.org/license-info). This version of this YANG module is part of RFCXXXX;9128; see the RFC itself for full legal notices."; revision2018-04-162021-09-03 { description "Initial revision."; reference "RFCXXXX:9128: A YANG Data Model forPIM";Protocol Independent Multicast (PIM)"; } /* * Features */ feature bsr { description "This feature indicates that the system supportsBSRBSRs (BootstrapRouter).";Routers)."; reference"RFC5059:"RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast(PIM).";(PIM)"; } feature bsr-election-state { if-featurebsr;"bsr"; description "This feature indicates that the system supports providing BSR election state."; reference"RFC5059:"RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast(PIM).";(PIM)"; } feature static-rp-override { description "This feature indicates that the system supports configuration of the static RP (Rendezvous Point)override.";that overrides the RP discoveries from other mechanisms."; reference"RFC7761:"RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 3.7.";(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 invalidJP (Join/Prune)Join/Prune message has been received."; } enum invalid-register { description "An invalidregisterRegister 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(bi-directional).";(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 frombootstrap.";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-featurestatic-rp-override;"static-rp-override"; type boolean; defaultfalse;"false"; description "When there is a conflict between staticRPRPs and dynamicRP,RPs, setting this attribute to 'true' will ask the system to use staticRP.";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(bi-directional), each(Bidirectional). Each ofthemthese modes is defined in asaparate YNAGseparate 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(Sparce Mode)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"Containing"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-featurebsr;"bsr"; description"Containing"Contains BSR(BootStrap(Bootstrap Router) attributes."; container bsr-candidate { presence "Present to serve as a BSRcandidate";candidate."; description "BSR candidate attributes."; choice interface-or-address { description "Use either an interface orip-address.";an IP address."; case interface { if-featurecandidate-interface;"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-featurecandidate-ipv4;"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-featurecandidate-ipv6;"candidate-ipv6"; leaf ipv6-address { type inet:ipv6-address; mandatory true; description "IP address to be used by a BSR."; } } } leafhash-mask-length{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"; } default64;"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"Containing"Contains RP candidate attributes."; list interface { if-featurecandidate-interface;"candidate-interface"; key "name"; description "A list of RPcandidates";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-featurecandidate-ipv4;"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-featurecandidate-ipv6;"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 stateattributes.attributes container bsr { config false; description "BSR information."; leaf address { type inet:ip-address; description "BSRaddress";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 BSRbecamecame up."; } } choice election-state { if-featurebsr-election-state;"bsr-election-state"; config false; description "BSR election state."; case candidate { leaf candidate-bsr-state { type enumeration { enum"candidate"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"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"elected { description "The router is the elected BSR for the scopezonezone, and it must perform all of the BSR functions."; } } description "Candidate-BSR (C-BSR) state."; reference"RFC5059,"RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM), Section3.1.1.";3.1.1"; } } case"non-candidate"non-candidate { leaf non-candidate-bsr-state { type enumeration { enum"no-info"no-info { description "The router has no information about this scope zone."; } enum"accept-any"accept-any { description "The router does not know of an activeBSR,BSR and will accept the first Bootstrap message it seesas givingthat provides the new BSR's identity and the RP-Set."; } enum"accept"accept { description "The router knows the identity of the currentBSR,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"Non-Candidate-BSR state."; reference"RFC5059,"RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM), Section3.1.2.";3.1.2"; } } } // election-state leaf bsr-next-bootstrap { type uint16; unitsseconds;"seconds"; config false; description "The remaining time interval in seconds until the nextbootstrapBootstrap 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; unitsseconds;"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"Containing"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"Containing"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(RP-Tree).";(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 messageisoriginated."; } } }<CODE ENDS> ]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-SM Module">numbered="true" toc="default"> <name>PIM-SM Module</name> <t> This module references <xreftarget="RFC4607"/>target="RFC4607" format="default"/>, <xref target="RFC6991"/>, <xref target="RFC7761" format="default"/>, and <xreftarget="RFC7761"/>.target="RFC8349"/>. </t><figure><artwork> <![CDATA[ <CODE BEGINS> file "ietf-pim-sm@2018-04-16.yang"<sourcecode name="ietf-pim-sm@2021-09-03.yang" type="yang" markers="true"><![CDATA[ module ietf-pim-sm { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-pim-sm"; prefix pim-sm; import ietf-inet-types { prefix"inet";inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-routing { prefix"rt";rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-pim-base { prefix"pim-base";pim-base; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } import ietf-pim-rp { prefix"pim-rp";pim-rp; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } organization "IETF PIM Working Group"; contact "WG Web:<http://tools.ietf.org/wg/pim/><https://datatracker.ietf.org/wg/pim/> WG List: <mailto:pim@ietf.org> Editor: Xufeng Liu <mailto:xufeng.liu.ietf@gmail.com> Editor: Pete McAllister <mailto:pete.mcallister@metaswitch.com> Editor: Anish Peter <mailto:anish.ietf@gmail.com> Editor: Mahesh Sivakumar <mailto:sivakumar.mahesh@gmail.com> Editor: Yisong Liu<mailto:liuyisong@huawei.com><mailto:liuyisong@chinamobile.com> Editor: Fangwei Hu<mailto:hu.fangwei@zte.com.cn>";<mailto:hufwei@gmail.com>"; description"The"This YANG module defines a PIM (Protocol Independent Multicast) SM (Sparse Mode) model. Copyright (c)20182022 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, theSimplifiedRevised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents(http://trustee.ietf.org/license-info).(https://trustee.ietf.org/license-info). This version of this YANG module is part of RFCXXXX;9128; see the RFC itself for full legal notices."; revision2018-04-162021-09-03 { description "Initial revision."; reference "RFCXXXX:9128: A YANG Data Model forPIM. RFC7761:Protocol Independent Multicast- Sparse Mode (PIM-SM): Protocol Specification (Revised). Sec. 4.2.";(PIM)"; } /* * Features */ feature spt-switch-infinity { description "This feature indicates that the system supports the configuration choice of whether to triggertheswitchover from the RPT (Rendezvous Point Tree) to the SPT (Shortest Path Tree)."; reference"RFC7761:"RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.2.";(Revised), Section 4.2"; } feature spt-switch-policy { description "This feature indicates that the system supports configuring the policy fortheswitchover from the RPT to the SPT."; reference"RFC7761:"RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification(Revised). Sec. 4.2.";(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 staticRP.";RPs."; container sm { presence"Indicate the"Indicates supportof sparse mode.";for PIM-SM."; description"PIM SM"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"PIM-SM augmentation."; container sm { description"PIM SM"PIM-SM configuration data."; container asm { description "ASM(Any Source(Any-Source Multicast) attributes."; container anycast-rp { presence "Present to enableanycast RPan Anycast-RP (Rendezvous Point)."; description"Anycast RP"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 IPv4anycast RP settings, onlyAnycast-RP settings. Only applicable whenpim-base:address-family'pim-base:address-family' is IPv4."; leaf anycast-address { type inet:ipv4-address; description "IP address of theanycast RPAnycast-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 withanycast RP.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 IPv6anycast RP settings, onlyAnycast-RP settings. Only applicable whenpim-base:address-family'pim-base:address-family' is IPv6."; leaf anycast-address { type inet:ipv6-address; description "IP address of theanycast RPAnycast-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 withanycast RP.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-featurespt-switch-infinity;"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 triggerstheswitchover from the RPT to the SPT."; leaf policy-name { if-featurespt-switch-policy;"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(Source-Specific Multicast)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 grouprangrange used by SSM. If a policy is not specified, the default SSM multicast grouprangrange is used. The default SSM multicast group range is 232.0.0.0/8 for IPv4 and ff3x::/96 forIPv6IPv6, where xreprentsrepresents any valid scope identifier. The definition of such a policy is outside the scope of this document."; reference"RFC4607:"RFC 4607: Source-Specific Multicast forIP.";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"PIM-SM augmentation."; container sm { presence "Present to enablesparse-mode.";PIM-SM."; description"PIM SM"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"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"PIM-SM augmentation."; uses static-rp-sm-container; } // augment }<CODE ENDS> ]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-DM Module">numbered="true" toc="default"> <name>PIM-DM Module</name> <t> This module references <xreftarget="RFC3973"/>.target="RFC3973" format="default"/> and <xref target="RFC8349"/>. </t><figure><artwork> <![CDATA[ <CODE BEGINS> file "ietf-pim-dm@2018-04-16.yang"<sourcecode name="ietf-pim-dm@2021-09-03.yang" type="yang" markers="true"><![CDATA[ module ietf-pim-dm { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-pim-dm"; prefix pim-dm; import ietf-routing { prefix"rt";rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-pim-base { prefix"pim-base";pim-base; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } organization "IETF PIM Working Group"; contact "WG Web:<http://tools.ietf.org/wg/pim/><https://datatracker.ietf.org/wg/pim/> WG List: <mailto:pim@ietf.org> Editor: Xufeng Liu <mailto:xufeng.liu.ietf@gmail.com> Editor: Pete McAllister <mailto:pete.mcallister@metaswitch.com> Editor: Anish Peter <mailto:anish.ietf@gmail.com> Editor: Mahesh Sivakumar <mailto:sivakumar.mahesh@gmail.com> Editor: Yisong Liu<mailto:liuyisong@huawei.com><mailto:liuyisong@chinamobile.com> Editor: Fangwei Hu<mailto:hu.fangwei@zte.com.cn>";<mailto:hufwei@gmail.com>"; description"The"This YANG module defines a PIM (Protocol Independent Multicast) DM (Dense Mode) model. Copyright (c)20182022 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, theSimplifiedRevised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents(http://trustee.ietf.org/license-info).(https://trustee.ietf.org/license-info). This version of this YANG module is part of RFCXXXX;9128; see the RFC itself for full legal notices."; revision2018-04-162021-09-03 { description "Initial revision."; reference "RFCXXXX:9128: A YANG Data Model forPIM. RFC 3973:Protocol Independent Multicast- Dense Mode (PIM-DM): Protocol Specification (Revised).";(PIM)"; } /* * Configuration data nodes */ augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family" { description"PIM DM (Dense Mode)"PIM-DM augmentation."; container dm { presence "Present to enabledense-mode.";PIM-DM."; description"PIM DM"PIM-DM configuration data."; } //Dmdm } // augment augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:interfaces/pim-base:interface/" + "pim-base:address-family" { description"PIM DM"PIM-DM augmentation toPIM base interface.";'pim-base:interface'."; container dm { presence "Present to enabledense-mode.";PIM-DM."; description"PIM DM"PIM-DM configuration data."; } //smdm } // augment }<CODE ENDS> ]]> </artwork></figure>]]></sourcecode> </section> <sectiontitle="PIM-BIDIR Module">numbered="true" toc="default"> <name>BIDIR-PIM Module</name> <t> This module references <xreftarget="RFC5015"/>.target="RFC5015" format="default"/>, <xref target="RFC6991"/>, <xref target="RFC8294"/>, <xref target="RFC8343"/>, and <xref target="RFC8349"/>. </t><figure><artwork> <![CDATA[ <CODE BEGINS> file "ietf-pim-bidir@2018-04-16.yang"<sourcecode name="ietf-pim-bidir@2021-09-03.yang" type="yang" markers="true"><![CDATA[ module ietf-pim-bidir { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-pim-bidir"; prefix pim-bidir; import ietf-inet-types { prefix"inet";inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-routing-types { prefix"rt-types";rt-types; reference "RFC 8294: Common YANG Data Types for the Routing Area"; } import ietf-interfaces { prefix"if";if; reference "RFC 8343: A YANG Data Model for Interface Management"; } import ietf-routing { prefix"rt";rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-pim-base { prefix"pim-base";pim-base; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } import ietf-pim-rp { prefix"pim-rp";pim-rp; reference "RFC 9128: A YANG Data Model for Protocol Independent Multicast (PIM)"; } organization "IETF PIM Working Group"; contact "WG Web:<http://tools.ietf.org/wg/pim/><https://datatracker.ietf.org/wg/pim/> WG List: <mailto:pim@ietf.org> Editor: Xufeng Liu <mailto:xufeng.liu.ietf@gmail.com> Editor: Pete McAllister <mailto:pete.mcallister@metaswitch.com> Editor: Anish Peter <mailto:anish.ietf@gmail.com> Editor: Mahesh Sivakumar <mailto:sivakumar.mahesh@gmail.com> Editor: Yisong Liu<mailto:liuyisong@huawei.com><mailto:liuyisong@chinamobile.com> Editor: Fangwei Hu<mailto:hu.fangwei@zte.com.cn>";<mailto:hufwei@gmail.com>"; description"The"This YANG module defines a PIM (Protocol Independent Multicast) BIDIR (Bidirectional) mode model. Copyright (c)20182022 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, theSimplifiedRevised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents(http://trustee.ietf.org/license-info).(https://trustee.ietf.org/license-info). This version of this YANG module is part of RFCXXXX;9128; see the RFC itself for full legal notices."; revision2018-04-162021-09-03 { description "Initial revision."; reference "RFCXXXX:9128: A YANG Data Model forPIM. RFC5015: BidirectionalProtocol Independent Multicast(BIDIR-PIM).";(PIM)"; } /* * Features */ feature intf-df-election { description"Support"Supports configuration of interface DF election."; reference"RFC5015:"RFC 5015: Bidirectional Protocol Independent Multicast(BIDIR-PIM). Sec. 3.5.";(BIDIR-PIM), Section 3.5"; } /* * Identities */ identity rp-bidir { base pim-rp:rp-mode; description "BIDIR(Bidirectional)mode."; } identity df-state { description "DF (Designated Forwarder) election state type."; reference"RFC5015:"RFC 5015: Bidirectional Protocol Independent Multicast(BIDIR-PIM).";(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"There either"Either (1) there is a different election winner orthat(2) no router on the link has a path to the RPA(Rendezvous-Point(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 actingDFDF, but another router has made a bid to take over."; } /* * Groupings */ grouping static-rp-bidir-container { description "Grouping that contains BIDIR(Bidirectional)attributes for a static RP(Rendezvous-Point).";(Rendezvous Point)."; container bidir { presence"Indicate the"Indicates supportoffor BIDIR mode."; description"PIM BIDIR"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 statedatedata nodes */ augment "/rt:routing/rt:control-plane-protocols/" + "pim-base:pim/pim-base:address-family" { description"PIM BIDIR (Bidirectional)"PIM-BIDIR augmentation."; container bidir { presence "Present to enable BIDIR mode."; description"PIM BIDIR"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"PIM-BIDIR augmentation."; container bidir { presence "Present to enable BIDIR mode."; description"PIM BIDIR"PIM-BIDIR configuration data."; container df-election { if-featureintf-df-election;"intf-df-election"; description "DF election attributes."; leaf offer-interval { type uint16; unitsmilliseconds;"milliseconds"; default100;"100"; description "Offerinterval specifiesinterval. Specifies the interval between repeated DF election messages."; } leaf backoff-interval { type uint16; unitsmilliseconds;"milliseconds"; default1000;"1000"; description "This is the interval that the acting DF waits between receiving a better DF Offer and sending the Pass message to transfer DFresponsibility";responsibility."; } leaf offer-multiplier { type uint8; default3;"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.The offer-multiplier'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 ofoffer-multiplier'offer-multiplier' *offer-interval.'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"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"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"PIM-BIDIR augmentation to RP state data."; container bidir { config false; description"PIM BIDIR"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 DFElectionelection 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 "Theaddressname of theRP.";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"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"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 }<CODE ENDS> ]]> </artwork></figure> </section>]]></sourcecode> </section><section title="Implementation Status"> <t> This section to be removed by the RFC editor. </t> <t> This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in <xref target="RFC7942"/>. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist. </t> <t> According to RFC 7942, "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit". </t> <t> This document is the work result of the PIM working group's YANG multicast design team. The following wiki page contains the information on the design team members, the meeting discussions, lists of modeled features, and which features are supported by which existing implementations: </t> <t> https://trac.ietf.org/trac/pim/wiki/yang </t></section> <sectiontitle="Security Considerations">numbered="true" toc="default"> <name>Security Considerations</name> <t> The YANGmodulemodules specified in this documentdefinesdefine a schema for data that is designed to be accessed via network management protocols such as NETCONF <xref target="RFC6241"/> or RESTCONF <xref target="RFC8040"/>. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) <xref target="RFC6242"/>. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS <xreftarget="RFC5246"/>.target="RFC8446"/>. </t> <t> TheNETCONF access control modelNetwork Configuration Access Control Model (NACM) <xreftarget="RFC6536"/>target="RFC8341"/> provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. </t> <t> There are a number of data nodes defined inthisthese YANGmodulemodules that are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability: </t><t> <list style="hanging"> <t hangText="pim-base:graceful-restart"><vspace blankLines="0" /><dl newline="true" spacing="normal"> <dt>pim-base:graceful-restart</dt> <dd> This subtree specifies the configuration forthePIM graceful restart at the global level on a device. Modifying the configuration can cause temporary interruption to the multicast routing during restart.</t> <t hangText="pim-base:address-family/pim-base:graceful-restart"><vspace blankLines="0" /></dd> <dt>pim-base:address-family/pim-base:graceful-restart</dt> <dd> This subtree specifies theper address familyper-address-family configuration forthePIM graceful restart on a device. Modifying the configuration can cause temporary interruption to the multicast routing during restart.</t> <t hangText="pim-base:address-family/pim-rp:pim-rp:rp"> <vspace blankLines="0" /></dd> <dt>pim-base:address-family/pim-rp:pim-rp:rp</dt> <dd> This subtree specifies the configuration for the PIM Rendezvous Point (RP) on a device. Modifying the configuration can cause RP malfunctions.</t> <t hangText="pim-base:address-family/pim-sm:sm"> <vspace blankLines="0" /></dd> <dt>pim-base:address-family/pim-sm:sm</dt> <dd> This subtree specifies the configuration forthePIM Sparse Mode(PIM-SM)(PIM&nbhy;SM) on a device. Modifying the configuration can cause multicast traffic to be disabled or rerouted in PIM-SM.</t> <t hangText="pim-base:address-family/pim-dm:dm"> <vspace blankLines="0" /></dd> <dt>pim-base:address-family/pim-dm:dm</dt> <dd> This subtree specifies the configuration forthePIM Dense Mode(PIM-DM)(PIM&nbhy;DM) on a device. Modifying the configuration can cause multicast traffic to be disabled or rerouted in PIM-DM.</t> <t hangText="pim-base:address-family/pim-bidir:bidir"> <vspace blankLines="0" /></dd> <dt>pim-base:address-family/pim-bidir:bidir</dt> <dd> This subtree specifies the configuration forthePIM Bidirectional Mode(PIM-BIDIR)(BIDIR-PIM) on a device. Modifying the configuration can cause multicast traffic to be disabled or rerouted inPIM-BIDIR. </t> <t hangText="pim-base:interfaces"> <vspace blankLines="0" />BIDIR-PIM. </dd> <dt>pim-base:interfaces</dt> <dd> This subtree specifies the configuration for the PIM interfaces on a device. Modifying the configuration can cause the PIM protocol to get insufficient or incorrect information.</t> </list> </t></dd> </dl> <t> These subtrees are allnnder /rt:routing/rt:control-plane-protocols/pim-base:pim.under "/rt:routing/rt:control-plane-protocols/pim-base:pim". </t> <t> Unauthorized access to any data node of these subtrees can adversely affect the multicast routing subsystem of both the local device and the network. This may lead to network malfunctions, delivery of packets to inappropriate destinations, and other problems. </t> <t> Some of the readable data nodes inthisthese YANGmodulemodules may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: </t> <t> /rt:routing/rt:control-plane-protocols/pim-base:pim </t> <t> Unauthorized access to any data node of the above subtree can disclose the operational state information of PIM on this device. </t> </section> <sectiontitle="IANA Considerations"> <t> RFC Ed.: In this section, replace all occurrences of 'XXXX' with the actual RFC number (and remove this note). </t>numbered="true" toc="default"> <name>IANA Considerations</name> <t>This document registersIANA has registered the following namespace URIs in theIETF"IETF XMLregistryRegistry" <xreftarget="RFC3688"/>:target="RFC3688" format="default"/>: </t><figure><artwork> -------------------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-pim-base Registrant Contact: The IESG. XML: N/A,<dl spacing="compact"> <dt>URI:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-base</dd> <dt>Registrant Contact:</dt><dd>The IESG.</dd> <dt>XML:</dt><dd>N/A; the requested URI is an XMLnamespace. -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-pim-bidir Registrant Contact: The IESG. XML: N/A,namespace.</dd> </dl> <dl spacing="compact"> <dt>URI:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-bidir</dd> <dt>Registrant Contact:</dt><dd>The IESG.</dd> <dt>XML:</dt><dd>N/A; the requested URI is an XMLnamespace. -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-pim-dm Registrant Contact: The IESG. XML: N/A,namespace.</dd> </dl> <dl spacing="compact"> <dt>URI:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-dm</dd> <dt>Registrant Contact:</dt><dd>The IESG.</dd> <dt>XML:</dt><dd>N/A; the requested URI is an XMLnamespace. -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-pim-rp Registrant Contact: The IESG. XML: N/A,namespace.</dd> </dl> <dl spacing="compact"> <dt>URI:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-rp</dd> <dt>Registrant Contact:</dt><dd>The IESG.</dd> <dt>XML:</dt><dd>N/A; the requested URI is an XMLnamespace. -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-pim-sm Registrant Contact: The IESG. XML: N/A,namespace.</dd> </dl> <dl spacing="compact"> <dt>URI:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-sm</dd> <dt>Registrant Contact:</dt><dd>The IESG.</dd> <dt>XML:</dt><dd>N/A; the requested URI is an XMLnamespace. -------------------------------------------------------------------- </artwork></figure>namespace.</dd> </dl> <t>This document registersIANA has registered the following YANG modules in theYANG"YANG ModuleNamesNames" registry <xreftarget="RFC7950"/>: </t> <figure><artwork> -------------------------------------------------------------------- name: ietf-pim-base namespace: urn:ietf:params:xml:ns:yang:ietf-pim-base prefix: pim-base reference: RFC XXXX -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- name: ietf-pim-bidir namespace: urn:ietf:params:xml:ns:yang:ietf-pim-bidir prefix: pim-bidir reference: RFC XXXX -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- name: ietf-pim-dm namespace: urn:ietf:params:xml:ns:yang:ietf-pim-dm prefix: pim-dm reference: RFC XXXX -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- name: ietf-pim-rp namespace: urn:ietf:params:xml:ns:yang:ietf-pim-rp prefix: pim-rp reference: RFC XXXX -------------------------------------------------------------------- </artwork></figure> <figure><artwork> -------------------------------------------------------------------- name: ietf-pim-sm namespace: urn:ietf:params:xml:ns:yang:ietf-pim-sm prefix: pim-sm reference: RFC XXXX -------------------------------------------------------------------- </artwork></figure> </section> <section title='Acknowledgements'> <t> The authors would like to thank Steve Baillargeon, Guo Feng, Robert Kebler, Tanmoy Kundu, and Stig Venaas for their valuable contributions.target="RFC6020" format="default"/>: </t> <dl spacing="compact"> <dt>Name:</dt><dd>ietf-pim-base</dd> <dt>Namespace:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-base</dd> <dt>Prefix:</dt><dd>pim-base</dd> <dt>Reference:</dt><dd>RFC 9128</dd> </dl> <dl spacing="compact"> <dt>Name:</dt><dd>ietf-pim-bidir</dd> <dt>Namespace:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-bidir</dd> <dt>Prefix:</dt><dd>pim-bidir</dd> <dt>Reference:</dt><dd>RFC 9128</dd> </dl> <dl spacing="compact"> <dt>Name:</dt><dd>ietf-pim-dm</dd> <dt>Namespace:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-dm</dd> <dt>Prefix:</dt><dd>pim-dm</dd> <dt>Reference:</dt><dd>RFC 9128</dd> </dl> <dl spacing="compact"> <dt>Name:</dt><dd>ietf-pim-rp</dd> <dt>Namespace:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-rp</dd> <dt>Prefix:</dt><dd>pim-rp</dd> <dt>Reference:</dt><dd>RFC 9128</dd> </dl> <dl spacing="compact"> <dt>Name:</dt><dd>ietf-pim-sm</dd> <dt>Namespace:</dt><dd>urn:ietf:params:xml:ns:yang:ietf-pim-sm</dd> <dt>Prefix:</dt><dd>pim-sm</dd> <dt>Reference:</dt><dd>RFC 9128</dd> </dl> </section> </middle> <back><references title="Normative References"> <?rfc include="reference.RFC.3569"?> <?rfc include="reference.RFC.3688"?> <?rfc include="reference.RFC.3973"?> <?rfc include="reference.RFC.4607"?> <?rfc include="reference.RFC.4610"?> <?rfc include="reference.RFC.5015"?> <?rfc include="reference.RFC.5059"?> <?rfc include="reference.RFC.5060"?> <?rfc include="reference.RFC.5246"?> <?rfc include="reference.RFC.6241"?> <?rfc include="reference.RFC.6242"?> <?rfc include="reference.RFC.6536"?> <?rfc include="reference.RFC.6991"?> <?rfc include="reference.RFC.7761"?> <?rfc include="reference.RFC.7950"?> <?rfc include="reference.RFC.8040"?> <?rfc include="reference.RFC.8294"?> <?rfc include="reference.RFC.8342"?> <?rfc include="reference.RFC.8343"?> <?rfc include="reference.RFC.8349"?> <?rfc include="reference.I-D.ietf-bfd-yang.xml"?><references> <name>References</name> <references> <name>Normative References</name> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3569.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3688.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3973.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.4607.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.4610.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.5015.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.5059.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.5060.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6020.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6241.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6242.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6991.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7761.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7950.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8040.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8294.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8341.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8342.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8343.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8349.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8446.xml"/> <!-- draft-ietf-bfd-rfc9127-bis (RFC 9314; published 9/2022) --> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.9314.xml"/> </references> <references> <name>Informative References</name> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3376.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3618.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.3810.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.5880.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.6388.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.7951.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8340.xml"/> <!-- draft-ietf-netmod-rfc6087bis (RFC 8407) --> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8407.xml"/> <xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8706.xml"/> </references><references title="Informative References"> <?rfc include="reference.RFC.3376"?> <?rfc include="reference.RFC.3618"?> <?rfc include="reference.RFC.3810"?> <?rfc include="reference.RFC.5306"?> <?rfc include="reference.RFC.5880"?> <?rfc include="reference.RFC.6388"?> <?rfc include="reference.RFC.7942"?> <?rfc include="reference.RFC.7951"?> <?rfc include="reference.RFC.8340"?> <?rfc include="reference.I-D.ietf-netmod-rfc6087bis.xml"?></references> <sectiontitle="Datanumbered="true" toc="default"> <name>Data TreeExample">Example</name> <t> Thissectionappendix contains an example of an instance datatreetree, intheJSON encoding <xreftarget="RFC7951"/>,target="RFC7951" format="default"/>, containing both configuration data and state data. </t><figure><artwork><artwork name="" type="" align="left" alt=""><![CDATA[ lo0: 2001:db8:0:200::1 (RP address) | +-------+ | | | Router| | eth21 +---+ R2 +---+ eth23 | | (RP) | | | +-------+ | lo0: 2001:db8:0:300::1 | +-------+ | | +-------+ | | | Router| | | | Router| | eth10 +--+ R1 +---+ eth12 eth32 +---+ R3 +--+ eth30 | | | | | | | | | +-------+ | +-------+ | +-------+ | | +-------+ | +-------+ | | | | | Router| | | | | | +--+ +---+ R4 +---+ +-------+ +--+ | | | | | | | | | Router| | | | +-------+ | | +-------+ +---+ R5 | | +-------+ Source | | | Receiver | +-------+</artwork></figure>]]></artwork> <t> The configuration instance data tree for Router R3 in the above figure could be as follows: </t><figure><artwork><sourcecode type="json"><![CDATA[ { "ietf-interfaces:interfaces": { "interface": [ { "name": "lo0", "description": "R3 loopback interface.", "type": "iana-if-type:softwareLoopback", "ietf-ip:ipv6": { "address": [ { "ip": "2001:db8:0:300::1", "prefix-length": 64 } ] } }, { "name": "eth30", "description": "An interface connected to the receiver.", "type": "iana-if-type:ethernetCsmacd", "ietf-ip:ipv6": { "forwarding": true } }, { "name": "eth32", "description": "An interface connected to the RP (R2).", "type": "iana-if-type:ethernetCsmacd", "ietf-ip:ipv6": { "forwarding": true } } ] }, "ietf-routing:routing": { "router-id": "203.0.113.3", "control-plane-protocols": { "ietf-pim-base:pim": { "address-family": [ { "address-family": "ietf-routing:ipv6", "ietf-pim-rp:rp": { "static-rp": { "ipv6-rp": [ { "rp-address": "2001:db8:0:200::1", "ietf-pim-sm:sm": { } } ] } } } ], "interfaces": { "interface": [ { "name": "lo0", "address-family": [ { "address-family": "ietf-routing:ipv6", "hello-interval": "infinity", "ietf-pim-sm:sm": { } } ] }, { "name": "eth30", "address-family": [ { "address-family": "ietf-routing:ipv6", "ietf-pim-sm:sm": { } } ] }, { "name": "eth32", "address-family": [ { "address-family": "ietf-routing:ipv6", "ietf-pim-sm:sm": { } } ] } ] } } } } }</artwork></figure>]]></sourcecode> <t> The corresponding operational state data for Router R3 could be as follows: </t><figure><artwork><sourcecode type="json"><![CDATA[ { "ietf-interfaces:interfaces": { "interface": [ { "name": "lo0", "description": "R3 loopback interface.", "type": "iana-if-type:softwareLoopback", "phys-address": "00:00:5e:00:53:03", "oper-status": "up", "statistics": { "discontinuity-time": "2018-01-23T12:34:56-05:00" }, "ietf-ip:ipv6": { "mtu": 1500, "address": [ { "ip": "2001:db8:0:300::1", "prefix-length": 64, "origin": "static", "status": "preferred" }, { "ip": "fe80::200:5eff:fe00:5303", "prefix-length": 64, "origin": "link-layer", "status": "preferred" } ], "neighbor": [ ] } }, { "name": "eth30", "description": "An interface connected to the receiver.", "type": "iana-if-type:ethernetCsmacd", "phys-address": "00:00:5e:00:53:30", "oper-status": "up", "statistics": { "discontinuity-time": "2018-01-23T12:34:56-05:00" }, "ietf-ip:ipv6": { "forwarding": true, "mtu": 1500, "address": [ { "ip": "fe80::200:5eff:fe00:5330", "prefix-length": 64, "origin": "link-layer", "status": "preferred" } ], "neighbor": [ ] } }, { "name": "eth32", "description": "An interface connected to the RP (R2).", "type": "iana-if-type:ethernetCsmacd", "phys-address": "00:00:5e:00:53:32", "oper-status": "up", "statistics": { "discontinuity-time": "2018-01-23T12:34:56-05:00" }, "ietf-ip:ipv6": { "forwarding": true, "mtu": 1500, "address": [ { "ip": "fe80::200:5eff:fe00:5332", "prefix-length": 64, "origin": "link-layer", "status": "preferred" } ], "neighbor": [ { "ip": "fe80::200:5eff:fe00:5323", "link-layer-address": "00:00:5e:00:53:23", "origin": "dynamic", "is-router": [null], "state": "reachable" } ] } } ] }, "ietf-routing:routing": { "router-id": "203.0.113.1", "interfaces": { "interface": [ "lo0", "eth30", "eth32" ] }, "control-plane-protocols": { "ietf-pim-base:pim": { "address-family": [ { "address-family": "ietf-routing:ipv6", "statistics": { "discontinuity-time": "2018-01-23T12:34:56-05:00" }, "topology-tree-info": { "ipv6-route": [ { "group": "ff06::1", "source-address": "*", "is-rpt": true, "expiration": 16, "incoming-interface": "eth32", "is-spt": false, "mode": "pim-asm", "msdp-learned": false, "rp-address": "2001:db8:0:200::1", "rpf-neighbor": "fe80::200:5eff:fe00:5323", "up-time": 123400, "outgoing-interface": [ { "name": "eth30", "expiration": 36, "up-time": 223400, "jp-state": "join" } ] }, { "group": "ff06::1", "source-address": "2001:db8:1:1::100", "is-rpt": false, "expiration": 8, "incoming-interface": "eth32", "is-spt": true, "mode": "pim-asm", "msdp-learned": false, "rp-address": "2001:db8:0:200::1", "rpf-neighbor": "fe80::200:5eff:fe00:5323", "up-time": 5200, "outgoing-interface": [ { "name": "eth30", "expiration": 6, "up-time": 5600, "jp-state": "join" } ] } ] }, "ietf-pim-rp:rp": { "static-rp": { "ipv6-rp": [ { "rp-address": "2001:db8:0:200::1", "ietf-pim-sm:sm": { } } ] }, "rp-list": { "ipv6-rp": [ { "rp-address": "2001:db8:0:200::1", "mode": "ietf-pim-sm:rp-sm", "info-source-type": "static", "up-time": 323400, "expiration": "not-set" } ] }, "rp-mappings": { "ipv6-rp": [ { "group-range": "ff06::1/128", "rp-address": "2001:db8:0:200::1", "up-time": 123400, "expiration": "36" } ] } } } ], "interfaces": { "interface": [ { "name": "lo0", "address-family": [ { "address-family": "ietf-routing:ipv6", "hello-interval": "infinity", "ietf-pim-sm:sm": { }, "oper-status": "up", "gen-id": 103689, "hello-expiration": "infinity", "ipv6": { "address": [ "fe80::200:5eff:fe00:5303" ], "dr-address": "fe80::200:5eff:fe00:5303" }, "neighbors": { "ipv6-neighbor": [ ] } } ] }, { "name": "eth30", "address-family": [ { "address-family": "ietf-routing:ipv6", "ietf-pim-sm:sm": { }, "oper-status": "up", "gen-id": 203689, "hello-expiration": 18, "ipv6": { "address": [ "fe80::200:5eff:fe00:5330" ], "dr-address": "fe80::200:5eff:fe00:5330" }, "neighbors": { "ipv6-neighbor": [ ] } } ] }, { "name": "eth32", "address-family": [ { "address-family": "ietf-routing:ipv6", "ietf-pim-sm:sm": { }, "oper-status": "up", "gen-id": 303689, "hello-expiration": 21, "ipv6": { "address": [ "fe80::200:5eff:fe00:5332" ], "dr-address": "fe80::200:5eff:fe00:5332" }, "neighbors": { "ipv6-neighbor": [ { "address": "fe80::200:5eff:fe00:5323", "expiration": 28, "dr-priority": 1, "gen-id": 102, "lan-prune-delay": { "present": false }, "up-time": 323500 } ] } } ] } ] } } } } }</artwork></figure>]]></sourcecode> </section> <section numbered="false" toc="default"> <name>Acknowledgments</name> <t> The authors would like to thank <contact fullname="Steve Baillargeon"/>, <contact fullname="Feng Guo"/>, <contact fullname="Robert Kebler"/>, <contact fullname="Tanmoy Kundu"/>, and <contact fullname="Stig Venaas"/> for their valuable contributions. </t> </section> </back> </rfc>