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";

    }


    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')";

    }

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

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

    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.";
      }
    }  // grouping 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" {
            value 0;
            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" {
            value 1;
            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'.";
      }
    }  // grouping state-group-attributes

    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 downstream-interface
              }  // list source
            }  // list group
          }  // list interface
        }  // container interfaces
      }  // container igmp-proxy
    }

    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 downstream-interface
              }  // list source
            }  // list group
          }  // list interface
        }  // container interfaces
      }  // container mld-proxy
    }
  }  // module ietf-igmp-mld-proxy