summaryrefslogtreecommitdiff
path: root/doc/rfc/rfc9166.txt
blob: ebd457a8ecc44aed897f244e8d4c81c8ce053f6c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
Internet Engineering Task Force (IETF)                           H. Zhao
Request for Comments: 9166                                      Ericsson
Category: Standards Track                                         X. Liu
ISSN: 2070-1721                                          IBM Corporation
                                                                  Y. Liu
                                                            China Mobile
                                                                A. Peter
                                                              Individual
                                                            M. Sivakumar
                                                        Juniper Networks
                                                            January 2022


  A YANG Data Model for Internet Group Management Protocol (IGMP) and
              Multicast Listener Discovery (MLD) Snooping

Abstract

   This document defines a YANG data model that can be used to configure
   and manage Internet Group Management Protocol (IGMP) and Multicast
   Listener Discovery (MLD) snooping devices.  The YANG module in this
   document conforms to the Network Management Datastore Architecture
   (NMDA).

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 7841.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   https://www.rfc-editor.org/info/rfc9166.

Copyright Notice

   Copyright (c) 2022 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Revised BSD License text as described in Section 4.e of the
   Trust Legal Provisions and are provided without warranty as described
   in the Revised BSD License.

Table of Contents

   1.  Introduction
     1.1.  Terminology
     1.2.  Tree Diagrams
     1.3.  Prefixes in Data Node Names
   2.  Design of Data Model
     2.1.  Overview
     2.2.  Optional Capabilities
     2.3.  Position of Address Family in Hierarchy
   3.  Module Structure
     3.1.  IGMP Snooping Instances
     3.2.  MLD Snooping Instances
     3.3.  Using IGMP and MLD Snooping Instances
     3.4.  IGMP and MLD Snooping Actions
   4.  IGMP and MLD Snooping YANG Module
   5.  Security Considerations
   6.  IANA Considerations
     6.1.  XML Registry
     6.2.  YANG Module Names Registry
   7.  References
     7.1.  Normative References
     7.2.  Informative References
   Appendix A.  Data Tree Example
   Authors' Addresses

1.  Introduction

   This document defines a YANG [RFC7950] data model for the management
   of IGMP and MLD snooping [RFC4541] devices.

   The YANG module in this document conforms to the NMDA defined in
   [RFC8342].  The NMDA adds the ability to inspect the current
   operational values for configuration, allowing clients to use
   identical paths for retrieving the configured values and the
   operational values.

1.1.  Terminology

   The terminology for describing YANG data models is found in [RFC6020]
   and [RFC7950], including:

   *  augment

   *  data model

   *  data node

   *  identity

   *  module

   The following terminologies are used in this document:

   mrouter:  multicast router, which is a router that has multicast
         routing enabled [RFC4286].

   mrouter interfaces:  snooping switch ports where multicast routers
         are attached [RFC4541].

   The following abbreviations are used in this document and 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 |
              +==========+======================+===========+
              | inet     | ietf-inet-types      | [RFC6991] |
              +----------+----------------------+-----------+
              | yang     | ietf-yang-types      | [RFC6991] |
              +----------+----------------------+-----------+
              | if       | ietf-interfaces      | [RFC8343] |
              +----------+----------------------+-----------+
              | rt       | ietf-routing         | [RFC8349] |
              +----------+----------------------+-----------+
              | rt-types | ietf-routing-types   | [RFC8294] |
              +----------+----------------------+-----------+
              | dot1q    | ieee802-dot1q-bridge | [dot1Qcp] |
              +----------+----------------------+-----------+

                  Table 1: Prefixes and Corresponding YANG
                                  Modules

2.  Design of Data Model

   An IGMP/MLD snooping switch [RFC4541] analyzes IGMP/MLD packets and
   sets up forwarding tables for multicast traffic.  If a switch does
   not run IGMP/MLD snooping, multicast traffic will be flooded in the
   broadcast domain.  If a switch runs IGMP/MLD snooping, multicast
   traffic will be forwarded based on the forwarding tables to avoid
   wasting bandwidth.  The IGMP/MLD snooping switch does not need to run
   any of the IGMP/MLD protocols.  Because the IGMP/MLD snooping is
   independent of the IGMP/MLD protocols, the data model defined in this
   document does not augment, or even require, the IGMP/MLD data model
   defined in [RFC8652].  The model covers considerations for IGMP and
   MLD snooping switches [RFC4541].

   IGMP and MLD snooping switches do not adhere to the conceptual model
   that provides the strict separation of functionality between
   different communications layers in the ISO model and instead utilize
   information in the upper-level protocol headers as factors to be
   considered in processing at the lower levels [RFC4541].

   IGMP snooping switches utilize IGMP and could support IGMPv1
   [RFC1112], IGMPv2 [RFC2236], and IGMPv3 [RFC3376].  MLD snooping
   switches utilize MLD and could support MLDv1 [RFC2710] and MLDv2
   [RFC3810].  The goal of this document is to define a data model that
   provides a common user interface to IGMP and MLD snooping.

2.1.  Overview

   The YANG module on IGMP and MLD snooping defined in this document has
   all the common building blocks for the IGMP and MLD snooping
   switches.

   The YANG module includes an IGMP and MLD snooping instance definition
   that uses the instance in the L2 service type of bridge [dot1Qcp].
   It also includes actions for clearing IGMP and MLD snooping group
   tables.

   The YANG module doesn't cover L2VPN, which will be specified in a
   separate document.

2.2.  Optional Capabilities

   This model is designed to represent the basic capability subsets of
   IGMP and MLD snooping.  The main design goals of this document are
   that the basic capabilities described in the model are supported by
   any major now-existing implementation and that the configuration of
   all implementations meeting the specifications is easy to express
   through some combination of the optional features in the model and
   simple vendor augmentations.

   There is also value in widely supported features being standardized
   to provide a standardized way to access these features, to save work
   for individual vendors, and to ensure that mapping between different
   vendors' configuration is not needlessly complicated.  Therefore,
   this model declares a number of features representing capabilities
   that not all deployed devices support.

   The extensive use of feature declarations should also substantially
   simplify the capability negotiation process for a vendor's IGMP and
   MLD snooping implementations.

   On the other hand, operational state parameters are not so widely
   designated as features, as there are many cases where the defaulting
   of an operational state parameter would not cause any harm to the
   system, and it is much more likely that an implementation without
   intrinsic support for a piece of operational state would be able to
   derive a suitable value for a state variable that is not
   intrinsically supported.

2.3.  Position of Address Family in Hierarchy

   IGMP snooping only supports IPv4, while MLD snooping only supports
   IPv6.  The data model defined in this document can be used for both
   IPv4 and IPv6 address families.

   This document defines IGMP snooping and MLD snooping as separate
   schema branches in the structure.  The benefits are:

   *  The model can support IGMP snooping (IPv4), MLD snooping (IPv6),
      or both optionally and independently.  Such flexibility cannot be
      achieved cleanly with a combined branch.

   *  The structure is consistent with other YANG data models such as
      [RFC8652], which uses separate branches for IPv4 and IPv6.

   *  Having separate branches for IGMP snooping and MLD snooping allows
      minor differences in their behavior to be modeled more simply and
      cleanly.  The two branches can better support different features
      and node types.

