draft-ietf-netmod-rfc8022bis-00.txt   draft-ietf-netmod-rfc8022bis-01.txt 
NETMOD Working Group L. Lhotka NETMOD Working Group L. Lhotka
Internet-Draft CZ.NIC Internet-Draft CZ.NIC
Intended status: Standards Track A. Lindem Intended status: Standards Track A. Lindem
Expires: May 4, 2018 Cisco Systems Expires: May 4, 2018 Cisco Systems
Y. Qu Y. Qu
Futurewei Technologies, Inc. Futurewei Technologies, Inc.
October 31, 2017 October 31, 2017
A YANG Data Model for Routing Management (NDMA Version) A YANG Data Model for Routing Management (NDMA Version)
draft-ietf-netmod-rfc8022bis-00 draft-ietf-netmod-rfc8022bis-01
Abstract Abstract
This document contains a specification of three YANG modules and one This document contains a specification of three YANG modules and one
submodule. Together they form the core routing data model that submodule. Together they form the core routing data model that
serves as a framework for configuring and managing a routing serves as a framework for configuring and managing a routing
subsystem. It is expected that these modules will be augmented by subsystem. It is expected that these modules will be augmented by
additional YANG modules defining data models for control-plane additional YANG modules defining data models for control-plane
protocols, route filters, and other functions. The core routing data protocols, route filters, and other functions. The core routing data
model provides common building blocks for such extensions -- routes, model provides common building blocks for such extensions -- routes,
Routing Information Bases (RIBs), and control-plane protocols. Routing Information Bases (RIBs), and control-plane protocols.
This version of these YANG modules uses new names for these YANG This version of these YANG modules uses new names for these YANG
models. The main difference from the first version is that this models. The main difference from the first version is that this
version fully conforms to the Network Management Datastore version fully conforms to the Network Management Datastore
Architecture (NMDA). Consequently, this document obsoletes RFC 8022. Architecture (NMDA). Consequently, this document obsoletes RFC 8022.
Deprecated versions of the prior YANG modules are provided as the
NDMA conpliant modules will replace the prior modules.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 4, 2018 . This Internet-Draft will expire on May 4, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology and Notation . . . . . . . . . . . . . . . . . . 4 2. Terminology and Notation . . . . . . . . . . . . . . . . . . 3
2.1. Glossary of New Terms . . . . . . . . . . . . . . . . . . 5 2.1. Glossary of New Terms . . . . . . . . . . . . . . . . . . 4
2.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 5 2.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 5
2.3. Prefixes in Data Node Names . . . . . . . . . . . . . . . 6 2.3. Prefixes in Data Node Names . . . . . . . . . . . . . . . 5
3. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . 6 3. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . 6
4. The Design of the Core Routing Data Model . . . . . . . . . . 7 4. The Design of the Core Routing Data Model . . . . . . . . . . 6
4.1. System-Controlled and User-Controlled List Entries . . . 8 4.1. System-Controlled and User-Controlled List Entries . . . 7
5. Basic Building Blocks . . . . . . . . . . . . . . . . . . . . 9 5. Basic Building Blocks . . . . . . . . . . . . . . . . . . . . 8
5.1. Route . . . . . . . . . . . . . . . . . . . . . . . . . . 9 5.1. Route . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.2. Routing Information Base (RIB) . . . . . . . . . . . . . 9 5.2. Routing Information Base (RIB) . . . . . . . . . . . . . 9
5.3. Control-Plane Protocol . . . . . . . . . . . . . . . . . 10 5.3. Control-Plane Protocol . . . . . . . . . . . . . . . . . 10
5.3.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . 10 5.3.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . 10
5.3.2. Defining New Control-Plane Protocols . . . . . . . . 11 5.3.2. Defining New Control-Plane Protocols . . . . . . . . 10
5.4. Parameters of IPv6 Router Advertisements . . . . . . . . 11 5.4. Parameters of IPv6 Router Advertisements . . . . . . . . 11
6. Interactions with Other YANG Modules . . . . . . . . . . . . 13 6. Interactions with Other YANG Modules . . . . . . . . . . . . 12
6.1. Module "ietf-interfaces" . . . . . . . . . . . . . . . . 13 6.1. Module "ietf-interfaces" . . . . . . . . . . . . . . . . 12
6.2. Module "ietf-ip" . . . . . . . . . . . . . . . . . . . . 13 6.2. Module "ietf-ip" . . . . . . . . . . . . . . . . . . . . 13
7. Routing Management YANG Module . . . . . . . . . . . . . . . 14 7. Routing Management YANG Module . . . . . . . . . . . . . . . 13
8. IPv4 Unicast Routing Management YANG Module . . . . . . . . . 24 8. IPv4 Unicast Routing Management YANG Module . . . . . . . . . 28
9. IPv6 Unicast Routing Management YANG Module . . . . . . . . . 29 9. IPv6 Unicast Routing Management YANG Module . . . . . . . . . 36
9.1. IPv6 Router Advertisements Submodule . . . . . . . . . . 34 9.1. IPv6 Router Advertisements Submodule . . . . . . . . . . 44
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 41 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 54
11. Security Considerations . . . . . . . . . . . . . . . . . . . 42 11. Security Considerations . . . . . . . . . . . . . . . . . . . 55
12. References . . . . . . . . . . . . . . . . . . . . . . . . . 43 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 56
12.1. Normative References . . . . . . . . . . . . . . . . . . 43 12.1. Normative References . . . . . . . . . . . . . . . . . . 56
12.2. Informative References . . . . . . . . . . . . . . . . . 44 12.2. Informative References . . . . . . . . . . . . . . . . . 57
Appendix A. Deprecated Models . . . . . . . . . . . . . . . . . 45 Appendix A. The Complete Data Trees . . . . . . . . . . . . . . 58
A.1. Deprecated ietf-routing Model . . . . . . . . . . . . . . 45 Appendix B. Minimum Implementation . . . . . . . . . . . . . . . 61
A.2. Deprecated ietf-ipv4-unicast Model . . . . . . . . . . . 58 Appendix C. Example: Adding a New Control-Plane Protocol . . . . 61
A.3. Deprecated ietf-ipv6-unicast Model . . . . . . . . . . . 64 Appendix D. Data Tree Example . . . . . . . . . . . . . . . . . 64
A.4. Deprecated ietf-ipv6-router-advertisements Model . . . . 69 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 72
Appendix B. The Complete Data Trees . . . . . . . . . . . . . . 80 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 72
Appendix C. Minimum Implementation . . . . . . . . . . . . . . . 83
Appendix D. Example: Adding a New Control-Plane Protocol . . . . 84
Appendix E. Data Tree Example . . . . . . . . . . . . . . . . . 86
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 94
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 94
1. Introduction 1. Introduction
This document contains a specification of the following YANG modules: This document contains a specification of the following YANG modules:
o The "ietf-routing-2" module provides generic components of a o The "ietf-routing" module provides generic components of a routing
routing data model. data model.
o The "ietf-ipv4-unicast-routing-2" module augments the "ietf- o The "ietf-ipv4-unicast-routing" module augments the "ietf-routing"
routing-2" module with additional data specific to IPv4 unicast. module with additional data specific to IPv4 unicast.
o The "ietf-ipv6-unicast-routing-2" module augments the "ietf- o The "ietf-ipv6-unicast-routing" module augments the "ietf-routing"
routing-2" module with additional data specific to IPv6 unicast. module with additional data specific to IPv6 unicast. Its
Its submodule "ietf-ipv6-router-advertisements" also augments the submodule "ietf-ipv6-router-advertisements" also augments the
"ietf-interfaces" [RFC7223] and "ietf-ip" [RFC7277] modules with "ietf-interfaces" [RFC7223] and "ietf-ip" [RFC7277] modules with
IPv6 router configuration variables required by [RFC4861]. IPv6 router configuration variables required by [RFC4861].
These modules together define the so-called core routing data model, These modules together define the so-called core routing data model,
which is intended as a basis for future data model development which is intended as a basis for future data model development
covering more-sophisticated routing systems. While these three covering more-sophisticated routing systems. While these three
modules can be directly used for simple IP devices with static modules can be directly used for simple IP devices with static
routing (see Appendix C), their main purpose is to provide essential routing (see Appendix B), their main purpose is to provide essential
building blocks for more-complicated data models involving multiple building blocks for more-complicated data models involving multiple
control-plane protocols, multicast routing, additional address control-plane protocols, multicast routing, additional address
families, and advanced functions such as route filtering or policy families, and advanced functions such as route filtering or policy
routing. To this end, it is expected that the core routing data routing. To this end, it is expected that the core routing data
model will be augmented by numerous modules developed by various IETF model will be augmented by numerous modules developed by various IETF
working groups. working groups.
This version of these YANG modules uses new names for these YANG This version of these YANG modules uses new names for these YANG
models. The main difference from the first version is that this models. The main difference from the first version is that this
version fully conforms to the Network Management Datastore version fully conforms to the Network Management Datastore
Architecture (NMDA) [I-D.ietf-netmod-revised-datastores]. Architecture (NMDA) [I-D.ietf-netmod-revised-datastores].
Consequently, this document obsoletes RFC 8022 [RFC8022]. Deprecated Consequently, this document obsoletes RFC 8022 [RFC8022].
versions of the prior YANG modules are provided as the Appendix A
NDMA conpliant modules will replace the prior modules.
2. Terminology and Notation 2. Terminology and Notation
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
The following terms are defined in [RFC6241]: The following terms are defined in [RFC6241]:
o client o client
skipping to change at page 5, line 7 skipping to change at page 4, line 42
o module o module
o schema tree o schema tree
o state data o state data
o RPC (Remote Procedure Call) operation o RPC (Remote Procedure Call) operation
2.1. Glossary of New Terms 2.1. Glossary of New Terms
core routing data model: YANG data model comprising "ietf-routing- core routing data model: YANG data model comprising "ietf-routing",
2", "ietf-ipv4-unicast-routing-2", and "ietf-ipv6-unicast-routing- "ietf-ipv4-unicast-routing", and "ietf-ipv6-unicast-routing"
2" modules. modules.
direct route: a route to a directly connected network. direct route: a route to a directly connected network.
Routing Information Base (RIB): An object containing a list of Routing Information Base (RIB): An object containing a list of
routes together with other information. See Section 5.2 for routes together with other information. See Section 5.2 for
details. details.
system-controlled entry: An entry of a list in operational state system-controlled entry: An entry of a list in operational state
("config false") that is created by the systemindependently of ("config false") that is created by the system independently of
what has been explicitly configured. See Section 4.1 for details. what has been explicitly configured. See Section 4.1 for details.
user-controlled entry: An entry of a list in operational state data user-controlled entry: An entry of a list in operational state data
("config false") that is created and deleted as a direct ("config false") that is created and deleted as a direct
consequence of certain configuration changes. See Section 4.1 for consequence of certain configuration changes. See Section 4.1 for
details. details.
2.2. Tree Diagrams 2.2. Tree Diagrams
A simplified graphical representation of the complete data tree is A simplified graphical representation of the complete data tree is
presented in Appendix B, and similar diagrams of its various subtrees presented in Appendix A, and similar diagrams of its various subtrees
appear in the main text. appear in the main text.
o Brackets "[" and "]" enclose list keys. o Brackets "[" and "]" enclose list keys.
o Curly braces "{" and "}" contain names of optional features that o Curly braces "{" and "}" contain names of optional features that
make the corresponding node conditional. make the corresponding node conditional.
o Abbreviations before data node names: "rw" means configuration o Abbreviations before data node names: "rw" means configuration
(read-write), "ro" state data (read-only), "-x" RPC operations or (read-write), "ro" state data (read-only), "-x" RPC operations or
actions, and "-n" notifications. actions, and "-n" notifications.
skipping to change at page 6, line 13 skipping to change at page 6, line 5
shown. shown.
2.3. Prefixes in Data Node Names 2.3. Prefixes in Data Node Names
In this document, names of data nodes, actions, and other data model 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 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, the context in which YANG module each name is defined. Otherwise,
names are prefixed using the standard prefix associated with the names are prefixed using the standard prefix associated with the
corresponding YANG module, as shown in Table 1. corresponding YANG module, as shown in Table 1.
+--------+-----------------------------+-----------+ +--------+---------------------------+-----------+
| Prefix | YANG module | Reference | | Prefix | YANG module | Reference |
+--------+-----------------------------+-----------+ +--------+---------------------------+-----------+
| if | ietf-interfaces | [RFC7223] | | if | ietf-interfaces | [RFC7223] |
| ip | ietf-ip | [RFC7277] | | ip | ietf-ip | [RFC7277] |
| rt | ietf-routing-2 | Section 7 | | rt | ietf-routing | Section 7 |
| v4ur | ietf-ipv4-unicast-routing-2 | Section 8 | | v4ur | ietf-ipv4-unicast-routing | Section 8 |
| v6ur | ietf-ipv6-unicast-routing-2 | Section 9 | | v6ur | ietf-ipv6-unicast-routing | Section 9 |
| yang | ietf-yang-types | [RFC6991] | | yang | ietf-yang-types | [RFC6991] |
| inet | ietf-inet-types | [RFC6991] | | inet | ietf-inet-types | [RFC6991] |
+--------+-----------------------------+-----------+ +--------+---------------------------+-----------+
Table 1: Prefixes and Corresponding YANG Modules Table 1: Prefixes and Corresponding YANG Modules
3. Objectives 3. Objectives
The initial design of the core routing data model was driven by the The initial design of the core routing data model was driven by the
following objectives: following objectives:
o The data model should be suitable for the common address families o The data model should be suitable for the common address families
-- in particular, IPv4 and IPv6 -- and for unicast and multicast -- in particular, IPv4 and IPv6 -- and for unicast and multicast
skipping to change at page 7, line 8 skipping to change at page 6, line 46
o Because device vendors will want to map the data models built on o Because device vendors will want to map the data models built on
this generic framework to their proprietary data models and this generic framework to their proprietary data models and
configuration interfaces, the framework should be flexible enough configuration interfaces, the framework should be flexible enough
to facilitate that and accommodate data models with different to facilitate that and accommodate data models with different
logic. logic.
4. The Design of the Core Routing Data Model 4. The Design of the Core Routing Data Model
The core routing data model consists of three YANG modules and one The core routing data model consists of three YANG modules and one
submodule. The first module, "ietf-routing-2", defines the generic submodule. The first module, "ietf-routing", defines the generic
components of a routing system. The other two modules, "ietf-ipv4- components of a routing system. The other two modules, "ietf-ipv4-
unicast-routing-2" and "ietf-ipv6-unicast-routing-2", augment the unicast-routing" and "ietf-ipv6-unicast-routing", augment the "ietf-
"ietf-routing-2" module with additional data nodes that are needed routing" module with additional data nodes that are needed for IPv4
for IPv4 and IPv6 unicast routing, respectively. The "ietf-ipv6- and IPv6 unicast routing, respectively. The "ietf-ipv6-unicast-
unicast-routing-2" module has a submodule, "ietf-ipv6-router- routing" module has a submodule, "ietf-ipv6-router-advertisements",
advertisements", that augments the "ietf-interfaces" [RFC7223] and that augments the "ietf-interfaces" [RFC7223] and "ietf-ip" [RFC7277]
"ietf-ip" [RFC7277] modules with configuration variables for IPv6 modules with configuration variables for IPv6 router advertisements
router advertisements as required by [RFC4861]. as required by [RFC4861].
Figures 1 shows abridged views of the hierarchies. See Appendix B Figure 1 shows abridged views of the hierarchies. See Appendix A
for the complete data trees. for the complete data trees.
+--rw routing +--rw routing
+--rw router-id? yang:dotted-quad +--rw router-id? yang:dotted-quad
+--ro interfaces +--ro interfaces
| +--ro interface* if:interface-ref | +--ro interface* if:interface-ref
+--rw control-plane-protocols +--rw control-plane-protocols
| +--rw control-plane-protocol* [type name] | +--rw control-plane-protocol* [type name]
| +--rw type identityref | +--rw type identityref
| +--rw name string | +--rw name string
skipping to change at page 8, line 22 skipping to change at page 8, line 12
The core routing data model defines several lists in the schema tree, The core routing data model defines several lists in the schema tree,
such as "rib", that have to be populated with at least one entry in such as "rib", that have to be populated with at least one entry in
any properly functioning device, and additional entries may be any properly functioning device, and additional entries may be
configured by a client. configured by a client.
In such a list, the server creates the required item as a so-called In such a list, the server creates the required item as a so-called
system-controlled entry in state data in the operational datastore system-controlled entry in state data in the operational datastore
[I-D.ietf-netmod-revised-datastores], i.e., inside read-only lists in [I-D.ietf-netmod-revised-datastores], i.e., inside read-only lists in
the "routing" container. the "routing" container.
An example can be seen in Appendix E: the "/routing/ribs/rib" list An example can be seen in Appendix D: the "/routing/ribs/rib" list
has two system-controlled entries named "ipv4-master" and has two system-controlled entries named "ipv4-master" and
"ipv6-master". "ipv6-master".
Additional entries may be created in the configuration by a client, Additional entries may be created in the configuration by a client,
e.g., via the NETCONF protocol. These are so-called user-controlled e.g., via the NETCONF protocol. These are so-called user-controlled
entries. If the server accepts a configured user-controlled entry, entries. If the server accepts a configured user-controlled entry,
then this entry also appears in the state data version of the list. then this entry also appears in the state data version of the list.
Corresponding entries in both versions of the list (in operational Corresponding entries in both versions of the list (in operational
datastore and intended datastore [I-D.ietf-netmod-revised-datastores] datastore and intended datastore [I-D.ietf-netmod-revised-datastores]
skipping to change at page 11, line 42 skipping to change at page 11, line 26
conditional and valid only if the value of "rt:type" or conditional and valid only if the value of "rt:type" or
"rt:source-protocol" is equal to (or derived from) the new protocol's "rt:source-protocol" is equal to (or derived from) the new protocol's
identity. identity.
It is also RECOMMENDED that protocol-specific data nodes be It is also RECOMMENDED that protocol-specific data nodes be
encapsulated in an appropriately named container with presence. Such encapsulated in an appropriately named container with presence. Such
a container may contain mandatory data nodes that are otherwise a container may contain mandatory data nodes that are otherwise
forbidden at the top level of an augment. forbidden at the top level of an augment.
The above steps are implemented by the example YANG module for the The above steps are implemented by the example YANG module for the
Routing Information Protocol (RIP) in Appendix D. Routing Information Protocol (RIP) in Appendix C.
5.4. Parameters of IPv6 Router Advertisements 5.4. Parameters of IPv6 Router Advertisements
YANG module "ietf-ipv6-router-advertisements" (Section 9.1), which is YANG module "ietf-ipv6-router-advertisements" (Section 9.1), which is
a submodule of the "ietf-ipv6-unicast-routing-2" module, augments the a submodule of the "ietf-ipv6-unicast-routing" module, augments the
configuration and state data of IPv6 interfaces with definitions of configuration and state data of IPv6 interfaces with definitions of
the following variables as required by Section 6.2.1 of [RFC4861]: the following variables as required by Section 6.2.1 of [RFC4861]:
o send-advertisements o send-advertisements
o max-rtr-adv-interval o max-rtr-adv-interval
o min-rtr-adv-interval o min-rtr-adv-interval
o managed-flag o managed-flag
o other-config-flag o other-config-flag
o link-mtu o link-mtu
skipping to change at page 14, line 15 skipping to change at page 13, line 46
In addition, the "ietf-ip" module allows for configuring IPv4 and In addition, the "ietf-ip" module allows for configuring IPv4 and
IPv6 addresses and network prefixes or masks on network-layer IPv6 addresses and network prefixes or masks on network-layer
interfaces. Configuration of these parameters on an enabled interfaces. Configuration of these parameters on an enabled
interface MUST result in an immediate creation of the corresponding interface MUST result in an immediate creation of the corresponding
direct route. The destination prefix of this route is set according direct route. The destination prefix of this route is set according
to the configured IP address and network prefix/mask, and the to the configured IP address and network prefix/mask, and the
interface is set as the outgoing interface for that route. interface is set as the outgoing interface for that route.
7. Routing Management YANG Module 7. Routing Management YANG Module
<CODE BEGINS> file "ietf-routing-2@2017-10-06.yang" <CODE BEGINS> file "ietf-routing@2017-10-30.yang"
module ietf-routing-2 { module ietf-routing {
yang-version "1.1"; yang-version "1.1";
namespace "urn:ietf:params:xml:ns:yang:ietf-routing-2"; namespace "urn:ietf:params:xml:ns:yang:ietf-routing";
prefix "rt"; prefix "rt";
import ietf-yang-types { import ietf-yang-types {
prefix "yang"; prefix "yang";
} }
import ietf-interfaces { import ietf-interfaces {
prefix "if"; prefix "if";
} }
skipping to change at page 15, line 11 skipping to change at page 14, line 42
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
reference "RFC XXXX"; reference "RFC XXXX";
revision 2017-10-06 { revision 2017-10-30 {
description description
"Network Managment Datastore Architecture (NDMA) "Network Managment Datastore Architecture (NDMA) Revision";
Initial Revision
Replaces ietf-routing.yang";
reference reference
"RFC XXXX: A YANG Data Model for Routing Management "RFC XXXX: A YANG Data Model for Routing Management
(NDMA Version)"; (NDMA Version)";
} }
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
/* Features */ /* Features */
feature multiple-ribs { feature multiple-ribs {
description description
"This feature indicates that the server supports user-defined "This feature indicates that the server supports user-defined
RIBs. RIBs.
Servers that do not advertise this feature SHOULD provide Servers that do not advertise this feature SHOULD provide
exactly one system-controlled RIB per supported address family exactly one system-controlled RIB per supported address family
and make it also the default RIB. This RIB then appears as an and make it also the default RIB. This RIB then appears as an
entry of the list /routing/ribs/rib."; entry of the list /routing/ribs/rib.";
skipping to change at page 24, line 36 skipping to change at page 24, line 25
} }
} }
leaf description { leaf description {
type string; type string;
description description
"Textual description of the RIB."; "Textual description of the RIB.";
} }
} }
} }
} }
/* Obsolete State Data */
container routing-state {
config false;
status obsolete;
description
"State data of the routing subsystem.";
uses router-id {
status obsolete;
description
"Global router ID.
It may be either configured or assigned algorithmically by
the implementation.";
}
container interfaces {
status obsolete;
description
"Network-layer interfaces used for routing.";
leaf-list interface {
type if:interface-state-ref;
status obsolete;
description
"Each entry is a reference to the name of a configured
network-layer interface.";
}
}
container control-plane-protocols {
status obsolete;
description
"Container for the list of routing protocol instances.";
list control-plane-protocol {
key "type name";
status obsolete;
description
"State data of a control-plane protocol instance.
An implementation MUST provide exactly one
system-controlled instance of the 'direct'
pseudo-protocol. Instances of other control-plane
protocols MAY be created by configuration.";
leaf type {
type identityref {
base control-plane-protocol;
}
status obsolete;
description
"Type of the control-plane protocol.";
}
leaf name {
type string;
status obsolete;
description
"The name of the control-plane protocol instance.
For system-controlled instances this name is
persistent, i.e., it SHOULD NOT change across
reboots.";
}
}
}
container ribs {
status obsolete;
description
"Container for RIBs.";
list rib {
key "name";
min-elements 1;
status obsolete;
description
"Each entry represents a RIB identified by the 'name'
key. All routes in a RIB MUST belong to the same address
family.
An implementation SHOULD provide one system-controlled
default RIB for each supported address family.";
leaf name {
type string;
status obsolete;
description
"The name of the RIB.";
}
uses address-family {
status obsolete;
description
"The address family of the RIB.";
}
leaf default-rib {
if-feature "multiple-ribs";
type boolean;
default "true";
status obsolete;
description
"This flag has the value of 'true' if and only if the
RIB is the default RIB for the given address family.
By default, control-plane protocols place their routes
in the default RIBs.";
}
container routes {
status obsolete;
description
"Current content of the RIB.";
list route {
status obsolete;
description
"A RIB route entry. This data node MUST be augmented
with information specific for routes of each address
family.";
leaf route-preference {
type route-preference;
status obsolete;
description
"This route attribute, also known as administrative
distance, allows for selecting the preferred route
among routes with the same destination prefix. A
smaller value means a more preferred route.";
}
container next-hop {
status obsolete;
description
"Route's next-hop attribute.";
uses next-hop-state-content {
status obsolete;
description
"Route's next-hop attribute operational state.";
}
}
uses route-metadata {
status obsolete;
description
"Route metadata.";
}
}
}
action active-route {
status obsolete;
description
"Return the active RIB route that is used for the
destination address.
Address-family-specific modules MUST augment input
parameters with a leaf named 'destination-address'.";
output {
container route {
status obsolete;
description
"The active RIB route for the specified
destination.
If no route exists in the RIB for the destination
address, no output is returned.
Address-family-specific modules MUST augment this
container with appropriate route contents.";
container next-hop {
status obsolete;
description
"Route's next-hop attribute.";
uses next-hop-state-content {
status obsolete;
description
"Active route state data.";
}
}
uses route-metadata {
status obsolete;
description
"Active route metadata.";
}
}
}
}
}
}
}
} }
<CODE ENDS> <CODE ENDS>
8. IPv4 Unicast Routing Management YANG Module 8. IPv4 Unicast Routing Management YANG Module
<CODE BEGINS> file "ietf-ipv4-unicast-routing-2@2017-10-06.yang" <CODE BEGINS> file "ietf-ipv4-unicast-routing@2017-10-14.yang"
module ietf-ipv4-unicast-routing-2 { module ietf-ipv4-unicast-routing {
yang-version "1.1"; yang-version "1.1";
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing-2"; "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing";
prefix "v4ur"; prefix "v4ur";
import ietf-routing-2 { import ietf-routing {
prefix "rt"; prefix "rt";
} }
import ietf-inet-types { import ietf-inet-types {
prefix "inet"; prefix "inet";
} }
organization organization
"IETF NETMOD - Networking Modeling Working Group"; "IETF NETMOD - Networking Modeling Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netmod/> "WG Web: <http://tools.ietf.org/wg/netmod/>
WG List: <mailto:rtgwg@ietf.org> WG List: <mailto:rtgwg@ietf.org>
Editor: Ladislav Lhotka Editor: Ladislav Lhotka
skipping to change at page 25, line 21 skipping to change at page 28, line 44
WG List: <mailto:rtgwg@ietf.org> WG List: <mailto:rtgwg@ietf.org>
Editor: Ladislav Lhotka Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz> <mailto:lhotka@nic.cz>
Acee Lindem Acee Lindem
<mailto:acee@cisco.com> <mailto:acee@cisco.com>
Yingzhen Qu Yingzhen Qu
<mailto:yingzhen.qu@huawei.com>"; <mailto:yingzhen.qu@huawei.com>";
description description
"This YANG module augments the 'ietf-routing-2' module with basic "This YANG module augments the 'ietf-routing' module with basic
configuration and state data for IPv4 unicast routing. configuration and state data for IPv4 unicast routing.
Copyright (c) 2017 IETF Trust and the persons Copyright (c) 2017 IETF Trust and the persons
identified as authors of the code. All rights reserved. identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
reference "RFC XXXX"; reference "RFC XXXX";
revision 2017-10-06 { revision 2017-10-14 {
description description
"Network Managment Datastore Architecture (NDMA) "Network Managment Datastore Architecture (NDMA) Revision";
Initial Revision
Replaces ietf-ipv4-unicast-routing.yang";
reference reference
"RFC XXXX: A YANG Data Model for Routing Management "RFC XXXX: A YANG Data Model for Routing Management
(NDMA Version)"; (NDMA Version)";
} }
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
/* Identities */ /* Identities */
identity ipv4-unicast { identity ipv4-unicast {
base rt:ipv4; base rt:ipv4;
description description
"This identity represents the IPv4 unicast address family."; "This identity represents the IPv4 unicast address family.";
} }
augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" { augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" {
when "derived-from-or-self(../../rt:address-family, " when "derived-from-or-self(../../rt:address-family, "
skipping to change at page 29, line 37 skipping to change at page 33, line 16
type inet:ipv4-address; type inet:ipv4-address;
description description
"IPv4 address of the next hop."; "IPv4 address of the next hop.";
} }
} }
} }
} }
} }
} }
} }
/* Obsolete State Data */
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route" {
when "derived-from-or-self(../../rt:address-family, "
+ "'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status obsolete;
description
"This leaf augments an IPv4 unicast route.";
leaf destination-prefix {
type inet:ipv4-prefix;
status obsolete;
description
"IPv4 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/"
+ "rt:next-hop/rt:next-hop-options/rt:simple-next-hop" {
when "derived-from-or-self(
../../../rt:address-family, 'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status obsolete;
description
"Augment 'simple-next-hop' case in IPv4 unicast routes.";
leaf next-hop-address {
type inet:ipv4-address;
status obsolete;
description
"IPv4 address of the next hop.";
}
}
augment "/rt:routing-state/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" {
when "derived-from-or-self(../../../../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status obsolete;
description
"This leaf augments the 'next-hop-list' case of IPv4 unicast
routes.";
leaf address {
type inet:ipv4-address;
status obsolete;
description
"IPv4 address of the next-hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:input" {
when "derived-from-or-self(../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast RIBs.";
}
status obsolete;
description
"This augment adds the input parameter of the 'active-route'
action.";
leaf destination-address {
type inet:ipv4-address;
status obsolete;
description
"IPv4 destination address.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route" {
when "derived-from-or-self(../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status obsolete;
description
"This augment adds the destination prefix to the reply of the
'active-route' action.";
leaf destination-prefix {
type inet:ipv4-prefix;
status obsolete;
description
"IPv4 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:simple-next-hop" {
when "derived-from-or-self(../../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status obsolete;
description
"Augment 'simple-next-hop' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv4-address;
status obsolete;
description
"IPv4 address of the next hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:next-hop-list/rt:next-hop-list/rt:next-hop" {
when "derived-from-or-self(../../../../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status obsolete;
description
"Augment 'next-hop-list' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv4-address;
status obsolete;
description
"IPv4 address of the next hop.";
}
}
} }
<CODE ENDS> <CODE ENDS>
9. IPv6 Unicast Routing Management YANG Module 9. IPv6 Unicast Routing Management YANG Module
<CODE BEGINS> file "ietf-ipv6-unicast-routing-2@2017-10-06.yang" <CODE BEGINS> file "ietf-ipv6-unicast-routing@2017-10-14.yang"
module ietf-ipv6-unicast-routing-2 { module ietf-ipv6-unicast-routing {
yang-version "1.1"; yang-version "1.1";
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing-2"; "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing";
prefix "v6ur"; prefix "v6ur";
import ietf-routing-2 { import ietf-routing {
prefix "rt"; prefix "rt";
} }
import ietf-inet-types { import ietf-inet-types {
prefix "inet"; prefix "inet";
} }
include ietf-ipv6-router-advertisements-2 { include ietf-ipv6-router-advertisements {
revision-date 2017-10-06; revision-date 2017-10-14;
} }
organization organization
"IETF NETMOD - Networking Modeling Working Group"; "IETF NETMOD - Networking Modeling Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netmod/> "WG Web: <http://tools.ietf.org/wg/netmod/>
WG List: <mailto:rtgwg@ietf.org> WG List: <mailto:rtgwg@ietf.org>
Editor: Ladislav Lhotka Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz> <mailto:lhotka@nic.cz>
skipping to change at page 30, line 38 skipping to change at page 37, line 4
Copyright (c) 2017 IETF Trust and the persons Copyright (c) 2017 IETF Trust and the persons
identified as authors of the code. All rights reserved. identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
reference "RFC XXXX"; reference "RFC XXXX";
revision 2017-10-06 { revision 2017-10-14 {
description description
"Network Managment Datastore Architecture (NDMA) "Network Managment Datastore Architecture (NDMA) revision";
Initial revision
Replaces ietf-ipv6-unicast-routing.yang";
reference reference
"RFC XXXX: A YANG Data Model for Routing Management "RFC XXXX: A YANG Data Model for Routing Management
(NDMA Version)"; (NDMA Version)";
} }
/* Identities */ /* Identities */
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
identity ipv6-unicast { identity ipv6-unicast {
base rt:ipv6; base rt:ipv6;
description description
"This identity represents the IPv6 unicast address family."; "This identity represents the IPv6 unicast address family.";
} }
augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" { augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" {
when "derived-from-or-self(../../rt:address-family, " when "derived-from-or-self(../../rt:address-family, "
+ "'v6ur:ipv6-unicast')" { + "'v6ur:ipv6-unicast')" {
description description
skipping to change at page 34, line 43 skipping to change at page 41, line 14
type inet:ipv6-address; type inet:ipv6-address;
description description
"IPv6 address of the next hop."; "IPv6 address of the next hop.";
} }
} }
} }
} }
} }
} }
} }
/* Obsolete State Data */
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route" {
when "derived-from-or-self(../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status obsolete;
description
"This leaf augments an IPv6 unicast route.";
leaf destination-prefix {
type inet:ipv6-prefix;
status obsolete;
description
"IPv6 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/"
+ "rt:next-hop/rt:next-hop-options/rt:simple-next-hop" {
when "derived-from-or-self(../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status obsolete;
description
"Augment 'simple-next-hop' case in IPv6 unicast routes.";
leaf next-hop-address {
type inet:ipv6-address;
status obsolete;
description
"IPv6 address of the next hop.";
}
}
augment "/rt:routing-state/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" {
when "derived-from-or-self(../../../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status obsolete;
description
"This leaf augments the 'next-hop-list' case of IPv6 unicast
routes.";
leaf address {
type inet:ipv6-address;
status obsolete;
description
"IPv6 address of the next hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/"
+ "rt:active-route/rt:input" {
when "derived-from-or-self(../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast RIBs.";
}
status obsolete;
description
"This augment adds the input parameter of the 'active-route'
action.";
leaf destination-address {
type inet:ipv6-address;
status obsolete;
description
"IPv6 destination address.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route" {
when "derived-from-or-self(../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status obsolete;
description
"This augment adds the destination prefix to the reply of the
'active-route' action.";
leaf destination-prefix {
type inet:ipv6-prefix;
status obsolete;
description
"IPv6 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:simple-next-hop" {
when "derived-from-or-self(../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status obsolete;
description
"Augment 'simple-next-hop' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv6-address;
status obsolete;
description
"IPv6 address of the next hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:next-hop-list/rt:next-hop-list/rt:next-hop" {
when "derived-from-or-self(../../../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status obsolete;
description
"Augment 'next-hop-list' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv6-address;
status obsolete;
description
"IPv6 address of the next hop.";
}
}
} }
<CODE ENDS> <CODE ENDS>
9.1. IPv6 Router Advertisements Submodule 9.1. IPv6 Router Advertisements Submodule
<CODE BEGINS> <CODE BEGINS> file "ietf-ipv6-router-advertisements@2017-10-14.yang"
file "ietf-ipv6-router-advertisements-2@2017-10-06.yang" submodule ietf-ipv6-router-advertisements {
submodule ietf-ipv6-router-advertisements-2 {
yang-version "1.1"; yang-version "1.1";
belongs-to ietf-ipv6-unicast-routing-2 {
belongs-to ietf-ipv6-unicast-routing {
prefix "v6ur"; prefix "v6ur";
} }
import ietf-inet-types { import ietf-inet-types {
prefix "inet"; prefix "inet";
} }
import ietf-interfaces { import ietf-interfaces {
prefix "if"; prefix "if";
} }
skipping to change at page 36, line 18 skipping to change at page 45, line 24
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as 'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119. described in RFC 2119.
This version of this YANG module is part of RFC 8022; This version of this YANG module is part of RFC 8022;
see the RFC itself for full legal notices."; see the RFC itself for full legal notices.";
reference reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6)."; "RFC 4861: Neighbor Discovery for IP version 6 (IPv6).";
revision 2017-10-05 { revision 2017-10-14 {
description description
"Network Managment Datastore Architecture (NDMA) "Network Managment Datastore Architecture (NDMA) Revision";
Initial Revision
Replaces ietf-ipv6-router-advertisements.yang";
reference reference
"RFC XXXX: A YANG Data Model for Routing Management "RFC XXXX: A YANG Data Model for Routing Management
(NDMA Version)"; (NDMA Version)";
} }
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
augment "/if:interfaces/if:interface/ip:ipv6" { augment "/if:interfaces/if:interface/ip:ipv6" {
description description
"Augment interface configuration with parameters of IPv6 "Augment interface configuration with parameters of IPv6
router advertisements."; router advertisements.";
container ipv6-router-advertisements { container ipv6-router-advertisements {
description description
"Configuration of IPv6 Router Advertisements."; "Configuration of IPv6 Router Advertisements.";
leaf send-advertisements { leaf send-advertisements {
type boolean; type boolean;
default "false"; default "false";
skipping to change at page 41, line 37 skipping to change at page 50, line 48
reference reference
"RFC 4861: Neighbor Discovery for IP version 6 "RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvAutonomousFlag."; (IPv6) - AdvAutonomousFlag.";
} }
} }
} }
} }
} }
} }
} }
}
<CODE ENDS>
10. IANA Considerations
This document registers the following namespace URIs in the "IETF XML
Registry" [RFC3688]:
URI: urn:ietf:params:xml:ns:yang:ietf-routing-2
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing-2
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing-2
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
This document registers the following YANG modules in the "YANG
Module Names" registry [RFC6020]:
Name: ietf-routing-2
Namespace: urn:ietf:params:xml:ns:yang:ietf-routing-2
Prefix: rt
Reference: RFC 8022
Name: ietf-ipv4-unicast-routing-2
Namespace: urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing-2
Prefix: v4ur
Reference: RFC 8022
Name: ietf-ipv6-unicast-routing-2
Namespace: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing-2
Prefix: v6ur
Reference: RFC 8022
This document registers the following YANG submodule in the "YANG
Module Names" registry [RFC6020]:
Name: ietf-ipv6-router-advertisements-2
Module: ietf-ipv6-unicast-routing-2
Reference: RFC 8022
11. Security Considerations
The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the
secure transport layer and the mandatory-to-implement secure
transport is SSH [RFC6242].
There are a number of data nodes defined in this YANG module which
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. These are the subtrees and data nodes
and their sensitivity/vulnerability:
/routing/control-plane-protocols/control-plane-protocol: This list
specifies the control-plane protocols configured on a device.
/routing/ribs/rib: This list specifies the RIBs configured for the
device.
Some of the readable data nodes in this 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. These are the subtrees and data
nodes and their sensitivity/vulnerability:
/routing/control-plane-protocols/control-plane-protocol: This list
specifies the control-plane protocols configured on a device.
Refer to the control plane models for a list of sensitive
information.
/routing/ribs/rib: This list specifies the RIB and their contents
for the device. Access to this information may disclose the
network topology and or other information.
12. References
12.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>.
[RFC4861] Narten, T., Nordmark, E., Simpson, W., and H. Soliman,
"Neighbor Discovery for IP version 6 (IPv6)", RFC 4861,
DOI 10.17487/RFC4861, September 2007, <https://www.rfc-
editor.org/info/rfc4861>.
[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>.
[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>.
[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>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 7223, DOI 10.17487/RFC7223, May 2014,
<https://www.rfc-editor.org/info/rfc7223>.
[RFC7277] Bjorklund, M., "A YANG Data Model for IP Management",
RFC 7277, DOI 10.17487/RFC7277, June 2014,
<https://www.rfc-editor.org/info/rfc7277>.
[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>.
[RFC8022] Lhotka, L. and A. Lindem, "A YANG Data Model for Routing
Management", RFC 8022, DOI 10.17487/RFC8022, November
2016, <https://www.rfc-editor.org/info/rfc8022>.
12.2. Informative References
[RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG
Data Model Documents", RFC 6087, DOI 10.17487/RFC6087,
January 2011, <https://www.rfc-editor.org/info/rfc6087>.
[RFC7895] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Module
Library", RFC 7895, DOI 10.17487/RFC7895, June 2016,
<https://www.rfc-editor.org/info/rfc7895>.
[RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG",
RFC 7951, DOI 10.17487/RFC7951, August 2016,
<https://www.rfc-editor.org/info/rfc7951>.
[I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-04
(work in progress), August 2017.
Appendix A. Deprecated Models
This appendix contains the deprecated versions of ietf-routing, ietf-
ipv4-unicast-routing, ietf-ipv6-unicast-routing, and ietf-ipv6-
router-advertisements.
A.1. Deprecated ietf-routing Model
<CODE BEGINS> file "ietf-routing@2017-10-06.yang"
module ietf-routing {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-routing";
prefix rt;
import ietf-yang-types {
prefix yang;
}
import ietf-interfaces {
prefix if;
}
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org>
WG Chair: Lou Berger
<mailto:lberger@labn.net>
WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net>
Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz>
Editor: Acee Lindem
<mailto:acee@cisco.com>";
description
"This YANG module defines essential components for the
management of a routing subsystem.
Copyright (c) 2016 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).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119.
This version of this YANG module is part of RFC TBD;
see the RFC itself for full legal notices.";
revision 2017-10-06 {
description
"Deprecated revision.";
reference "RFC TBD: Revised YANG Data Model for Routing
Management";
}
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
feature multiple-ribs {
status deprecated;
description
"This feature indicates that the server supports user-defined
RIBs.
Servers that do not advertise this feature SHOULD provide
exactly one system-controlled RIB per supported address
family and make it also the default RIB. This RIB then
appears as an entry of the list /routing-state/ribs/rib.";
}
feature router-id {
status deprecated;
description
"This feature indicates that the server supports
configuration of an explicit 32-bit router ID that is used
by some routing protocols.
Servers that do not advertise this feature set a router ID
algorithmically, usually to one of the configured IPv4
addresses. However, this algorithm is implementation
specific.";
}
identity address-family {
status deprecated;
description
"Base identity from which identities describing address
families are derived.";
}
identity ipv4 {
base address-family;
status deprecated;
description
"This identity represents IPv4 address family.";
}
identity ipv6 {
base address-family;
status deprecated;
description
"This identity represents IPv6 address family.";
}
identity control-plane-protocol {
status deprecated;
description
"Base identity from which control-plane protocol identities
are derived.";
}
identity routing-protocol {
base control-plane-protocol;
status deprecated;
description
"Identity from which Layer 3 routing protocol identities are
derived.";
}
identity direct {
base routing-protocol;
status deprecated;
description
"Routing pseudo-protocol that provides routes to directly
connected networks.";
}
identity static {
base routing-protocol;
status deprecated;
description
"Static routing pseudo-protocol.";
}
typedef route-preference {
type uint32;
status deprecated;
description
"This type is used for route preferences.";
}
grouping address-family {
status deprecated;
description
"This grouping provides a leaf identifying an address
family.";
leaf address-family {
type identityref {
base address-family;
}
mandatory true;
status deprecated;
description
"Address family.";
}
}
grouping router-id {
status deprecated;
description
"This grouping provides router ID.";
leaf router-id {
type yang:dotted-quad;
status deprecated;
description
"A 32-bit number in the form of a dotted quad that is used
by some routing protocols identifying a router.";
reference "RFC 2328: OSPF Version 2.";
}
}
grouping special-next-hop {
status deprecated;
description
"This grouping provides a leaf with an enumeration of special
next hops.";
leaf special-next-hop {
type enumeration {
enum "blackhole" {
status deprecated;
description
"Silently discard the packet.";
}
enum "unreachable" {
status deprecated;
description
"Discard the packet and notify the sender with an error
message indicating that the destination host is
unreachable.";
}
enum "prohibit" {
status deprecated;
description
"Discard the packet and notify the sender with an error
message indicating that the communication is
administratively prohibited.";
}
enum "receive" {
status deprecated;
description
"The packet will be received by the local system.";
}
}
status deprecated;
description
"Options for special next hops.";
}
}
grouping next-hop-content {
status deprecated;
description
"Generic parameters of next hops in static routes.";
choice next-hop-options {
mandatory true;
status deprecated;
description
"Options for next hops in static routes.
It is expected that further cases will be added through
augments from other modules.";
case simple-next-hop {
status deprecated;
description
"This case represents a simple next hop consisting of the
next-hop address and/or outgoing interface.
Modules for address families MUST augment this case with
a leaf containing a next-hop address of that address
family.";
leaf outgoing-interface {
type if:interface-ref;
status deprecated;
description
"Name of the outgoing interface.";
}
}
case special-next-hop {
status deprecated;
uses special-next-hop;
}
case next-hop-list {
status deprecated;
container next-hop-list {
status deprecated;
description
"Container for multiple next-hops.";
list next-hop {
key "index";
status deprecated;
description
"An entry of a next-hop list.
Modules for address families MUST augment this list
with a leaf containing a next-hop address of that
address family.";
leaf index {
type string;
status deprecated;
description
"A user-specified identifier utilized to uniquely
reference the next-hop entry in the next-hop list.
The value of this index has no semantic meaning
other than for referencing the entry.";
}
leaf outgoing-interface {
type if:interface-ref;
status deprecated;
description
"Name of the outgoing interface.";
}
}
}
}
}
}
grouping next-hop-state-content {
status deprecated;
description
"Generic parameters of next hops in state data.";
choice next-hop-options {
mandatory true;
status deprecated;
description
"Options for next hops in state data.
It is expected that further cases will be added through
augments from other modules, e.g., for recursive
next hops.";
case simple-next-hop {
status deprecated;
description
"This case represents a simple next hop consisting of the
next-hop address and/or outgoing interface.
Modules for address families MUST augment this case with
a leaf containing a next-hop address of that address
family.";
leaf outgoing-interface {
type if:interface-state-ref;
status deprecated;
description
"Name of the outgoing interface.";
}
}
case special-next-hop {
status deprecated;
uses special-next-hop;
}
case next-hop-list {
status deprecated;
container next-hop-list {
status deprecated;
description
"Container for multiple next hops.";
list next-hop {
status deprecated;
description
"An entry of a next-hop list.
Modules for address families MUST augment this list
with a leaf containing a next-hop address of that
address family.";
leaf outgoing-interface {
type if:interface-state-ref;
status deprecated;
description
"Name of the outgoing interface.";
}
}
}
}
}
}
grouping route-metadata {
status deprecated;
description
"Common route metadata.";
leaf source-protocol {
type identityref {
base routing-protocol;
}
mandatory true;
status deprecated;
description
"Type of the routing protocol from which the route
originated.";
}
leaf active {
type empty;
status deprecated;
description
"Presence of this leaf indicates that the route is
preferred among all routes in the same RIB that have the
same destination prefix.";
}
leaf last-updated {
type yang:date-and-time;
status deprecated;
description
"Time stamp of the last modification of the route. If the
route was never modified, it is the time when the route
was inserted into the RIB.";
}
}
container routing-state {
config false;
status deprecated;
description
"State data of the routing subsystem.";
uses router-id {
status deprecated;
description
"Global router ID.
It may be either configured or assigned algorithmically by
the implementation.";
}
container interfaces {
status deprecated;
description
"Network-layer interfaces used for routing.";
leaf-list interface {
type if:interface-state-ref;
status deprecated;
description
"Each entry is a reference to the name of a configured
network-layer interface.";
}
}
container control-plane-protocols {
status deprecated;
description
"Container for the list of routing protocol instances.";
list control-plane-protocol {
key "type name";
status deprecated;
description
"State data of a control-plane protocol instance.
An implementation MUST provide exactly one
system-controlled instance of the 'direct'
pseudo-protocol. Instances of other control-plane
protocols MAY be created by configuration.";
leaf type {
type identityref {
base control-plane-protocol;
}
status deprecated;
description
"Type of the control-plane protocol.";
}
leaf name {
type string;
status deprecated;
description
"The name of the control-plane protocol instance.
For system-controlled instances this name is
persistent, i.e., it SHOULD NOT change across
reboots.";
}
}
}
container ribs {
status deprecated;
description
"Container for RIBs.";
list rib {
key "name";
min-elements 1;
status deprecated;
description
"Each entry represents a RIB identified by the 'name'
key. All routes in a RIB MUST belong to the same address
family.
An implementation SHOULD provide one system-controlled
default RIB for each supported address family.";
leaf name {
type string;
status deprecated;
description
"The name of the RIB.";
}
uses address-family;
leaf default-rib {
if-feature "multiple-ribs";
type boolean;
default "true";
status deprecated;
description
"This flag has the value of 'true' if and only if the
RIB is the default RIB for the given address family.
By default, control-plane protocols place their routes
in the default RIBs.";
}
container routes {
status deprecated;
description
"Current content of the RIB.";
list route {
status deprecated;
description
"A RIB route entry. This data node MUST be augmented
with information specific for routes of each address
family.";
leaf route-preference {
type route-preference;
status deprecated;
description
"This route attribute, also known as administrative
distance, allows for selecting the preferred route
among routes with the same destination prefix. A
smaller value means a more preferred route.";
}
container next-hop {
status deprecated;
description
"Route's next-hop attribute.";
uses next-hop-state-content;
}
uses route-metadata;
}
}
action active-route {
status deprecated;
description
"Return the active RIB route that is used for the
destination address.
Address-family-specific modules MUST augment input
parameters with a leaf named 'destination-address'.";
output {
container route {
status deprecated;
description
"The active RIB route for the specified
destination.
If no route exists in the RIB for the destination
address, no output is returned.
Address-family-specific modules MUST augment this
container with appropriate route contents.";
container next-hop {
status deprecated;
description
"Route's next-hop attribute.";
uses next-hop-state-content;
}
uses route-metadata;
}
}
}
}
}
}
container routing {
status deprecated;
description
"Configuration parameters for the routing subsystem.";
uses router-id {
if-feature "router-id";
status deprecated;
description
"Configuration of the global router ID. Routing protocols
that use router ID can use this parameter or override it
with another value.";
}
container control-plane-protocols {
status deprecated;
description
"Configuration of control-plane protocol instances.";
list control-plane-protocol {
key "type name";
status deprecated;
description
"Each entry contains configuration of a control-plane
protocol instance.";
leaf type {
type identityref {
base control-plane-protocol;
}
status deprecated;
description
"Type of the control-plane protocol - an identity
derived from the 'control-plane-protocol' base
identity.";
}
leaf name {
type string;
status deprecated;
description
"An arbitrary name of the control-plane protocol
instance.";
}
leaf description {
type string;
status deprecated;
description
"Textual description of the control-plane protocol
instance.";
}
container static-routes {
when "derived-from-or-self(../type, 'rt:static')" {
description
"This container is only valid for the 'static'
routing protocol.";
}
status deprecated;
description
"Configuration of the 'static' pseudo-protocol.
Address-family-specific modules augment this node with
their lists of routes.";
}
}
}
container ribs {
status deprecated;
description
"Configuration of RIBs.";
list rib {
key "name";
status deprecated;
description
"Each entry contains configuration for a RIB identified
by the 'name' key.
Entries having the same key as a system-controlled entry
of the list /routing-state/ribs/rib are used for
configuring parameters of that entry. Other entries
define additional user-controlled RIBs.";
leaf name {
type string;
status deprecated;
description
"The name of the RIB.
For system-controlled entries, the value of this leaf
must be the same as the name of the corresponding
entry in state data.
For user-controlled entries, an arbitrary name can be
used.";
}
uses address-family {
status deprecated;
description
"Address family of the RIB.
It is mandatory for user-controlled RIBs. For
system-controlled RIBs it can be omitted; otherwise,
it must match the address family of the corresponding
state entry.";
refine "address-family" {
mandatory false;
}
}
leaf description {
type string;
status deprecated;
description
"Textual description of the RIB.";
}
}
}
}
}
<CODE ENDS>
A.2. Deprecated ietf-ipv4-unicast Model
<CODE BEGINS> file "ietf-ipv4-unicast-routing@2017-10-06.yang"
module ietf-ipv4-unicast-routing {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing";
prefix v4ur;
import ietf-routing {
prefix rt;
}
import ietf-inet-types {
prefix inet;
}
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org>
WG Chair: Lou Berger
<mailto:lberger@labn.net>
WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net>
Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz>
Editor: Acee Lindem
<mailto:acee@cisco.com>";
description
"This YANG module augments the 'ietf-routing' module with basic
configuration and state data for IPv4 unicast routing.
Copyright (c) 2016 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).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as
described in RFC 2119.
This version of this YANG module is part of RFC TBD;
see the RFC itself for full legal notices.";
revision 2017-10-06 {
description
"Deprecated revision.";
reference "RFC TBD: Revised YANG Data Model for Routing
Management";
}
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
identity ipv4-unicast {
base rt:ipv4;
status deprecated;
description
"This identity represents the IPv4 unicast address family.";
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route" {
when "derived-from-or-self(../../rt:address-family, "
+ "'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status deprecated;
description
"This leaf augments an IPv4 unicast route.";
leaf destination-prefix {
type inet:ipv4-prefix;
status deprecated;
description
"IPv4 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/"
+ "rt:next-hop/rt:next-hop-options/rt:simple-next-hop" {
when "derived-from-or-self(
../../../rt:address-family, 'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status deprecated;
description
"Augment 'simple-next-hop' case in IPv4 unicast routes.";
leaf next-hop-address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 address of the next hop.";
}
}
augment "/rt:routing-state/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" {
when "derived-from-or-self(../../../../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status deprecated;
description
"This leaf augments the 'next-hop-list' case of IPv4 unicast
routes.";
leaf address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 address of the next-hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:input" {
when "derived-from-or-self(../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast RIBs.";
}
status deprecated;
description
"This augment adds the input parameter of the 'active-route'
action.";
leaf destination-address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 destination address.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route" {
when "derived-from-or-self(../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status deprecated;
description
"This augment adds the destination prefix to the reply of the
'active-route' action.";
leaf destination-prefix {
type inet:ipv4-prefix;
status deprecated;
description
"IPv4 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:simple-next-hop" {
when "derived-from-or-self(../../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status deprecated;
description
"Augment 'simple-next-hop' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 address of the next hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:next-hop-list/rt:next-hop-list/rt:next-hop" {
when "derived-from-or-self(../../../../../rt:address-family,
'v4ur:ipv4-unicast')" {
description
"This augment is valid only for IPv4 unicast.";
}
status deprecated;
description
"Augment 'next-hop-list' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 address of the next hop.";
}
}
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/rt:static-routes" {
status deprecated;
description
"This augment defines the configuration of the 'static'
pseudo-protocol with data specific to IPv4 unicast.";
container ipv4 {
status deprecated;
description
"Configuration of a 'static' pseudo-protocol instance
consists of a list of routes.";
list route {
key "destination-prefix";
status deprecated;
description
"A list of static routes.";
leaf destination-prefix {
type inet:ipv4-prefix;
mandatory true;
status deprecated;
description
"IPv4 destination prefix.";
}
leaf description {
type string;
status deprecated;
description
"Textual description of the route.";
}
container next-hop {
status deprecated;
description
"Configuration of next-hop.";
uses rt:next-hop-content {
status deprecated;
augment "next-hop-options/simple-next-hop" {
status deprecated;
description
"Augment 'simple-next-hop' case in IPv4 static
routes.";
leaf next-hop-address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 address of the next hop.";
}
}
augment "next-hop-options/next-hop-list/" +
"next-hop-list/next-hop" {
status deprecated;
description
"Augment 'next-hop-list' case in IPv4 static
routes.";
leaf next-hop-address {
type inet:ipv4-address;
status deprecated;
description
"IPv4 address of the next hop.";
}
}
}
}
}
}
}
}
<CODE ENDS>
A.3. Deprecated ietf-ipv6-unicast Model
<CODE BEGINS> file "ietf-ipv6-unicast-routing@2017-10-06.yang"
module ietf-ipv6-unicast-routing {
yang-version 1.1;
namespace
"urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing";
prefix v6ur;
import ietf-routing {
prefix rt;
}
import ietf-inet-types {
prefix inet;
}
include ietf-ipv6-router-advertisements {
revision-date 2017-10-06;
}
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org>
WG Chair: Lou Berger
<mailto:lberger@labn.net>
WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net>
Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz>
Editor: Acee Lindem
<mailto:acee@cisco.com>";
description
"This YANG module augments the 'ietf-routing' module with basic
configuration and state data for IPv6 unicast routing.
Copyright (c) 2016 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).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as described
in RFC 2119.
This version of this YANG module is part of RFC TBD;
see the RFC itself for full legal notices.";
revision 2017-10-06 {
description
"Deprecated revision.";
reference "RFC TBD: Revised YANG Data Model for Routing
Management";
}
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
identity ipv6-unicast {
base rt:ipv6;
status deprecated;
description
"This identity represents the IPv6 unicast address family.";
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route" {
when "derived-from-or-self(../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status deprecated;
description
"This leaf augments an IPv6 unicast route.";
leaf destination-prefix {
type inet:ipv6-prefix;
status deprecated;
description
"IPv6 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/"
+ "rt:next-hop/rt:next-hop-options/rt:simple-next-hop" {
when "derived-from-or-self(../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status deprecated;
description
"Augment 'simple-next-hop' case in IPv6 unicast routes.";
leaf next-hop-address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 address of the next hop.";
}
}
augment "/rt:routing-state/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" {
when "derived-from-or-self(../../../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status deprecated;
description
"This leaf augments the 'next-hop-list' case of IPv6 unicast
routes.";
leaf address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 address of the next hop.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/"
+ "rt:active-route/rt:input" {
when "derived-from-or-self(../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast RIBs.";
}
status deprecated;
description
"This augment adds the input parameter of the 'active-route'
action.";
leaf destination-address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 destination address.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route" {
when "derived-from-or-self(../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status deprecated;
description
"This augment adds the destination prefix to the reply of the
'active-route' action.";
leaf destination-prefix {
type inet:ipv6-prefix;
status deprecated;
description
"IPv6 destination prefix.";
}
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:simple-next-hop" {
when "derived-from-or-self(../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status deprecated;
description
"Augment 'simple-next-hop' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 address of the next hop.";
} /* Obsolete State Data */
}
augment "/rt:routing-state/rt:ribs/rt:rib/rt:active-route/"
+ "rt:output/rt:route/rt:next-hop/rt:next-hop-options/"
+ "rt:next-hop-list/rt:next-hop-list/rt:next-hop" {
when "derived-from-or-self(../../../../../rt:address-family,
'v6ur:ipv6-unicast')" {
description
"This augment is valid only for IPv6 unicast.";
}
status deprecated;
description
"Augment 'next-hop-list' case in the reply to the
'active-route' action.";
leaf next-hop-address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 address of the next hop.";
}
}
augment "/rt:routing/rt:control-plane-protocols/"
+ "rt:control-plane-protocol/rt:static-routes" {
status deprecated;
description
"This augment defines the configuration of the 'static'
pseudo-protocol with data specific to IPv6 unicast.";
container ipv6 {
status deprecated;
description
"Configuration of a 'static' pseudo-protocol instance
consists of a list of routes.";
list route {
key "destination-prefix";
status deprecated;
description
"A list of static routes.";
leaf destination-prefix {
type inet:ipv6-prefix;
mandatory true;
status deprecated;
description
"IPv6 destination prefix.";
}
leaf description {
type string;
status deprecated;
description
"Textual description of the route.";
}
container next-hop {
status deprecated;
description
"Configuration of next-hop.";
uses rt:next-hop-content {
status deprecated;
augment "next-hop-options/simple-next-hop" {
status deprecated;
description
"Augment 'simple-next-hop' case in IPv6 static
routes.";
leaf next-hop-address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 address of the next hop.";
}
}
augment "next-hop-options/next-hop-list/"
+ "next-hop-list/next-hop" {
status deprecated;
description
"Augment 'next-hop-list' case in IPv6 static
routes.";
leaf next-hop-address {
type inet:ipv6-address;
status deprecated;
description
"IPv6 address of the next hop.";
}
}
}
}
}
}
}
}
<CODE ENDS>
A.4. Deprecated ietf-ipv6-router-advertisements Model
<CODE BEGINS> file "ietf-ipv6-router-advertisements@2017-10-06.yang"
submodule ietf-ipv6-router-advertisements {
yang-version 1.1;
belongs-to ietf-ipv6-unicast-routing {
prefix v6ur;
}
import ietf-inet-types {
prefix inet;
}
import ietf-interfaces {
prefix if;
}
import ietf-ip {
prefix ip;
}
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netmod/>
WG List: <mailto:netmod@ietf.org>
WG Chair: Lou Berger
<mailto:lberger@labn.net>
WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net>
Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz>
Editor: Acee Lindem
<mailto:acee@cisco.com>";
description
"This YANG module augments the 'ietf-ip' module with
configuration and state data of IPv6 router advertisements.
Copyright (c) 2016 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).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as described
in RFC 2119.
This version of this YANG module is part of RFC TBD;
see the RFC itself for full legal notices.";
reference "RFC 4861: Neighbor Discovery for IP version 6 (IPv6).";
revision 2017-10-06 {
description
"Deprecated revision.";
reference "RFC TBD: Revised YANG Data Model for
Routing Management";
}
revision 2016-11-04 {
description
"Initial revision.";
reference
"RFC 8022: A YANG Data Model for Routing Management";
}
augment "/if:interfaces-state/if:interface/ip:ipv6" { augment "/if:interfaces-state/if:interface/ip:ipv6" {
status deprecated; status obsolete;
description description
"Augment interface state data with parameters of IPv6 router "Augment interface state data with parameters of IPv6 router
advertisements."; advertisements.";
container ipv6-router-advertisements { container ipv6-router-advertisements {
status deprecated; status obsolete;
description description
"Parameters of IPv6 Router Advertisements."; "Parameters of IPv6 Router Advertisements.";
leaf send-advertisements { leaf send-advertisements {
type boolean; type boolean;
status deprecated; status obsolete;
description description
"A flag indicating whether or not the router sends periodic "A flag indicating whether or not the router sends periodic
Router Advertisements and responds to Router Router Advertisements and responds to Router
Solicitations."; Solicitations.";
} }
leaf max-rtr-adv-interval { leaf max-rtr-adv-interval {
type uint16 { type uint16 {
range "4..1800"; range "4..1800";
} }
units "seconds"; units "seconds";
status deprecated; status obsolete;
description description
"The maximum time allowed between sending unsolicited "The maximum time allowed between sending unsolicited
multicast Router Advertisements from the interface."; multicast Router Advertisements from the interface.";
} }
leaf min-rtr-adv-interval { leaf min-rtr-adv-interval {
type uint16 { type uint16 {
range "3..1350"; range "3..1350";
} }
units "seconds"; units "seconds";
status deprecated; status obsolete;
description description
"The minimum time allowed between sending unsolicited "The minimum time allowed between sending unsolicited
multicast Router Advertisements from the interface."; multicast Router Advertisements from the interface.";
} }
leaf managed-flag { leaf managed-flag {
type boolean; type boolean;
status deprecated; status obsolete;
description description
"The value that is placed in the 'Managed address "The value that is placed in the 'Managed address
configuration' flag field in the Router Advertisement."; configuration' flag field in the Router Advertisement.";
} }
leaf other-config-flag { leaf other-config-flag {
type boolean; type boolean;
status deprecated; status obsolete;
description description
"The value that is placed in the 'Other configuration' flag "The value that is placed in the 'Other configuration' flag
field in the Router Advertisement."; field in the Router Advertisement.";
} }
leaf link-mtu { leaf link-mtu {
type uint32; type uint32;
status deprecated; status obsolete;
description description
"The value that is placed in MTU options sent by the "The value that is placed in MTU options sent by the
router. A value of zero indicates that no MTU options are router. A value of zero indicates that no MTU options are
sent."; sent.";
} }
leaf reachable-time { leaf reachable-time {
type uint32 { type uint32 {
range "0..3600000"; range "0..3600000";
} }
units "milliseconds"; units "milliseconds";
status deprecated; status obsolete;
description description
"The value that is placed in the Reachable Time field in "The value that is placed in the Reachable Time field in
the Router Advertisement messages sent by the router. A the Router Advertisement messages sent by the router. A
value of zero means unspecified (by this router)."; value of zero means unspecified (by this router).";
} }
leaf retrans-timer { leaf retrans-timer {
type uint32; type uint32;
units "milliseconds"; units "milliseconds";
status deprecated; status obsolete;
description description
"The value that is placed in the Retrans Timer field in the "The value that is placed in the Retrans Timer field in the
Router Advertisement messages sent by the router. A value Router Advertisement messages sent by the router. A value
of zero means unspecified (by this router)."; of zero means unspecified (by this router).";
} }
leaf cur-hop-limit { leaf cur-hop-limit {
type uint8; type uint8;
status deprecated; status obsolete;
description description
"The value that is placed in the Cur Hop Limit field in the "The value that is placed in the Cur Hop Limit field in the
Router Advertisement messages sent by the router. A value Router Advertisement messages sent by the router. A value
of zero means unspecified (by this router)."; of zero means unspecified (by this router).";
} }
leaf default-lifetime { leaf default-lifetime {
type uint16 { type uint16 {
range "0..9000"; range "0..9000";
} }
units "seconds"; units "seconds";
status deprecated; status obsolete;
description description
"The value that is placed in the Router Lifetime field of "The value that is placed in the Router Lifetime field of
Router Advertisements sent from the interface, in seconds. Router Advertisements sent from the interface, in seconds.
A value of zero indicates that the router is not to be A value of zero indicates that the router is not to be
used as a default router."; used as a default router.";
} }
container prefix-list { container prefix-list {
status deprecated; status obsolete;
description description
"A list of prefixes that are placed in Prefix Information "A list of prefixes that are placed in Prefix Information
options in Router Advertisement messages sent from the options in Router Advertisement messages sent from the
interface. interface.
By default, these are all prefixes that the router By default, these are all prefixes that the router
advertises via routing protocols as being on-link for the advertises via routing protocols as being on-link for the
interface from which the advertisement is sent."; interface from which the advertisement is sent.";
list prefix { list prefix {
key "prefix-spec"; key "prefix-spec";
status deprecated; status obsolete;
description description
"Advertised prefix entry and its parameters."; "Advertised prefix entry and its parameters.";
leaf prefix-spec { leaf prefix-spec {
type inet:ipv6-prefix; type inet:ipv6-prefix;
status deprecated; status obsolete;
description description
"IPv6 address prefix."; "IPv6 address prefix.";
} }
leaf valid-lifetime { leaf valid-lifetime {
type uint32; type uint32;
units "seconds"; units "seconds";
status deprecated; status obsolete;
description description
"The value that is placed in the Valid Lifetime in the "The value that is placed in the Valid Lifetime in the
Prefix Information option. The designated value of Prefix Information option. The designated value of
all 1's (0xffffffff) represents infinity. all 1's (0xffffffff) represents infinity.
An implementation SHOULD keep this value constant in An implementation SHOULD keep this value constant in
consecutive advertisements except when it is consecutive advertisements except when it is
explicitly changed in configuration."; explicitly changed in configuration.";
} }
leaf on-link-flag { leaf on-link-flag {
type boolean; type boolean;
status deprecated; status obsolete;
description description
"The value that is placed in the on-link flag ('L-bit') "The value that is placed in the on-link flag ('L-bit')
field in the Prefix Information option."; field in the Prefix Information option.";
} }
leaf preferred-lifetime { leaf preferred-lifetime {
type uint32; type uint32;
units "seconds"; units "seconds";
status deprecated; status obsolete;
description description
"The value that is placed in the Preferred Lifetime in "The value that is placed in the Preferred Lifetime in
the Prefix Information option, in seconds. The the Prefix Information option, in seconds. The
designated value of all 1's (0xffffffff) represents designated value of all 1's (0xffffffff) represents
infinity. infinity.
An implementation SHOULD keep this value constant in An implementation SHOULD keep this value constant in
consecutive advertisements except when it is consecutive advertisements except when it is
explicitly changed in configuration."; explicitly changed in configuration.";
} }
leaf autonomous-flag { leaf autonomous-flag {
type boolean; type boolean;
status deprecated; status obsolete;
description description
"The value that is placed in the Autonomous Flag field "The value that is placed in the Autonomous Flag field
in the Prefix Information option."; in the Prefix Information option.";
} }
} }
} }
} }
} }
augment "/if:interfaces/if:interface/ip:ipv6" { }
status deprecated; <CODE ENDS>
description
"Augment interface configuration with parameters of IPv6 router
advertisements.";
container ipv6-router-advertisements {
status deprecated;
description
"Configuration of IPv6 Router Advertisements.";
leaf send-advertisements { 10. IANA Considerations
type boolean;
default "false";
status deprecated;
description
"A flag indicating whether or not the router sends periodic
Router Advertisements and responds to Router
Solicitations.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvSendAdvertisements.";
}
leaf max-rtr-adv-interval {
type uint16 {
range "4..1800";
}
units "seconds";
default "600";
status deprecated;
description
"The maximum time allowed between sending unsolicited
multicast Router Advertisements from the interface.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
MaxRtrAdvInterval.";
}
leaf min-rtr-adv-interval {
type uint16 {
range "3..1350";
}
units "seconds";
must ". <= 0.75 * ../max-rtr-adv-interval" {
description
"The value MUST NOT be greater than 75% of
'max-rtr-adv-interval'.";
}
status deprecated;
description
"The minimum time allowed between sending unsolicited
multicast Router Advertisements from the interface.
The default value to be used operationally if this leaf is [RFC8022] registered the following namespace URIs in the "IETF XML
not configured is determined as follows: Registry" [RFC3688]:
- if max-rtr-adv-interval >= 9 seconds, the default URI: urn:ietf:params:xml:ns:yang:ietf-routing
value is 0.33 * max-rtr-adv-interval; Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
- otherwise, it is 0.75 * max-rtr-adv-interval."; URI: urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
reference URI: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - Registrant Contact: The IESG.
MinRtrAdvInterval."; XML: N/A; the requested URI is an XML namespace.
}
leaf managed-flag {
type boolean;
default "false";
status deprecated;
description
"The value to be placed in the 'Managed address
configuration' flag field in the Router Advertisement.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvManagedFlag.";
}
leaf other-config-flag {
type boolean;
default "false";
status deprecated;
description
"The value to be placed in the 'Other configuration' flag
field in the Router Advertisement.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvOtherConfigFlag.";
}
leaf link-mtu {
type uint32;
default "0";
status deprecated;
description
"The value to be placed in MTU options sent by the router.
A value of zero indicates that no MTU options are sent.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvLinkMTU.";
}
leaf reachable-time {
type uint32 {
range "0..3600000";
}
units "milliseconds";
default "0";
status deprecated;
description
"The value to be placed in the Reachable Time field in the
Router Advertisement messages sent by the router. A value
of zero means unspecified (by this router).";
reference [RFC8022] registered the following YANG modules in the "YANG Module
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - Names" registry [RFC6020]:
AdvReachableTime.";
}
leaf retrans-timer {
type uint32;
units "milliseconds";
default "0";
status deprecated;
description
"The value to be placed in the Retrans Timer field in the
Router Advertisement messages sent by the router. A value
of zero means unspecified (by this router).";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvRetransTimer.";
}
leaf cur-hop-limit {
type uint8;
status deprecated;
description
"The value to be placed in the Cur Hop Limit field in the
Router Advertisement messages sent by the router. A value
of zero means unspecified (by this router).
If this parameter is not configured, the device SHOULD use Name: ietf-routing
the value specified in IANA Assigned Numbers that was in Namespace: urn:ietf:params:xml:ns:yang:ietf-routing
effect at the time of implementation."; Prefix: rt
reference Reference: RFC 8022
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - Name: ietf-ipv4-unicast-routing
AdvCurHopLimit. Namespace: urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing
Prefix: v4ur
Reference: RFC 8022
IANA: IP Parameters, Name: ietf-ipv6-unicast-routing
http://www.iana.org/assignments/ip-parameters"; Namespace: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing
} Prefix: v6ur
leaf default-lifetime { Reference: RFC 8022
type uint16 {
range "0..9000";
}
units "seconds";
status deprecated;
description
"The value to be placed in the Router Lifetime field of
Router Advertisements sent from the interface, in seconds.
It MUST be either zero or between max-rtr-adv-interval and
9000 seconds. A value of zero indicates that the router
is not to be used as a default router. These limits may
be overridden by specific documents that describe how IPv6
operates over different link layers.
If this parameter is not configured, the device SHOULD use This document registers the following YANG submodule in the "YANG
a value of 3 * max-rtr-adv-interval."; Module Names" registry [RFC6020]:
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvDefaultLifeTime.";
}
container prefix-list {
status deprecated;
description
"Configuration of prefixes to be placed in Prefix
Information options in Router Advertisement messages sent
from the interface.
Prefixes that are advertised by default but do not have Name: ietf-ipv6-router-advertisements
their entries in the child 'prefix' list are advertised Module: ietf-ipv6-unicast-routing
with the default values of all parameters. Reference: RFC 8022
The link-local prefix SHOULD NOT be included in the list 11. Security Considerations
of advertised prefixes.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvPrefixList.";
list prefix {
key "prefix-spec";
status deprecated;
description
"Configuration of an advertised prefix entry.";
leaf prefix-spec {
type inet:ipv6-prefix;
status deprecated;
description
"IPv6 address prefix.";
}
choice control-adv-prefixes {
default "advertise";
status deprecated;
description
"Either the prefix is explicitly removed from the
set of advertised prefixes, or the parameters with
which it is advertised are specified (default case).";
leaf no-advertise {
type empty;
status deprecated;
description
"The prefix will not be advertised.
This can be used for removing the prefix from the The YANG module defined in this memo is designed to be accessed via
default set of advertised prefixes."; the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the
} secure transport layer and the mandatory-to-implement secure
case advertise { transport is SSH [RFC6242].
status deprecated;
leaf valid-lifetime {
type uint32;
units "seconds";
default "2592000";
status deprecated;
description
"The value to be placed in the Valid Lifetime in
the Prefix Information option. The designated
value of all 1's (0xffffffff) represents
infinity.";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvValidLifetime.";
}
leaf on-link-flag {
type boolean;
default "true";
status deprecated;
description
"The value to be placed in the on-link flag
('L-bit') field in the Prefix Information
option.";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvOnLinkFlag.";
}
leaf preferred-lifetime {
type uint32;
units "seconds";
must ". <= ../valid-lifetime" {
description
"This value MUST NOT be greater than
valid-lifetime.";
}
default "604800";
status deprecated;
description
"The value to be placed in the Preferred Lifetime
in the Prefix Information option. The designated
value of all 1's (0xffffffff) represents
infinity.";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvPreferredLifetime.";
}
leaf autonomous-flag {
type boolean;
default "true";
status deprecated;
description
"The value to be placed in the Autonomous Flag
field in the Prefix Information option.";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvAutonomousFlag.";
}
}
}
}
}
}
}
}
<CODE ENDS>
Appendix B. The Complete Data Trees There are a number of data nodes defined in this YANG module which
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. These are the subtrees and data nodes
and their sensitivity/vulnerability:
/routing/control-plane-protocols/control-plane-protocol: This list
specifies the control-plane protocols configured on a device.
/routing/ribs/rib: This list specifies the RIBs configured for the
device.
Some of the readable data nodes in this 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. These are the subtrees and data
nodes and their sensitivity/vulnerability:
/routing/control-plane-protocols/control-plane-protocol: This list
specifies the control-plane protocols configured on a device.
Refer to the control plane models for a list of sensitive
information.
/routing/ribs/rib: This list specifies the RIB and their contents
for the device. Access to this information may disclose the
network topology and or other information.
12. References
12.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>.
[RFC4861] Narten, T., Nordmark, E., Simpson, W., and H. Soliman,
"Neighbor Discovery for IP version 6 (IPv6)", RFC 4861,
DOI 10.17487/RFC4861, September 2007, <https://www.rfc-
editor.org/info/rfc4861>.
[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>.
[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>.
[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>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 7223, DOI 10.17487/RFC7223, May 2014,
<https://www.rfc-editor.org/info/rfc7223>.
[RFC7277] Bjorklund, M., "A YANG Data Model for IP Management",
RFC 7277, DOI 10.17487/RFC7277, June 2014,
<https://www.rfc-editor.org/info/rfc7277>.
[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>.
[RFC8022] Lhotka, L. and A. Lindem, "A YANG Data Model for Routing
Management", RFC 8022, DOI 10.17487/RFC8022, November
2016, <https://www.rfc-editor.org/info/rfc8022>.
12.2. Informative References
[RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG
Data Model Documents", RFC 6087, DOI 10.17487/RFC6087,
January 2011, <https://www.rfc-editor.org/info/rfc6087>.
[RFC7895] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Module
Library", RFC 7895, DOI 10.17487/RFC7895, June 2016,
<https://www.rfc-editor.org/info/rfc7895>.
[RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG",
RFC 7951, DOI 10.17487/RFC7951, August 2016,
<https://www.rfc-editor.org/info/rfc7951>.
[I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-05
(work in progress), October 2017.
Appendix A. The Complete Data Trees
This appendix presents the complete tree of the core routing data This appendix presents the complete tree of the core routing data
model. See Section 2.2 for an explanation of the symbols used. The model. See Section 2.2 for an explanation of the symbols used. The
data type of every leaf node is shown near the right end of the data type of every leaf node is shown near the right end of the
corresponding line. corresponding line.
module: ietf-routing-2 module: ietf-routing
+--rw routing +--rw routing
+--rw router-id? yang:dotted-quad +--rw router-id? yang:dotted-quad
+--ro interfaces +--ro interfaces
| +--ro interface* if:interface-ref | +--ro interface* if:interface-ref
+--rw control-plane-protocols +--rw control-plane-protocols
| +--rw control-plane-protocol* [type name] | +--rw control-plane-protocol* [type name]
| +--rw type identityref | +--rw type identityref
| +--rw name string | +--rw name string
| +--rw description? string | +--rw description? string
| +--rw static-routes | +--rw static-routes
skipping to change at page 83, line 7 skipping to change at page 60, line 33
| | +--ro v4ur:next-hop-address? | | +--ro v4ur:next-hop-address?
| | | inet:ipv4-address | | | inet:ipv4-address
| | +--ro v6ur:next-hop-address? | | +--ro v6ur:next-hop-address?
| | inet:ipv6-address | | inet:ipv6-address
| +--ro source-protocol identityref | +--ro source-protocol identityref
| +--ro active? empty | +--ro active? empty
| +--ro last-updated? yang:date-and-time | +--ro last-updated? yang:date-and-time
| +--ro v4ur:destination-prefix? inet:ipv4-prefix | +--ro v4ur:destination-prefix? inet:ipv4-prefix
| +--ro v6ur:destination-prefix? inet:ipv6-prefix | +--ro v6ur:destination-prefix? inet:ipv6-prefix
+--rw description? string +--rw description? string
module: ietf-ipv6-unicast-routing-2 module: ietf-ipv6-unicast-routing
augment /if:interfaces/if:interface/ip:ipv6: augment /if:interfaces/if:interface/ip:ipv6:
+--rw ipv6-router-advertisements +--rw ipv6-router-advertisements
+--rw send-advertisements? boolean +--rw send-advertisements? boolean
+--rw max-rtr-adv-interval? uint16 +--rw max-rtr-adv-interval? uint16
+--rw min-rtr-adv-interval? uint16 +--rw min-rtr-adv-interval? uint16
+--rw managed-flag? boolean +--rw managed-flag? boolean
+--rw other-config-flag? boolean +--rw other-config-flag? boolean
+--rw link-mtu? uint32 +--rw link-mtu? uint32
+--rw reachable-time? uint32 +--rw reachable-time? uint32
+--rw retrans-timer? uint32 +--rw retrans-timer? uint32
skipping to change at page 83, line 32 skipping to change at page 61, line 10
+--rw prefix-spec inet:ipv6-prefix +--rw prefix-spec inet:ipv6-prefix
+--rw (control-adv-prefixes)? +--rw (control-adv-prefixes)?
+--:(no-advertise) +--:(no-advertise)
| +--rw no-advertise? empty | +--rw no-advertise? empty
+--:(advertise) +--:(advertise)
+--rw valid-lifetime? uint32 +--rw valid-lifetime? uint32
+--rw on-link-flag? boolean +--rw on-link-flag? boolean
+--rw preferred-lifetime? uint32 +--rw preferred-lifetime? uint32
+--rw autonomous-flag? boolean +--rw autonomous-flag? boolean
Appendix C. Minimum Implementation Appendix B. Minimum Implementation
Some parts and options of the core routing model, such as user- Some parts and options of the core routing model, such as user-
defined RIBs, are intended only for advanced routers. This appendix defined RIBs, are intended only for advanced routers. This appendix
gives basic non-normative guidelines for implementing a bare minimum gives basic non-normative guidelines for implementing a bare minimum
of available functions. Such an implementation may be used for hosts of available functions. Such an implementation may be used for hosts
or very simple routers. or very simple routers.
A minimum implementation does not support the feature A minimum implementation does not support the feature
"multiple-ribs". This means that a single system-controlled RIB is "multiple-ribs". This means that a single system-controlled RIB is
available for each supported address family -- IPv4, IPv6, or both. available for each supported address family -- IPv4, IPv6, or both.
skipping to change at page 84, line 13 skipping to change at page 61, line 36
instance(s) of the "static" pseudo-protocol. instance(s) of the "static" pseudo-protocol.
For hosts that are never intended to act as routers, the ability to For hosts that are never intended to act as routers, the ability to
turn on sending IPv6 router advertisements (Section 5.4) should be turn on sending IPv6 router advertisements (Section 5.4) should be
removed. removed.
Platforms with severely constrained resources may use deviations for Platforms with severely constrained resources may use deviations for
restricting the data model, e.g., limiting the number of "static" restricting the data model, e.g., limiting the number of "static"
control-plane protocol instances. control-plane protocol instances.
Appendix D. Example: Adding a New Control-Plane Protocol Appendix C. Example: Adding a New Control-Plane Protocol
This appendix demonstrates how the core routing data model can be This appendix demonstrates how the core routing data model can be
extended to support a new control-plane protocol. The YANG module extended to support a new control-plane protocol. The YANG module
"example-rip" shown below is intended as an illustration rather than "example-rip" shown below is intended as an illustration rather than
a real definition of a data model for the Routing Information a real definition of a data model for the Routing Information
Protocol (RIP). For the sake of brevity, this module does not obey Protocol (RIP). For the sake of brevity, this module does not obey
all the guidelines specified in [RFC6087]. See also Section 5.3.2. all the guidelines specified in [RFC6087]. See also Section 5.3.2.
module example-rip { module example-rip {
skipping to change at page 84, line 29 skipping to change at page 62, line 4
Protocol (RIP). For the sake of brevity, this module does not obey Protocol (RIP). For the sake of brevity, this module does not obey
all the guidelines specified in [RFC6087]. See also Section 5.3.2. all the guidelines specified in [RFC6087]. See also Section 5.3.2.
module example-rip { module example-rip {
yang-version "1.1"; yang-version "1.1";
namespace "http://example.com/rip"; namespace "http://example.com/rip";
prefix "rip"; prefix "rip";
import ietf-interfaces { import ietf-interfaces {
prefix "if"; prefix "if";
} }
import ietf-routing-2 { import ietf-routing {
prefix "rt"; prefix "rt";
} }
identity rip { identity rip {
base rt:routing-protocol; base rt:routing-protocol;
description description
"Identity for the Routing Information Protocol (RIP)."; "Identity for the Routing Information Protocol (RIP).";
} }
typedef rip-metric { typedef rip-metric {
skipping to change at page 86, line 29 skipping to change at page 64, line 4
} }
leaf update-interval { leaf update-interval {
type uint8 { type uint8 {
range "10..60"; range "10..60";
} }
units "seconds"; units "seconds";
default "30"; default "30";
description description
"Time interval between periodic updates."; "Time interval between periodic updates.";
} }
} }
} }
} }
Appendix E. Data Tree Example Appendix D. Data Tree Example
This section contains an example of an instance data tree in the JSON This section contains an example of an instance data tree in the JSON
encoding [RFC7951], containing both configuration and state data. encoding [RFC7951], containing both configuration and state data.
The data conforms to a data model that is defined by the following The data conforms to a data model that is defined by the following
YANG library specification [RFC7895]: YANG library specification [RFC7895]:
{ {
"ietf-yang-library:modules-state": { "ietf-yang-library:modules-state": {
"module-set-id": "c2e1f54169aa7f36e1a6e8d0865d441d3600f9c4", "module-set-id": "c2e1f54169aa7f36e1a6e8d0865d441d3600f9c4",
"module": [ "module": [
{ {
"name": "ietf-routing-2", "name": "ietf-routing",
"revision": "2017-09-13", "revision": "2017-09-13",
"feature": [ "feature": [
"multiple-ribs", "multiple-ribs",
"router-id" "router-id"
], ],
"namespace": "urn:ietf:params:xml:ns:yang:ietf-routing-2", "namespace": "urn:ietf:params:xml:ns:yang:ietf-routing",
"conformance-type": "implement" "conformance-type": "implement"
}, },
{ {
"name": "ietf-ipv4-unicast-routing-2", "name": "ietf-ipv4-unicast-routing",
"revision": "2017-09-13", "revision": "2017-09-13",
"namespace": "namespace":
"urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing-2", "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing",
"conformance-type": "implement" "conformance-type": "implement"
}, },
{ {
"name": "ietf-ipv6-unicast-routing-2", "name": "ietf-ipv6-unicast-routing",
"revision": "2017-09-13", "revision": "2017-09-13",
"namespace": "namespace":
"urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing-3", "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing-3",
"conformance-type": "implement" "conformance-type": "implement"
}, },
{ {
"name": "ietf-interfaces", "name": "ietf-interfaces",
"revision": "2014-05-08", "revision": "2014-05-08",
"namespace": "urn:ietf:params:xml:ns:yang:ietf-interfaces", "namespace": "urn:ietf:params:xml:ns:yang:ietf-interfaces",
"conformance-type": "implement" "conformance-type": "implement"
skipping to change at page 89, line 40 skipping to change at page 67, line 33
"address": [ "address": [
{ {
"ip": "2001:0db8:0:2::1", "ip": "2001:0db8:0:2::1",
"prefix-length": 64 "prefix-length": 64
} }
], ],
"forwarding": true, "forwarding": true,
"autoconf": { "autoconf": {
"create-global-addresses": false "create-global-addresses": false
}, },
"ietf-ipv6-unicast-routing-2: "ietf-ipv6-unicast-routing:
ipv6-router-advertisements-2": { ipv6-router-advertisements": {
"send-advertisements": true "send-advertisements": true
} }
} }
} }
] ]
}, },
"ietf-interfaces:interfaces-state": { "ietf-interfaces:interfaces-state": {
"interface": [ "interface": [
{ {
"name": "eth0", "name": "eth0",
skipping to change at page 90, line 29 skipping to change at page 68, line 22
}, },
"ietf-ip:ipv6": { "ietf-ip:ipv6": {
"forwarding": true, "forwarding": true,
"mtu": 1500, "mtu": 1500,
"address": [ "address": [
{ {
"ip": "2001:0db8:0:1::1", "ip": "2001:0db8:0:1::1",
"prefix-length": 64 "prefix-length": 64
} }
], ],
"ietf-ipv6-unicast-routing-2: "ietf-ipv6-unicast-routing:
ipv6-router-advertisements-2": { ipv6-router-advertisements": {
"send-advertisements": false "send-advertisements": false
} }
} }
}, },
{ {
"name": "eth1", "name": "eth1",
"type": "iana-if-type:ethernetCsmacd", "type": "iana-if-type:ethernetCsmacd",
"phys-address": "00:0C:42:E5:B1:EA", "phys-address": "00:0C:42:E5:B1:EA",
"oper-status": "up", "oper-status": "up",
"statistics": { "statistics": {
skipping to change at page 91, line 15 skipping to change at page 69, line 7
}, },
"ietf-ip:ipv6": { "ietf-ip:ipv6": {
"forwarding": true, "forwarding": true,
"mtu": 1500, "mtu": 1500,
"address": [ "address": [
{ {
"ip": "2001:0db8:0:2::1", "ip": "2001:0db8:0:2::1",
"prefix-length": 64 "prefix-length": 64
} }
], ],
"ietf-ipv6-unicast-routing-2: "ietf-ipv6-unicast-routing:
ipv6-router-advertisements-2": { ipv6-router-advertisements": {
"send-advertisements": true, "send-advertisements": true,
"prefix-list": { "prefix-list": {
"prefix": [ "prefix": [
{ {
"prefix-spec": "2001:db8:0:2::/64" "prefix-spec": "2001:db8:0:2::/64"
} }
] ]
} }
} }
} }
} }
] ]
}, },
"ietf-routing-2:routing": { "ietf-routing:routing": {
"router-id": "192.0.2.1", "router-id": "192.0.2.1",
"control-plane-protocols": { "control-plane-protocols": {
"control-plane-protocol": [ "control-plane-protocol": [
{ {
"type": "ietf-routing-2:static", "type": "ietf-routing:static",
"name": "st0", "name": "st0",
"description": "description":
"Static routing is used for the internal network.", "Static routing is used for the internal network.",
"static-routes": { "static-routes": {
"ietf-ipv4-unicast-routing-2:ipv4": { "ietf-ipv4-unicast-routing:ipv4": {
"route": [ "route": [
{ {
"destination-prefix": "0.0.0.0/0", "destination-prefix": "0.0.0.0/0",
"next-hop": { "next-hop": {
"next-hop-address": "192.0.2.2" "next-hop-address": "192.0.2.2"
} }
} }
] ]
}, },
"ietf-ipv6-unicast-routing-2:ipv6": { "ietf-ipv6-unicast-routing:ipv6": {
"route": [ "route": [
{ {
"destination-prefix": "::/0", "destination-prefix": "::/0",
"next-hop": { "next-hop": {
"next-hop-address": "2001:db8:0:1::2" "next-hop-address": "2001:db8:0:1::2"
} }
} }
] ]
} }
} }
} }
] ]
} }
"ribs": { "ribs": {
"rib": [ "rib": [
{ {
"name": "ipv4-master", "name": "ipv4-master",
"address-family": "address-family":
"ietf-ipv4-unicast-routing-2:ipv4-unicast", "ietf-ipv4-unicast-routing:ipv4-unicast",
"default-rib": true, "default-rib": true,
"routes": { "routes": {
"route": [ "route": [
{ {
"ietf-ipv4-unicast-routing-2:destination-prefix": "ietf-ipv4-unicast-routing:destination-prefix":
"192.0.2.1/24", "192.0.2.1/24",
"next-hop": { "next-hop": {
"outgoing-interface": "eth0" "outgoing-interface": "eth0"
}, },
"route-preference": 0, "route-preference": 0,
"source-protocol": "ietf-routing-2:direct", "source-protocol": "ietf-routing:direct",
"last-updated": "2015-10-24T17:11:27+02:00" "last-updated": "2015-10-24T17:11:27+02:00"
}, },
{ {
"ietf-ipv4-unicast-routing-2:destination-prefix": "ietf-ipv4-unicast-routing:destination-prefix":
"198.51.100.0/24", "198.51.100.0/24",
"next-hop": { "next-hop": {
"outgoing-interface": "eth1" "outgoing-interface": "eth1"
}, },
"source-protocol": "ietf-routing-2:direct", "source-protocol": "ietf-routing:direct",
"route-preference": 0, "route-preference": 0,
"last-updated": "2015-10-24T17:11:27+02:00" "last-updated": "2015-10-24T17:11:27+02:00"
}, },
{ {
"ietf-ipv4-unicast-routing-2:destination-prefix": "ietf-ipv4-unicast-routing:destination-prefix":
"0.0.0.0/0", "0.0.0.0/0",
"source-protocol": "ietf-routing-2:static", "source-protocol": "ietf-routing:static",
"route-preference": 5, "route-preference": 5,
"next-hop": { "next-hop": {
"ietf-ipv4-unicast-routing-2:next-hop-address": "ietf-ipv4-unicast-routing:next-hop-address":
"192.0.2.2" "192.0.2.2"
}, },
"last-updated": "2015-10-24T18:02:45+02:00" "last-updated": "2015-10-24T18:02:45+02:00"
} }
] ]
} }
}, },
{ {
"name": "ipv6-master", "name": "ipv6-master",
"address-family": "address-family":
"ietf-ipv6-unicast-routing-2:ipv6-unicast", "ietf-ipv6-unicast-routing:ipv6-unicast",
"default-rib": true, "default-rib": true,
"routes": { "routes": {
"route": [ "route": [
{ {
"ietf-ipv6-unicast-routing-2:destination-prefix": "ietf-ipv6-unicast-routing:destination-prefix":
"2001:db8:0:1::/64", "2001:db8:0:1::/64",
"next-hop": { "next-hop": {
"outgoing-interface": "eth0" "outgoing-interface": "eth0"
}, },
"source-protocol": "ietf-routing-2:direct", "source-protocol": "ietf-routing:direct",
"route-preference": 0, "route-preference": 0,
"last-updated": "2015-10-24T17:11:27+02:00" "last-updated": "2015-10-24T17:11:27+02:00"
}, },
{ {
"ietf-ipv6-unicast-routing-2:destination-prefix": "ietf-ipv6-unicast-routing:destination-prefix":
"2001:db8:0:2::/64", "2001:db8:0:2::/64",
"next-hop": { "next-hop": {
"outgoing-interface": "eth1" "outgoing-interface": "eth1"
}, },
"source-protocol": "ietf-routing-2:direct", "source-protocol": "ietf-routing:direct",
"route-preference": 0, "route-preference": 0,
"last-updated": "2015-10-24T17:11:27+02:00" "last-updated": "2015-10-24T17:11:27+02:00"
}, },
{ {
"ietf-ipv6-unicast-routing-2:destination-prefix": "ietf-ipv6-unicast-routing:destination-prefix":
"::/0", "::/0",
"next-hop": { "next-hop": {
"ietf-ipv6-unicast-routing-2:next-hop-address": "ietf-ipv6-unicast-routing:next-hop-address":
"2001:db8:0:1::2" "2001:db8:0:1::2"
}, },
"source-protocol": "ietf-routing-2:static", "source-protocol": "ietf-routing:static",
"route-preference": 5, "route-preference": 5,
"last-updated": "2015-10-24T18:02:45+02:00" "last-updated": "2015-10-24T18:02:45+02:00"
} }
] ]
} }
} }
] ]
} }
}, },
} }
Acknowledgments Acknowledgments
The authors wish to thank Nitin Bahadur, Martin Bjorklund, Dean The authors wish to thank Nitin Bahadur, Martin Bjorklund, Dean
Bogdanovic, Jeff Haas, Joel Halpern, Wes Hardaker, Sriganesh Kini, Bogdanovic, Jeff Haas, Joel Halpern, Wes Hardaker, Sriganesh Kini,
David Lamparter, Andrew McGregor, Jan Medved, Xiang Li, Stephane David Lamparter, Andrew McGregor, Jan Medved, Xiang Li, Stephane
Litkowski, Thomas Morin, Tom Petch, Yingzhen Qu, Bruno Rijsman, Litkowski, Thomas Morin, Tom Petch, Yingzhen Qu, Bruno Rijsman,
 End of changes. 132 change blocks. 
1857 lines changed or deleted 759 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/