RIB Extension YANG Data Model
draft-ietf-rtgwg-yang-rib-extend-06

Document Type Active Internet-Draft (rtgwg WG)
Authors Acee Lindem  , Yingzhen Qu 
Last updated 2021-03-25 (latest revision 2021-02-03)
Replaces draft-acee-rtgwg-yang-rib-extend
Stream Internet Engineering Task Force (IETF)
Intended RFC status (None)
Formats plain text pdf htmlized (tools) htmlized bibtex
Yang Validation 0 errors, 0 warnings.
Reviews
Additional Resources
- Yang catalog entry for ietf-rib-extension@2020-09-18.yang
- Yang impact analysis for draft-ietf-rtgwg-yang-rib-extend
- Mailing list discussion
Stream WG state WG Document
Other - see Comment Log
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                          A. Lindem
Internet-Draft                                             Cisco Systems
Intended status: Standards Track                                   Y. Qu
Expires: August 7, 2021                           Futurewei Technologies
                                                        February 3, 2021

                     RIB Extension YANG Data Model
                  draft-ietf-rtgwg-yang-rib-extend-06

Abstract

   The Routing Information Base (RIB) is a list of routes and their
   corresponding administrative data and operational state.

   RFC 8349 defines the basic building blocks for RIB, and this model
   augments it to support multiple next-hops (aka, paths) for each route
   as well as additional attributes.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on August 7, 2021.

Copyright Notice

   Copyright (c) 2021 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 Simplified BSD License text as described in Section 4.e of

Lindem & Qu              Expires August 7, 2021                 [Page 1]
Internet-Draft                YANG RIB-EXT                 February 2021

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology and Notation  . . . . . . . . . . . . . . . . . .   3
     2.1.  Glossary of New Terms . . . . . . . . . . . . . . . . . .   4
     2.2.  Tree Diagrams . . . . . . . . . . . . . . . . . . . . . .   4
     2.3.  Prefixes in Data Node Names . . . . . . . . . . . . . . .   4
   3.  Design of the Model . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  RIB Tags and Preference . . . . . . . . . . . . . . . . .   5
     3.2.  Multiple next-hops  . . . . . . . . . . . . . . . . . . .   5
     3.3.  Repair path . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  RIB Model Tree  . . . . . . . . . . . . . . . . . . . . . . .   5
   5.  RIB Extension YANG Model  . . . . . . . . . . . . . . . . . .   6
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .  14
   7.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  15
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  15
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .  15
     8.2.  Informative References  . . . . . . . . . . . . . . . . .  16
   Appendix A.  Combined Tree Diagram  . . . . . . . . . . . . . . .  17
   Appendix B.  ietf-rib-extension.yang example  . . . . . . . . . .  19
   Appendix C.  Acknowledgments  . . . . . . . . . . . . . . . . . .  24
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  24

1.  Introduction

   This document defines a YANG [RFC6020][RFC7950] data model which
   extends the generic data model for RIB by augmenting the ietf-routing
   model as defined in [RFC8349].

   RIB is a collection of best routes from all routing protocols.
   Within a protocol, routes are selected based on the metrics in use by
   that protocol, and the protocol installs its best routes to RIB.  RIB
   selects the best route by comparing the route preference (aka,
   administrative distance) of the associated protocol.

   The augmentations described herein extend the RIB to support multiple
   paths per route, route metrics, and administrative tags.

   The YANG modules in this document conform to the Network Management
   Datastore Architecture (NMDA) [RFC8342].

Lindem & Qu              Expires August 7, 2021                 [Page 2]
Internet-Draft                YANG RIB-EXT                 February 2021

2.  Terminology and Notation

   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 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

   The following terms are defined in [RFC8342]:

   o  client

   o  server

   o  configuration

   o  system state

   o  operational state

   o  intended configuration

   The following terms are defined in [RFC7950]:

   o  action

   o  augment

   o  container

   o  container with presence

   o  data model

   o  data node

   o  feature

   o  leaf

   o  list

   o  mandatory node

   o  module

   o  schema tree

Lindem & Qu              Expires August 7, 2021                 [Page 3]
Internet-Draft                YANG RIB-EXT                 February 2021

   o  RPC (Remote Procedure Call) operation

2.1.  Glossary of New Terms

      Routing Information Base (RIB): An object containing a list of
      routes, together with other information.  See [RFC8349]
      Section 5.2 for details.

2.2.  Tree Diagrams

   Tree diagrams used in this document follow the notation defined in
   [RFC8340].

2.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 |
            +--------+---------------------------+-----------+
            | if     | ietf-interfaces           | [RFC8343] |
            |        |                           |           |
            | rt     | ietf-routing              | [RFC8349] |
            |        |                           |           |
            | v4ur   | ietf-ipv4-unicast-routing | [RFC8349] |
            |        |                           |           |
            | v6ur   | ietf-ipv6-unicast-routing | [RFC8349] |
            |        |                           |           |
            | inet   | ietf-inet-types           | [RFC6991] |
            +--------+---------------------------+-----------+

             Table 1: Prefixes and Corresponding YANG Modules