3.  Module Structure

   This model augments the core routing data model specified in
   [RFC8349].

      +--rw routing
         +--rw router-id?
         +--rw control-plane-protocols
         |  +--rw control-plane-protocol* [type name]
         |     +--rw type
         |     +--rw name
         |     +--rw igmp-snooping-instance <= Augmented by this Model
                        ...
         |     +--rw mld-snooping-instance   <= Augmented by this Model
                        ...

   The "igmp-snooping-instance" container instantiates an IGMP snooping
   instance.  The "mld-snooping-instance" container instantiates an MLD
   snooping instance.

   The YANG data model defined in this document conforms to the NMDA
   [RFC8342].  The operational state data is combined with the
   associated configuration data in the same hierarchy [RFC8407].

3.1.  IGMP Snooping Instances

   The YANG module ietf-igmp-mld-snooping augments /rt:routing/
   rt:control-plane-protocols/rt:control-plane-protocol to add the igmp-
   snooping-instance container.

   All the IGMP snooping-related attributes have been defined in the
   igmp-snooping-instance.  The read-write attributes represent
   configurable data.  The read-only attributes represent state data.

   One igmp-snooping-instance could be used in one bridge [dot1Qcp]
   instance, and it corresponds to one bridge instance.

   Currently, the value of l2-service-type in igmp-snooping-instance
   could only be set to 'bridge'.  After it is set, igmp-snooping-
   instance could be used in the bridge service.

   The values of bridge-mrouter-interface are filled by the snooping
   device dynamically.  It is different from static-bridge-mrouter-
   interface, which is configured.

   The attributes under the interfaces show the statistics of IGMP
   snooping-related packets.

   augment /rt:routing/rt:control-plane-protocols
            /rt:control-plane-protocol:
     +--rw igmp-snooping-instance {igmp-snooping}?
        +--rw l2-service-type?                     l2-service-type
        +--rw enabled?                             boolean
        +--rw forwarding-table-type?               enumeration
        +--rw explicit-tracking?                   boolean
        |       {explicit-tracking}?
        +--rw lite-exclude-filter?                 empty
        |       {lite-exclude-filter}?
        +--rw send-query?                          boolean
        +--rw fast-leave?                          empty {fast-leave}?
        +--rw last-member-query-interval?          uint16
        +--rw query-interval?                      uint16
        +--rw query-max-response-time?             uint16
        +--rw require-router-alert?                boolean
        |       {require-router-alert}?
        +--rw robustness-variable?                 uint8
        +--rw static-bridge-mrouter-interface*     if:interface-ref
        |       {static-mrouter-interface}?
        +--rw igmp-version?                        uint8
        +--rw querier-source?                      inet:ipv4-address
        +--rw static-l2-multicast-group* [group source-addr]
        |       {static-l2-multicast-group}?
        |  +--rw group
        |  |       rt-types:ipv4-multicast-group-address
        |  +--rw source-addr
        |  |       rt-types:ipv4-multicast-source-address
        |  +--rw bridge-outgoing-interface*   if:interface-ref
        +--ro entries-count?                       yang:gauge32
        +--ro bridge-mrouter-interface*            if:interface-ref
        +--ro group* [address]
        |  +--ro address
        |  |       rt-types:ipv4-multicast-group-address
        |  +--ro mac-address?     yang:phys-address
        |  +--ro expire?          rt-types:timer-value-seconds16
        |  +--ro up-time          uint32
        |  +--ro last-reporter?   inet:ipv4-address
        |  +--ro source* [address]
        |     +--ro address
        |     |       rt-types:ipv4-multicast-source-address
        |     +--ro bridge-outgoing-interface*   if:interface-ref
        |     +--ro up-time                      uint32
        |     +--ro expire?
        |     |       rt-types:timer-value-seconds16
        |     +--ro host-count?                  yang:gauge32
        |     |       {explicit-tracking}?
        |     +--ro last-reporter?               inet:ipv4-address
        |     +--ro host* [address] {explicit-tracking}?
        |        +--ro address        inet:ipv4-address
        |        +--ro filter-mode    filter-mode-type
        +--ro interfaces
           +--ro interface* [name]
              +--ro name          if:interface-ref
              +--ro statistics
                 +--ro discontinuity-time?   yang:date-and-time
                 +--ro received
                 |  +--ro query-count?                  yang:counter64
                 |  +--ro membership-report-v1-count?   yang:counter64
                 |  +--ro membership-report-v2-count?   yang:counter64
                 |  +--ro membership-report-v3-count?   yang:counter64
                 |  +--ro leave-count?                  yang:counter64
                 |  +--ro pim-hello-count?              yang:counter64
                 +--ro sent
                    +--ro query-count?                  yang:counter64
                    +--ro membership-report-v1-count?   yang:counter64
                    +--ro membership-report-v2-count?   yang:counter64
                    +--ro membership-report-v3-count?   yang:counter64
                    +--ro leave-count?                  yang:counter64
                    +--ro pim-hello-count?              yang:counter64

3.2.  MLD Snooping Instances

   The YANG module ietf-igmp-mld-snooping augments /rt:routing/
   rt:control-plane-protocols/rt:control-plane-protocol to add the mld-
   snooping-instance container.  The mld-snooping-instance could be used
   in the bridge [dot1Qcp] service to enable MLD snooping.

   All the MLD snooping-related attributes have been defined in the mld-
   snooping-instance.  The read-write attributes represent configurable
   data.  The read-only attributes represent state data.

   The mld-snooping-instance has a similar structure to IGMP snooping.
   Some leaves are protocol related.  The mld-snooping-instance uses
   IPv6 addresses and mld-version, while igmp-snooping-instance uses
   IPv4 addresses and igmp-version.  Statistic counters in each of the
   above snooping instances are also tailored to the specific protocol
   type.  One mld-snooping-instance could be used in one bridge instance
   and corresponds to one bridge instance.

   Currently, the value of l2-service-type in mld-snooping-instance
   could only be set to 'bridge'.  After it is set, mld-snooping-
   instance could be used in the bridge service.

   The value of bridge-mrouter-interface is filled by the snooping
   device dynamically.  It is different from static-bridge-mrouter-
   interface, which is configured.

   The attributes under the interfaces show the statistics of MLD
   snooping-related packets.

   augment /rt:routing/rt:control-plane-protocols
               /rt:control-plane-protocol:
     +--rw mld-snooping-instance {mld-snooping}?
     +--rw l2-service-type?                          l2-service-type
        +--rw enabled?                             boolean
        +--rw forwarding-table-type?               enumeration
        +--rw explicit-tracking?                   boolean
        |       {explicit-tracking}?
        +--rw lite-exclude-filter?                 empty
        |       {lite-exclude-filter}?
        +--rw send-query?                          boolean
        +--rw fast-leave?                          empty {fast-leave}?
        +--rw last-member-query-interval?          uint16
        +--rw query-interval?                      uint16
        +--rw query-max-response-time?             uint16
        +--rw require-router-alert?                boolean
        |       {require-router-alert}?
        +--rw robustness-variable?                 uint8
        +--rw static-bridge-mrouter-interface*     if:interface-ref
        |       {static-mrouter-interface}?
        +--rw mld-version?                         uint8
        +--rw querier-source?                      inet:ipv6-address
        +--rw static-l2-multicast-group* [group source-addr]
        |       {static-l2-multicast-group}?
        |  +--rw group
        |  |       rt-types:ipv6-multicast-group-address
        |  +--rw source-addr
        |  |       rt-types:ipv6-multicast-source-address
        |  +--rw bridge-outgoing-interface*   if:interface-ref
        +--ro entries-count?                       yang:gauge32
        +--ro bridge-mrouter-interface*            if:interface-ref
        +--ro group* [address]
        |  +--ro address
        |  |       rt-types:ipv6-multicast-group-address
        |  +--ro mac-address?     yang:phys-address
        |  +--ro expire?          rt-types:timer-value-seconds16
        |  +--ro up-time          uint32
        |  +--ro last-reporter?   inet:ipv6-address
        |  +--ro source* [address]
        |     +--ro address
        |     |       rt-types:ipv6-multicast-source-address
        |     +--ro bridge-outgoing-interface*   if:interface-ref
        |     +--ro up-time                      uint32
        |     +--ro expire?
        |     |       rt-types:timer-value-seconds16
        |     +--ro host-count?                  yang:gauge32
        |     |       {explicit-tracking}?
        |     +--ro last-reporter?               inet:ipv6-address
        |     +--ro host* [address]       {explicit-tracking}?
        |        +--ro address             inet:ipv6-address
        |        +--ro filter-mode    filter-mode-type
        +--ro interfaces
           +--ro interface* [name]
              +--ro name          if:interface-ref
              +--ro statistics
                 +--ro discontinuity-time?   yang:date-and-time
                 +--ro received
                 |  +--ro query-count?       yang:counter64
                 |  +--ro report-v1-count?   yang:counter64
                 |  +--ro report-v2-count?   yang:counter64
                 |  +--ro done-count?        yang:counter64
                 |  +--ro pim-hello-count?   yang:counter64
                 +--ro sent
                    +--ro query-count?       yang:counter64
                    +--ro report-v1-count?   yang:counter64
                    +--ro report-v2-count?   yang:counter64
                    +--ro done-count?        yang:counter64
                    +--ro pim-hello-count?   yang:counter64

