module ietf-segment-routing-mpls {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-segment-routing-mpls";

    prefix sr-mpls;

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


    }
    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-segment-routing {
      prefix sr;
      reference
        "RFC 9020: YANG Data Model for Segment Routing";


    }
    import ietf-segment-routing-common {
      prefix sr-cmn;
      reference
        "RFC 9020: YANG Data Model for Segment Routing";


    }

    organization
      "IETF SPRING - SPRING Working Group";

    contact
      "WG Web:   <https://datatracker.ietf.org/wg/spring/>
     WG List:  <mailto:spring@ietf.org>

     Author:    Stephane Litkowski
               <mailto:slitkows.ietf@gmail.com>
     Author:    Yingzhen Qu
               <mailto:yingzhen.qu@futurewei.com>
     Author:    Acee Lindem
               <mailto:acee@cisco.com>
     Author:    Pushpasis Sarkar
               <mailto:pushpasis.ietf@gmail.com>
     Author:    Jeff Tantsura
               <jefftant.ietf@gmail.com>

    ";

    description
      "This YANG module defines a generic configuration model for
     the Segment Routing MPLS data plane.

     This YANG module conforms to the Network Management
     Datastore Architecture (NMDA), as described in RFC 8242.

     The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
     NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
     'MAY', and 'OPTIONAL' in this document are to be interpreted as
     described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
     they appear in all capitals, as shown here.

     Copyright (c) 2021 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 Simplified 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 9020;
     see the RFC itself for full legal notices.";

    reference
      "RFC 9020: YANG Data Model for Segment Routing";


    revision "2021-05-26" {
      description "Initial version";
      reference
        "RFC 9020: YANG Data Model for Segment Routing";

    }


    feature mapping-server {
      description
        "Support for Segment Routing Mapping Server (SRMS).";
      reference
        "RFC 8661: Segment Routing MPLS Interworking
        	  with LDP";

    }

    feature protocol-srgb {
      description
        "Support for per-protocol Segment Routing Global Block
       (SRGB) configuration.";
      reference
        "RFC 8660: Segment Routing with the MPLS
        	  Data Plane";

    }

    typedef system-id {
      type string {
        pattern
          '[0-9A-Fa-f]{4}\.[0-9A-Fa-f]{4}\.[0-9A-Fa-f]{4}';
      }
      description
        "This type defines an IS-IS system-id using a pattern.
       An example system-id is 0143.0438.AEF0.";
    }

    typedef router-or-system-id {
      type union {
        type rt-types:router-id;
        type system-id;
      }
      description
        "OSPF/BGP router-id or IS-IS system ID.";
    }

    notification segment-routing-srgb-collision {
      description
        "This notification is sent when SRGB blocks received from
       different routers collide.";
      list srgb-collisions {
        description
          "List of SRGB blocks that collide.";
        leaf lower-bound {
          type uint32;
          description
            "Lower value in the block.";
        }

        leaf upper-bound {
          type uint32;
          description
            "Upper value in the block.";
        }

        leaf routing-protocol {
          type leafref {
            path "/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol/rt:name";
          }
          description
            "Routing protocol reference for SRGB collision.";
        }

        leaf originating-rtr-id {
          type router-or-system-id;
          description
            "Originating router ID of this SRGB block.";
        }
      }  // list srgb-collisions
    }  // notification segment-routing-srgb-collision

    notification segment-routing-global-sid-collision {
      description
        "This notification is sent when a new mapping is learned
       containing a mapping where the SID is already used.
       The notification generation must be throttled with at least
       a 5-second gap between notifications.";
      leaf received-target {
        type string;
        description
          "Target received in the router advertisement that caused
         the SID collision.";
      }

      leaf new-sid-rtr-id {
        type router-or-system-id;
        description
          "Router ID that advertised the colliding SID.";
      }

      leaf original-target {
        type string;
        description
          "Target already available in the database with the same SID
         as the received target.";
      }

      leaf original-sid-rtr-id {
        type router-or-system-id;
        description
          "Router ID for the router that originally advertised the
         colliding SID, i.e., the instance in the database.";
      }

      leaf index {
        type uint32;
        description
          "Value of the index used by two different prefixes.";
      }

      leaf routing-protocol {
        type leafref {
          path "/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol/rt:name";
        }
        description
          "Routing protocol reference for colliding SID.";
      }
    }  // notification segment-routing-global-sid-collision

    notification segment-routing-index-out-of-range {
      description
        "This notification is sent when a binding is received
       containing a segment index that is out of the local
       configured ranges.  The notification generation must be
       throttled with at least a 5-second gap between
       notifications.";
      leaf received-target {
        type string;
        description
          "A human-readable string representing the target
         received in the protocol-specific advertisement
         corresponding to the out-of-range index.";
      }

      leaf received-index {
        type uint32;
        description
          "Value of the index received.";
      }

      leaf routing-protocol {
        type leafref {
          path "/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol/rt:name";
        }
        description
          "Routing protocol reference for out-of-range indexed.";
      }
    }  // notification segment-routing-index-out-of-range
  }  // module ietf-segment-routing-mpls