3.  Design of the Model

   The YANG definitions in this document augment the ietf-routing model
   defined in [RFC8349], which provides a basis for routing system data
   model development.  Together with modules defined in [RFC8349], a
   generic RIB Yang model is defined to implement and monitor a RIB.

   The models in [RFC8349] also define the basic configuration and
   operational state for both IPv4 and IPv6 static routes and this
   document also provides augmentations for static routes to support
   multiple next-hop and more next-hop attributes.

Lindem & Qu              Expires August 7, 2021                 [Page 4]
Internet-Draft                YANG RIB-EXT                 February 2021

3.1.  RIB Tags and Preference

   Individual routes tags are supported at both the route and next-hop
   level.  A preference per next-hop is also supported for selection of
   the most preferred reachable static route.

3.2.  Multiple next-hops

   Both IPv4 and IPv6 static route configuration defined in [RFC8349]
   have been augmented with a multi-next-hop option.

   A static route/prefix can be configured to have multiple next-hops,
   each with their own tag and route preference.

   In RIB, a route may have multiple next-hops.  They can be either
   equal cost multiple paths (ECMP), or they may have different metrics.

3.3.  Repair path

   The IP Fast Reroute (IPFRR) pre-computes repair paths by routing
   protocols [RFC5714], and the best repair path is installed in RIB.

   Each route in RIB is augmented with the best repair path if
   available.

4.  RIB Model Tree

   The tree associated with the "ietf-rib-extension" module follows.
   The meaning of the symbols can be found in [RFC8340].  The ietf-
   routing.yang tree with the augmentations herein is included in
   Appendix A.

   module: ietf-rib-extension
     augment /rt:routing/rt:control-plane-protocols
             /rt:control-plane-protocol/rt:static-routes/v4ur:ipv4
             /v4ur:route/v4ur:next-hop/v4ur:next-hop-options
             /v4ur:simple-next-hop:
       +--rw preference?   uint32
       +--rw tag?          uint32
     augment /rt:routing/rt:control-plane-protocols
             /rt:control-plane-protocol/rt:static-routes/v4ur:ipv4
             /v4ur:route/v4ur:next-hop/v4ur:next-hop-options
             /v4ur:next-hop-list/v4ur:next-hop-list/v4ur:next-hop:
       +--rw preference?   uint32
       +--rw tag?          uint32
     augment /rt:routing/rt:control-plane-protocols
             /rt:control-plane-protocol/rt:static-routes/v6ur:ipv6
             /v6ur:route/v6ur:next-hop/v6ur:next-hop-options

Lindem & Qu              Expires August 7, 2021                 [Page 5]
Internet-Draft                YANG RIB-EXT                 February 2021

             /v6ur:simple-next-hop:
       +--rw preference?   uint32
       +--rw tag?          uint32
     augment /rt:routing/rt:control-plane-protocols
             /rt:control-plane-protocol/rt:static-routes/v6ur:ipv6
             /v6ur:route/v6ur:next-hop/v6ur:next-hop-options
             /v6ur:next-hop-list/v6ur:next-hop-list/v6ur:next-hop:
       +--rw preference?   uint32
       +--rw tag?          uint32
     augment /rt:routing/rt:ribs/rt:rib:
       +--ro rib-summary-statistics
          +--ro total-routes?              uint32
          +--ro total-active-routes?       uint32
          +--ro total-route-memory?        uint64
          +--ro protocol-rib-statistics* []
             +--ro rib-protocol?             identityref
             +--ro protocol-total-routes?    uint32
             +--ro protocol-active-routes?   uint32
             +--ro protocol-route-memory?    uint64
     augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route:
       +--ro metric?            uint32
       +--ro tag?               uint32
       +--ro application-tag?   uint32
     augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route
             /rt:next-hop/rt:next-hop-options/rt:simple-next-hop:
       +--ro repair-path
          +--ro outgoing-interface?   if:interface-state-ref
          +--ro next-hop-address?     inet:ip-address
          +--ro metric?               uint32
     augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route
             /rt:next-hop/rt:next-hop-options/rt:special-next-hop:
       +--ro repair-path
          +--ro outgoing-interface?   if:interface-state-ref
          +--ro next-hop-address?     inet:ip-address
          +--ro metric?               uint32
     augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route
             /rt:next-hop/rt:next-hop-options/rt:next-hop-list
             /rt:next-hop-list/rt:next-hop:
       +--ro repair-path
          +--ro outgoing-interface?   if:interface-state-ref
          +--ro next-hop-address?     inet:ip-address
          +--ro metric?               uint32

