draft-ietf-pim-igmp-mld-yang-06.txt   draft-ietf-pim-igmp-mld-yang-07.txt 
PIM Working Group X. Liu PIM Working Group X. Liu
Internet-Draft Jabil Internet-Draft Volta Networks
Intended Status: Standard Track F. Guo Intended Status: Standard Track F. Guo
Expires: April 20, 2018 Huawei Expires: December 22, 2018 Huawei Technologies
M. Sivakumar M. Sivakumar
Cisco Juniper Networks
P. McAllister P. McAllister
Metaswitch Networks Metaswitch Networks
A. Peter A. Peter
Juniper Networks Individual
Oct 20, 2017 June 22,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-06 draft-ietf-pim-igmp-mld-yang-07
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 April 20, 2018. This Internet-Draft will expire on December 22, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2018 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 19 skipping to change at page 2, line 19
Abstract Abstract
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. Multicast Listener Discovery (MLD) devices.
Table of Contents Table of Contents
1. Introduction ................................................ 2 1. Introduction ................................................ 2
1.1. Requirements Language................................... 3 1.1. Terminology ............................................ 3
1.2. Terminology ............................................ 3 1.2. Tree Diagrams .......................................... 3
2. Design of Data model......................................... 3 1.3. Prefixes in Data Node Names............................. 3
2.1. Scope of model ......................................... 3 2. Design of Data model......................................... 4
2.2. Optional capabilities................................... 3 2.1. Scope of model ......................................... 4
2.3. Position of address family in hierarchy................. 4 2.2. Optional capabilities................................... 4
3. Module Structure ............................................ 4 2.3. Position of address family in hierarchy ................ 5
3.1. IGMP Configuration and Operational state................ 4 3. Module Structure ............................................ 5
3.2. MLD Configuration and Operational State................. 6 3.1. IGMP Configuration and Operational state ............... 5
3.3. IGMP and MLD RPC........................................ 8 3.2. MLD Configuration and Operational State ................ 7
3.3. IGMP and MLD RPC ....................................... 9
4. IGMP and MLD YANG Modules.................................... 9 4. IGMP and MLD YANG Modules.................................... 9
5. Security Considerations..................................... 32 5. Security Considerations..................................... 33
6. IANA Considerations ........................................ 32 6. IANA Considerations ........................................ 35
7. Acknowledgments ............................................ 33 7. Acknowledgments ............................................ 36
8. Contributing Authors........................................ 33 8. Contributing Authors........................................ 36
9. References ................................................. 33 9. References ................................................. 36
9.1. Normative References................................... 33 9.1. Normative References .................................. 36
9.2. Informative References................................. 34 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 NETCONF [RFC6241]. YANG is now also being used as a managed using network management protocols such as NETCONF [RFC6241]
component of wider management interfaces, such as CLIs. or RESTCONF [RFC8040]. YANG is now also being used as a component
of 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. Requirements Language 1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC-2119 [RFC2119].
1.2. Terminology
The terminology for describing YANG data models is found in The terminology for describing YANG data models is found in
[RFC6020] [RFC7950]. [RFC6020] [RFC7950].
This document employs YANG tree diagrams, which are explained in [I- The following abbreviations are used in this document and the
D.ietf-netmod-rfc6087bis]. defined model:
IGMP:
Internet Group Management Protocol [RFC3376].
MLD:
Multicast Listener Discovery [RFC3810].
1.2. Tree Diagrams
Tree diagrams used in this document follow the notation defined in
[RFC8340].
1.3. Prefixes in Data Node Names
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
the context in which YANG module each name is defined. Otherwise,
names are prefixed using the standard prefix associated with the
corresponding YANG module, as shown in Table 1.
+-----------+--------------------+---------------------+
| Prefix | YANG module | Reference |
+-----------+--------------------+---------------------+
| yang | ietf-yang-types | [RFC6991] |
| inet | ietf-inet-types | [RFC6991] |
| if | ietf-interfaces | [RFC8343] |
| rt | ietf-routing | [RFC8349] |
+-----------+--------------------+---------------------+
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 4, line 35 skipping to change at page 5, line 23
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
3.1. IGMP Configuration and Operational state 3.1. IGMP Configuration and Operational state
The IGMP YANG model follows the Guidelines for YANG Module Authors The IGMP YANG model conforms to the Network Management Datastore
(NMDA) [draft-dsdt-nmda-guidelines-01]. The IGMP module defines the Architecture (NMDA) [RFC8342]. The operational state data is
routing-control-plane-protocol-wide configuration and operational combined with the associated configuration data in the same
state options separately in a three-level hierarchy as listed below: hierarchy [I-D.ietf-netmod-rfc6087bis]. The IGMP module defines in a
three-level hierarchy structure as listed below:
Global level: IGMP configuration and operational state attributes Global level: IGMP configuration and operational state attributes
for the entire routing system. for the entire routing system.
Interface-global: Only including configuration data nodes now. Interface-global: Only including configuration data nodes that
IGMP configuration attributes are applicable to all the interfaces IGMP configuration attributes are applicable to all the interfaces
whose interface-level corresponding attributes are not existing, whose interface-level corresponding attributes are not existing,
with same attributes' value for these interfaces. with same attributes' value for these interfaces.
Interface-level: IGMP configuration and operational state Interface-level: IGMP configuration and operational state
attributes specific to the given interface. attributes specific to the given interface.
Where fields are not genuinely essential to protocol operation, they Where fields are not genuinely essential to protocol operation, they
are marked as optional. Some fields will be essential but have a are marked as optional. Some fields will be essential but have a
default specified, so that they need not be configured explicitly. default specified, so that they need not be configured explicitly.
We define the IGMP model as a protocol-centric model , and the IGMP This model augments the core routing data model "ietf-routing"
model augments "/rt:routing/rt:control-plane-protocols/ rt:control- specified in [RFC8349]. The IGMP model augments "/rt:routing/
plane-protocol" in [draft-acee-netmod-rfc8022bis-01] and would allow rt:control-plane-protocols" as opposed to augmenting "/rt:routing/
a single protocol instance per VRF. rt:control-plane-protocols/rt:control-plane-protocol", as the latter
would allow multiple protocol instances, while the IGMP protocol is
designed to be enabled or disabled as a single protocol instance on
a network instance or a logical network element.
augment /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol: augment /rt:routing/rt:control-plane-protocols:
+--rw igmp +--rw 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
skipping to change at page 5, line 48 skipping to change at page 6, line 40
+--rw last-member-query-interval? uint16 +--rw last-member-query-interval? uint16
+--rw max-groups-per-interface? uint32 {intf-max-groups}? +--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 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 enable? boolean {intf-admin-enable}?
+--rw group-policy? string +--rw group-policy? String
+--rw immediate-leave? empty {intf-immediate-leave}? +--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-groups? uint32 {intf-max-groups}?
+--rw max-group-sources? uint32 {intf-max-group-sources}? +--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 source-policy? string {intf-source-policy}?
+--rw verify-source-subnet? empty {intf-verify-source-subnet}? +--rw verify-source-subnet? empty {intf-verify-source-subnet}?
+--rw explicit-tracking? boolean {intf-explicit-tracking}? +--rw explicit-tracking? boolean {intf-explicit-tracking}?
+--rw exclude-lite? boolean {intf-exclude-lite}? +--rw exclude-lite? boolean {intf-exclude-lite}?
+--rw version? uint8 +--rw version? uint8
+--rw join-group* inet:ipv4-address {intf-join-group}? +--rw join-group* inet:ipv4-address {intf-join-group}?
+--rw ssm-map* [source-addr group-policy] {intf-ssm-map}? +--rw ssm-map* [source-addr group-policy] {intf-ssm-map}?
| +--rw source-addr ssm-map-ipv4-addr-type | +--rw source-addr ssm-map-ipv4-addr-type
| +--rw group-policy string | +--rw 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 inet:ipv4-address
| +--rw source-addr source-ipv4-addr-type | +--rw source-addr source-ipv4-addr-type
+--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* inet:ipv4-address {intf-join-group}?
+--ro group* [group-address] +--ro group* [group-address]
+--ro group-address inet:ipv4-address +--ro group-address inet:ipv4-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
skipping to change at page 6, line 41 skipping to change at page 7, line 34
+--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 the routing-control-plane-protocol-wide MLD module also defines in a three-level hierarchy structure as
configuration and operational state options separately in a three- listed below:
level hierarchy.
augment /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol: augment /rt:routing/rt:control-plane-protocols:
+--rw mld +--rw 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
skipping to change at page 9, line 7 skipping to change at page 9, line 46
+---w input +---w input
+---w interface? string +---w interface? string
+---w group? inet:ipv6-address +---w group? inet:ipv6-address
+---w source? inet:ipv6-address +---w source? inet:ipv6-address
4. IGMP and MLD YANG Modules 4. IGMP and MLD YANG Modules
<CODE BEGINS> file "ietf-igmp-mld@2017-10-20.yang" <CODE BEGINS> file "ietf-igmp-mld@2018-06-22.yang"
module ietf-igmp-mld { module ietf-igmp-mld {
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";
skipping to change at page 9, line 47 skipping to change at page 10, line 41
"WG Web: <http://tools.ietf.org/wg/pim/> "WG Web: <http://tools.ietf.org/wg/pim/>
WG List: <mailto:pim@ietf.org> WG List: <mailto:pim@ietf.org>
WG Chair: Stig Venaas WG Chair: Stig Venaas
<mailto:stig@venaas.com> <mailto:stig@venaas.com>
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@jabil.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:masivaku@cisco.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 {
description
"Updated yang data model for parameter range and description.";
reference
"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
"RFC XXXX: A YANG Data Model for IGMP and MLD"; "RFC XXXX: A YANG Data Model for IGMP and MLD";
} }
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
*/ */
skipping to change at page 14, line 36 skipping to change at page 15, line 33
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 can join."; "The number of groups that IGMP or MLD joins.";
} }
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 45 skipping to change at page 17, line 42
} }
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."; 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."; 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..65535";
} }
units seconds; units seconds;
default 10; default 10;
description description
skipping to change at page 17, line 21 skipping to change at page 18, line 30
leaf require-router-alert { leaf require-router-alert {
if-feature intf-require-router-alert; if-feature intf-require-router-alert;
type boolean; type boolean;
default false; default false;
description description
"Protocol packets should contain router alert IP option."; "Protocol packets should contain router alert IP option.";
} }
leaf robustness-variable { leaf robustness-variable {
type uint8 { type uint8 {
range "2..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 } // interfaces-config-attributes
skipping to change at page 18, line 27 skipping to change at page 19, line 33
type uint8 { type uint8 {
range "1..3"; range "1..3";
} }
description "IGMP version."; description "IGMP version.";
reference "RFC1112, RFC2236, RFC3376."; reference "RFC1112, RFC2236, RFC3376.";
} }
leaf-list join-group { leaf-list join-group {
if-feature intf-join-group; if-feature intf-join-group;
type inet:ipv4-address; type inet:ipv4-address;
description description
"The router joins this multicast group on the interface."; "The router itself joins this multicast group
on the interface as a host.";
} }
list ssm-map { list ssm-map {
if-feature intf-ssm-map; if-feature intf-ssm-map;
key "source-addr group-policy"; key "source-addr group-policy";
description "The policy for (*,G) mapping to (S,G)."; description "The policy for (*,G) mapping to (S,G).";
leaf source-addr { leaf source-addr {
type ssm-map-ipv4-addr-type; type ssm-map-ipv4-addr-type;
description description
"Multicast source IP address."; "Multicast source IP address.";
} }
leaf group-policy { leaf group-policy {
type string; type string;
description description
"Name of the access policy used to filter IGMP "Name of the access policy used to filter IGMP
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. ";
} }
} }
list static-group { list static-group {
if-feature intf-static-group; if-feature intf-static-group;
key "group-addr 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).";
skipping to change at page 19, line 34 skipping to change at page 20, line 43
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 string;
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 IGMPv2 or MLDv1 leave message. receiving an IGMP or MLD? 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 { leaf last-member-query-interval {
type uint16 { type uint16 {
range "1..65535"; range "1..65535";
} }
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 { leaf max-groups {
skipping to change at page 20, line 24 skipping to change at page 21, line 33
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 group sources."; "The maximum number of (source, group) entries.";
} }
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."; 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."; 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..65535";
} }
units seconds; units seconds;
default 10; default 10;
description description
skipping to change at page 21, line 10 skipping to change at page 22, line 29
leaf require-router-alert { leaf require-router-alert {
if-feature intf-require-router-alert; if-feature intf-require-router-alert;
type boolean; type boolean;
description description
"Protocol packets should contain router alert IP option."; "Protocol packets should contain router alert IP option.";
} }
leaf robustness-variable { leaf robustness-variable {
type uint8 { type uint8 {
range "2..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.";
} }
leaf source-policy { leaf source-policy {
if-feature intf-source-policy; if-feature intf-source-policy;
skipping to change at page 22, line 34 skipping to change at page 24, line 4
} }
list ssm-map { list ssm-map {
if-feature intf-ssm-map; if-feature intf-ssm-map;
key "source-addr group-policy"; key "source-addr group-policy";
description "The policy for (*,G) mapping to (S,G)."; description "The policy for (*,G) mapping to (S,G).";
leaf source-addr { leaf 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 group-policy {
type string; type string;
description description
"Name of the access policy used to filter MLD "Name of the access policy used to filter 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.";
} }
} }
list static-group { list static-group {
if-feature intf-static-group; if-feature intf-static-group;
key "group source-addr"; key "group source-addr";
description description
"A static multicast route, (*,G) or (S,G)."; "A static multicast route, (*,G) or (S,G).";
skipping to change at page 28, line 41 skipping to change at page 30, line 11
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
/* /*
* Configuration and Operational state data nodes (NMDA version) * Configuration and Operational state data nodes (NMDA version)
*/ */
augment "/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol" 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 {
description description
"IGMP operational state data."; "IGMP operational state data.";
container global { container global {
skipping to change at page 29, line 40 skipping to change at page 31, line 10
} }
uses interface-config-attributes-igmp { uses interface-config-attributes-igmp {
if-feature per-interface-config; if-feature per-interface-config;
} }
uses interface-state-attributes-igmp; uses interface-state-attributes-igmp;
} // interface } // interface
} // interfaces } // interfaces
} // igmp } // igmp
}//augment }//augment
augment "/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol" 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 {
description description
"MLD operational state data."; "MLD operational state data.";
container global { container global {
skipping to change at page 30, line 46 skipping to change at page 32, line 16
} // 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 cache entries."; "Clears the specified IGMP entries.";
input { input {
leaf interface { leaf interface {
type string; type string;
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 {
skipping to change at page 31, line 26 skipping to change at page 32, line 46
"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 entires."; "Clears the specified MLD cache entries.";
input { input {
leaf interface { leaf interface {
type string; type string;
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 {
skipping to change at page 32, line 4 skipping to change at page 33, line 22
} }
leaf source { leaf source {
type inet:ipv6-address; type inet:ipv6-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
*/ */
} }
<CODE ENDS> <CODE ENDS>
5. Security Considerations 5. Security Considerations
The data model defined does not introduce any security implications. The YANG module specified in this document defines a schema for data
This document does not change any underlying security issues that is designed to be accessed via network management protocols
inherent in [RFC8022]. such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF
layer is the secure transport layer, and the mandatory-to-implement
secure transport is Secure Shell (SSH) [RFC6242]. The lowest
RESTCONF layer is HTTPS, and the mandatory-to-implement secure
transport is TLS [RFC5246].
The NETCONF access control model [RFC6536] 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.
There are a number of data nodes defined in this YANG module 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:
igmp:global
This subtree specifies the configuration for the IGMP attributes
at the global level on a device. Modifying the configuration can
cause IGMP membership deleted or reconstructed on all the
interfaces of a device.
igmp:interfaces
This subtree specifies the configuration for the IGMP attributes
at all of the interfaces level on a device. Modifying the
configuration can cause IGMP membership deleted or reconstructed
on all the interfaces of a device.
igmp:interfaces/interface
This subtree specifies the configuration for the IGMP attributes
at the interface level on a device. Modifying the configuration
can cause IGMP membership deleted or reconstructed on a specific
interface of a device.
These subtrees are all under /rt:routing/rt:control-plane
protocols/igmp:
mld:global
This subtree specifies the configuration for the MLD attributes at
the global level on a device. Modifying the configuration can
cause MLD membership deleted or reconstructed on all the
interfaces of a device.
mld:interfaces
This subtree specifies the configuration for the MLD attributes at
all of the interfaces level on a device. Modifying the
configuration can cause MLD membership deleted or reconstructed on
all the interfaces of a device.
mld:interfaces/interface
This subtree specifies the configuration for the MLD attributes at
the interface level on a device. Modifying the configuration can
cause MLD membership deleted or reconstructed on a specific
interface of a device.
These subtrees are all under /rt:routing/rt:control-plane-
protocols/mld:
Unauthorized access to any data node of these subtrees can adversely
affect the membership records of multicast routing subsystem on the
local device. This may lead to network malfunctions, delivery of
packets to inappropriate destinations, and other problems.
Some of the readable data nodes in this YANG module 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:
/rt:routing/rt:control-plane-protocols/igmp
/rt:routing/rt:control-plane-protocols/mld
Unauthorized access to any data node of the above subtree can
disclose the operational state information of IGMP or MLD on this
device.
Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the
operations and their sensitivity/vulnerability:
clear-igmp-groups
clear-mld-groups
Unauthorized access to any of the above RPC operations can delete
the IGMP or MLD membership records on this device.
6. IANA Considerations 6. IANA Considerations
RFC Ed.: In this section, replace all occurrences of 'XXXX' with the RFC Ed.: In this section, replace all occurrences of 'XXXX' with the
actual RFC number (and remove this note). actual RFC number (and remove this note).
This document registers the following namespace URIs in the IETF XML This document registers the following namespace URIs in the IETF XML
registry [RFC3688]: registry [RFC3688]:
-------------------------------------------------------------------- --------------------------------------------------------------------
skipping to change at page 33, line 15 skipping to change at page 36, line 27
7. Acknowledgments 7. Acknowledgments
The authors would like to thank Steve Baillargeon, Hu Fangwei, The authors would like to thank Steve Baillargeon, Hu Fangwei,
Robert Kebler, Tanmoy Kundu, and Stig Venaas for their valuable Robert Kebler, Tanmoy Kundu, and Stig Venaas for their valuable
contributions. contributions.
8. Contributing Authors 8. Contributing Authors
Yisong Liu Yisong Liu
Huawei Technologies Huawei Technologies
Huawei Bld., No.156 Beiqing Rd. Huawei Bldg., No.156 Beiqing Rd.
Beijing 100095 Beijing 100095
China China
Email: liuyisong@huawei.com Email: liuyisong@huawei.com
9. References 9. References
9.1. Normative References 9.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010
[RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG
Data Model Documents", RFC 6087, January 2011
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, June 2011
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, August 2016
[RFC8022] Lhotka, L. and A. Lindem, "A YANG Data Model for Routing
Management", RFC 8022, November 2016
[I-D.dsdt-nmda-guidelines] M. Bjorklund, J. Schoenwaelder, P.
Shafer, K. Watsen, R. Wilton, "Guidelines for YANG Module
Authors (NMDA)", draft-dsdt-nmda-guidelines-01, May 2017
[draft-bjorklund-netmod-rfc7223bis-00] M. Bjorklund, "A YANG Data
Model for Interface Management", draft-bjorklund-netmod-
rfc7223bis-00, August 2017
[draft-bjorklund-netmod-rfc7277bis-00] M. Bjorklund, "A YANG Data
Model for IP Management", draft-bjorklund-netmod-
rfc7277bis-00, August 2017
[I-D.ietf-netmod-rfc6087bis] Bierman, A., "Guidelines for Authors
and Reviewers of YANG Data Model Documents", draft-ietf-
netmod-rfc6087bis-14, September 2017
[I-D.acee-netmod-rfc8022bis] L. Lhotka, A. Lindem and Y.Qu, "A YANG
Data Model for Routing Management (NDMA Version)", draft-
acee-netmod-rfc8022bis-02, September 2017
9.2. Informative 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
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
Switches", RFC 4541, May 2006. Switches", RFC 4541, May 2006.
[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
(TLS) Protocol Version 1.2", RFC 5246, August 2008
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, June 2011
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, March
2012
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, July 2013
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, August 2016
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, January 2017
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, March 2018
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, March 2018
[RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
Routing Management (NMDA Version)", RFC 8349, March 2018
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",
BCP 215, RFC 8340, March 2018
[I-D.ietf-netmod-rfc6087bis] Bierman, A., "Guidelines for Authors
and Reviewers of YANG Data Model Documents", draft-ietf-
netmod-rfc6087bis-20(work in progress), March 2018
Authors' Addresses Authors' Addresses
Xufeng Liu Xufeng Liu
Jabil Volta Networks
8281 Greensboro Drive, Suite 200
McLean VA 22102
USA
EMail: Xufeng_Liu@jabil.com EMail: xufeng.liu.ietf@gmail.com
Feng Guo Feng Guo
Huawei Huawei Technologies
Huawei Bld., No.156 Beiqing Rd. Huawei Bldg., No.156 Beiqing Rd.
Beijing 100095 Beijing 100095
China China
Email: guofeng@huawei.com Email: guofeng@huawei.com
Mahesh Sivakumar Mahesh Sivakumar
Cisco Systems, Inc. Juniper Networks
510 McCarthy Boulevard 1133 Innovation Way
Milpitas, California 95035 Sunnyvale, California
USA USA
Email: masivaku@cisco.com Email: sivakumar.mahesh@gmail.com
Pete McAllister Pete McAllister
Metaswitch Networks Metaswitch Networks
100 Church Street 100 Church Street
Enfield EN2 6BQ Enfield EN2 6BQ
UK UK
EMail: pete.mcallister@metaswitch.com EMail: pete.mcallister@metaswitch.com
Anish Peter Anish Peter
 End of changes. 56 change blocks. 
130 lines changed or deleted 296 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/