3.3.  Using IGMP and MLD Snooping Instances

   The igmp-snooping-instance could be used in the service of bridge
   [dot1Qcp] to configure the IGMP snooping.

   For the bridge service, this model augments /dot1q:bridges/
   dot1q:bridge to use igmp-snooping-instance.  It means IGMP snooping
   is enabled in the bridge.

   It also augments /dot1q:bridges/dot1q:bridge/dot1q:component/
   dot1q:bridge-vlan/dot1q:vlan to use igmp-snooping-instance.  It means
   IGMP snooping is enabled in the specified VLAN on the bridge.

   The mld-snooping-instance could be used in concurrence with igmp-
   snooping-instance to configure the MLD snooping.

   augment /dot1q:bridges/dot1q:bridge:
     +--rw igmp-snooping-instance?   igmp-mld-snooping-instance-ref
     +--rw mld-snooping-instance?    igmp-mld-snooping-instance-ref

   augment /dot1q:bridges/dot1q:bridge/dot1q:component
             /dot1q:bridge-vlan/dot1q:vlan:
     +--rw igmp-snooping-instance?   igmp-mld-snooping-instance-ref
     +--rw mld-snooping-instance?    igmp-mld-snooping-instance-ref

3.4.  IGMP and MLD Snooping Actions

   IGMP and MLD snooping actions clear the specified IGMP and MLD
   snooping group tables.  If both source X and group Y are specified,
   only source X from group Y in that specific instance will be cleared.

   augment /rt:routing/rt:control-plane-protocols
               /rt:control-plane-protocol:
     +--rw igmp-snooping-instance {igmp-snooping}?
        +---x clear-igmp-snooping-groups {action-clear-groups}?
           +---w input
              +---w group     union
              +---w source    rt-types:ipv4-multicast-source-address

   augment /rt:routing/rt:control-plane-protocols
               /rt:control-plane-protocol:
     +--rw mld-snooping-instance {mld-snooping}?
        +---x clear-mld-snooping-groups {action-clear-groups}?
           +---w input
              +---w group     union
              +---w source    rt-types:ipv6-multicast-source-address