5.  RIB Extension YANG Model

   <CODE BEGINS> file "ietf-rib-extension@2021-02-03.yang"
   module ietf-rib-extension {
     yang-version "1.1";

Lindem & Qu              Expires August 7, 2021                 [Page 6]
Internet-Draft                YANG RIB-EXT                 February 2021

     namespace "urn:ietf:params:xml:ns:yang:ietf-rib-extension";

     prefix rib-ext;

     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 (NMDA Version)";
     }

     import ietf-routing {
       prefix "rt";
       reference "RFC 8349: A YANG Data Model for Routing
                            Management (NMDA Version)";
     }

     import ietf-ipv4-unicast-routing {
       prefix "v4ur";
       reference "RFC 8349: A YANG Data Model for Routing
                            Management (NMDA Version)";
     }

     import ietf-ipv6-unicast-routing {
       prefix "v6ur";
       reference "RFC 8349: A YANG Data Model for Routing
                            Management (NMDA Version)";
     }

     organization
       "IETF RTGWG - Routing Working Group";

     contact
       "WG Web:   <http://datatracker.ietf.org/group/rtgwg/>
        WG List:  <mailto:rtgwg@ietf.org>

        Author:   Acee Lindem
                  <mailto:acee@cisco.com>
        Author:   Yingzhen Qu
                  <mailto:yingzhen.qu@futurewei.com>";

     description
       "This YANG module extends the generic data model for
        RIB by augmenting the ietf-routing model. It is

