module ietf-rib-extension {
yang-version "1.1";
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:
WG List:
Author: Acee Lindem
Author: Yingzhen Qu
";
description
"This document defines a YANG data model which extends
the RIBs defined in ietf-routing YANG module with more
route attributes.
This YANG model conforms to the Network Management
Datastore Architecture (NDMA) as described in RFC 8342.
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 XXXX;
see the RFC itself for full legal notices.";
revision 2023-05-01 {
description
"Initial Version";
reference
"RFC XXXX: A YANG Data Model for RIB Extensions.";
}
/* Groupings */
grouping rib-statistics {
description
"Statistics grouping used for RIB augmentation.";
container statistics {
config false;
description
"Container for RIB statistics.";
leaf total-routes {
type uint32;
description
"Total routes in the RIB";
}
leaf total-active-routes {
type uint32;
description
"Total active routes in the RIB. An active route is
preferred over other routes to the same destination
prefix.";
}
leaf total-route-memory {
type uint64;
units "bytes";
description
"Total memory for all routes in the RIB.";
}
list protocol-statistics {
description "RIB statistics per protocol.";
leaf protocol {
type identityref {
base rt:routing-protocol;
}
description "Routing protocol.";
}
leaf routes {
type uint32;
description
"Total routes for protocol in the RIB.";
}
leaf active-routes {
type uint32;
description
"Total active routes for protocol in the RIB. An active
route is preferred over other routes to the same
destination prefix.";
}
leaf route-memory {
type uint64;
units "bytes";
description
"Total memory for all routes for protocol in the RIB.";
}
}
}
}
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 routes.";
leaf metric {
type uint32;
description
"The metric is a numeric value 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-list tag {
type uint32;
description
"A 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
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
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 {
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 attributes.";
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
"Augment simple-next-hop with repair-path.";
uses repair-path;
}
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
"Augment the next-hop with a repair path.";
uses repair-path;
}
}