4.  IGMP and MLD Snooping YANG Module

   This module references [RFC1112], [RFC2236], [RFC2710], [RFC3376],
   [RFC3810], [RFC4541], [RFC5790], [RFC6636], [RFC6991], [RFC7761],
   [RFC8343], and [dot1Qcp].

   <CODE BEGINS> file "ietf-igmp-mld-snooping@2022-01-31.yang"
   module ietf-igmp-mld-snooping {
     yang-version 1.1;
     namespace "urn:ietf:params:xml:ns:yang:ietf-igmp-mld-snooping";
     prefix ims;

     import ietf-inet-types {
       prefix inet;
       reference
         "RFC 6991: Common YANG Data Types";
     }
     import ietf-yang-types {
       prefix yang;
       reference
         "RFC 6991: Common YANG Data Types";
     }
     import ietf-interfaces {
       prefix if;
       reference
         "RFC 8343: A YANG Data Model for Interface Management";
     }
     import ietf-routing {
       prefix rt;
       reference
         "RFC 8349: A YANG Data Model for Routing Management (NMDA
          Version)";
     }
     import ietf-routing-types {
       prefix rt-types;
       reference
         "RFC 8294: Common YANG Data Types for the Routing Area";
     }
     import ieee802-dot1q-bridge {
       prefix dot1q;
       reference
         "dot1Qcp: IEEE 802.1Qcp-2018 Standard for Local and
          Metropolitan area networks--Bridges and Bridged Networks
          --Amendment 30: YANG Data Model";
     }

     organization
       "IETF PIM Working Group";
     contact
       "WG Web:   <http://datatracker.ietf.org/wg/pim/>
        WG List:  <mailto:pim@ietf.org>

        Editors:  Hongji Zhao
                  <mailto:hongji.zhao@ericsson.com>

                  Xufeng Liu
                  <mailto:xufeng.liu.ietf@gmail.com>

                  Yisong Liu
                  <mailto:liuyisong@chinamobile.com>

                  Anish Peter
                  <mailto:anish.ietf@gmail.com>

                  Mahesh Sivakumar
                  <mailto:sivakumar.mahesh@gmail.com>

       ";
     description
       "The module defines a collection of YANG definitions common for
        all devices that implement Internet Group Management Protocol
        (IGMP) and Multicast Listener Discovery (MLD) snooping, which is
        described in RFC 4541.

        Copyright (c) 2022 IETF Trust and the persons identified as
        authors of the code.  All rights reserved.

        Redistribution and use in source and binary forms, with or
        without modification, is permitted pursuant to, and subject to
        the license terms contained in, the Revised BSD License set
        forth in Section 4.c of the IETF Trust's Legal Provisions
        Relating to IETF Documents
        (http://trustee.ietf.org/license-info).

        This version of this YANG module is part of RFC 9166; see the
        RFC itself for full legal notices.";

     revision 2022-01-31 {
       description
         "Initial revision.";
       reference
         "RFC 9166: A YANG Data Model for Internet Group Management
          Protocol (IGMP) and Multicast Listener Discovery (MLD)
          Snooping";
     }

     /*
      * Features
      */

     feature igmp-snooping {
       description
         "Support IGMP snooping.";
       reference
         "RFC 4541: Considerations for Internet Group Management
          Protocol (IGMP) and Multicast Listener Discovery (MLD)
          Snooping Switches";
     }

     feature mld-snooping {
       description
         "Support MLD snooping.";
       reference
         "RFC 4541: Considerations for Internet Group Management
          Protocol (IGMP) and Multicast Listener Discovery (MLD)
          Snooping Switches";
     }

     feature fast-leave {
       description
         "Support configuration of fast leave.  The fast leave feature
          does not send last member query messages to hosts.";
       reference
         "RFC 3376: Internet Group Management Protocol, Version 3";
     }

     feature static-l2-multicast-group {
       description
         "Support configuration of static L2 multicast group.";
     }

     feature static-mrouter-interface {
       description
         "Support multicast router interface explicitly configured
          by management.";
       reference
         "RFC 4541: Considerations for Internet Group Management
          Protocol (IGMP) and Multicast Listener Discovery (MLD)
          Snooping Switches";
     }

     feature action-clear-groups {
       description
         "Support clearing statistics by action for IGMP and MLD
          snooping.";
     }

     feature require-router-alert {
       description
         "Support configuration of require-router-alert.";
       reference
         "RFC 3376: Internet Group Management Protocol, Version 3";
     }

     feature lite-exclude-filter {
       description
         "Enable the support of the simplified EXCLUDE filter.";
       reference
         "RFC 5790: Lightweight Internet Group Management Protocol
          Version 3 (IGMPv3) and Multicast Listener Discovery Version
          2 (MLDv2) Protocols";
     }

     feature explicit-tracking {
       description
         "Support configuration of per-instance explicit-tracking.";
       reference
         "RFC 6636: Tuning the Behavior of the Internet Group Management
          Protocol (IGMP) and Multicast Listener Discovery (MLD) for
          Routers in Mobile and Wireless Networks";
     }

     /* identities */

     identity l2-service-type {
       description
         "Base identity for L2 service type in IGMP and MLD snooping.";
     }

     identity bridge {
       base l2-service-type;
       description
         "This identity represents bridge service.";
     }

     identity filter-mode {
       description
         "Base identity for filter mode in IGMP and MLD snooping.";
     }

     identity include {
       base filter-mode;
       description
         "This identity represents include mode.";
     }

     identity exclude {
       base filter-mode;
       description
         "This identity represents exclude mode.";
     }

     identity igmp-snooping {
       base rt:control-plane-protocol;
       description
         "IGMP snooping.";
     }

     identity mld-snooping {
       base rt:control-plane-protocol;
       description
         "MLD snooping.";
     }

     /*
      * Typedefs
      */

     typedef l2-service-type {
       type identityref {
         base l2-service-type;
       }
       description
         "The L2 service type used with IGMP and MLD
          snooping.";
     }

     typedef filter-mode-type {
       type identityref {
         base filter-mode;
       }
       description
         "The host filter mode.";
     }

     typedef igmp-mld-snooping-instance-ref {
       type leafref {
         path "/rt:routing/rt:control-plane-protocols"
            + "/rt:control-plane-protocol/rt:name";
       }
       description
         "This type is used by data models that need to
          reference IGMP or MLD snooping instance.";
     }

     /*
      * Groupings
      */

     grouping instance-config-attributes-igmp-mld-snooping {
       description
         "IGMP and MLD snooping configuration of each VLAN.";
       leaf enabled {
         type boolean;
         default "false";
         description
           "Set the value to true to enable IGMP and MLD snooping.";
       }
       leaf forwarding-table-type {
         type enumeration {
           enum mac {
             description
               "MAC-based lookup mode.";
           }
           enum ip {
             description
               "IP-based lookup mode.";
           }
         }
         default "ip";
         description
           "The default forwarding table type is ip.";
       }
       leaf explicit-tracking {
         if-feature "explicit-tracking";
         type boolean;
         default "false";
         description
           "Track the IGMPv3 and MLDv2 snooping membership reports
            from individual hosts.  It contributes to saving network
            resources and shortening leave latency.";
       }
       leaf lite-exclude-filter {
         if-feature "lite-exclude-filter";
         type empty;
         description
           "For IGMP snooping, the presence of this
            leaf enables the support of the simplified EXCLUDE filter
            in the Lightweight IGMPv3 protocol, which simplifies the
            standard versions of IGMPv3.
            For MLD Snooping, the presence of this
            leaf enables the support of the simplified EXCLUDE filter
            in the Lightweight MLDv2 protocol, which simplifies the
            standard versions of MLDv2.";
         reference
           "RFC 5790: Lightweight Internet Group Management Protocol
            Version 3 (IGMPv3) and Multicast Listener Discovery Version
            2 (MLDv2) Protocols";
       }
       leaf send-query {
         type boolean;
         default "false";
         description
           "When it is true, this switch will send out a periodic IGMP
            General Query Message or MLD General Query Message.";
       }
       leaf fast-leave {
         if-feature "fast-leave";
         type empty;
         description
           "When fast leave is enabled, the software assumes
            that no more than one host is present on each VLAN port.";
       }
       leaf last-member-query-interval {
         type uint16 {
           range "10..10230";
         }
         units "deciseconds";
         default "10";
         description
           "Last Member Query Interval, which may be tuned to modify
            the leave latency of the network.
            It is represented in units of 1/10 second.";
         reference
           "RFC 3376: Internet Group Management Protocol, Version 3,
            Section 8.8";
       }
       leaf query-interval {
         type uint16;
         units "seconds";
         default "125";
         description
           "The Query Interval is the interval between General Queries
            sent by the Querier.";
         reference
           "RFC 3376: Internet Group Management Protocol, Version 3,
            Sections 4.1.7, 8.2, and 8.14.2";
       }
       leaf query-max-response-time {
         type uint16;
         units "deciseconds";
         default "100";
         description
           "Query maximum response time specifies the maximum time
            allowed before sending a responding report.
            It is represented in units of 1/10 second.";
         reference
           "RFC 3376: Internet Group Management Protocol, Version 3,
            Sections 4.1.1, 8.3, and 8.14.3";
       }
       leaf require-router-alert {
         if-feature "require-router-alert";
         type boolean;
         default "false";
         description
           "When the value is true, a router alert should exist
            in the IP header of the IGMP or MLD packet.  If it
            doesn't exist, the IGMP or MLD packet will be ignored.";
         reference
           "RFC 3376: Internet Group Management Protocol, Version 3,
            Sections 9.1, 9.2, and 9.3";
       }
       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
           "RFC 3376: Internet Group Management Protocol, Version 3,
            Sections 4.1.6, 8.1, and 8.14.1";
       }
       leaf-list static-bridge-mrouter-interface {
         when 'derived-from-or-self(../l2-service-type,"ims:bridge")';
         if-feature "static-mrouter-interface";
         type if:interface-ref;
         description
           "Static mrouter interface in bridge forwarding";
       }
     } // instance-config-attributes-igmp-mld-snooping

     grouping instance-state-group-attributes-igmp-mld-snooping {
       description
         "Attributes for both IGMP and MLD snooping groups.";
       leaf mac-address {
         type yang:phys-address;
         description
           "Destination MAC address for L2 multicast.";
       }
       leaf expire {
         type rt-types:timer-value-seconds16;
         units "seconds";
         description
           "The time left before multicast group timeout.";
       }
       leaf up-time {
         type uint32;
         units "seconds";
         mandatory true;
         description
           "The time elapsed since the L2 multicast record was
            created.";
       }
     } // instance-state-group-attributes-igmp-mld-snooping

     grouping instance-state-attributes-igmp-mld-snooping {
       description
         "State attributes for IGMP or MLD snooping instance.";
       leaf entries-count {
         type yang:gauge32;
         config false;
         description
           "The number of L2 multicast entries in IGMP and MLD
            snooping.";
       }
       leaf-list bridge-mrouter-interface {
         when 'derived-from-or-self(../l2-service-type,"ims:bridge")';
         type if:interface-ref;
         config false;
         description
           "Indicates a list of mrouter interfaces dynamically learned
            in a bridge.  When this switch receives IGMP/MLD queries
            from a multicast router on an interface, the interface will
            become an mrouter interface for IGMP/MLD snooping.";
       }
     } // instance-config-attributes-igmp-mld-snooping

     grouping instance-state-source-attributes-igmp-mld-snooping {
       description
         "State attributes for IGMP or MLD snooping instance.";
       leaf-list bridge-outgoing-interface {
         when 'derived-from-or-self(../../../l2-service-type,
               "ims:bridge")';
         type if:interface-ref;
         description
           "Outgoing interface in bridge forwarding.";
       }
       leaf up-time {
         type uint32;
         units "seconds";
         mandatory true;
         description
           "The time elapsed since L2 multicast record was created.";
       }
       leaf expire {
         type rt-types:timer-value-seconds16;
         units "seconds";
         description
           "The time left before multicast group timeout.";
       }
       leaf host-count {
         if-feature "explicit-tracking";
         type yang:gauge32;
         description
           "The number of host addresses.";
       }
     } // instance-state-source-attributes-igmp-mld-snooping

     grouping igmp-snooping-statistics {
       description
         "The statistics attributes for IGMP snooping.";
       leaf query-count {
         type yang:counter64;
         description
           "The number of Membership Query messages.";
         reference
           "RFC 2236: Internet Group Management Protocol, Version 2";
       }
       leaf membership-report-v1-count {
         type yang:counter64;
         description
           "The number of Version 1 Membership Report messages.";
         reference
           "RFC 1112: Host extensions for IP multicasting";
       }
       leaf membership-report-v2-count {
         type yang:counter64;
         description
           "The number of Version 2 Membership Report messages.";
         reference
           "RFC 2236: Internet Group Management Protocol, Version 2";
       }
       leaf membership-report-v3-count {
         type yang:counter64;
         description
           "The number of Version 3 Membership Report messages.";
         reference
           "RFC 3376: Internet Group Management Protocol, Version 3";
       }
       leaf leave-count {
         type yang:counter64;
         description
           "The number of Leave Group messages.";
         reference
           "RFC 2236: Internet Group Management Protocol, Version 2";
       }
       leaf pim-hello-count {
         type yang:counter64;
         description
           "The number of PIM hello messages.";
         reference
           "RFC 7761: Protocol Independent Multicast - Sparse Mode
            (PIM-SM): Protocol Specification (Revised)";
       }
     } // igmp-snooping-statistics

     grouping mld-snooping-statistics {
       description
         "The statistics attributes for MLD snooping.";
       leaf query-count {
         type yang:counter64;
         description
           "The number of Multicast Listener Query messages.";
         reference
           "RFC 3810: Multicast Listener Discovery Version 2 (MLDv2)
            for IPv6";
       }
       leaf report-v1-count {
         type yang:counter64;
         description
           "The number of Version 1 Multicast Listener Report.";
         reference
           "RFC 2710: Multicast Listener Discovery (MLD) for IPv6";
       }
       leaf report-v2-count {
         type yang:counter64;
         description
           "The number of Version 2 Multicast Listener Report.";
         reference
           "RFC 3810: Multicast Listener Discovery Version 2 (MLDv2)
            for IPv6";
       }
       leaf done-count {
         type yang:counter64;
         description
           "The number of Version 1 Multicast Listener Done.";
         reference
           "RFC 2710: Multicast Listener Discovery (MLD) for IPv6";
       }
       leaf pim-hello-count {
         type yang:counter64;
         description
           "The number of PIM hello messages.";
         reference
           "RFC 7761: Protocol Independent Multicast - Sparse Mode
            (PIM-SM): Protocol Specification (Revised)";
       }
     } // mld-snooping-statistics

     augment "/rt:routing/rt:control-plane-protocols"
           + "/rt:control-plane-protocol" {
       when 'derived-from-or-self(rt:type, "ims:igmp-snooping")' {
         description
           "This container is only valid for IGMP snooping.";
       }
       description
         "IGMP snooping augmentation to control-plane protocol
          configuration and state.";
       container igmp-snooping-instance {
         if-feature "igmp-snooping";
         description
           "IGMP snooping instance to configure igmp-snooping.";
         leaf l2-service-type {
           type l2-service-type;
           default "bridge";
           description
             "It indicates bridge or other services.";
         }
         uses instance-config-attributes-igmp-mld-snooping;
         leaf igmp-version {
           type uint8 {
             range "1..3";
           }
           default "2";
           description
             "IGMP version.";
         }
         leaf querier-source {
           type inet:ipv4-address;
           description
             "The source address of the IGMP General Query message,
              which is sent out by this switch.";
         }
         list static-l2-multicast-group {
           if-feature "static-l2-multicast-group";
           key "group source-addr";
           description
             "A static multicast route, (*,G) or (S,G).";
           leaf group {
             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.";
           }
           leaf-list bridge-outgoing-interface {
             when 'derived-from-or-self(../../l2-service-type,
                   "ims:bridge")';
             type if:interface-ref;
             description
               "Outgoing interface in bridge forwarding.";
           }
         } // static-l2-multicast-group
         uses instance-state-attributes-igmp-mld-snooping;
         list group {
           key "address";
           config false;
           description
             "IGMP snooping information.";
           leaf address {
             type rt-types:ipv4-multicast-group-address;
             description
               "Multicast group IPv4 address.";
           }
           uses instance-state-group-attributes-igmp-mld-snooping;
           leaf last-reporter {
             type inet:ipv4-address;
             description
               "Address of the last host that has sent a report to join
                the multicast group.";
           }
           list source {
             key "address";
             description
               "Source IPv4 address for multicast stream.";
             leaf address {
               type rt-types:ipv4-multicast-source-address;
               description
                 "Source IPv4 address for multicast stream.";
             }
             uses instance-state-source-attributes-igmp-mld-snooping;
             leaf last-reporter {
               type inet:ipv4-address;
               description
                 "Address of the last host that has sent a report
                  to join the multicast group.";
             }
             list host {
               if-feature "explicit-tracking";
               key "address";
               description
                 "List of multicast membership hosts
                  of the specific multicast source group.";
               leaf address {
                 type inet:ipv4-address;
                 description
                   "Multicast membership host address.";
               }
               leaf filter-mode {
                 type filter-mode-type;
                 mandatory true;
                 description
                   "Filter mode for a multicast membership
                    host may be either include or exclude.";
               }
             } // list host
           } // list source
         } // list group
         container interfaces {
           config false;
           description
             "Contains the interfaces associated with the IGMP snooping
              instance.";
           list interface {
             key "name";
             description
               "A list of interfaces associated with the IGMP snooping
                instance.";
             leaf name {
               type if:interface-ref;
               description
                 "The name of the interface.";
             }
             container statistics {
               description
                 "The interface statistics for IGMP snooping.";
               leaf discontinuity-time {
                 type yang:date-and-time;
                 description
                   "The time on the most recent occasion at which any
                    one or more of the statistic counters suffered a
                    discontinuity.  If no such discontinuities have
                    occurred since the last re-initialization of the
                    local management subsystem, then this node contains
                    the time the local management subsystem
                    re-initialized itself.";
               }
               container received {
                 description
                   "Number of received snooped IGMP packets.";
                 uses igmp-snooping-statistics;
               }
               container sent {
                 description
                   "Number of sent snooped IGMP packets.";
                 uses igmp-snooping-statistics;
               }
             }
           }
         }
         action clear-igmp-snooping-groups {
           if-feature "action-clear-groups";
           description
             "Clear IGMP snooping cache tables.";
           input {
             leaf group {
               type union {
                 type enumeration {
                   enum all-groups {
                     description
                       "All multicast group addresses.";
                   }
                 }
                 type rt-types:ipv4-multicast-group-address;
               }
               mandatory true;
               description
                 "Multicast group IPv4 address.  If value
                  'all-groups' is specified, all IGMP snooping
                  group entries are cleared for the specified source
                  address.";
             }
             leaf source {
               type rt-types:ipv4-multicast-source-address;
               mandatory true;
               description
                 "Multicast source IPv4 address.  If value '*' is
                  specified, all IGMP snooping source-group tables
                  are cleared.";
             }
           }
         } // action clear-igmp-snooping-groups
       } // igmp-snooping-instance
     } // augment

     augment "/rt:routing/rt:control-plane-protocols"
           + "/rt:control-plane-protocol" {
       when 'derived-from-or-self(rt:type, "ims:mld-snooping")' {
         description
           "This container is only valid for MLD snooping.";
       }
       description
         "MLD snooping augmentation to control-plane protocol
          configuration and state.";
       container mld-snooping-instance {
         if-feature "mld-snooping";
         description
           "MLD snooping instance to configure mld-snooping.";
         leaf l2-service-type {
           type l2-service-type;
           default "bridge";
           description
             "It indicates bridge or other services.";
         }
         uses instance-config-attributes-igmp-mld-snooping;
         leaf mld-version {
           type uint8 {
             range "1..2";
           }
           default "2";
           description
             "MLD version.";
         }
         leaf querier-source {
           type inet:ipv6-address;
           description
             "The source address of MLD General Query message, which
              is sent out by this switch.";
         }
         list static-l2-multicast-group {
           if-feature "static-l2-multicast-group";
           key "group source-addr";
           description
             "A static multicast route, (*,G) or (S,G).";
           leaf group {
             type rt-types:ipv6-multicast-group-address;
             description
               "Multicast group IPv6 address.";
           }
           leaf source-addr {
             type rt-types:ipv6-multicast-source-address;
             description
               "Multicast source IPv6 address.";
           }
           leaf-list bridge-outgoing-interface {
             when 'derived-from-or-self(../../l2-service-type,
                   "ims:bridge")';
             type if:interface-ref;
             description
               "Outgoing interface in bridge forwarding.";
           }
         } // static-l2-multicast-group
         uses instance-state-attributes-igmp-mld-snooping;
         list group {
           key "address";
           config false;
           description
             "MLD snooping statistics information.";
           leaf address {
             type rt-types:ipv6-multicast-group-address;
             description
               "Multicast group IPv6 address.";
           }
           uses instance-state-group-attributes-igmp-mld-snooping;
           leaf last-reporter {
             type inet:ipv6-address;
             description
               "Address of the last host that has sent report
                to join the multicast group.";
           }
           list source {
             key "address";
             description
               "Source IPv6 address for multicast stream.";
             leaf address {
               type rt-types:ipv6-multicast-source-address;
               description
                 "Source IPv6 address for multicast stream.";
             }
             uses instance-state-source-attributes-igmp-mld-snooping;
             leaf last-reporter {
               type inet:ipv6-address;
               description
                 "Address of the last host that has sent report
                  to join the multicast group.";
             }
             list host {
               if-feature "explicit-tracking";
               key "address";
               description
                 "List of multicast membership hosts
                  of the specific multicast source group.";
               leaf address {
                 type inet:ipv6-address;
                 description
                   "Multicast membership host address.";
               }
               leaf filter-mode {
                 type filter-mode-type;
                 mandatory true;
                 description
                   "Filter mode for a multicast membership
                    host may be either include or exclude.";
               }
             } // list host
           } // list source
         } // list group
         container interfaces {
           config false;
           description
             "Contains the interfaces associated with the MLD snooping
              instance.";
           list interface {
             key "name";
             description
               "A list of interfaces associated with the MLD snooping
                instance.";
             leaf name {
               type if:interface-ref;
               description
                 "The name of the interface.";
             }
             container statistics {
               description
                 "The interface statistics for MLD snooping.";
               leaf discontinuity-time {
                 type yang:date-and-time;
                 description
                   "The time on the most recent occasion at which
                    any one or more of the statistic counters suffered
                    a discontinuity.  If no such discontinuities have
                    occurred since the last re-initialization of the
                    local management subsystem, then this node contains
                    the time the local management subsystem
                    re-initialized itself.";
               }
               container received {
                 description
                   "Number of received snooped MLD packets.";
                 uses mld-snooping-statistics;
               }
               container sent {
                 description
                   "Number of sent snooped MLD packets.";
                 uses mld-snooping-statistics;
               }
             }
           }
         }
         action clear-mld-snooping-groups {
           if-feature "action-clear-groups";
           description
             "Clear MLD snooping cache tables.";
           input {
             leaf group {
               type union {
                 type enumeration {
                   enum all-groups {
                     description
                       "All multicast group addresses.";
                   }
                 }
                 type rt-types:ipv6-multicast-group-address;
               }
               mandatory true;
               description
                 "Multicast group IPv6 address.  If value 'all-groups'
                  is specified, all MLD snooping group entries are
                  cleared for the specified source address.";
             }
             leaf source {
               type rt-types:ipv6-multicast-source-address;
               mandatory true;
               description
                 "Multicast source IPv6 address.  If value '*' is
                  specified, all MLD snooping source-group tables
                  are cleared.";
             }
           }
         } // action clear-mld-snooping-groups
       } // mld-snooping-instance
     } // augment

     augment "/dot1q:bridges/dot1q:bridge" {
       description
         "Use IGMP or MLD snooping instance in bridge.";
       leaf igmp-snooping-instance {
         type igmp-mld-snooping-instance-ref;
         description
           "Configure IGMP snooping instance under bridge view.";
       }
       leaf mld-snooping-instance {
         type igmp-mld-snooping-instance-ref;
         description
           "Configure MLD snooping instance under bridge view.";
       }
     }

     augment "/dot1q:bridges/dot1q:bridge"
           + "/dot1q:component/dot1q:bridge-vlan/dot1q:vlan" {
       description
         "Use IGMP or MLD snooping instance in a certain VLAN
          of bridge.";
       leaf igmp-snooping-instance {
         type igmp-mld-snooping-instance-ref;
         description
           "Configure IGMP snooping instance under VLAN view.";
       }
       leaf mld-snooping-instance {
         type igmp-mld-snooping-instance-ref;
         description
           "Configure MLD snooping instance under VLAN view.";
       }
     }
   }
   <CODE ENDS>