Lindem & Qu              Expires August 7, 2021                 [Page 7]
Internet-Draft                YANG RIB-EXT                 February 2021

        intended that the module will be extended by vendors
        to define vendor-specific RIB parameters.

        This YANG model conforms to the Network Management
        Datastore Architecture (NDMA) as described in RFC 8342.

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

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

     revision 2021-02-03 {
       description
         "Initial RFC Version";
       reference
         "RFC XXXX: A YANG Data Model for RIB Extensions.";
     }

     /* Groupings */
     grouping rib-statistics {
       description
         "Statistics grouping used for RIB augmentation";
       container rib-summary-statistics {
         config false;
         description "Container for RIB statistics";
         leaf total-routes {
           type uint32;
           description
             "Total routes in the RIB from all protocols";
         }
         leaf total-active-routes {
           type uint32;
           description
             "Total active routes in the RIB";
         }
         leaf total-route-memory {
           type uint64;
           description
             "Total memory for all routes in the RIB from all
              protocol clients";

Lindem & Qu              Expires August 7, 2021                 [Page 8]
Internet-Draft                YANG RIB-EXT                 February 2021

         }
         list protocol-rib-statistics {
           description "List protocol statistics";
           leaf rib-protocol {
             type identityref {
               base rt:routing-protocol;
             }
             description "Routing protocol for statistics";
           }
           leaf protocol-total-routes {
             type uint32;
             description
               "Total number routes for protocol in the RIB";
           }
           leaf protocol-active-routes {
             type uint32;
             description
               "Number active routes for protocol in the RIB";
           }
           leaf protocol-route-memory {
             type uint64;
             description
               "Total memory for all routes in the RIB for protocol";
           }
         }
       }
     }

     grouping next-hop {
       description
         "Next-hop grouping";
       leaf interface {
         type if:interface-ref;
         description
           "Outgoing interface";
       }
       leaf address {
         type inet:ip-address;
         description
           "IPv4 or IPv6 Address of the next-hop";
       }
     }

     grouping attributes {
       description
         "Common attributes applicable to all paths";
       leaf metric {
         type uint32;

Lindem & Qu              Expires August 7, 2021                 [Page 9]
Internet-Draft                YANG RIB-EXT                 February 2021

         description
           "The metric is a numeric value that indicating the
            cost of the route from the perspective of the routing
            protocol installing the route. In general, routes with
            a lower metric installed by the same routing protocol
            are lower cost to reach and are preferable to routes
            with a higher metric. However, metrics from different
            routing protocols are not directly comparable.";
       }
       leaf tag {
         type uint32;
         description
           "The tag is a 32-bit opaque value associated with the
            route that can be used for policy decisions such as
            advertisement and filtering of the route.";
       }
       leaf application-tag {
         type uint32;
         description
           "The application-specific tag is an additional tag that
            can be used by applications that require semantics and/or
            policy different from that of the tag. For example,
            the tag is usually automatically advertised in OSPF
            AS-External Link State Advertisements (LSAs) while this
            application-specific tag is not advertised implicitly.";
       }
     }
     grouping repair-path {
       description
         "Grouping for IP Fast Reroute repair path.";
       container repair-path {
         description
           "IP Fast Reroute next-hop repair path";
         leaf outgoing-interface {
           type if:interface-state-ref;
           description
             "Name of the outgoing interface.";
         }
         leaf next-hop-address {
           type inet:ip-address;
           description
             "IP address of the next hop.";
         }
         leaf metric {
           type uint32;
           description
             "The metric for the repair path. While the IP Fast
              Reroute re-route repair is local and the metric is

Lindem & Qu              Expires August 7, 2021                [Page 10]
Internet-Draft                YANG RIB-EXT                 February 2021

              not advertised externally, the metric for repair path
              is useful for troubleshooting purposes.";
         }
         reference
           "RFC 5714: IP Fast Reroute Framework.";
       }
     }

     augment "/rt:routing/rt:control-plane-protocols/"
       + "rt:control-plane-protocol/rt:static-routes/v4ur:ipv4/"
       + "v4ur:route/v4ur:next-hop/v4ur:next-hop-options/"
       + "v4ur:simple-next-hop"
     {
       description
         "Augment 'simple-next-hop' case in IPv4 unicast route.";
       leaf preference {
         type uint32;
         default "1";
         description
           "The preference is used to select among multiple static
            routes, Routes with a lower preference next-hop are
            preferred and equal preference routes result in
            Equal-Cost-Multi-Path (ECMP) static routes.";
       }
       leaf tag {
         type uint32;
         default "0";
         description
           "The tag is a 32-bit opaque value associated with the
            route that can be used for policy decisions such as
            advertisement and filtering of the route.";
       }
     }

     augment "/rt:routing/rt:control-plane-protocols/"
       + "rt:control-plane-protocol/rt:static-routes/v4ur:ipv4/"
       + "v4ur:route/v4ur:next-hop/v4ur:next-hop-options/"
       + "v4ur:next-hop-list/v4ur:next-hop-list/v4ur:next-hop"
     {
       description
         "Augment static route configuration 'next-hop-list'.";

       leaf preference {
         type uint32;
         default "1";
         description
           "The preference is used to select among multiple static
            routes, Routes with a lower preference next-hop are

Lindem & Qu              Expires August 7, 2021                [Page 11]
Internet-Draft                YANG RIB-EXT                 February 2021

            preferred and equal preference routes result in
            Equal-Cost-Multi-Path (ECMP) static routes.";
       }
       leaf tag {
         type uint32;
         default "0";
         description
           "The tag is a 32-bit opaque value associated with the
            route that can be used for policy decisions such as
            advertisement and filtering of the route.";
       }
     }

     augment "/rt:routing/rt:control-plane-protocols/"
       + "rt:control-plane-protocol/rt:static-routes/v6ur:ipv6/"
       + "v6ur:route/v6ur:next-hop/v6ur:next-hop-options/"
       + "v6ur:simple-next-hop"
     {
       description
         "Augment 'simple-next-hop' case in IPv6 unicast route.";
       leaf preference {
         type uint32;
         default "1";
         description
           "The preference is used to select among multiple static
            routes, Routes with a lower preference next-hop are
            preferred and equal preference routes result in
            Equal-Cost-Multi-Path (ECMP) static routes.";
       }
       leaf tag {
         type uint32;
         default "0";
         description
           "The tag is a 32-bit opaque value associated with the
            route that can be used for policy decisions such as
            advertisement and filtering of the route.";
       }
     }

     augment "/rt:routing/rt:control-plane-protocols/"
       + "rt:control-plane-protocol/rt:static-routes/v6ur:ipv6/"
       + "v6ur:route/v6ur:next-hop/v6ur:next-hop-options/"
       + "v6ur:next-hop-list/v6ur:next-hop-list/v6ur:next-hop"
     {
       description
         "Augment static route configuration 'next-hop-list'.";

       leaf preference {

Lindem & Qu              Expires August 7, 2021                [Page 12]
Internet-Draft                YANG RIB-EXT                 February 2021

         type uint32;
         default "1";
         description
           "The preference is used to select among multiple static
            routes, Routes with a lower preference next-hop are
            preferred and equal preference routes result in
            Equal-Cost-Multi-Path (ECMP) static routes.";
       }
       leaf tag {
         type uint32;
         default "0";
         description
           "The tag is a 32-bit opaque value associated with the
            route that can be used for policy decisions such as
            advertisement and filtering of the route.";
       }
     }

     augment "/rt:routing/rt:ribs/rt:rib"
     {
       description "Augment a RIB with statistics";
       uses rib-statistics;
     }

     augment "/rt:routing/rt:ribs/rt:rib/"
       + "rt:routes/rt:route"
     {
       description
         "Augment a route in RIB with tag.";
       uses attributes;
     }

     augment "/rt:routing/rt:ribs/rt:rib/"
       + "rt:routes/rt:route/rt:next-hop/rt:next-hop-options/"
       + "rt:simple-next-hop"
     {
       description
         "Add more parameters to a path.";
       uses repair-path;
     }

     augment "/rt:routing/rt:ribs/rt:rib/"
       + "rt:routes/rt:route/rt:next-hop/rt:next-hop-options/"
       + "rt:special-next-hop"
     {
       description
         "Add more parameters to a path.";
       uses repair-path;

Lindem & Qu              Expires August 7, 2021                [Page 13]
Internet-Draft                YANG RIB-EXT                 February 2021

     }

     augment "/rt:routing/rt:ribs/rt:rib/"
       + "rt:routes/rt:route/rt:next-hop/rt:next-hop-options/"
       + "rt:next-hop-list/rt:next-hop-list/rt:next-hop"
     {
       description
         "This case augments the 'next-hop-options' in the routing
          model.";
       uses repair-path;
     }
   }
   <CODE ENDS>

