RFC 9398

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

πŸ“… published May 2023, from ietf

Part 1 of 4: RFC 9398 πŸ’–

Okay bestie, let's get into this one! πŸ¦‹ This is RFC 9398, and it's giving YANG data model realness. It's a Standards Track document from the IETF, all about how to configure and manage IGMP or MLD Proxy devices. Iconic. πŸ‘‘

Here's the title block tea β˜•:

  • Number: RFC 9398
  • Title: A YANG Data Model for Internet Group Management Protocol (IGMP) and Multicast Listener Discovery (MLD) Proxy Devices
  • Authors: H. Zhao (Ericsson), X. Liu (Alef Edge), Y. Liu (China Mobile), M. Panchanathan (Cisco Systems, Inc.), and M. Sivakumar (Juniper)
  • Category: Standards Track
  • Date: May 2023
  • ISSN: 2070-1721
  • Obsoletes / Updates: The title block in this copy doesn't list either, so there's nothing to report there. πŸ™ˆ

Here's the scoop on the abstract ✨: this document defines a YANG data model that can be used to configure and manage IGMP or MLD Proxy devices. The YANG module in this document conforms to the Network Management Datastore Architecture (NMDA). Main character energy. πŸ’…


Status of This Memo 🌸

This is an Internet Standards Track document. πŸŽ€

It's a product of the Internet Engineering Task Force (IETF), so it represents the consensus of the IETF community. It got public review and was approved for publication by the Internet Engineering Steering Group (IESG). For more on Internet Standards, check Section 2 of RFC 7841. πŸ“š

Want the current status, any errata, or a way to give feedback? Head to https://www.rfc-editor.org/info/rfc9398. πŸ”₯

Copyright (c) 2023 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. Please review these carefully, because they describe your rights and restrictions. 🫢 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 Features
    • 2.3. Position of Address Family in Hierarchy
  • 3. Module Structure
    • 3.1. IGMP Proxy Configuration and Operational State
    • 3.2. MLD Proxy Configuration and Operational State
  • 4. IGMP/MLD Proxy YANG Module
  • 5. Security Considerations
  • 6. IANA Considerations
    • 6.1. IETF 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 πŸ¦‹

Okay so this document defines a YANG data model [RFC7950] for managing IGMP or MLD Proxy devices [RFC4605]. The YANG module here conforms to the Network Management Datastore Architecture as defined in [RFC8342]. Yes, it's a whole vibe. πŸ’–

1.1. Terminology πŸŽ€

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

  • augment
  • data model
  • data node
  • identity
  • module

These abbreviations are used in this document and in the defined YANG data model:

  • IGMP: Internet Group Management Protocol [RFC3376].
  • MLD: Multicast Listener Discovery [RFC3810].
  • PIM: Protocol Independent Multicast [RFC7761].

1.2. Tree Diagrams 🌸

Tree diagrams in this document follow the notation defined in [RFC8340]. Tiny diagrams, big energy. ✨

1.3. Prefixes in Data Node Names πŸ“

Names of data nodes and other data model objects are often used without a prefix, as long as the context clearly tells you which YANG module each name is defined in. Otherwise, names get the standard prefix tied to their YANG module, as shown in Table 1. πŸ’…

+==========+====================+===========+
| Prefix   | YANG Module        | Reference |
+==========+====================+===========+
| inet     | ietf-inet-types    | [RFC6991] |
+----------+--------------------+-----------+
| if       | ietf-interfaces    | [RFC8343] |
+----------+--------------------+-----------+
| rt       | ietf-routing       | [RFC8349] |
+----------+--------------------+-----------+
| rt-types | ietf-routing-types | [RFC8294] |
+----------+--------------------+-----------+
| pim-base | ietf-pim-base      | [RFC9128] |
+----------+--------------------+-----------+

   Table 1: Prefixes and Corresponding YANG
                   Modules

2. Design of Data Model 🧁

The model covers forwarding based on IGMP and MLD proxying [RFC4605]. The goal here is a data model that gives IGMP/MLD Proxy devices a common user interface. 🫢

2.1. Overview 🌷

The model in this document has all the common building blocks for IGMP/MLD Proxy devices and can be used to configure those devices. You can also pull operational state data and statistics through this model. πŸ“Š