5.  Security Considerations

   The YANG module specified in this document defines a schema for data
   that is designed to be accessed via network management protocols 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
   [RFC8446].

   The Network Configuration Access Control Model (NACM) [RFC8341]
   provides the means to restrict access for particular NETCONF or
   RESTCONF users to a preconfigured subset of all available NETCONF or
   RESTCONF protocol operations and content.

   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:

   Under /rt:routing/rt:control-plane-protocols/rt:control-plane-
   protocol:/

      ims:igmp-snooping-instance

      ims:mld-snooping-instance

   The subtrees under /dot1q:bridges/dot1q:bridge

      ims:igmp-snooping-instance

      ims:mld-snooping-instance

   The subtrees under /dot1q:bridges/dot1q:bridge/dot1q:component/
   dot1q:bridge-vlan/dot1q:vlan

      ims:igmp-snooping-instance

      ims:mld-snooping-instance

   Unauthorized access to any data node of these subtrees can adversely
   affect the IGMP and MLD snooping subsystem of both the local device
   and the network.  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:

   Under /rt:routing/rt:control-plane-protocols/rt:control-plane-
   protocol:/

      ims:igmp-snooping-instance

      ims:mld-snooping-instance

   Unauthorized access to any data node of these subtrees can disclose
   the operational state information of IGMP and MLD snooping on this
   device.  The group/source/host information may expose multicast group
   memberships and, transitively, the associations between the user on
   the host and the contents from the source, which could be privately
   sensitive.  Some of the action 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:

   Under /rt:routing/rt:control-plane-protocols/rt:control-plane-
   protocol:/

      ims:igmp-snooping-instance/ims:clear-igmp-snooping-groups

      ims:mld-snooping-instance/ims:clear-mld-snooping-groups

   Some of the actions in this YANG module may be considered sensitive
   or vulnerable in some network environments.  The IGMP and MLD
   snooping YANG module supports the "clear-igmp-snooping-groups" and
   "clear-mld-snooping-groups" actions.  If unauthorized action is
   invoked, the IGMP and MLD snooping group tables will be cleared
   unexpectedly.  Especially when using wildcard, all the multicast
   traffic will be flooded in the broadcast domain.  The devices that
   use this YANG module should heed the security considerations in
   [RFC4541].

