module ietf-pim-rp {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-pim-rp";

    prefix pim-rp;

    import ietf-inet-types {
      prefix inet;
      reference
        "RFC 6991: Common YANG Data Types";


    }
    import ietf-routing-types {
      prefix rt-types;
      reference
        "RFC 8294: Common YANG Data Types for the Routing Area";


    }
    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-pim-base {
      prefix pim-base;
      reference
        "RFC 9128: A 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>

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

Editor:   Pete McAllister
	  <mailto:pete.mcallister@metaswitch.com>

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

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

Editor:   Yisong Liu
	  <mailto:liuyisong@chinamobile.com>

Editor:   Fangwei Hu
	  <mailto:hufwei@gmail.com>";

    description
      "This YANG module defines a PIM (Protocol Independent Multicast)
RP (Rendezvous Point) model.

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
(https://trustee.ietf.org/license-info).

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

    revision "2022-10-19" {
      description "Initial revision.";
      reference
        "RFC 9128: A YANG Data Model for Protocol Independent
        Multicast (PIM)";

    }


    feature bsr {
      description
        "This feature indicates that the system supports BSRs
(Bootstrap Routers).";
      reference
        "RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol
        Independent Multicast (PIM)";

    }

    feature bsr-election-state {
      if-feature bsr;
      description
        "This feature indicates that the system supports providing
BSR election state.";
      reference
        "RFC 5059: Bootstrap Router (BSR) Mechanism for Protocol
        Independent Multicast (PIM)";

    }

    feature static-rp-override {
      description
        "This feature indicates that the system supports configuration
of the static RP (Rendezvous Point) that overrides the RP
discoveries from other mechanisms.";
      reference
        "RFC 7761: Protocol Independent Multicast - Sparse Mode
        (PIM-SM): Protocol Specification (Revised), Section 3.7";

    }

    feature candidate-interface {
      description
        "This feature indicates that the system supports using
an interface to configure a BSR or RP candidate.";
    }

    feature candidate-ipv4 {
      description
        "This feature indicates that the system supports using
an IPv4 address to configure a BSR or RP candidate.";
    }

    feature candidate-ipv6 {
      description
        "This feature indicates that the system supports using
an IPv6 address to configure a BSR or RP candidate.";
    }

    typedef rp-event-type {
      type enumeration {
        enum "invalid-jp" {
          value 0;
          description
            "An invalid Join/Prune message has been received.";
        }
        enum "invalid-register" {
          value 1;
          description
            "An invalid Register message has been received.";
        }
        enum "mapping-created" {
          value 2;
          description
            "A new mapping has been created.";
        }
        enum "mapping-deleted" {
          value 3;
          description
            "A mapping has been deleted.";
        }
      }
      description
        "Operational status event type for notifications.";
    }

    identity rp-mode {
      description
        "The mode of an RP, which can be SM (Sparse Mode) or
BIDIR (Bidirectional).";
    }

    identity rp-info-source-type {
      description
        "The information source of an RP.";
    }

    identity static {
      base rp-info-source-type;
      description
        "The RP is statically configured.";
    }

    identity bootstrap {
      base rp-info-source-type;
      description
        "The RP is learned from a Bootstrap.";
    }

    notification pim-rp-event {
      description
        "Notification event for an RP.";
      leaf event-type {
        type rp-event-type;
        description "Event type.";
      }

      leaf instance-af-ref {
        type leafref {
          path "/rt:routing/rt:control-plane-protocols/pim-base:pim/pim-base:address-family/pim-base:address-family";
        }
        description
          "Reference to a PIM instance address family.";
      }

      leaf group {
        type rt-types:ip-multicast-group-address;
        description "Group address.";
      }

      leaf rp-address {
        type inet:ip-address;
        description "RP address.";
      }

      leaf is-rpt {
        type boolean;
        description
          "'true' if the tree is an RPT (Rendezvous Point Tree).";
      }

      leaf mode {
        type identityref {
          base pim-base:pim-mode;
        }
        description "PIM mode.";
      }

      leaf message-origin {
        type inet:ip-address;
        description
          "Where the message originated.";
      }
    }  // notification pim-rp-event
  }  // module ietf-pim-rp