6.  Security Considerations

   The YANG modules specified in this document define 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 NETCONF access control model [RFC8341] provides the means to
   restrict access for particular NETCONF or RESTCONF users to a pre-
   configured subset of all available NETCONF or RESTCONF protocol
   operations and content.

   There are a number of data nodes defined in ietf-rib-extensions.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.  For these augmentations to
   ietf-routing.yang, the ability to delete, add, and modify IPv4 and
   IPv6 static routes would allow traffic to be misrouted.

   Some of the readable data nodes in the ietf-rib-extensions.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.  The exposure
   of the Routing Information Base (RIB) will expose the routing
   topology of the network.  This may be undesirable since both due to
   the fact that exposure may facilitate other attacks.  Additionally,
   network operators may consider their topologies to be sensitive
   confidential data.

Lindem & Qu              Expires August 7, 2021                [Page 14]
Internet-Draft                YANG RIB-EXT                 February 2021

   All the security considerations for [RFC8349] writable and readable
   data nodes apply to the augmentations described herein.

7.  IANA Considerations

   This document registers a URI in the IETF XML registry [RFC3688].
   Following the format in [RFC3688], the following registration is
   requested to be made:

      URI: urn:ietf:params:xml:ns:yang:ietf-rib-extension
      Registrant Contact: The IESG.
      XML: N/A, the requested URI is an XML namespace.

   This document registers a YANG module in the YANG Module Names
   registry [RFC6020].

      name: ietf-rib-extension
      namespace: urn:ietf:params:xml:ns:yang:ietf-rib-extension
      prefix: rib-ext
      reference: RFC XXXX

8.  References

8.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119,
              DOI 10.17487/RFC2119, March 1997,
              <https://www.rfc-editor.org/info/rfc2119>.

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

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