6.  IANA Considerations

6.1.  XML Registry

   This document registers the following namespace URI in the "IETF XML
   Registry" [RFC3688]:

   URI:  urn:ietf:params:xml:ns:yang:ietf-igmp-mld-snooping
   Registrant Contact:  The IETF.
   XML:  N/A; the requested URI is an XML namespace.

6.2.  YANG Module Names Registry

   This document registers the following YANG module in the "YANG Module
   Names" registry [RFC7950]:

   Name:         ietf-igmp-mld-snooping
   Namespace:    urn:ietf:params:xml:ns:yang:ietf-igmp-mld-snooping
   Prefix:       ims
   Reference:    RFC 9166

7.  References

7.1.  Normative References

   [dot1Qcp]  IEEE, "Standard for Local and metropolitan area networks--
              Bridges and Bridged Networks--Amendment 30: YANG Data
              Model", IEEE Std 802.1Qcp-2018,
              DOI 10.1109/IEEESTD.2018.8467507, September 2018,
              <https://ieeexplore.ieee.org/servlet/
              opac?punumber=8467505>.

   [RFC1112]  Deering, S., "Host extensions for IP multicasting", STD 5,
              RFC 1112, DOI 10.17487/RFC1112, August 1989,
              <https://www.rfc-editor.org/info/rfc1112>.

   [RFC2236]  Fenner, W., "Internet Group Management Protocol, Version
              2", RFC 2236, DOI 10.17487/RFC2236, November 1997,
              <https://www.rfc-editor.org/info/rfc2236>.

   [RFC2710]  Deering, S., Fenner, W., and B. Haberman, "Multicast
              Listener Discovery (MLD) for IPv6", RFC 2710,
              DOI 10.17487/RFC2710, October 1999,
              <https://www.rfc-editor.org/info/rfc2710>.

   [RFC3376]  Cain, B., Deering, S., Kouvelas, I., Fenner, B., and A.
              Thyagarajan, "Internet Group Management Protocol, Version
              3", RFC 3376, DOI 10.17487/RFC3376, October 2002,
              <https://www.rfc-editor.org/info/rfc3376>.

   [RFC3688]  Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
              DOI 10.17487/RFC3688, January 2004,
              <https://www.rfc-editor.org/info/rfc3688>.

   [RFC3810]  Vida, R., Ed. and L. Costa, Ed., "Multicast Listener
              Discovery Version 2 (MLDv2) for IPv6", RFC 3810,
              DOI 10.17487/RFC3810, June 2004,
              <https://www.rfc-editor.org/info/rfc3810>.

   [RFC4286]  Haberman, B. and J. Martin, "Multicast Router Discovery",
              RFC 4286, DOI 10.17487/RFC4286, December 2005,
              <https://www.rfc-editor.org/info/rfc4286>.

   [RFC4541]  Christensen, M., Kimball, K., and F. Solensky,
              "Considerations for Internet Group Management Protocol
              (IGMP) and Multicast Listener Discovery (MLD) Snooping
              Switches", RFC 4541, DOI 10.17487/RFC4541, May 2006,
              <https://www.rfc-editor.org/info/rfc4541>.

   [RFC5790]  Liu, H., Cao, W., and H. Asaeda, "Lightweight Internet
              Group Management Protocol Version 3 (IGMPv3) and Multicast
              Listener Discovery Version 2 (MLDv2) Protocols", RFC 5790,
              DOI 10.17487/RFC5790, February 2010,
              <https://www.rfc-editor.org/info/rfc5790>.

   [RFC6020]  Bjorklund, M., Ed., "YANG - A Data Modeling Language for
              the Network Configuration Protocol (NETCONF)", RFC 6020,
              DOI 10.17487/RFC6020, October 2010,
              <https://www.rfc-editor.org/info/rfc6020>.

   [RFC6241]  Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
              and A. Bierman, Ed., "Network Configuration Protocol
              (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
              <https://www.rfc-editor.org/info/rfc6241>.

   [RFC6242]  Wasserman, M., "Using the NETCONF Protocol over Secure
              Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
              <https://www.rfc-editor.org/info/rfc6242>.

   [RFC6636]  Asaeda, H., Liu, H., and Q. Wu, "Tuning the Behavior of
              the Internet Group Management Protocol (IGMP) and
              Multicast Listener Discovery (MLD) for Routers in Mobile
              and Wireless Networks", RFC 6636, DOI 10.17487/RFC6636,
              May 2012, <https://www.rfc-editor.org/info/rfc6636>.

   [RFC6991]  Schoenwaelder, J., Ed., "Common YANG Data Types",
              RFC 6991, DOI 10.17487/RFC6991, July 2013,
              <https://www.rfc-editor.org/info/rfc6991>.

   [RFC7761]  Fenner, B., Handley, M., Holbrook, H., Kouvelas, I.,
              Parekh, R., Zhang, Z., and L. Zheng, "Protocol Independent
              Multicast - Sparse Mode (PIM-SM): Protocol Specification
              (Revised)", STD 83, RFC 7761, DOI 10.17487/RFC7761, March
              2016, <https://www.rfc-editor.org/info/rfc7761>.

   [RFC7950]  Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
              RFC 7950, DOI 10.17487/RFC7950, August 2016,
              <https://www.rfc-editor.org/info/rfc7950>.

   [RFC8040]  Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
              Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
              <https://www.rfc-editor.org/info/rfc8040>.

   [RFC8294]  Liu, X., Qu, Y., Lindem, A., Hopps, C., and L. Berger,
              "Common YANG Data Types for the Routing Area", RFC 8294,
              DOI 10.17487/RFC8294, December 2017,
              <https://www.rfc-editor.org/info/rfc8294>.

   [RFC8340]  Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
              BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
              <https://www.rfc-editor.org/info/rfc8340>.

   [RFC8341]  Bierman, A. and M. Bjorklund, "Network Configuration
              Access Control Model", STD 91, RFC 8341,
              DOI 10.17487/RFC8341, March 2018,
              <https://www.rfc-editor.org/info/rfc8341>.

   [RFC8342]  Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
              and R. Wilton, "Network Management Datastore Architecture
              (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
              <https://www.rfc-editor.org/info/rfc8342>.

   [RFC8343]  Bjorklund, M., "A YANG Data Model for Interface
              Management", RFC 8343, DOI 10.17487/RFC8343, March 2018,
              <https://www.rfc-editor.org/info/rfc8343>.

   [RFC8349]  Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
              Routing Management (NMDA Version)", RFC 8349,
              DOI 10.17487/RFC8349, March 2018,
              <https://www.rfc-editor.org/info/rfc8349>.

   [RFC8446]  Rescorla, E., "The Transport Layer Security (TLS) Protocol
              Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
              <https://www.rfc-editor.org/info/rfc8446>.

7.2.  Informative References

   [RFC7951]  Lhotka, L., "JSON Encoding of Data Modeled with YANG",
              RFC 7951, DOI 10.17487/RFC7951, August 2016,
              <https://www.rfc-editor.org/info/rfc7951>.

   [RFC8407]  Bierman, A., "Guidelines for Authors and Reviewers of
              Documents Containing YANG Data Models", BCP 216, RFC 8407,
              DOI 10.17487/RFC8407, October 2018,
              <https://www.rfc-editor.org/info/rfc8407>.

   [RFC8652]  Liu, X., Guo, F., Sivakumar, M., McAllister, P., and A.
              Peter, "A YANG Data Model for the Internet Group
              Management Protocol (IGMP) and Multicast Listener
              Discovery (MLD)", RFC 8652, DOI 10.17487/RFC8652, November
              2019, <https://www.rfc-editor.org/info/rfc8652>.

Appendix A.  Data Tree Example

   This section contains an example of bridge service in the JSON
   encoding [RFC7951], containing both configuration and state data.

              +-----------+
              +  Source   +
              +-----+-----+
                    |
   -----------------+----------------------------
                    |eth1/1
                +---+---+
                +  R1   +
                +-+---+-+
           eth1/2 |    \ eth1/3
                  |     \
                  |      \
                  |       \
                  |        \
           eth2/1 |         \ eth3/1
              +---+---+   +--+---+
              +  R2   +   +  R3  +
              +---+---+   +--+---+
           eth2/2 |          | eth3/2
                  |          |
   ---------------+----------+-------------------
                  |          |
                  |          |
         +--------+--+   +---+--------+
         + Receiver1 +   +  Receiver2 +
         +-----------+   +------------+

   The configuration data for R1 in the above figure could be as
   follows:

   {
   "ietf-interfaces:interfaces":{
     "interface":[
      {
       "name":"eth1/1",
       "type":"iana-if-type:ethernetCsmacd"
      }
     ]
    },
    "ietf-routing:routing":{
     "control-plane-protocols":{
      "control-plane-protocol":[
       {
        "type":"ietf-igmp-mld-snooping:igmp-snooping",
        "name":"bis1",
        "ietf-igmp-mld-snooping:igmp-snooping-instance":{
          "l2-service-type":"ietf-igmp-mld-snooping:bridge",
          "enabled":true
        }
       }
      ]
     }
    },
    "ieee802-dot1q-bridge:bridges":{
     "bridge":[
      {
       "name":"isp1",
       "address":"00-23-ef-a5-77-12",
       "bridge-type":"ieee802-dot1q-bridge:customer-vlan-bridge",
       "component":[
        {
         "name":"comp1",
         "type":"ieee802-dot1q-bridge:c-vlan-component",
         "bridge-vlan":{
          "vlan":[
           {
            "vid":101,
            "ietf-igmp-mld-snooping:igmp-snooping-instance":"bis1"
           }
          ]
         }
        }
       ]
      }
     ]
    }
   }

   The corresponding operational state data for R1 could be as follows:

   {
    "ietf-interfaces:interfaces": {
     "interface": [
      {
       "name": "eth1/1",
       "type": "iana-if-type:ethernetCsmacd",
       "oper-status": "up",
       "statistics": {
        "discontinuity-time": "2018-05-23T12:34:56-05:00"
       }
      }
     ]
    },
    "ietf-routing:routing": {
     "control-plane-protocols": {
      "control-plane-protocol": [
       {
        "type": "ietf-igmp-mld-snooping:igmp-snooping",
        "name": "bis1",
        "ietf-igmp-mld-snooping:igmp-snooping-instance": {
         "l2-service-type": "ietf-igmp-mld-snooping:bridge",
         "enabled": true
        }
       }
      ]
     }
    },
    "ieee802-dot1q-bridge:bridges": {
     "bridge": [
      {
       "name": "isp1",
       "address": "00-23-ef-a5-77-12",
       "bridge-type": "ieee802-dot1q-bridge:customer-vlan-bridge",
       "component": [
        {
         "name": "comp1",
         "type": "ieee802-dot1q-bridge:c-vlan-component",
         "bridge-vlan": {
          "vlan": [
           {
            "vid": 101,
            "ietf-igmp-mld-snooping:igmp-snooping-instance": "bis1"
           }
          ]
         }
        }
       ]
      }
     ]
    }
   }

   The following action is to clear all the entries whose group address
   is 225.1.1.1 for igmp-snooping-instance bis1.

   POST /restconf/operations/ietf-routing:routing/\
   control-plane-protocols/\
   control-plane-protocol=ietf-igmp-mld-snooping:igmp-snooping,bis1/\
   ietf-igmp-mld-snooping:igmp-snooping-instance/\
   clear-igmp-snooping-groups HTTP/1.1
   Host: example.com
   Content-Type: application/yang-data+json

   {
     "ietf-igmp-mld-snooping:input" : {
       "group": "225.1.1.1",
       "source": "*"
     }
   }

Authors' Addresses

   Hongji Zhao
   Ericsson (China) Communications Company Ltd.
   Ericsson Tower, No. 5 Lize East Street
   Beijing
   100102
   China

   Email: hongji.zhao@ericsson.com


   Xufeng Liu
   IBM Corporation
   2300 Dulles Station Blvd.
   Herndon, VA 20171
   United States of America

   Email: xufeng.liu.ietf@gmail.com


   Yisong Liu
   China Mobile
   China

   Email: liuyisong@chinamobile.com


   Anish Peter
   Individual

   Email: anish.ietf@gmail.com


   Mahesh Sivakumar
   Juniper Networks
   1133 Innovation Way
   Sunnyvale, CA
   United States of America

   Email: sivakumar.mahesh@gmail.com