2.2. Optional Features πŸŽ€

This model is designed to represent the basic capability subsets of IGMP/MLD Proxies. The main design goals are that (1) the basic capabilities described in the model will be supported by any major implementations that exist at the time of this writing, and (2) the configuration of all implementations meeting the specifications will be easy to express through some combination of the optional features in the model and simple vendor augmentations. Big brain moves. 🧠

This model declares two features for capabilities that not all deployed devices support. One feature is called "igmp-proxy", and the other is called "mld-proxy". Either or both features could be implemented, which gives vendors more choices. πŸ¦‹

2.3. Position of Address Family in Hierarchy 🌈

IGMP Proxies only support IPv4, while MLD Proxies only support IPv6. The data model in this document can be used for both IPv4 and IPv6 address families. πŸ’œ

This document defines IGMP Proxies and MLD Proxies in separate schema branches. The benefits of this technique are as follows:

  • The model can support IGMP Proxies (IPv4), MLD Proxies (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 the model defined in [RFC8652], which uses separate branches for IPv4 and IPv6.
  • Having separate branches for IGMP Proxies and MLD Proxies 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-proxy <= Augmented by this model
                  ...
   |     +--rw mld-proxy  <= Augmented by this model

The "igmp-proxy" container instantiates an IGMP Proxy. The "mld-proxy" container instantiates an MLD Proxy. 🌸

3.1. IGMP Proxy Configuration and Operational State πŸ’–

The YANG module augments /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol to add the igmp-proxy container. πŸ¦‹

All attributes related to IGMP Proxies are defined in the igmp-proxy container. The read-write attributes represent configurable data, and the read-only attributes represent state data. πŸ’…

The igmp-version parameter represents the IGMP protocol version, and the default value is 2. If the value of the "enabled" parameter is "true", it means the IGMP Proxy is enabled. πŸŽ€

The interface list under igmp-proxy contains upstream interfaces for an IGMP Proxy. There's a constraint to make sure the upstream interface for the IGMP Proxy is not configured to use PIM. πŸ”₯

To configure a downstream interface for an IGMP Proxy, you need the ability to enable IGMP on that interface. This is defined in "A YANG Data Model for the Internet Group Management Protocol (IGMP) and Multicast Listener Discovery (MLD)" [RFC8652]. 🌈

augment /rt:routing/rt:control-plane-protocols
          /rt:control-plane-protocol:
  +--rw igmp-proxy! {igmp-proxy}?
     +--rw interfaces
        +--rw interface* [name]
           +--rw name                     if:interface-ref
           +--rw igmp-version?            uint8
           +--rw enabled?                 boolean
           +--rw sender-source-address?   inet:ipv4-address-no-zone
           +--ro group* [group-address]
              +--ro group-address
              |       rt-types:ipv4-multicast-group-address
              +--ro up-time?         uint32
              +--ro filter-mode      enumeration
              +--ro source* [source-address]
                 +--ro source-address
                 |       inet:ipv4-address-no-zone
                 +--ro up-time?                uint32
                 +--ro downstream-interface* [name]
                    +--ro name    if:interface-ref

Part 1 is done, bestie! πŸŽ€ Part 2 is coming next with Section 3.2 and onward, so stay tuned. πŸ«ΆπŸ’–

3.2. MLD Proxy Configuration and Operational State ✨

okay so this part is all about the MLD side πŸŽ€ the YANG module augments /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol to add the mld-proxy container 🧚

all the MLD Proxy attributes live in that mld-proxy container πŸ’– the read-write ones are your configurable data (you get to set those), and the read-only ones are state data (you just look, no touching πŸ‘€)

the mld-version parameter is the MLD protocol version, and its default value is 2 πŸ’… if enabled is true, that means the MLD Proxy is switched on πŸ”₯

the interface list under mld-proxy holds the upstream interfaces for an MLD Proxy πŸ¦‹ there's a constraint that makes sure the upstream interface for the MLD Proxy is not set up to use PIM πŸ™… no PIM on the upstream, bestie!

to set up a downstream interface for an MLD Proxy, you enable MLD on that interface 🌸 this is defined in "A YANG Data Model for the Internet Group Management Protocol (IGMP) and Multicast Listener Discovery (MLD)" [RFC8652] πŸ“š

   augment /rt:routing/rt:control-plane-protocols
             /rt:control-plane-protocol:
     +--rw mld-proxy! {mld-proxy}?
        +--rw interfaces
           +--rw interface* [name]
              +--rw name                     if:interface-ref
              +--rw mld-version?             uint8
              +--rw enabled?                 boolean
              +--rw sender-source-address?   inet:ipv6-address-no-zone
              +--ro group* [group-address]
                 +--ro group-address
                 |       rt-types:ipv6-multicast-group-address
                 +--ro up-time?         uint32
                 +--ro filter-mode      enumeration
                 +--ro source* [source-address]
                    +--ro source-address
                    |       inet:ipv6-address-no-zone
                    +--ro up-time?                uint32
                    +--ro downstream-interface* [name]
                       +--ro name    if:interface-ref

4. IGMP/MLD Proxy YANG Module πŸ‘‘

this module references [RFC4605], [RFC6991], [RFC8294], [RFC8343], [RFC8349], and [RFC9128] 🫢

   <CODE BEGINS> file "ietf-igmp-mld-proxy@2023-05-30.yang"
   module ietf-igmp-mld-proxy {
     yang-version 1.1;
     namespace "urn:ietf:params:xml:ns:yang:ietf-igmp-mld-proxy";
     prefix igmp-mld-proxy;

     import ietf-inet-types {
       prefix inet;
       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 ietf-pim-base {
       prefix pim-base;
       reference
         "RFC 9128: YANG Data Model for Protocol Independent Multicast
          (PIM)";
     }

     organization
       "IETF PIM Working Group";
     contact
       "WG Web:   <https://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>

                  Mani Panchanathan
                  <mailto:mapancha@cisco.com>

                  Mahesh Sivakumar
                  <mailto:sivakumar.mahesh@gmail.com>";
     description
       "This module defines a collection of YANG definitions common for
        all Internet Group Management Protocol (IGMP) and Multicast
        Listener Discovery (MLD) Proxy devices.

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

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

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

     revision 2023-05-30 {
       description
         "Initial revision.";
       reference
         "RFC 9398: A YANG Data Model for Internet Group Management
          Protocol (IGMP) and Multicast Listener Discovery (MLD)
          Proxy Devices";
     }

     /*
      * Features
      */

     feature igmp-proxy {
       description
         "Support for the IGMP Proxy protocol.";
       reference
         "RFC 4605: Internet Group Management Protocol (IGMP) /
          Multicast Listener Discovery (MLD)-Based Multicast Forwarding
          ('IGMP/MLD Proxying')";
     }

     feature mld-proxy {
       description
         "Support for the MLD Proxy protocol.";
       reference
         "RFC 4605: Internet Group Management Protocol (IGMP) /
          Multicast Listener Discovery (MLD)-Based Multicast Forwarding
          ('IGMP/MLD Proxying')";
     }

     /*
      * Identities
      */

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

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

     /*
      * Groupings
      */

     grouping per-interface-config-attributes {
       description
         "'config' attributes as listed under an interface entry.";
       leaf enabled {
         type boolean;
         default "true";
         description
           "Set the value to 'true' to enable the IGMP/MLD Proxy.";
       }
     } // per-interface-config-attributes

     grouping state-group-attributes {
       description
         "State group attributes.";
       leaf up-time {
         type uint32;
         units "seconds";
         description
           "The elapsed time for (S,G) or (*,G).";
       }
       leaf filter-mode {
         type enumeration {
           enum include {
             description
               "In 'include' mode, reception of packets sent
                to the specified multicast address is requested
                only from those IP source addresses listed in the
                'source' list parameter.";
           }
           enum exclude {
             description
               "In 'exclude' mode, reception of packets sent
                to the given multicast address is requested
                from all IP source addresses except those
                listed in the 'source' list parameter.";
           }
         }
         mandatory true;
         description
           "Filter mode for a multicast group.
            May be either 'include' or 'exclude'.";
       }
     } // state-group-attributes

     /* augments */

     augment "/rt:routing/rt:control-plane-protocols"
           + "/rt:control-plane-protocol" {
       when "derived-from-or-self(rt:type, "
          + "'igmp-mld-proxy:igmp-proxy')" {
         description
           "This augmentation is only valid for IGMP Proxies.";
       }
       description
         "IGMP Proxy augmentation to routing control plane protocol
          configuration and state.";
       container igmp-proxy {
         if-feature "igmp-proxy";
         presence "IGMP Proxy configuration.";
         description
           "IGMP Proxy instance configuration.";
         container interfaces {
           description
             "Contains a list of upstream interfaces.";
           list interface {
             key "name";
             description
               "List of upstream interfaces.";
             leaf name {
               type if:interface-ref;
               must 'not( current() = /rt:routing'
                  + '/rt:control-plane-protocols/pim-base:pim'
                  + '/pim-base:interfaces/pim-base:interface'
                  + '/pim-base:name )' {
                 description
                   "The upstream interface for the IGMP Proxy
                    must not be configured to use PIM.";
               }
               description
                 "The upstream interface name.";
             }
             leaf igmp-version {
               type uint8 {
                 range "1..3";
               }
               default "2";
               description
                 "IGMP version.";
             }
             uses per-interface-config-attributes;
             leaf sender-source-address {
               type inet:ipv4-address-no-zone;
               description
                 "The sender source address of an
                  IGMP membership report message or leave message.";
             }
             list group {
               key "group-address";
               config false;
               description
                 "List of the multicast groups in the membership
                  database built on this upstream interface.";
               leaf group-address {
                 type rt-types:ipv4-multicast-group-address;
                 description
                   "Multicast group address.";
               }
               uses state-group-attributes;
               list source {
                 key "source-address";
                 description
                   "Multicast source information
                    for the multicast group.";
                 leaf source-address {
                   type inet:ipv4-address-no-zone;
                   description
                     "Multicast source address.";
                 }
                 leaf up-time {
                   type uint32;
                   units "seconds";
                   description
                     "The elapsed time for (S,G) or (*,G).";
                 }
                 list downstream-interface {
                   key "name";
                   description
                     "List of downstream interfaces.";
                   leaf name {
                     type if:interface-ref;
                     description
                       "Downstream interfaces
                        for each upstream interface.";
                   }
                 }
               } // list source
             } // list group
           } // interface
         } // interfaces
       }
     }
     augment "/rt:routing/rt:control-plane-protocols"
           + "/rt:control-plane-protocol" {
       when "derived-from-or-self(rt:type, "
          + "'igmp-mld-proxy:mld-proxy')" {
         description
           "This augmentation is only valid for MLD Proxies.";
       }
       description
         "MLD Proxy augmentation to routing control plane protocol
          configuration and state.";
       container mld-proxy {
         if-feature "mld-proxy";
         presence "MLD Proxy configuration.";
         description
           "MLD Proxy instance configuration.";
         container interfaces {
           description
             "Contains a list of upstream interfaces.";
           list interface {
             key "name";
             description
               "List of upstream interfaces.";
             leaf name {
               type if:interface-ref;
               must 'not( current() = /rt:routing'
                  + '/rt:control-plane-protocols/pim-base:pim'
                  + '/pim-base:interfaces/pim-base:interface'
                  + '/pim-base:name )' {
                 description
                   "The upstream interface for the MLD Proxy
                    must not be configured to use PIM.";
               }
               description
                 "The upstream interface name.";
             }
             leaf mld-version {
               type uint8 {
                 range "1..2";
               }
               default "2";
               description
                 "MLD version.";
             }
             uses per-interface-config-attributes;
             leaf sender-source-address {
               type inet:ipv6-address-no-zone;
               description
                 "The sender source address of an
                  MLD membership report message or leave message.";
             }
             list group {
               key "group-address";
               config false;
               description
                 "List of the multicast groups in the membership
                  database built on this upstream interface.";
               leaf group-address {
                 type rt-types:ipv6-multicast-group-address;
                 description
                   "Multicast group address.";
               }
               uses state-group-attributes;
               list source {
                 key "source-address";
                 description
                   "Multicast source information
                    for the multicast group.";
                 leaf source-address {
                   type inet:ipv6-address-no-zone;
                   description
                     "Multicast source address.";
                 }
                 leaf up-time {
                   type uint32;
                   units "seconds";
                   description
                     "The elapsed time for (S,G) or (*,G).";
                 }
                 list downstream-interface {
                   key "name";
                   description
                     "List of downstream interfaces.";
                   leaf name {
                     type if:interface-ref;
                     description
                       "Downstream interfaces
                        for each upstream interface.";
                   }
                 }
               } // list source
             } // list group
           } // interface
         } // interfaces
       }
     }
   }
   <CODE ENDS>

5. Security Considerations πŸ”

Okay bestie, this section is SERIOUS business 🚨 but it's also kind of iconic, so let's go! πŸ’… The YANG module in this doc is basically a schema for data that's meant to be reached through network management protocols like NETCONF [RFC6241] or RESTCONF [RFC8040]. For NETCONF, the lowest layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. For RESTCONF, the lowest layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446]. πŸ”’

Then there's the Network Configuration Access Control Model (NACM) [RFC8341] πŸ›‘οΈ which lets you limit particular NETCONF or RESTCONF users to a preconfigured subset of all the available protocol operations and content. Very much a "who gets to touch what" moment. πŸ‘‘

Now, a bunch of data nodes in this module are writable, creatable, and deletable (that's config true, which is the default) 🫣. These nodes may be considered sensitive or vulnerable in some network environments. Write operations (for example, edit-config) to them without proper protection can have a negative effect on network operations. Here are the subtrees and nodes, and why they're sensitive:

Under /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol:/ with igmp-mld-proxy:igmp-proxy:

  • igmp-mld-proxy:interfaces: this subtree specifies the interface list for an IGMP Proxy. Changing the configuration may cause the IGMP Proxy interface to be deleted or changed. πŸ’₯
  • igmp-mld-proxy:interfaces/interface: this subtree specifies the configuration for the IGMP Proxy attributes at the interface level. Changing it may cause the IGMP Proxy to be deleted or changed on a specific interface. 😱

Under /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol:/ with igmp-mld-proxy:mld-proxy:

  • igmp-mld-proxy:interfaces: this subtree specifies the interface list for an MLD Proxy. Changing the configuration may cause the MLD Proxy interface to be deleted or changed. πŸ’₯
  • igmp-mld-proxy:interfaces/interface: this subtree specifies the configuration for the MLD Proxy attributes at the interface level. Changing it may cause the MLD Proxy to be deleted or changed on a specific interface. 😱

Unauthorized access to any data nodes in these subtrees can adversely affect the IGMP/MLD Proxy subsystem of both the local device and the network. 🌈 That can lead to network malfunctions, packets being delivered to the wrong places, and other problems. Not a vibe. πŸ’€

Some of the readable data nodes in this module may also be considered sensitive or vulnerable in some network environments, so it's really important to control read access to them (for example, through get, get-config, or notification). Here's the list, under /rt:routing/rt:control-plane-protocols/rt:control-plane-protocol:/:

  • igmp-mld-proxy:igmp-proxy
  • igmp-mld-proxy:mld-proxy

Unauthorized access to any data nodes in these subtrees can disclose operational state information about the IGMP/MLD Proxy on this device. Group information and source information may expose multicast group memberships, and that's the kind of tea nobody wants leaked. 🫒🍡

6. IANA Considerations 🌸

6.1. IETF XML Registry πŸŽ€

Here's the bit where this doc registers a namespace URI in the "IETF XML Registry" [RFC3688]. The registration looks like this:

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

6.2. YANG Module Names Registry πŸ¦‹

And this part registers the YANG module in the "YANG Module Names" registry [RFC6020], like so:

Name:  ietf-igmp-mld-proxy
Namespace:  urn:ietf:params:xml:ns:yang:ietf-igmp-mld-proxy
Prefix:  igmp-mld-proxy
Reference:  RFC 9398

7. References πŸ“š

7.1. Normative References 🧚

These are the normative references, the ones you absolutely need to read to get the full picture. Every one is listed with all of its details:

7.2. Informative References πŸ“š

Okay, bestie, these are the "for your curiosity" references, so you don't need them to get the core spec, but they're worth a peek πŸ€“

[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.

[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.

[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.

Appendix A. Data Tree Example ✨

Now for the fun part, the example πŸŽ€ This one shows an IGMP Proxy in action, written in JSON encoding [RFC7951], and it includes both configuration and state data. In the example, the IGMP Proxy is turned on for interface eth1/1 πŸ’–

Quick note: we also need IGMP enabled on eth1/2 and eth1/3, but the config details for those are left out, because this doc is all about IGMP/MLD Proxies, not those interfaces πŸ™ˆ

Here's the topology, with a Source sitting above R1, and two Receivers hanging off the downstream side:

              +-----------+
              +  Source   +
              +-----+-----+
                    |
   -----------------+----------------------------
                    |eth1/1
                +---+----+
                +  R1    +
                +-+----+-+
           eth1/2 |     \ eth1/3
                  |      \
                  |       \
                  |        \
   ---------------+---------+--------------------
                  |          \
                  |           \
        +---------+--+     +---+--------+
        + Receiver 1 +     + Receiver 2 +
        +------------+     +------------+

The configuration data for R1 in the figure above could look like this πŸ’…

{
    "ietf-interfaces:interfaces": {
      "interface": [
        {
          "name": "eth1/1",
          "type": "iana-if-type:ipForward",
          "ietf-ip:ipv4": {
            "address": [
              {
                "ip": "203.0.113.1",
                "prefix-length": 24
              }
            ]
          }
        }
      ]
    },
   "ietf-routing:routing": {
      "control-plane-protocols": {
        "control-plane-protocol": [
          {
            "type": "ietf-igmp-mld-proxy:igmp-proxy",
            "name": "proxy1",
            "ietf-igmp-mld-proxy:igmp-proxy": {
              "interfaces": {
                "interface": [
                  {
                    "name": "eth1/1",
                    "igmp-version": 3,
                    "enabled": true
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

And the matching operational state data for R1 could look like this πŸ¦‹

{
    "ietf-interfaces:interfaces": {
      "interface": [
        {
          "name": "eth1/1",
          "type": "iana-if-type:ipForward",
          "admin-status": "up",
          "oper-status": "up",
          "if-index": 25678136,
          "statistics": {
            "discontinuity-time": "2021-05-23T10:34:56-06:00"
          },
          "ietf-ip:ipv4": {
            "address": [
              {
                "ip": "203.0.113.1",
                "prefix-length": 24
              }
            ]
          }
        }
      ]
    },
   "ietf-routing:routing": {
      "control-plane-protocols": {
        "control-plane-protocol": [
          {
            "type": "ietf-igmp-mld-proxy:igmp-proxy",
            "name": "proxy1",
            "ietf-igmp-mld-proxy:igmp-proxy": {
              "interfaces": {
                "interface": [
                  {
                    "name": "eth1/1",
                    "igmp-version": 3,
                    "enabled": true,
                    "group": [
                      {
                        "group-address": "233.252.0.23",
                        "filter-mode": "include",
                        "source": [
                          {
                            "source-address": "192.0.2.1",
                            "downstream-interface": [
                              {
                                "name": "eth1/2"
                              },
                              {
                                "name": "eth1/3"
                              }
                            ]
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Authors' Addresses πŸ’Œ

Here's who made this happen, bestie, with their contact details 🫢

Hongji Zhao
Ericsson (China) Communications Company Ltd.
Ericsson Tower, No. 5 Lize East Street
Beijing
100102
China
Email: hongji.zhao@ericsson.com


Xufeng Liu
Alef Edge
United States of America
Email: xufeng.liu.ietf@gmail.com


Yisong Liu
China Mobile
China
Email: liuyisong@chinamobile.com


Mani Panchanathan
Cisco Systems, Inc.
3625 Cisco Way
San Jose, CA
United States of America
Email: mapancha@cisco.com


Mahesh Sivakumar
Juniper Networks
1133 Innovation Way
Sunnyvale, CA
United States of America
Email: sivakumar.mahesh@gmail.com

That's the whole RFC, bestie! 🌈 Five brilliant people, one very neat little proxy spec πŸ‘‘

πŸ“¦ where this page comes from