Lindem & Qu              Expires August 7, 2021                [Page 15]
Internet-Draft                YANG RIB-EXT                 February 2021

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

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

   [RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
              2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
              May 2017, <https://www.rfc-editor.org/info/rfc8174>.

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

8.2.  Informative References

   [RFC5714]  Shand, M. and S. Bryant, "IP Fast Reroute Framework",
              RFC 5714, DOI 10.17487/RFC5714, January 2010,
              <https://www.rfc-editor.org/info/rfc5714>.

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

Lindem & Qu              Expires August 7, 2021                [Page 16]
Internet-Draft                YANG RIB-EXT                 February 2021

Appendix A.  Combined Tree Diagram

   This appendix includes the combined ietf-routing.yang, ietf-ipv4-
   unicast-routing.yang, ietf-ipv6-unicast-routing.yang and ietf-rib-
   extensions.yang tree diagram.

module: ietf-routing
  +--rw routing
    +--rw router-id?                 yang:dotted-quad {router-id}?
    +--ro interfaces
    |  +--ro interface*   if:interface-ref
    +--rw control-plane-protocols
    |  +--rw control-plane-protocol* [type name]
    |     +--rw type             identityref
    |     +--rw name             string
    |     +--rw description?     string
    |     +--rw static-routes
    |        +--rw v4ur:ipv4
    |        |  +--rw v4ur:route* [destination-prefix]
    |        |     +--rw v4ur:destination-prefix    inet:ipv4-prefix
    |        |     +--rw v4ur:description?          string
    |        |     +--rw v4ur:next-hop
    |        |        +--rw (v4ur:next-hop-options)
    |        |           +--:(v4ur:simple-next-hop)
    |        |           |  +--rw v4ur:outgoing-interface?   if:interface-ref
    |        |           |  +--rw v4ur:next-hop-address?     inet:ipv4-address
    |        |           |  +--rw rib-ext:preference?        uint32
    |        |           |  +--rw rib-ext:tag?               uint32
    |        |           +--:(v4ur:special-next-hop)
    |        |           |  +--rw v4ur:special-next-hop?     enumeration
    |        |           +--:(v4ur:next-hop-list)
    |        |              +--rw v4ur:next-hop-list
    |        |                 +--rw v4ur:next-hop* [index]
    |        |                    +--rw v4ur:index                 string
    |        |                    +--rw v4ur:outgoing-interface?   if:interface-ref
    |        |                    +--rw v4ur:next-hop-address?     inet:ipv4-address
    |        |                    +--rw rib-ext:preference?        uint32
    |        |                    +--rw rib-ext:tag?               uint32
    |        +--rw v6ur:ipv6
    |           +--rw v6ur:route* [destination-prefix]
    |              +--rw v6ur:destination-prefix    inet:ipv6-prefix
    |              +--rw v6ur:description?          string
    |              +--rw v6ur:next-hop
    |                 +--rw (v6ur:next-hop-options)
    |                    +--:(v6ur:simple-next-hop)
    |                    |  +--rw v6ur:outgoing-interface?   if:interface-ref
    |                    |  +--rw v6ur:next-hop-address?     inet:ipv6-address
    |                    |  +--rw rib-ext:preference?        uint32

Lindem & Qu              Expires August 7, 2021                [Page 17]
Internet-Draft                YANG RIB-EXT                 February 2021

    |                    |  +--rw rib-ext:tag?               uint32
    |                    +--:(v6ur:special-next-hop)
    |                    |  +--rw v6ur:special-next-hop?     enumeration
    |                    +--:(v6ur:next-hop-list)
    |                       +--rw v6ur:next-hop-list
    |                          +--rw v6ur:next-hop* [index]
    |                             +--rw v6ur:index                 string
    |                             +--rw v6ur:outgoing-interface?   if:interface-ref
    |                             +--rw v6ur:next-hop-address?     inet:ipv6-address
    |                             +--rw rib-ext:preference?        uint32
    |                             +--rw rib-ext:tag?               uint32
    +--rw ribs
       +--rw rib* [name]
          +--rw name                            string
          +--rw address-family                  identityref
          +--ro default-rib?                    boolean {multiple-ribs}?
          +--ro routes
          |  +--ro route* []
          |     +--ro route-preference?          route-preference
          |     +--ro next-hop
          |     |  +--ro (next-hop-options)
          |     |     +--:(simple-next-hop)
          |     |     |  +--ro outgoing-interface?      if:interface-ref
          |     |     |  +--ro v4ur:next-hop-address?   inet:ipv4-address
          |     |     |  +--ro v6ur:next-hop-address?   inet:ipv6-address
          |     |     |  +--ro rib-ext:repair-path
          |     |     |     +--ro rib-ext:outgoing-interface?   if:interface-state-ref
          |     |     |     +--ro rib-ext:next-hop-address?     inet:ip-address
          |     |     |     +--ro rib-ext:metric?               uint32
          |     |     +--:(special-next-hop)
          |     |     |  +--ro special-next-hop?        enumeration
          |     |     |  +--ro rib-ext:repair-path
          |     |     |     +--ro rib-ext:outgoing-interface?   if:interface-state-ref
          |     |     |     +--ro rib-ext:next-hop-address?     inet:ip-address
          |     |     |     +--ro rib-ext:metric?               uint32
          |     |     +--:(next-hop-list)
          |     |        +--ro next-hop-list
          |     |           +--ro next-hop* []
          |     |              +--ro outgoing-interface?    if:interface-ref
          |     |              +--ro v4ur:address?          inet:ipv4-address
          |     |              +--ro v6ur:address?          inet:ipv6-address
          |     |              +--ro rib-ext:repair-path
          |     |                 +--ro rib-ext:outgoing-interface?   if:interface-state-ref
          |     |                 +--ro rib-ext:next-hop-address?     inet:ip-address
          |     |                 +--ro rib-ext:metric?               uint32
          |     +--ro source-protocol            identityref
          |     +--ro active?                    empty
          |     +--ro last-updated?              yang:date-and-time

Lindem & Qu              Expires August 7, 2021                [Page 18]
Internet-Draft                YANG RIB-EXT                 February 2021

          |     +--ro v4ur:destination-prefix?   inet:ipv4-prefix
          |     +--ro v6ur:destination-prefix?   inet:ipv6-prefix
          |     +--ro rib-ext:metric?            uint32
          |     +--ro rib-ext:tag?               uint32
          |     +--ro rib-ext:application-tag?   uint32
          +---x active-route
          |  +---w input
          |  |  +---w v4ur:destination-address?   inet:ipv4-address
          |  |  +---w v6ur:destination-address?   inet:ipv6-address
          |  +--ro output
          |     +--ro route
          |        +--ro next-hop
          |        |  +--ro (next-hop-options)
          |        |     +--:(simple-next-hop)
          |        |     |  +--ro outgoing-interface?      if:interface-ref
          |        |     |  +--ro v4ur:next-hop-address?   inet:ipv4-address
          |        |     |  +--ro v6ur:next-hop-address?   inet:ipv6-address
          |        |     +--:(special-next-hop)
          |        |     |  +--ro special-next-hop?        enumeration
          |        |     +--:(next-hop-list)
          |        |        +--ro next-hop-list
          |        |           +--ro next-hop* []
          |        |              +--ro outgoing-interface?      if:interface-ref
          |        |              +--ro v4ur:next-hop-address?   inet:ipv4-address
          |        |              +--ro v6ur:next-hop-address?   inet:ipv6-address
          |        +--ro source-protocol            identityref
          |        +--ro active?                    empty
          |        +--ro last-updated?              yang:date-and-time
          |        +--ro v4ur:destination-prefix?   inet:ipv4-prefix
          |        +--ro v6ur:destination-prefix?   inet:ipv6-prefix
          +--rw description?                      string
          +--ro rib-ext:rib-summary-statistics
             +--ro rib-ext:total-routes?              uint32
             +--ro rib-ext:total-active-routes?       uint32
             +--ro rib-ext:total-route-memory?        uint64
             +--ro rib-ext:protocol-rib-statistics* []
                +--ro rib-ext:rib-protocol?             identityref
                +--ro rib-ext:protocol-total-routes?    uint32
                +--ro rib-ext:protocol-active-routes?   uint32
                +--ro rib-ext:protocol-route-memory?    uint64

Appendix B.  ietf-rib-extension.yang example

   The following is an XML example using the RIB extension module and
   RFC 8349.

  <routing xmlns="urn:ietf:params:xml:ns:yang:ietf-routing">

Lindem & Qu              Expires August 7, 2021                [Page 19]
Internet-Draft                YANG RIB-EXT                 February 2021

    <control-plane-protocols>
      <control-plane-protocol>
        <type>static</type>
        <name>static-routing-protocol</name>
        <static-routes>
          <ipv4 xmlns="urn:ietf:params:xml:ns:yang:\
            ietf-ipv4-unicast-routing">
            <route>
              <destination-prefix>0.0.0.0/0</destination-prefix>
              <next-hop>
                <next-hop-address>192.0.2.2</next-hop-address>
                <preference xmlns="urn:ietf:params:xml:ns:yang:\
                  ietf-rib-extension">30</preference>
                <tag xmlns="urn:ietf:params:xml:ns:yang:\
                  ietf-rib-extension">99</tag>
              </next-hop>
            </route>
          </ipv4>
          <ipv6 xmlns="urn:ietf:params:xml:ns:yang:\
            ietf-ipv6-unicast-routing">
            <route>
              <destination-prefix>0::/0</destination-prefix>
              <next-hop>
                <next-hop-address>2001:db8:aaaa::1111</next-hop-address>
                <preference xmlns="urn:ietf:params:xml:ns:yang:\
                  ietf-rib-extension">30</preference>
                <tag xmlns="urn:ietf:params:xml:ns:yang:\
                  ietf-rib-extension">66</tag>
              </next-hop>
            </route>
          </ipv6>
        </static-routes>
      </control-plane-protocol>
    </control-plane-protocols>
    <ribs>
      <rib>
        <name>ipv4-master</name>
        <address-family xmlns:v4ur="urn:ietf:params:xml:ns:yang:\
          ietf-ipv4-unicast-routing">v4ur:ipv4-unicast</address-family>
        <default-rib>true</default-rib>
        <routes>
          <route>
            <destination-prefix xmlns="urn:ietf:params:xml:ns:yang:\
              ietf-ipv4-unicast-routing">0.0.0.0/0</destination-prefix>
            <next-hop>
              <next-hop-address xmlns="urn:ietf:params:xml:ns:yang:\
                ietf-ipv4-unicast-routing">192.0.2.2</next-hop-address>
            </next-hop>

Lindem & Qu              Expires August 7, 2021                [Page 20]
Internet-Draft                YANG RIB-EXT                 February 2021

            <route-preference>5</route-preference>
            <source-protocol>static</source-protocol>
            <last-updated>2015-10-24T18:02:45+02:00</last-updated>
          </route>
          <route>
            <destination-prefix xmlns="urn:ietf:params:xml:ns:yang:\
              ietf-ipv4-unicast-routing">198.51.100.0/24\
            </destination-prefix>
            <next-hop>
              <next-hop-address xmlns="urn:ietf:params:xml:ns:yang:\
                ietf-ipv4-unicast-routing">192.0.2.2</next-hop-address>
              <repair-path xmlns="urn:ietf:params:xml:ns:yang:\
                ietf-rib-extension">
                <next-hop-address>203.0.113.1</next-hop-address>
                <metric>200</metric>
              </repair-path>
            </next-hop>
            <route-preference>110</route-preference>
            <source-protocol xmlns:ospf="urn:ietf:params:xml:ns:yang:\
              ietf-ospf">ospf:ospf</source-protocol>
            <last-updated>2015-10-24T18:02:45+02:00</last-updated>
          </route>
        </routes>
      </rib>
      <rib>
        <name>ipv6-master</name>
        <address-family xmlns:v6ur="urn:ietf:params:xml:ns:yang:\
          ietf-ipv6-unicast-routing">v6ur:ipv6-unicast</address-family>
        <default-rib>true</default-rib>
        <routes>
          <route>
            <destination-prefix xmlns="urn:ietf:params:xml:ns:yang:\
              ietf-ipv6-unicast-routing">0::/0</destination-prefix>
            <next-hop>
              <next-hop-address xmlns="urn:ietf:params:xml:ns:yang:\
                ietf-ipv6-unicast-routing">2001:db8:aaaa::1111\
              </next-hop-address>
            </next-hop>
            <route-preference>5</route-preference>
            <source-protocol>static</source-protocol>
            <last-updated>2015-10-24T18:02:45+02:00</last-updated>
          </route>
          <route>
            <destination-prefix xmlns="urn:ietf:params:xml:ns:yang:\
              ietf-ipv6-unicast-routing">2001:db8:bbbb::/64\
            </destination-prefix>
            <next-hop>
              <next-hop-address xmlns="urn:ietf:params:xml:ns:yang:\

Lindem & Qu              Expires August 7, 2021                [Page 21]
Internet-Draft                YANG RIB-EXT                 February 2021

                ietf-ipv6-unicast-routing">2001:db8:aaaa::1111\
              </next-hop-address>
              <repair-path xmlns="urn:ietf:params:xml:ns:yang:\
                ietf-rib-extension">
                <next-hop-address>2001:db8:cccc::2222</next-hop-address>
                <metric>200</metric>
              </repair-path>
            </next-hop>
            <route-preference>110</route-preference>
            <source-protocol xmlns:ospf="urn:ietf:params:xml:ns:yang:\
              ietf-ospf">ospf:ospf</source-protocol>
            <last-updated>2015-10-24T18:02:45+02:00</last-updated>
          </route>
        </routes>
      </rib>
    </ribs>
  </routing>

   The following is the same example using JSON format.

  {
    "ietf-routing:routing": {
      "control-plane-protocols": {
        "control-plane-protocol": [
          {
            "type": "static",
            "name": "static-routing-protocol",
            "static-routes": {
              "ietf-ipv4-unicast-routing:ipv4": {
                "route": [
                  {
                    "destination-prefix": "0.0.0.0/0",
                    "next-hop": {
                      "next-hop-address": "192.0.2.2",
                      "ietf-rib-extension:preference": 30,
                      "ietf-rib-extension:tag": 99
                    }
                  }
                ]
              },
              "ietf-ipv6-unicast-routing:ipv6": {
                "route": [
                  {
                    "destination-prefix": "::/0",
                    "next-hop": {
                      "next-hop-address": "2001:db8:aaaa::1111",
                      "ietf-rib-extension:preference": 30,

Lindem & Qu              Expires August 7, 2021                [Page 22]
Internet-Draft                YANG RIB-EXT                 February 2021

                      "ietf-rib-extension:tag": 66
                    }
                  }
                ]
              }
            }
          }
        ]
      },
      "ribs": {
        "rib": [
          {
            "name": "ipv4-master",
            "address-family": "ietf-ipv4-unicast-routing:ipv4-unicast",
            "default-rib": true,
            "routes": {
              "route": [
                {
                  "next-hop": {
                    "ietf-ipv4-unicast-routing:next-hop-address": \
                    "192.0.2.2"
                  },
                  "route-preference": 5,
                  "source-protocol": "static",
                  "last-updated": "2015-10-24T18:02:45+02:00",
                  "ietf-ipv4-unicast-routing:destination-prefix": \
                  "0.0.0.0/0"
                },
                {
                  "next-hop": {
                    "ietf-rib-extension:repair-path": {
                      "next-hop-address": "203.0.113.1",
                      "metric": 200
                    },
                    "ietf-ipv4-unicast-routing:next-hop-address": \
                    "192.0.2.2"
                  },
                  "route-preference": 110,
                  "source-protocol": "ietf-ospf:ospf",
                  "last-updated": "2015-10-24T18:02:45+02:00",
                  "ietf-ipv4-unicast-routing:destination-prefix": \
                  "198.51.100.0/24"
                }
              ]
            }
          },
          {
            "name": "ipv6-master",

Lindem & Qu              Expires August 7, 2021                [Page 23]
Internet-Draft                YANG RIB-EXT                 February 2021

            "address-family": "ietf-ipv6-unicast-routing:ipv6-unicast",
            "default-rib": true,
            "routes": {
              "route": [
                {
                  "next-hop": {
                    "ietf-ipv6-unicast-routing:next-hop-address": \
                    "2001:db8:aaaa::1111"
                  },
                  "route-preference": 5,
                  "source-protocol": "static",
                  "last-updated": "2015-10-24T18:02:45+02:00",
                  "ietf-ipv6-unicast-routing:destination-prefix": "::/0"
                },
                {
                  "next-hop": {
                    "ietf-rib-extension:repair-path": {
                      "next-hop-address": "2001:db8:cccc::2222",
                      "metric": 200
                    },
                    "ietf-ipv6-unicast-routing:next-hop-address": \
                    "2001:db8:aaaa::1111"
                  },
                  "route-preference": 110,
                  "source-protocol": "ietf-ospf:ospf",
                  "last-updated": "2015-10-24T18:02:45+02:00",
                  "ietf-ipv6-unicast-routing:destination-prefix": \
                  "2001:db8:bbbb::/64"
                }
              ]
            }
          }
        ]
      }
    }
  }

Appendix C.  Acknowledgments

   The RFC text was produced using Marshall Rose's xml2rfc tool.

   The authors wish to thank Les Ginsberg, Krishna Deevi, and Suyoung
   Yoon for their helpful comments and suggestions.

   The authors wish to thank Tom Petch, Rob Wilton and Chris Hopps for
   their reviews and comments.

Lindem & Qu              Expires August 7, 2021                [Page 24]
Internet-Draft                YANG RIB-EXT                 February 2021

Authors' Addresses

   Acee Lindem
   Cisco Systems
   301 Midenhall Way
   Cary, NC  27513
   USA

   EMail: acee@cisco.com

   Yingzhen Qu
   Futurewei Technologies
   2330 Central Expressway
   Santa Clara, CA  95050
   USA

   EMail: yingzhen.qu@futurewei.com

Lindem & Qu              Expires August 7, 2021                [Page 25]