draft-ietf-pim-igmp-mld-yang-07.txt   draft-ietf-pim-igmp-mld-yang-08.txt 
PIM Working Group X. Liu PIM Working Group X. Liu
Internet-Draft Volta Networks Internet-Draft Volta
Intended Status: Standard Track F. Guo Intended Status: Standard Track F. Guo
Expires: December 22, 2018 Huawei Technologies Expires: April 15, 2019 Huawei
M. Sivakumar M. Sivakumar
Juniper Networks Juniper
P. McAllister P. McAllister
Metaswitch Networks Metaswitch Networks
A. Peter A. Peter
Individual Individual
June 22,2018 October 15, 2018
A YANG Data Model for Internet Group Management Protocol (IGMP) and A YANG data model for Internet Group Management Protocol (IGMP) and
Multicast Listener Discovery (MLD) Multicast Listener Discovery (MLD)
draft-ietf-pim-igmp-mld-yang-07 draft-ietf-pim-igmp-mld-yang-08
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet- other groups may also distribute working documents as Internet-
Drafts. Drafts.
skipping to change at page 1, line 39 skipping to change at page 1, line 39
months and may be updated, replaced, or obsoleted by other documents months and may be updated, replaced, or obsoleted by other documents
at any time. It is inappropriate to use Internet-Drafts as at any time. It is inappropriate to use Internet-Drafts as
reference material or to cite them other than as "work in progress." reference material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html http://www.ietf.org/shadow.html
This Internet-Draft will expire on December 22, 2018. This Internet-Draft will expire on April 15, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with carefully, as they describe your rights and restrictions with
respect to this document. Code Components extracted from this respect to this document. Code Components extracted from this
document must include Simplified BSD License text as described in document must include Simplified BSD License text as described in
Section 4.e of the Trust Legal Provisions and are provided without Section 4.e of the Trust Legal Provisions and are provided without
skipping to change at page 2, line 25 skipping to change at page 2, line 25
Table of Contents Table of Contents
1. Introduction ................................................ 2 1. Introduction ................................................ 2
1.1. Terminology ............................................ 3 1.1. Terminology ............................................ 3
1.2. Tree Diagrams .......................................... 3 1.2. Tree Diagrams .......................................... 3
1.3. Prefixes in Data Node Names............................. 3 1.3. Prefixes in Data Node Names............................. 3
2. Design of Data model......................................... 4 2. Design of Data model......................................... 4
2.1. Scope of model ......................................... 4 2.1. Scope of model ......................................... 4
2.2. Optional capabilities................................... 4 2.2. Optional capabilities................................... 4
2.3. Position of address family in hierarchy ................ 5 2.3. Position of address family in hierarchy................. 5
3. Module Structure ............................................ 5 3. Module Structure ............................................ 5
3.1. IGMP Configuration and Operational state ............... 5 3.1. IGMP Configuration and Operational state................ 5
3.2. MLD Configuration and Operational State ................ 7 3.2. MLD Configuration and Operational State................. 7
3.3. IGMP and MLD RPC ....................................... 9 3.3. IGMP and MLD RPC........................................ 9
4. IGMP and MLD YANG Modules.................................... 9 4. IGMP and MLD YANG Modules................................... 10
5. Security Considerations..................................... 33 5. Security Considerations..................................... 33
6. IANA Considerations ........................................ 35 6. IANA Considerations ........................................ 35
7. Acknowledgments ............................................ 36 7. Acknowledgments ............................................ 35
8. Contributing Authors........................................ 36 8. Contributing Authors........................................ 36
9. References ................................................. 36 9. References ................................................. 36
9.1. Normative References .................................. 36 9.1. Normative References................................... 36
9.2. Informative References ................................ 38 9.2. Informative References................................. 38
1. Introduction 1. Introduction
YANG [RFC6020] [RFC7950] is a data definition language that was YANG [RFC6020] [RFC7950] is a data definition language that was
introduced to model the configuration and running state of a device introduced to model the configuration and running state of a device
managed using network management protocols such as NETCONF [RFC6241] managed using network management protocols such as NETCONF [RFC6241]
or RESTCONF [RFC8040]. YANG is now also being used as a component or RESTCONF [RFC8040]. YANG is now also being used as a component of
of wider management interfaces, such as CLIs. wider management interfaces, such as CLIs.
This document defines a YANG data model that can be used to This document defines a YANG data model that can be used to
configure and manage Internet Group Management Protocol (IGMP) and configure and manage Internet Group Management Protocol (IGMP) and
Multicast Listener Discovery (MLD) devices. This model will support Multicast Listener Discovery (MLD) devices. This model will support
the core IGMP and MLD protocols, as well as many other features the core IGMP and MLD protocols, as well as many other features
mentioned in separate IGMP and MLD RFCs. Non-core features are mentioned in separate IGMP and MLD RFCs. Non-core features are
defined as optional in the provided data model. defined as optional in the provided data model.
1.1. Terminology 1.1. Terminology
skipping to change at page 3, line 34 skipping to change at page 3, line 34
Tree diagrams used in this document follow the notation defined in Tree diagrams used in this document follow the notation defined in
[RFC8340]. [RFC8340].
1.3. Prefixes in Data Node Names 1.3. Prefixes in Data Node Names
In this document, names of data nodes, actions, and other data model In this document, names of data nodes, actions, and other data model
objects are often used without a prefix, as long as it is clear from objects are often used without a prefix, as long as it is clear from
the context in which YANG module each name is defined. Otherwise, the context in which YANG module each name is defined. Otherwise,
names are prefixed using the standard prefix associated with the names are prefixed using the standard prefix associated with the
corresponding YANG module, as shown in Table 1.
+-----------+--------------------+---------------------+ +-----------+--------------------------+---------------------+
| Prefix | YANG module | Reference | | Prefix | YANG module | Reference |
+-----------+--------------------+---------------------+ +-----------+--------------------------+---------------------+
| yang | ietf-yang-types | [RFC6991] | | yang | ietf-yang-types | [RFC6991] |
| inet | ietf-inet-types | [RFC6991] | | inet | ietf-inet-types | [RFC6991] |
| if | ietf-interfaces | [RFC8343] | | if | ietf-interfaces | [RFC8343] |
| rt | ietf-routing | [RFC8349] | | ip | ietf-ip | [RFC8344] |
+-----------+--------------------+---------------------+ | rt | ietf-routing | [RFC8349] |
Table 1: Prefixes and Corresponding YANG Modules
| rt-types | ietf-routing-types | [RFC8294] |
| acl | ietf-access-control-list | [I-D.ietf-acl-yang] |
+-----------+--------------------------+---------------------+
Table 1: Prefixes and Corresponding YANG Modules
2. Design of Data model 2. Design of Data model
2.1. Scope of model 2.1. Scope of model
The model covers IGMPv1 [RFC1112], IGMPv2 [RFC2236], IGMPv3 The model covers IGMPv1 [RFC1112], IGMPv2 [RFC2236], IGMPv3
[RFC3376] and MLDv1 [RFC2710], MLDv2 [RFC3810]. [RFC3376] and MLDv1 [RFC2710], MLDv2 [RFC3810].
The configuration of IGMP and MLD features, and the operational The configuration of IGMP and MLD features, and the operational
state fields and RPC definitions are not all included in this state fields and RPC definitions are not all included in this
skipping to change at page 5, line 5 skipping to change at page 5, line 9
MLD implementations. MLD implementations.
On the other hand, operational state parameters are not so widely On the other hand, operational state parameters are not so widely
designated as features, as there are many cases where the defaulting designated as features, as there are many cases where the defaulting
of an operational state parameter would not cause any harm to the of an operational state parameter would not cause any harm to the
system, and it is much more likely that an implementation without system, and it is much more likely that an implementation without
native support for a piece of operational state would be able to native support for a piece of operational state would be able to
derive a suitable value for a state variable that is not natively derive a suitable value for a state variable that is not natively
supported. supported.
For the same reason, wide constant ranges (for example, timer
maximum and minimum) will be used in the model. It is expected that
vendors will augment the model with any specific restrictions that
might be required. Vendors may also extend the features list with
proprietary extensions.
2.3. Position of address family in hierarchy 2.3. Position of address family in hierarchy
The current document contains IGMP and MLD as separate schema The current document contains IGMP and MLD as separate schema
branches in the structure. The reason for this is to make it easier branches in the structure. The reason for this is to make it easier
for implementations which may optionally choose to support specific for implementations which may optionally choose to support specific
address families. And the names of objects may be different between address families. And the names of objects may be different between
the IPv4 (IGMP) and IPv6 (MLD) address families. the IPv4 (IGMP) and IPv6 (MLD) address families.
3. Module Structure 3. Module Structure
skipping to change at page 5, line 52 skipping to change at page 5, line 50
default specified, so that they need not be configured explicitly. default specified, so that they need not be configured explicitly.
This model augments the core routing data model "ietf-routing" This model augments the core routing data model "ietf-routing"
specified in [RFC8349]. The IGMP model augments "/rt:routing/ specified in [RFC8349]. The IGMP model augments "/rt:routing/
rt:control-plane-protocols" as opposed to augmenting "/rt:routing/ rt:control-plane-protocols" as opposed to augmenting "/rt:routing/
rt:control-plane-protocols/rt:control-plane-protocol", as the latter rt:control-plane-protocols/rt:control-plane-protocol", as the latter
would allow multiple protocol instances, while the IGMP protocol is would allow multiple protocol instances, while the IGMP protocol is
designed to be enabled or disabled as a single protocol instance on designed to be enabled or disabled as a single protocol instance on
a network instance or a logical network element. a network instance or a logical network element.
augment /rt:routing/rt:control-plane-protocols: augment /rt:routing/rt:control-plane-protocols:
+--rw igmp +--rw igmp {feature-igmp}?
+--rw global +--rw global
| +--rw enable? boolean {global-admin-enable}? | +--rw enable? boolean {global-admin-enable}?
| +--rw max-entries? uint32 {global-max-entries}? | +--rw max-entries? uint32 {global-max-entries}?
| +--rw max-groups? uint32 {global-max-groups}? | +--rw max-groups? uint32 {global-max-groups}?
| +--ro entries-count? uint32 | +--ro entries-count? uint32
| +--ro groups-count? uint32 | +--ro groups-count? uint32
| +--ro statistics | +--ro statistics
| +--ro discontinuity-time? yang:date-and-time | +--ro discontinuity-time? yang:date-and-time
| +--ro error | +--ro error
| | +--ro total? yang:counter64 | | +--ro total? yang:counter64
skipping to change at page 6, line 31 skipping to change at page 6, line 30
| | +--ro query? yang:counter64 | | +--ro query? yang:counter64
| | +--ro report? yang:counter64 | | +--ro report? yang:counter64
| | +--ro leave? yang:counter64 | | +--ro leave? yang:counter64
| +--ro sent | +--ro sent
| +--ro total? yang:counter64 | +--ro total? yang:counter64
| +--ro query? yang:counter64 | +--ro query? yang:counter64
| +--ro report? yang:counter64 | +--ro report? yang:counter64
| +--ro leave? yang:counter64 | +--ro leave? yang:counter64
+--rw interfaces +--rw interfaces
+--rw last-member-query-interval? uint16 +--rw last-member-query-interval? uint16
+--rw max-groups-per-interface? uint32 {intf-max-groups}?
+--rw query-interval? uint16 +--rw query-interval? uint16
+--rw query-max-response-time? uint16 +--rw query-max-response-time? uint16
+--rw require-router-alert? boolean {intf-require-router-alert}? +--rw require-router-alert? boolean {intf-require-router-alert}?
+--rw robustness-variable? uint8 +--rw robustness-variable? uint8
+--rw version? uint8 +--rw version? uint8
+--rw max-groups-per-interface? uint32 {intf-max-groups}?
+--rw interface* [interface-name] +--rw interface* [interface-name]
+--rw interface-name if:interface-ref +--rw interface-name if:interface-ref
+--rw enable? boolean {intf-admin-enable}?
+--rw group-policy? String
+--rw immediate-leave? empty {intf-immediate-leave}?
+--rw last-member-query-interval? uint16 +--rw last-member-query-interval? uint16
+--rw max-groups? uint32 {intf-max-groups}?
+--rw max-group-sources? uint32 {intf-max-group-sources}?
+--rw query-interval? uint16 +--rw query-interval? uint16
+--rw query-max-response-time? uint16 +--rw query-max-response-time? uint16
+--rw require-router-alert? boolean {intf-require-router-alert}? +--rw require-router-alert? boolean {intf-require-router-alert}?
+--rw robustness-variable? uint8 +--rw robustness-variable? uint8
+--rw source-policy? string {intf-source-policy}?
+--rw verify-source-subnet? empty {intf-verify-source-subnet}?
+--rw explicit-tracking? boolean {intf-explicit-tracking}?
+--rw exclude-lite? boolean {intf-exclude-lite}?
+--rw version? uint8 +--rw version? uint8
+--rw join-group* inet:ipv4-address {intf-join-group}? +--rw enable? boolean {intf-admin-enable}?
+--rw ssm-map* [source-addr group-policy] {intf-ssm-map}? +--rw group-policy? -> /acl:acls/acl/name
| +--rw source-addr ssm-map-ipv4-addr-type +--rw immediate-leave? empty {intf-immediate-leave}?
| +--rw group-policy string +--rw max-groups? uint32 {intf-max-groups}?
+--rw max-group-sources? uint32 {intf-max-group-sources}?
+--rw source-policy? -> /acl:acls/acl/name {intf-source-policy}?
+--rw verify-source-subnet? empty {intf-verify-source-subnet}?
+--rw explicit-tracking? empty {intf-explicit-tracking}?
+--rw exclude-lite? empty {intf-exclude-lite}?
+--rw join-group* rt-types:ipv4-multicast-group-address {intf-join-group}?
+--rw ssm-map* [ssm-map-source-addr ssm-map-group-policy] {intf-ssm-map}?
| +--rw ssm-map-source-addr ssm-map-ipv4-addr-type
| +--rw ssm-map-group-policy string
+--rw static-group* [group-addr source-addr] {intf-static-group}? +--rw static-group* [group-addr source-addr] {intf-static-group}?
| +--rw group-addr inet:ipv4-address | +--rw group-addr rt-types:ipv4-multicast-group-address
| +--rw source-addr source-ipv4-addr-type | +--rw source-addr rt-types:ipv4-multicast-source-address
+--ro oper-status? Enumeration +--ro oper-status enumeration
+--ro querier? inet:ipv4-address +--ro querier inet:ipv4-address
+--ro joined-group* inet:ipv4-address {intf-join-group}? +--ro joined-group* rt-types:ipv4-multicast-group-address {intf-join-group}?
+--ro group* [group-address] +--ro group* [group-address]
+--ro group-address inet:ipv4-address +--ro group-address rt-types:ipv4-multicast-group-address
+--ro expire? uint32 +--ro expire uint32
+--ro filter-mode? enumeration +--ro filter-mode enumeration
+--ro up-time? uint32 +--ro up-time uint32
+--ro last-reporter? inet:ipv4-address +--ro last-reporter? inet:ipv4-address
+--ro source* [source-address] +--ro source* [source-address]
+--ro source-address inet:ipv4-address +--ro source-address inet:ipv4-address
+--ro expire? uint32 +--ro expire uint32
+--ro up-time? uint32 +--ro up-time uint32
+--ro host-count? uint32 {intf-explicit-tracking}? +--ro host-count? uint32 {intf-explicit-tracking}?
+--ro last-reporter? inet:ipv4-address +--ro last-reporter? inet:ipv4-address
+--ro host* [host-address] {intf-explicit-tracking}? +--ro host* [host-address] {intf-explicit-tracking}?
+--ro host-address inet:ipv4-address +--ro host-address inet:ipv4-address
+--ro host-filter-mode? enumeration +--ro host-filter-mode enumeration
3.2. MLD Configuration and Operational State 3.2. MLD Configuration and Operational State
The MLD YANG model uses the same structure as IGMP YANG model. The The MLD YANG model uses the same structure as IGMP YANG model. The
MLD module also defines in a three-level hierarchy structure as MLD module also defines in a three-level hierarchy structure as
listed below: listed below:
augment /rt:routing/rt:control-plane-protocols: augment /rt:routing/rt:control-plane-protocols:
+--rw mld +--rw mld {feature-mld}?
+--rw global +--rw global
| +--rw enable? boolean {global-admin-enable}? | +--rw enable? boolean {global-admin-enable}?
| +--rw max-entries? uint32 {global-max-entries}? | +--rw max-entries? uint32 {global-max-entries}?
| +--rw max-groups? uint32 {global-max-groups}? | +--rw max-groups? uint32 {global-max-groups}?
| +--ro entries-count? uint32 | +--ro entries-count? uint32
| +--ro groups-count? uint32 | +--ro groups-count? uint32
| +--ro statistics | +--ro statistics
| +--ro discontinuity-time? yang:date-and-time | +--ro discontinuity-time? yang:date-and-time
| +--ro error | +--ro error
| | +--ro total? yang:counter64 | | +--ro total? yang:counter64
skipping to change at page 8, line 18 skipping to change at page 8, line 17
| | +--ro query? yang:counter64 | | +--ro query? yang:counter64
| | +--ro report? yang:counter64 | | +--ro report? yang:counter64
| | +--ro leave? yang:counter64 | | +--ro leave? yang:counter64
| +--ro sent | +--ro sent
| +--ro total? yang:counter64 | +--ro total? yang:counter64
| +--ro query? yang:counter64 | +--ro query? yang:counter64
| +--ro report? yang:counter64 | +--ro report? yang:counter64
| +--ro leave? yang:counter64 | +--ro leave? yang:counter64
+--rw interfaces +--rw interfaces
+--rw last-member-query-interval? uint16 +--rw last-member-query-interval? uint16
+--rw max-groups-per-interface? uint32 {intf-max-groups}?
+--rw query-interval? uint16 +--rw query-interval? uint16
+--rw query-max-response-time? uint16 +--rw query-max-response-time? uint16
+--rw require-router-alert? boolean {intf-require-router-alert}? +--rw require-router-alert? boolean {intf-require-router-alert}?
+--rw robustness-variable? uint8 +--rw robustness-variable? uint8
+--rw version? uint8 +--rw version? uint8
+--rw max-groups-per-interface? uint32 {intf-max-groups}?
+--rw interface* [interface-name] +--rw interface* [interface-name]
+--rw interface-name if:interface-ref +--rw interface-name if:interface-ref
+--rw enable? boolean {intf-admin-enable}?
+--rw group-policy? string
+--rw immediate-leave? empty {intf-immediate-leave}?
+--rw last-member-query-interval? uint16 +--rw last-member-query-interval? uint16
+--rw max-groups? uint32 {intf-max-groups}?
+--rw max-group-sources? uint32 {intf-max-group-sources}?
+--rw query-interval? uint16 +--rw query-interval? uint16
+--rw query-max-response-time? uint16 +--rw query-max-response-time? uint16
+--rw require-router-alert? boolean {intf-require-router-alert}? +--rw require-router-alert? boolean {intf-require-router-alert}?
+--rw robustness-variable? uint8 +--rw robustness-variable? uint8
+--rw source-policy? string {intf-source-policy}?
+--rw verify-source-subnet? empty {intf-verify-source-subnet}?
+--rw explicit-tracking? boolean {intf-explicit-tracking}?
+--rw exclude-lite? boolean {intf-exclude-lite}?
+--rw version? uint8 +--rw version? uint8
+--rw join-group* inet:ipv6-address {intf-join-group}? +--rw enable? boolean {intf-admin-enable}?
+--rw ssm-map* [source-addr group-policy] {intf-ssm-map}? +--rw group-policy? -> /acl:acls/acl/name
| +--rw source-addr ssm-map-ipv6-addr-type +--rw immediate-leave? empty {intf-immediate-leave}?
| +--rw group-policy string +--rw max-groups? uint32 {intf-max-groups}?
+--rw static-group* [group source-addr] {intf-static-group}? +--rw max-group-sources? uint32 {intf-max-group-sources}?
| +--rw group inet:ipv6-address +--rw source-policy? -> /acl:acls/acl/name {intf-source-policy}?
| +--rw source-addr source-ipv6-addr-type +--rw verify-source-subnet? empty {intf-verify-source-subnet}?
+--ro oper-status? enumeration +--rw explicit-tracking? empty {intf-explicit-tracking}?
+--ro querier? inet:ipv6-address +--rw exclude-lite? empty {intf-exclude-lite}?
+--ro joined-group* inet:ipv6-address {intf-join-group}? +--rw join-group* rt-types:ipv6-multicast-group-address {intf-join-group}?
+--rw ssm-map* [ssm-map-source-addr ssm-map-group-policy] {intf-ssm-map}?
| +--rw ssm-map-source-addr ssm-map-ipv6-addr-type
| +--rw ssm-map-group-policy string
+--rw static-group* [group-addr source-addr] {intf-static-group}?
| +--rw group-addr rt-types:ipv6-multicast-group-address
| +--rw source-addr rt-types:ipv6-multicast-source-address
+--ro oper-status enumeration
+--ro querier inet:ipv6-address
+--ro joined-group* rt-types:ipv6-multicast-group-address {intf-join-group}?
+--ro group* [group-address] +--ro group* [group-address]
+--ro group-address inet:ipv6-address +--ro group-address rt-types:ipv6-multicast-group-address
+--ro expire? uint32 +--ro expire uint32
+--ro filter-mode? enumeration +--ro filter-mode enumeration
+--ro up-time? uint32 +--ro up-time uint32
+--ro last-reporter? inet:ipv6-address +--ro last-reporter? inet:ipv6-address
+--ro source* [source-address] +--ro source* [source-address]
+--ro source-address inet:ipv6-address +--ro source-address inet:ipv6-address
+--ro expire? uint32 +--ro expire uint32
+--ro up-time? uint32 +--ro up-time uint32
+--ro host-count? uint32 {intf-explicit-tracking}? +--ro host-count? uint32 {intf-explicit-tracking}?
+--ro last-reporter? inet:ipv6-address +--ro last-reporter? inet:ipv6-address
+--ro host* [host-address] {intf-explicit-tracking}? +--ro host* [host-address] {intf-explicit-tracking}?
+--ro host-address inet:ipv6-address +--ro host-address inet:ipv6-address
+--ro host-filter-mode? enumeration +--ro host-filter-mode enumeration
3.3. IGMP and MLD RPC 3.3. IGMP and MLD RPC
IGMP and MLD RPC clears the specified IGMP and MLD group membership. IGMP and MLD RPC clears the specified IGMP and MLD group membership.
rpcs: rpcs:
+---x clear-igmp-groups {rpc-clear-groups}? +---x clear-igmp-groups {rpc-clear-groups}?
| +---w input | +---w input
| +---w interface? string | +---w interface-name? -> /rt:routing/control-plane-
protocols/igmp-mld:igmp/interfaces/interface/interface-name
{feature-igmp}?
| +---w group? inet:ipv4-address | +---w group-address? rt-types:ipv4-multicast-group-
address
| +---w source? inet:ipv4-address | +---w source-address? rt-types:ipv4-multicast-source-
address
+---x clear-mld-groups {rpc-clear-groups}? +---x clear-mld-groups {rpc-clear-groups}?
+---w input +---w input
+---w interface? string +---w interface-name? -> /rt:routing/control-plane-
protocols/igmp-mld:mld/interfaces/interface/interface-name {feature-
mld}?
+---w group? inet:ipv6-address +---w group-addrss? rt-types:ipv6-multicast-group-
address
+---w source? inet:ipv6-address +---w source-address? rt-types:ipv6-multicast-source-
address
4. IGMP and MLD YANG Modules 4. IGMP and MLD YANG Modules
<CODE BEGINS> file "ietf-igmp-mld@2018-06-22.yang" <CODE BEGINS> file "ietf-igmp-mld@2018-09-15.yang"
module ietf-igmp-mld { module ietf-igmp-mld {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-igmp-mld"; namespace "urn:ietf:params:xml:ns:yang:ietf-igmp-mld";
// replace with IANA namespace when assigned // replace with IANA namespace when assigned
prefix igmp-mld; prefix igmp-mld;
import ietf-inet-types { import ietf-inet-types {
prefix "inet"; prefix "inet";
} }
import ietf-yang-types { import ietf-yang-types {
prefix "yang"; prefix "yang";
} }
import ietf-routing-types {
prefix "rt-types";
}
import ietf-access-control-list {
prefix "acl";
}
import ietf-routing { import ietf-routing {
prefix "rt"; prefix "rt";
} }
import ietf-interfaces { import ietf-interfaces {
prefix "if"; prefix "if";
} }
import ietf-ip { import ietf-ip {
prefix ip; prefix ip;
skipping to change at page 10, line 47 skipping to change at page 11, line 12
WG Chair: Mike McBride WG Chair: Mike McBride
<mailto:mmcbride7@gmail.com> <mailto:mmcbride7@gmail.com>
Editor: Xufeng Liu Editor: Xufeng Liu
<mailto:xufeng.liu.ietf@gmail.com> <mailto:xufeng.liu.ietf@gmail.com>
Editor: Feng Guo Editor: Feng Guo
<mailto:guofeng@huawei.com> <mailto:guofeng@huawei.com>
Editor: Mahesh Sivakumar Editor: Mahesh Sivakumar
<mailto:masivaku@cisco.com> <mailto:sivakumar.mahesh@gmail.com>
Editor: Pete McAllister Editor: Pete McAllister
<mailto:pete.mcallister@metaswitch.com> <mailto:pete.mcallister@metaswitch.com>
Editor: Anish Peter Editor: Anish Peter
<mailto:anish.ietf@gmail.com>"; <mailto:anish.ietf@gmail.com>";
description description
"The module defines a collection of YANG definitions common for "The module defines a collection of YANG definitions common for
IGMP and MLD."; IGMP and MLD.";
revision 2018-06-22 { revision 2018-09-15 {
description
"Updated yang data model for default value, address type and
repeated leaf definition.";
reference
"RFC XXXX: A YANG Data Model for IGMP and MLD";
}
revision 2018-06-21 {
description description
"Updated yang data model for parameter range and description."; "Updated yang data model for parameter range and description.";
reference reference
"RFC XXXX: A YANG Data Model for IGMP and MLD"; "RFC XXXX: A YANG Data Model for IGMP and MLD";
} }
revision 2017-10-20 { revision 2017-10-20 {
description description
"Updated yang data model for adding explicit-tracking and "Updated yang data model for adding explicit-tracking and
lightweight IGMPv3 and MLDv2 function."; lightweight IGMPv3 and MLDv2 function.";
reference reference
skipping to change at page 11, line 33 skipping to change at page 12, line 5
revision 2017-09-19 { revision 2017-09-19 {
description description
"Updated yang data model for NMDA version and errata."; "Updated yang data model for NMDA version and errata.";
reference reference
"RFC XXXX: A YANG Data Model for IGMP and MLD"; "RFC XXXX: A YANG Data Model for IGMP and MLD";
} }
/* /*
* Features * Features
*/ */
feature feature-igmp {
description
"Support IGMP protocol for IPv4 group membership record.";
}
feature feature-mld {
description
"Support MLD protocol for IPv6 group membership record.";
}
feature global-admin-enable { feature global-admin-enable {
description description
"Support global configuration to enable or disable protocol."; "Support global configuration to enable or disable protocol.";
} }
feature global-interface-config { feature global-interface-config {
description description
"Support global configuration applied for all interfaces."; "Support global configuration applied for all interfaces.";
} }
skipping to change at page 14, line 7 skipping to change at page 14, line 35
description description
"Source address is specified in SSM map policy."; "Source address is specified in SSM map policy.";
} }
} }
type inet:ipv6-address; type inet:ipv6-address;
} }
description description
"Multicast source IP address type for SSM map."; "Multicast source IP address type for SSM map.";
} // source-ipv6-addr-type } // source-ipv6-addr-type
typedef source-ipv4-addr-type {
type union {
type enumeration {
enum '*' {
description
"Any source address.";
}
}
type inet:ipv4-address;
}
description
"Multicast source IP address type.";
} // source-ipv4-addr-type
typedef source-ipv6-addr-type {
type union {
type enumeration {
enum '*' {
description
"Any source address.";
}
}
type inet:ipv6-address;
}
description
"Multicast source IP address type.";
} // source-ipv6-addr-type
/* /*
* Identities * Identities
*/ */
/* /*
* Groupings * Groupings
*/ */
grouping global-config-attributes { grouping global-config-attributes {
description "Global IGMP and MLD configuration."; description "Global IGMP and MLD configuration.";
leaf enable { leaf enable {
if-feature global-admin-enable; if-feature global-admin-enable;
type boolean; type boolean;
default false;
description description
"true to enable IGMP or MLD in the routing instance; "true to enable IGMP or MLD in the routing instance;
false to disable IGMP or MLD in the routing instance."; false to disable IGMP or MLD in the routing instance.";
} }
leaf max-entries { leaf max-entries {
if-feature global-max-entries; if-feature global-max-entries;
type uint32; type uint32;
description description
"The maximum number of entries in IGMP or MLD."; "The maximum number of entries in IGMP or MLD.";
} }
leaf max-groups { leaf max-groups {
if-feature global-max-groups; if-feature global-max-groups;
type uint32; type uint32;
description description
skipping to change at page 15, line 33 skipping to change at page 15, line 36
leaf entries-count { leaf entries-count {
type uint32; type uint32;
config false; config false;
description description
"The number of entries in IGMP or MLD."; "The number of entries in IGMP or MLD.";
} }
leaf groups-count { leaf groups-count {
type uint32; type uint32;
config false; config false;
description description
"The number of groups that IGMP or MLD joins."; "The number of groups that IGMP or MLD can join.";
} }
container statistics { container statistics {
config false; config false;
description "Global statistics."; description "Global statistics.";
leaf discontinuity-time { leaf discontinuity-time {
type yang:date-and-time; type yang:date-and-time;
description description
"The time on the most recent occasion at which any one "The time on the most recent occasion at which any one
skipping to change at page 16, line 51 skipping to change at page 17, line 4
} }
leaf query { leaf query {
type yang:counter64; type yang:counter64;
description description
"The number of query messages."; "The number of query messages.";
} }
leaf report { leaf report {
type yang:counter64; type yang:counter64;
description description
"The number of report messages."; "The number of report messages.";
} }
leaf leave { leaf leave {
type yang:counter64; type yang:counter64;
description description
"The number of leave messages."; "The number of leave messages.";
} }
} // global-statistics-sent-received } // global-statistics-sent-received
grouping interfaces-config-attributes { grouping interface-global-config-attributes {
description description
"Configuration attributes applied to the interfaces whose "Configuration attributes applied to the interface global level
per interface attributes are not existing."; whose per interface attributes are not existing.";
leaf max-groups-per-interface {
if-feature intf-max-groups;
type uint32;
description
"The maximum number of groups that IGMP or MLD can join.";
}
} //interface-global-config-attributes
grouping interface-common-config-attributes {
description
"Configuration attributes applied to both the interface global
level and interface level.";
leaf last-member-query-interval { leaf last-member-query-interval {
type uint16 { type uint16 {
range "1..65535"; range "1..1023";
} }
units seconds; units seconds;
default 1; default 1;
description description
"Last Member Query Interval, which may be tuned to modify the "Last Member Query Interval, which may be tuned to modify the
leave latency of the network."; leave latency of the network.";
reference "RFC3376. Sec. 8.8."; reference "RFC3376. Sec. 8.8.";
} }
leaf max-groups-per-interface {
if-feature intf-max-groups;
type uint32;
description
"The maximum number of groups that IGMP or MLD can join.";
}
leaf query-interval { leaf query-interval {
type uint16 { type uint16 {
range "1..31744"; range "1..31744";
} }
units seconds; units seconds;
default 125; default 125;
description description
"The Query Interval is the interval between General Queries "The Query Interval is the interval between General Queries
sent by the Querier.In RFC3376, Querier's Query Interval(QQI) is sent by the Querier.In RFC3376, Querier's Query Interval(QQI) is
represented from the Querier's Query Interval Code in query represented from the Querier's Query Interval Code in query
skipping to change at page 17, line 45 skipping to change at page 18, line 4
type uint16 { type uint16 {
range "1..31744"; range "1..31744";
} }
units seconds; units seconds;
default 125; default 125;
description description
"The Query Interval is the interval between General Queries "The Query Interval is the interval between General Queries
sent by the Querier.In RFC3376, Querier's Query Interval(QQI) is sent by the Querier.In RFC3376, Querier's Query Interval(QQI) is
represented from the Querier's Query Interval Code in query represented from the Querier's Query Interval Code in query
message as follows: message as follows:
If QQIC < 128, QQI = QQIC If QQIC < 128, QQI = QQIC
If QQIC >= 128, QQIC represents a floating-point value as follows: If QQIC >= 128, QQIC represents a floating-point value as follows:
0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
|1| exp | mant | |1| exp | mant |
+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
QQI = (mant | 0x10) << (exp + 3) QQI = (mant | 0x10) << (exp + 3)
The maximum value of QQI is 31744."; The maximum value of QQI is 31744.";
reference "RFC3376. Sec. 4.1.7, 8.2, 8.14.2."; reference "RFC3376. Sec. 4.1.7, 8.2, 8.14.2.";
} }
leaf query-max-response-time { leaf query-max-response-time {
type uint16 { type uint16 {
range "1..65535"; range "1..1023";
} }
units seconds; units seconds;
default 10; default 10;
description description
"Query maximum response time specifies the maximum time "Query maximum response time specifies the maximum time
allowed before sending a responding report."; allowed before sending a responding report.";
reference "RFC3376. Sec. 4.1.1, 8.3, 8.14.3."; reference "RFC3376. Sec. 4.1.1, 8.3, 8.14.3.";
} }
leaf require-router-alert { leaf require-router-alert {
skipping to change at page 18, line 39 skipping to change at page 18, line 47
type uint8 { type uint8 {
range "1..7"; range "1..7";
} }
default 2; default 2;
description description
"Querier's Robustness Variable allows tuning for the expected "Querier's Robustness Variable allows tuning for the expected
packet loss on a network."; packet loss on a network.";
reference "RFC3376. Sec. 4.1.6, 8.1, 8.14.1."; reference "RFC3376. Sec. 4.1.6, 8.1, 8.14.1.";
} }
} // interfaces-config-attributes } // interface-common-config-attributes
grouping interfaces-config-attributes-igmp {
description "interfaces configuration for IGMP.";
uses interfaces-config-attributes; grouping interface-common-config-attributes-igmp {
description
"Configuration attributes applied to both the interface global
level and interface level for IGMP.";
uses interface-common-config-attributes;
leaf version { leaf version {
type uint8 { type uint8 {
range "1..3"; range "1..3";
} }
default 2;
description "IGMP version."; description "IGMP version.";
reference "RFC1112, RFC2236, RFC3376."; reference "RFC1112, RFC2236, RFC3376.";
} }
} }
grouping interfaces-config-attributes-mld {
description "interfaces configuration for MLD.";
uses interfaces-config-attributes; grouping interface-common-config-attributes-mld {
description
"Configuration attributes applied to both the interface global
level and interface level for MLD.";
uses interface-common-config-attributes;
leaf version { leaf version {
type uint8 { type uint8 {
range "1..2"; range "1..2";
} }
default 2;
description "MLD version."; description "MLD version.";
reference "RFC2710, RFC3810."; reference "RFC2710, RFC3810.";
} }
} }
grouping interface-config-attributes-igmp { grouping interfaces-config-attributes-igmp {
description "Per interface configuration for IGMP."; description
"Configuration attributes applied to the interface global
uses interface-config-attributes-igmp-mld; level for IGMP.";
uses interface-common-config-attributes-igmp;
leaf version { uses interface-global-config-attributes;
type uint8 { }
range "1..3";
}
description "IGMP version.";
reference "RFC1112, RFC2236, RFC3376.";
}
leaf-list join-group {
if-feature intf-join-group;
type inet:ipv4-address;
description
"The router itself joins this multicast group
on the interface as a host.";
}
list ssm-map {
if-feature intf-ssm-map;
key "source-addr group-policy";
description "The policy for (*,G) mapping to (S,G).";
leaf source-addr {
type ssm-map-ipv4-addr-type;
description
"Multicast source IP address.";
}
leaf group-policy {
type string;
description
"Name of the access policy used to filter IGMP
membership. A device can restrict the length
and value of this name, possibly space and special
characters are not allowed. ";
}
}
list static-group {
if-feature intf-static-group;
key "group-addr source-addr";
description
"A static multicast route, (*,G) or (S,G).";
leaf group-addr { grouping interfaces-config-attributes-mld {
type inet:ipv4-address; description
description "Configuration attributes applied to the interface global
"Multicast group IP address."; level for MLD.";
} uses interface-common-config-attributes-mld;
leaf source-addr { uses interface-global-config-attributes;
type source-ipv4-addr-type; }
description
"Multicast source IP address.";
}
}
} // interface-config-attributes-igmp
grouping interface-config-attributes-igmp-mld { grouping interface-specific-config-attributes {
description description
"Per interface configuration for both IGMP and MLD."; "Per interface configuration attributes for both IGMP and MLD
whose are not existing in interface global level.";
leaf enable { leaf enable {
if-feature intf-admin-enable; if-feature intf-admin-enable;
type boolean; type boolean;
default false; default false;
description description
"true to enable IGMP or MLD on the interface; "true to enable IGMP or MLD on the interface;
false to disable IGMP or MLD on the interface."; false to disable IGMP or MLD on the interface.";
} }
leaf group-policy { leaf group-policy {
type string; type leafref {
path "/acl:acls/acl:acl/acl:name";
}
description description
"Name of the access policy used to filter IGMP or MLD "Name of the access policy used to filter IGMP or MLD
membership. A device can restrict the length membership.A device can restrict the length
and value of this name, possibly space and special and value of this name, possibly space and special
characters are not allowed."; characters are not allowed.";
} }
leaf immediate-leave { leaf immediate-leave {
if-feature intf-immediate-leave; if-feature intf-immediate-leave;
type empty; type empty;
description description
"If present, IGMP or MLD perform an immediate leave upon "If present, IGMP or MLD perform an immediate leave upon
receiving an IGMP or MLD? leave message. receiving an IGMPv2 or MLDv1 leave message.
If the router is IGMP-enabled or MLD-enabled, it sends an If the router is IGMP-enabled or MLD-enabled, it sends an
IGMP or MLD last member query with a last member query IGMP or MLD last member query with a last member query
response time. However, the router does not wait for response time. However, the router does not wait for
the response time before it prunes off the group."; the response time before it prunes off the group.";
} }
leaf last-member-query-interval {
type uint16 {
range "1..65535";
}
units seconds;
default 1;
description
"Last Member Query Interval, which may be tuned to modify the
leave latency of the network.";
reference "RFC3376. Sec. 8.8.";
}
leaf max-groups { leaf max-groups {
if-feature intf-max-groups; if-feature intf-max-groups;
type uint32; type uint32;
description description
"The maximum number of groups that IGMP ro MLD can join."; "The maximum number of groups that IGMP ro MLD can join.";
} }
leaf max-group-sources { leaf max-group-sources {
if-feature intf-max-group-sources; if-feature intf-max-group-sources;
type uint32; type uint32;
description description
"The maximum number of (source, group) entries."; "The maximum number of group sources.";
}
leaf query-interval {
type uint16 {
range "1..31744";
}
units seconds;
default 125;
description
"The Query Interval is the interval between General Queries
sent by the Querier.In RFC3376, Querier's Query Interval(QQI) is
represented from the Querier's Query Interval Code in query
message as follows:
If QQIC < 128, QQI = QQIC
If QQIC >= 128, QQIC represents a floating-point value as follows:
0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+
|1| exp | mant |
+-+-+-+-+-+-+-+-+
QQI = (mant | 0x10) << (exp + 3)
The maximum value of QQI is 31744.";
reference "RFC3376. Sec. 4.1.7, 8.2, 8.14.2.";
}
leaf query-max-response-time {
type uint16 {
range "1..65535";
}
units seconds;
default 10;
description
"Query maximum response time specifies the maximum time
allowed before sending a responding report.";
reference "RFC3376. Sec. 4.1.1, 8.3, 8.14.3.";
}
leaf require-router-alert {
if-feature intf-require-router-alert;
type boolean;
description
"Protocol packets should contain router alert IP option.";
}
leaf robustness-variable {
type uint8 {
range "1..7";
}
default 2;
description
"Querier's Robustness Variable allows tuning for the expected
packet loss on a network.";
reference "RFC3376. Sec. 4.1.6, 8.1, 8.14.1.";
} }
leaf source-policy { leaf source-policy {
if-feature intf-source-policy; if-feature intf-source-policy;
type string; type leafref {
path "/acl:acls/acl:acl/acl:name";
}
description description
"Name of the access policy used to filter sources. "Name of the access policy used to filter sources.
A device can restrict the length A device can restrict the length
and value of this name, possibly space and special and value of this name, possibly space and special
characters are not allowed."; characters are not allowed.";
} }
leaf verify-source-subnet { leaf verify-source-subnet {
if-feature intf-verify-source-subnet; if-feature intf-verify-source-subnet;
type empty; type empty;
description description
"If present, the interface accepts packets with matching "If present, the interface accepts packets with matching
source IP subnet only."; source IP subnet only.";
} }
leaf explicit-tracking { leaf explicit-tracking {
if-feature intf-explicit-tracking; if-feature intf-explicit-tracking;
type boolean; type empty;
description description
"IGMP/MLD-based explicit membership tracking function "If present, IGMP/MLD-based explicit membership tracking function
for multicast routers and IGMP/MLD proxy devices for multicast routers and IGMP/MLD proxy devices
supporting IGMPv3/MLDv2. The explicit membership tracking supporting IGMPv3/MLDv2. The explicit membership tracking
function contributes to saving network resources and function contributes to saving network resources and
shortening leave latency."; shortening leave latency.";
} }
leaf exclude-lite { leaf exclude-lite {
if-feature intf-exclude-lite; if-feature intf-exclude-lite;
type boolean; type empty;
description description
"lightweight IGMPv3 and MLDv2 protocols, which simplify the "If present, lightweight IGMPv3 and MLDv2 protocols will run on the
standard versions of IGMPv3 and MLDv2."; which simplify the standard versions of IGMPv3 and MLDv2.";
reference "RFC5790"; reference "RFC5790";
} }
} // interface-config-attributes-igmp-mld } // interface-specific-config-attributes
grouping interface-config-attributes-mld { grouping interface-config-attributes-igmp {
description "Per interface configuration for MLD."; description
"Per interface configuration attributes for IGMP.";
uses interface-config-attributes-igmp-mld; uses interface-common-config-attributes-igmp;
uses interface-specific-config-attributes;
leaf version { leaf-list join-group {
type uint8 { if-feature intf-join-group;
range "1..2"; type rt-types:ipv4-multicast-group-address;
description
"The router joins this multicast group on the interface.";
}
list ssm-map {
if-feature intf-ssm-map;
key "ssm-map-source-addr ssm-map-group-policy";
description "The policy for (*,G) mapping to (S,G).";
leaf ssm-map-source-addr {
type ssm-map-ipv4-addr-type;
description
"Multicast source IPv4 address.";
}
leaf ssm-map-group-policy {
type string;
description
"Name of the policy used to define ssm-map rules.
A device can restrict the length
and value of this name, possibly space and special
characters are not allowed. ";
}
}
list static-group {
if-feature intf-static-group;
key "group-addr source-addr";
description
"A static multicast route, (*,G) or (S,G).";
leaf group-addr {
type rt-types:ipv4-multicast-group-address;
description
"Multicast group IPv4 address.";
}
leaf source-addr {
type rt-types:ipv4-multicast-source-address;
description
"Multicast source IPv4 address.";
} }
description "MLD version.";
reference "RFC2710, RFC3810.";
} }
} // interface-config-attributes-igmp
grouping interface-config-attributes-mld {
description
"Per interface configuration attributes for MLD.";
uses interface-common-config-attributes-mld;
uses interface-specific-config-attributes;
leaf-list join-group { leaf-list join-group {
if-feature intf-join-group; if-feature intf-join-group;
type inet:ipv6-address; type rt-types:ipv6-multicast-group-address;
description description
"The router joins this multicast group on the interface."; "The router joins this multicast group on the interface.";
} }
list ssm-map { list ssm-map {
if-feature intf-ssm-map; if-feature intf-ssm-map;
key "source-addr group-policy"; key "ssm-map-source-addr ssm-map-group-policy";
description "The policy for (*,G) mapping to (S,G)."; description "The policy for (*,G) mapping to (S,G).";
leaf source-addr { leaf ssm-map-source-addr {
type ssm-map-ipv6-addr-type; type ssm-map-ipv6-addr-type;
description description
"Multicast source IPv6 address."; "Multicast source IPv6 address.";
} }
leaf group-policy { leaf ssm-map-group-policy {
type string; type string;
description description
"Name of the access policy used to filter MLD "Name of the policy used to define ssm-map rules.
membership. A device can restrict the length A device can restrict the length
and value of this name, possibly space and special and value of this name, possibly space and special
characters are not allowed."; characters are not allowed.";
} }
} }
list static-group { list static-group {
if-feature intf-static-group; if-feature intf-static-group;
key "group source-addr"; key "group-addr source-addr";
description description
"A static multicast route, (*,G) or (S,G)."; "A static multicast route, (*,G) or (S,G).";
leaf group { leaf group-addr {
type inet:ipv6-address; type rt-types:ipv6-multicast-group-address;
description description
"Multicast group IPv6 address."; "Multicast group IPv6 address.";
} }
leaf source-addr { leaf source-addr {
type source-ipv6-addr-type; type rt-types:ipv6-multicast-source-address;
description description
"Multicast source IPv6 address."; "Multicast source IPv6 address.";
} }
} }
} // interface-config-attributes-mld } // interface-config-attributes-mld
grouping interface-state-attributes-igmp-mld {
description
"Per interface state attributes for both IGMP and MLD.";
leaf oper-status {
type enumeration {
enum up {
description
"Ready to pass packets.";
}
enum down {
description
"The interface does not pass any packets.";
}
}
config false;
mandatory true;
description
"Interface up or down state for IGMP or MLD protocol";
}
} // interface-config-attributes-igmp-mld
grouping interface-state-attributes-igmp { grouping interface-state-attributes-igmp {
description description
"Per interface state attributes for IGMP."; "Per interface state attributes for IGMP.";
uses interface-state-attributes-igmp-mld; uses interface-state-attributes-igmp-mld;
leaf querier { leaf querier {
type inet:ipv4-address; type inet:ipv4-address;
config false; config false;
mandatory true;
description "The querier address in the subnet"; description "The querier address in the subnet";
} }
leaf-list joined-group { leaf-list joined-group {
if-feature intf-join-group; if-feature intf-join-group;
type inet:ipv4-address; type rt-types:ipv4-multicast-group-address;
config false; config false;
description description
"The routers that joined this multicast group."; "The routers that joined this multicast group.";
} }
list group { list group {
key "group-address"; key "group-address";
config false; config false;
description description
"Multicast group membership information "Multicast group membership information
that joined on the interface."; that joined on the interface.";
leaf group-address { leaf group-address {
type inet:ipv4-address; type rt-types:ipv4-multicast-group-address;
description description
"Multicast group address."; "Multicast group address.";
} }
uses interface-state-group-attributes-igmp-mld; uses interface-state-group-attributes-igmp-mld;
leaf last-reporter { leaf last-reporter {
type inet:ipv4-address; type inet:ipv4-address;
description description
"The last host address which has sent the "The last host address which has sent the
report to join the multicast group."; report to join the multicast group.";
} }
list source { list source {
key "source-address"; key "source-address";
description description
"List of multicast source information "List of multicast source information
of the multicast group."; of the multicast group.";
leaf source-address { leaf source-address {
type inet:ipv4-address; type inet:ipv4-address;
description description
"Multicast source address"; "Multicast source address in group record.";
} }
uses interface-state-source-attributes-igmp-mld; uses interface-state-source-attributes-igmp-mld;
leaf last-reporter { leaf last-reporter {
type inet:ipv4-address; type inet:ipv4-address;
description description
"The last host address which has sent the "The last host address which has sent the
report to join the multicast source and group."; report to join the multicast source and group.";
} }
list host { list host {
if-feature intf-explicit-tracking; if-feature intf-explicit-tracking;
key "host-address"; key "host-address";
description description
"List of multicast membership hosts "List of multicast membership hosts
of the specific multicast source-group."; of the specific multicast source-group.";
leaf host-address { leaf host-address {
type inet:ipv4-address; type inet:ipv4-address;
description description
"Multicast membership host address."; "Multicast membership host address.";
} }
leaf host-filter-mode { uses interface-state-host-attributes-igmp-mld;
type enumeration {
enum "include" {
description
"In include mode";
}
enum "exclude" {
description
"In exclude mode.";
}
}
description
"Filter mode for a multicast membership
host may be either include or exclude.";
}
}// list host }// list host
} // list source } // list source
} // list group } // list group
} // interface-state-attributes-igmp } // interface-state-attributes-igmp
grouping interface-state-attributes-igmp-mld {
description
"Per interface state attributes for both IGMP and MLD.";
leaf oper-status {
type enumeration {
enum up {
description
"Ready to pass packets.";
}
enum down {
description
"The interface does not pass any packets.";
}
}
config false;
description
"interface up or down state for IGMP or MLD protocol";
}
} // interface-config-attributes-igmp-mld
grouping interface-state-attributes-mld { grouping interface-state-attributes-mld {
description description
"Per interface state attributes for MLD."; "Per interface state attributes for MLD.";
uses interface-state-attributes-igmp-mld; uses interface-state-attributes-igmp-mld;
leaf querier { leaf querier {
type inet:ipv6-address; type inet:ipv6-address;
config false; config false;
mandatory true;
description description
"The querier address in the subnet."; "The querier address in the subnet.";
} }
leaf-list joined-group { leaf-list joined-group {
if-feature intf-join-group; if-feature intf-join-group;
type inet:ipv6-address; type rt-types:ipv6-multicast-group-address;
config false; config false;
description description
"The routers that joined this multicast group."; "The routers that joined this multicast group.";
} }
list group { list group {
key "group-address"; key "group-address";
config false; config false;
description description
"Multicast group membership information "Multicast group membership information
that joined on the interface."; that joined on the interface.";
leaf group-address { leaf group-address {
type inet:ipv6-address; type rt-types:ipv6-multicast-group-address;
description description
"Multicast group address."; "Multicast group address.";
} }
uses interface-state-group-attributes-igmp-mld; uses interface-state-group-attributes-igmp-mld;
leaf last-reporter { leaf last-reporter {
type inet:ipv6-address; type inet:ipv6-address;
description description
"The last host address which has sent the "The last host address which has sent the
report to join the multicast group."; report to join the multicast group.";
} }
list source { list source {
key "source-address"; key "source-address";
description description
"List of multicast source information "List of multicast source information
skipping to change at page 27, line 47 skipping to change at page 26, line 43
} }
list source { list source {
key "source-address"; key "source-address";
description description
"List of multicast source information "List of multicast source information
of the multicast group."; of the multicast group.";
leaf source-address { leaf source-address {
type inet:ipv6-address; type inet:ipv6-address;
description description
"Multicast source address"; "Multicast source address in group record";
} }
uses interface-state-source-attributes-igmp-mld; uses interface-state-source-attributes-igmp-mld;
leaf last-reporter { leaf last-reporter {
type inet:ipv6-address; type inet:ipv6-address;
description description
"The last host address which has sent the "The last host address which has sent the
report to join the multicast source and group."; report to join the multicast source and group.";
} }
list host { list host {
if-feature intf-explicit-tracking; if-feature intf-explicit-tracking;
key "host-address"; key "host-address";
description description
"List of multicast membership hosts "List of multicast membership hosts
of the specific multicast source-group."; of the specific multicast source-group.";
leaf host-address { leaf host-address {
type inet:ipv6-address; type inet:ipv6-address;
description description
"Multicast membership host address."; "Multicast membership host address.";
} }
leaf host-filter-mode { uses interface-state-host-attributes-igmp-mld;
type enumeration {
enum "include" {
description
"In include mode";
}
enum "exclude" {
description
"In exclude mode.";
}
}
description
"Filter mode for a multicast membership
host may be either include or exclude.";
}
}// list host }// list host
} // list source } // list source
} // list group } // list group
} // interface-state-attributes-mld } // interface-state-attributes-mld
grouping interface-state-group-attributes-igmp-mld { grouping interface-state-group-attributes-igmp-mld {
description description
"Per interface state attributes for both IGMP and MLD "Per interface state attributes for both IGMP and MLD
groups."; groups.";
leaf expire { leaf expire {
type uint32; type uint32;
units seconds; units seconds;
mandatory true;
description description
"The time left before multicast group state expires."; "The time left before multicast group state expires.";
} }
leaf filter-mode { leaf filter-mode {
type enumeration { type enumeration {
enum "include" { enum "include" {
description description
"In include mode, reception of packets sent "In include mode, reception of packets sent
to the specified multicast address is requested to the specified multicast address is requested
only from those IP source addresses listed in the only from those IP source addresses listed in the
source-list parameter"; source-list parameter";
} }
enum "exclude" { enum "exclude" {
description description
"In exclude mode, reception of packets sent "In exclude mode, reception of packets sent
to the given multicast address is requested to the given multicast address is requested
from all IP source addresses except those from all IP source addresses except those
listed in the source-list parameter."; listed in the source-list parameter.";
} }
} }
mandatory true;
description description
"Filter mode for a multicast group, "Filter mode for a multicast group,
may be either include or exclude."; may be either include or exclude.";
} }
leaf up-time { leaf up-time {
type uint32; type uint32;
units seconds; units seconds;
mandatory true;
description description
"The elapsed time since the device created multicast group record."; "The elapsed time since the device created multicast group record.";
} }
} // interface-state-group-attributes-igmp-mld } // interface-state-group-attributes-igmp-mld
grouping interface-state-source-attributes-igmp-mld { grouping interface-state-source-attributes-igmp-mld {
description description
"Per interface state attributes for both IGMP and MLD "Per interface state attributes for both IGMP and MLD
source-group records."; source-group records.";
leaf expire { leaf expire {
type uint32; type uint32;
units seconds; units seconds;
mandatory true;
description description
"The time left before multicast source-group state expires."; "The time left before multicast source-group state expires.";
} }
leaf up-time { leaf up-time {
type uint32; type uint32;
units seconds; units seconds;
mandatory true;
description description
"The elapsed time since the device created multicast "The elapsed time since the device created multicast
source-group record."; source-group record.";
} }
leaf host-count { leaf host-count {
if-feature intf-explicit-tracking; if-feature intf-explicit-tracking;
type uint32; type uint32;
description description
"The number of host addresses."; "The number of host addresses.";
} }
} // interface-state-source-attributes-igmp-mld } // interface-state-source-attributes-igmp-mld
grouping interface-state-host-attributes-igmp-mld {
description
"Per interface state attributes for both IGMP and MLD
hosts of source-group records.";
leaf host-filter-mode {
type enumeration {
enum "include" {
description
"In include mode";
}
enum "exclude" {
description
"In exclude mode.";
}
}
mandatory true;
description
"Filter mode for a multicast membership
host may be either include or exclude.";
}
}// interface-state-host-attributes-igmp-mld
/* /*
* Configuration and Operational state data nodes (NMDA version) * Configuration and Operational state data nodes (NMDA version)
*/ */
augment "/rt:routing/rt:control-plane-protocols" augment "/rt:routing/rt:control-plane-protocols"
{ {
description description
"IGMP augmentation to routing control plane protocol "IGMP augmentation to routing control plane protocol
configuration and state."; configuration and state.";
container igmp { container igmp {
if-feature feature-igmp;
description description
"IGMP operational state data."; "IGMP configuration and operational state data.";
container global { container global {
description description
"Global attributes."; "Global attributes.";
uses global-config-attributes; uses global-config-attributes;
uses global-state-attributes; uses global-state-attributes;
} }
container interfaces { container interfaces {
description description
skipping to change at page 31, line 17 skipping to change at page 30, line 27
} // igmp } // igmp
}//augment }//augment
augment "/rt:routing/rt:control-plane-protocols" augment "/rt:routing/rt:control-plane-protocols"
{ {
description description
"MLD augmentation to routing control plane protocol "MLD augmentation to routing control plane protocol
configuration and state."; configuration and state.";
container mld { container mld {
if-feature feature-mld;
description description
"MLD operational state data."; "MLD configuration and operational state data.";
container global { container global {
description description
"Global attributes."; "Global attributes.";
uses global-config-attributes; uses global-config-attributes;
uses global-state-attributes; uses global-state-attributes;
} }
container interfaces { container interfaces {
description description
skipping to change at page 32, line 16 skipping to change at page 31, line 26
} // interfaces } // interfaces
} // mld } // mld
} // augment } // augment
/* /*
* RPCs * RPCs
*/ */
rpc clear-igmp-groups { rpc clear-igmp-groups {
if-feature rpc-clear-groups; if-feature rpc-clear-groups;
description description
"Clears the specified IGMP entries."; "Clears the specified IGMP cache entries.";
input { input {
leaf interface { leaf interface-name {
type string; if-feature feature-igmp;
type leafref {
path "/rt:routing/rt:control-plane-protocols/"
+ "igmp-mld:igmp/igmp-mld:interfaces/"
+ "igmp-mld:interface/igmp-mld:interface-name";
}
description description
"Name of the IGMP interface. "Name of the IGMP interface.
If it is not specified, groups from all interfaces are If it is not specified, groups from all interfaces are
cleared."; cleared.";
} }
leaf group { leaf group-address {
type inet:ipv4-address; type rt-types:ipv4-multicast-group-address;
description description
"Multicast group IPv4 address. "Multicast group IPv4 address.
If it is not specified, all IGMP group entries are If it is not specified, all IGMP group entries are
cleared."; cleared.";
} }
leaf source { leaf source-address {
type inet:ipv4-address; type rt-types:ipv4-multicast-source-address;
description description
"Multicast source IPv4 address. "Multicast source IPv4 address.
If it is not specified, all IGMP source-group entries are If it is not specified, all IGMP source-group entries are
cleared."; cleared.";
} }
} }
} // rpc clear-igmp-groups } // rpc clear-igmp-groups
rpc clear-mld-groups { rpc clear-mld-groups {
if-feature rpc-clear-groups; if-feature rpc-clear-groups;
description description
"Clears the specified MLD cache entries."; "Clears the specified MLD cache entires.";
input { input {
leaf interface { leaf interface-name {
type string; if-feature feature-mld;
type leafref {
path "/rt:routing/rt:control-plane-protocols/"
+ "igmp-mld:mld/igmp-mld:interfaces/"
+ "igmp-mld:interface/igmp-mld:interface-name";
}
description description
"Name of the MLD interface. "Name of the MLD interface.
If it is not specified, groups from all interfaces are If it is not specified, groups from all interfaces are
cleared."; cleared.";
} }
leaf group { leaf group-addrss {
type inet:ipv6-address; type rt-types:ipv6-multicast-group-address;
description description
"Multicast group IPv6 address. "Multicast group IPv6 address.
If it is not specified, all MLD group entries are If it is not specified, all MLD group entries are
cleared."; cleared.";
} }
leaf source { leaf source-address {
type inet:ipv6-address; type rt-types:ipv6-multicast-source-address;
description description
"Multicast source IPv6 address. "Multicast source IPv6 address.
If it is not specified, all MLD source-group entries are If it is not specified, all MLD source-group entries are
cleared."; cleared.";
} }
} }
} // rpc clear-mld-groups } // rpc clear-mld-groups
/* /*
* Notifications * Notifications
skipping to change at page 34, line 23 skipping to change at page 33, line 49
configuration can cause IGMP membership deleted or reconstructed configuration can cause IGMP membership deleted or reconstructed
on all the interfaces of a device. on all the interfaces of a device.
igmp:interfaces/interface igmp:interfaces/interface
This subtree specifies the configuration for the IGMP attributes This subtree specifies the configuration for the IGMP attributes
at the interface level on a device. Modifying the configuration at the interface level on a device. Modifying the configuration
can cause IGMP membership deleted or reconstructed on a specific can cause IGMP membership deleted or reconstructed on a specific
interface of a device. interface of a device.
These subtrees are all under /rt:routing/rt:control-plane These subtrees are all under
protocols/igmp:
mld:global /rt:routing/rt:control-plane protocols/igmp:
mld:global
This subtree specifies the configuration for the MLD attributes at This subtree specifies the configuration for the MLD attributes at
the global level on a device. Modifying the configuration can the global level on a device. Modifying the configuration can
cause MLD membership deleted or reconstructed on all the cause MLD membership deleted or reconstructed on all the
interfaces of a device. interfaces of a device.
mld:interfaces mld:interfaces
This subtree specifies the configuration for the MLD attributes at This subtree specifies the configuration for the MLD attributes at
all of the interfaces level on a device. Modifying the all of the interfaces level on a device. Modifying the
configuration can cause MLD membership deleted or reconstructed on configuration can cause MLD membership deleted or reconstructed on
all the interfaces of a device. all the interfaces of a device.
mld:interfaces/interface mld:interfaces/interface
This subtree specifies the configuration for the MLD attributes at This subtree specifies the configuration for the MLD attributes at
the interface level on a device. Modifying the configuration can the interface level on a device. Modifying the configuration can
cause MLD membership deleted or reconstructed on a specific cause MLD membership deleted or reconstructed on a specific
interface of a device. interface of a device.
These subtrees are all under /rt:routing/rt:control-plane- These subtrees are all under
protocols/mld:
/rt:routing/rt:control-plane-protocols/mld:
Unauthorized access to any data node of these subtrees can adversely Unauthorized access to any data node of these subtrees can adversely
affect the membership records of multicast routing subsystem on the affect the membership records of multicast routing subsystem on the
local device. This may lead to network malfunctions, delivery of local device. This may lead to network malfunctions, delivery of
packets to inappropriate destinations, and other problems. packets to inappropriate destinations, and other problems.
Some of the readable data nodes in this YANG module may be Some of the readable data nodes in this YANG module may be
considered sensitive or vulnerable in some network environments. It considered sensitive or vulnerable in some network environments. It
is thus important to control read access (e.g., via get, get-config, is thus important to control read access (e.g., via get, get-config,
or notification) to these data nodes. These are the subtrees and or notification) to these data nodes. These are the subtrees and
skipping to change at page 36, line 44 skipping to change at page 36, line 26
9.1. Normative References 9.1. Normative References
[RFC1112] Deering, S., "Host extensions for IP multicasting", STD 5, [RFC1112] Deering, S., "Host extensions for IP multicasting", STD 5,
RFC 1112, August 1989. RFC 1112, August 1989.
[RFC2236] Fenner, W., "Internet Group Management Protocol, Version [RFC2236] Fenner, W., "Internet Group Management Protocol, Version
2", RFC 2236, November 1997. 2", RFC 2236, November 1997.
[RFC2710] Deering, S., Fenner, W., and B. Haberman, "Multicast [RFC2710] Deering, S., Fenner, W., and B. Haberman, "Multicast
Listener Discovery (MLD) for IPv6", RFC 2710, October Listener Discovery (MLD) for IPv6", RFC 2710, October
1999. 1999.
[RFC3376] Cain, B., Deering, S., Kouvelas, I., Fenner, B., and A. [RFC3376] Cain, B., Deering, S., Kouvelas, I., Fenner, B., and A.
Thyagarajan, "Internet Group Management Protocol, Version Thyagarajan, "Internet Group Management Protocol, Version
3", RFC 3376, October 2002. 3", RFC 3376, October 2002.
[RFC3688] Mealling, M., "The IETF XML Registry", RFC 3688, January [RFC3688] Mealling, M., "The IETF XML Registry", RFC 3688, January
2004 2004
[RFC3810] Vida, R. and L. Costa, "Multicast Listener Discovery [RFC3810] Vida, R. and L. Costa, "Multicast Listener Discovery
Version 2 (MLDv2) for IPv6", RFC 3810, June 2004. Version 2 (MLDv2) for IPv6", RFC 3810, June 2004.
[RFC4541] M. Christensen, K. Kimball and F. Solensky, [RFC4541] M. Christensen, K. Kimball and F. Solensky,
"Considerations for Internet Group Management Protocol "Considerations for Internet Group Management Protocol
(IGMP) and Multicast Listener Discovery (MLD) Snooping (IGMP) and Multicast Listener Discovery (MLD) Snooping
skipping to change at page 37, line 23 skipping to change at page 37, line 7
[RFC4605] B. Fenner, H. He, B. Haberman, and H. Sandick, "Internet [RFC4605] B. Fenner, H. He, B. Haberman, and H. Sandick, "Internet
Group Management Protocol (IGMP) / Multicast Listener Group Management Protocol (IGMP) / Multicast Listener
Discovery (MLD)-Based Multicast Forwarding ("IGMP/MLD Discovery (MLD)-Based Multicast Forwarding ("IGMP/MLD
Proxying")", RFC 4605, August 2006. Proxying")", RFC 4605, August 2006.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, August 2008 (TLS) Protocol Version 1.2", RFC 5246, August 2008
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010 October 2010
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, June 2011 (NETCONF)", RFC 6241, June 2011
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011 Shell (SSH)", RFC 6242, June 2011
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, March Protocol (NETCONF) Access Control Model", RFC 6536, April
2012 2012
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, July 2013 RFC 6991, July 2013
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, August 2016 RFC 7950, August 2016
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, January 2017 Protocol", RFC 8040, January 2017
[RFC8294] Liu, X., Qu, Y., Lindem, A., Hopps, C., and L. Berger,
"Common YANG Data Types for the Routing Area", RFC 8294,
December 2017
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, March 2018 (NMDA)", RFC 8342, April 2018
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface [RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, March 2018 Management", RFC 8343, April 2018
[RFC8344] M. Bjorklund, "A YANG Data Model for IP Management",
RFC8344, April 2018
[RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
Routing Management (NMDA Version)", RFC 8349, March 2018 Routing Management (NMDA Version)", RFC 8349, April 2018
[I-D.ietf-acl-yang] M. Jethanandani, L. Huang, S. Agarwal and D.
Blair, "Network Access Control List (ACL) YANG Data
Model", draft-ietf-netmod-acl-model-19(work in progress),
April 2018
9.2. Informative References 9.2. Informative References
[RFC5790] H. Liu, W. Cao and H. Asaeda, "Lightweight Internet Group [RFC5790] H. Liu, W. Cao and H. Asaeda, "Lightweight Internet Group
Management Protocol Version 3 (IGMPv3) and Multicast Management Protocol Version 3 (IGMPv3) and Multicast
Listener Discovery Version 2 (MLDv2) Protocols", RFC 5790, Listener Discovery Version 2 (MLDv2) Protocols", RFC 5790,
February 2010 February 2010
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, March 2018 BCP 215, RFC 8340, April 2018
[I-D.ietf-netmod-rfc6087bis] Bierman, A., "Guidelines for Authors [I-D.ietf-netmod-rfc6087bis] Bierman, A., "Guidelines for Authors
and Reviewers of YANG Data Model Documents", draft-ietf- and Reviewers of YANG Data Model Documents", draft-ietf-
netmod-rfc6087bis-20(work in progress), March 2018 netmod-rfc6087bis-20(work in progress), April 2018
Authors' Addresses Authors' Addresses
Xufeng Liu Xufeng Liu
Volta Networks Volta Networks
EMail: xufeng.liu.ietf@gmail.com EMail: xufeng.liu.ietf@gmail.com
Feng Guo Feng Guo
Huawei Technologies Huawei Technologies
 End of changes. 153 change blocks. 
394 lines changed or deleted 384 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/