draft-ietf-netmod-routing-cfg-05.txt   draft-ietf-netmod-routing-cfg-06.txt 
NETMOD L. Lhotka NETMOD L. Lhotka
Internet-Draft CZ.NIC Internet-Draft CZ.NIC
Intended status: Standards Track October 4, 2012 Intended status: Standards Track November 15, 2012
Expires: April 7, 2013 Expires: May 19, 2013
A YANG Data Model for Routing Configuration A YANG Data Model for Routing Management
draft-ietf-netmod-routing-cfg-05 draft-ietf-netmod-routing-cfg-06
Abstract Abstract
This document contains a specification of three YANG modules. This document contains a specification of three YANG modules.
Together they form the core routing data model which serves as a Together they form the core routing data model which serves as a
framework for configuring a routing subsystem. It is therefore framework for configuring and managing a routing subsystem. It is
expected that these modules will be augmented by additional YANG expected that these modules will be augmented by additional YANG
modules defining data models for individual routing protocols and modules defining data models for individual routing protocols and
other related functions. The core routing data model provides common other related functions. The core routing data model provides common
building blocks for such configurations - router instances, routes, building blocks for such extensions - router instances, routes,
routing tables, routing protocols and route filters. routing tables, routing protocols and route filters.
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 April 7, 2013. This Internet-Draft will expire on May 19, 2013.
Copyright Notice Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the Copyright (c) 2012 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
skipping to change at page 2, line 13 skipping to change at page 2, line 13
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 . . . . . . . . . . . . . . . . . . . 4
2.1. Glossary of New Terms . . . . . . . . . . . . . . . . . . 4 2.1. Glossary of New Terms . . . . . . . . . . . . . . . . . . 4
2.2. Prefixes in Data Node Names . . . . . . . . . . . . . . . 5 2.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 5
3. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.3. Prefixes in Data Node Names . . . . . . . . . . . . . . . 5
4. The Design of the Core Routing Data Model . . . . . . . . . . 7 3. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.1. Router . . . . . . . . . . . . . . . . . . . . . . . . . . 10 4. The Design of the Core Routing Data Model . . . . . . . . . . 8
4.1. Router . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.1.1. Configuration of IPv6 Router Interfaces . . . . . . . 11 4.1.1. Configuration of IPv6 Router Interfaces . . . . . . . 11
4.2. Routes . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4.2. Routes . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.3. Routing Tables . . . . . . . . . . . . . . . . . . . . . . 12 4.3. Routing Tables . . . . . . . . . . . . . . . . . . . . . . 13
4.4. Routing Protocols . . . . . . . . . . . . . . . . . . . . 14 4.4. Routing Protocols . . . . . . . . . . . . . . . . . . . . 15
4.4.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . . 15 4.4.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . . 15
4.4.2. Defining New Routing Protocols . . . . . . . . . . . . 15 4.4.2. Defining New Routing Protocols . . . . . . . . . . . . 16
4.5. Route Filters . . . . . . . . . . . . . . . . . . . . . . 18 4.5. Route Filters . . . . . . . . . . . . . . . . . . . . . . 17
4.6. RPC Operations . . . . . . . . . . . . . . . . . . . . . . 19 4.6. RPC Operations . . . . . . . . . . . . . . . . . . . . . . 18
5. Interactions with Other YANG Modules . . . . . . . . . . . . . 20 5. Interactions with Other YANG Modules . . . . . . . . . . . . . 19
5.1. Module "ietf-interfaces" . . . . . . . . . . . . . . . . . 20 5.1. Module "ietf-interfaces" . . . . . . . . . . . . . . . . . 19
5.2. Module "ietf-ip" . . . . . . . . . . . . . . . . . . . . . 20 5.2. Module "ietf-ip" . . . . . . . . . . . . . . . . . . . . . 19
6. Routing YANG Module . . . . . . . . . . . . . . . . . . . . . 22 6. Routing YANG Module . . . . . . . . . . . . . . . . . . . . . 21
7. IPv4 Unicast Routing YANG Module . . . . . . . . . . . . . . . 36 7. IPv4 Unicast Routing YANG Module . . . . . . . . . . . . . . . 35
8. IPv6 Unicast Routing YANG Module . . . . . . . . . . . . . . . 40 8. IPv6 Unicast Routing YANG Module . . . . . . . . . . . . . . . 39
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 49 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 49
10. Security Considerations . . . . . . . . . . . . . . . . . . . 51 10. Security Considerations . . . . . . . . . . . . . . . . . . . 51
11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 52 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 52
12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 53 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 53
12.1. Normative References . . . . . . . . . . . . . . . . . . . 53 12.1. Normative References . . . . . . . . . . . . . . . . . . . 53
12.2. Informative References . . . . . . . . . . . . . . . . . . 53 12.2. Informative References . . . . . . . . . . . . . . . . . . 53
Appendix A. Example: Adding a New Routing Protocol . . . . . . . 54 Appendix A. The Complete Data Tree . . . . . . . . . . . . . . . 54
Appendix B. Example: NETCONF <get> Reply . . . . . . . . . . . . 56 Appendix B. Example: Adding a New Routing Protocol . . . . . . . 56
Appendix C. Change Log . . . . . . . . . . . . . . . . . . . . . 61 Appendix C. Example: NETCONF <get> Reply . . . . . . . . . . . . 59
C.1. Changes Between Versions -04 and -05 . . . . . . . . . . . 61 Appendix D. Change Log . . . . . . . . . . . . . . . . . . . . . 64
C.2. Changes Between Versions -03 and -04 . . . . . . . . . . . 61 D.1. Changes Between Versions -05 and -06 . . . . . . . . . . . 64
C.3. Changes Between Versions -02 and -03 . . . . . . . . . . . 62 D.2. Changes Between Versions -04 and -05 . . . . . . . . . . . 64
C.4. Changes Between Versions -01 and -02 . . . . . . . . . . . 62 D.3. Changes Between Versions -03 and -04 . . . . . . . . . . . 65
C.5. Changes Between Versions -00 and -01 . . . . . . . . . . . 63 D.4. Changes Between Versions -02 and -03 . . . . . . . . . . . 65
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 64 D.5. Changes Between Versions -01 and -02 . . . . . . . . . . . 66
D.6. Changes Between Versions -00 and -01 . . . . . . . . . . . 66
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 68
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 Module "ietf-routing" provides generic components of a routing o Module "ietf-routing" provides generic components of a routing
data model. data model.
o Module "ietf-ipv4-unicast-routing" augments the "ietf-routing" o Module "ietf-ipv4-unicast-routing" augments the "ietf-routing"
module with additional data specific to IPv4 unicast. module with additional data specific to IPv4 unicast.
o Module "ietf-ipv6-unicast-routing" augments the "ietf-routing" o Module "ietf-ipv6-unicast-routing" augments the "ietf-routing"
module with additional data specific to IPv6 unicast, including module with additional data specific to IPv6 unicast, including
the router configuration variables required by [RFC4861]. the 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 proposed as a basis for the development of data models for which is proposed as a basis for the development of data models for
more sophisticated routing configurations. While these three modules configuration and management of more sophisticated routing systems.
can be directly used for simple IP devices with static routing, their While these three modules can be directly used for simple IP devices
main purpose is to provide essential building blocks for more with static routing, their main purpose is to provide essential
complicated setups involving multiple routing protocols, multicast building blocks for more complicated setups involving multiple
routing, additional address families, and advanced functions such as routing protocols, multicast routing, additional address families,
route filtering or policy routing. To this end, it is expected that and advanced functions such as route filtering or policy routing. To
the core routing data model will be augmented by numerous modules this end, it is expected that the core routing data model will be
developed by other IETF working groups. augmented by numerous modules developed by other IETF working groups.
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 4, line 27 skipping to change at page 4, line 27
o protocol operation o protocol operation
o server o server
The following terms are defined in [RFC6020]: The following terms are defined in [RFC6020]:
o augment o augment
o configuration data o configuration data
o container
o data model o data model
o data node o data node
o data type
o identity
o mandatory node o mandatory node
o module o module
o operational state data o state data
o prefix
o RPC operation o RPC operation
2.1. Glossary of New Terms 2.1. Glossary of New Terms
active route: a route which is actually used for sending packets. active route: a route which is actually used for sending packets.
If there are multiple candidate routes with a matching destination If there are multiple candidate routes with a matching destination
prefix, then it is up to the routing algorithm to select the prefix, then it is up to the routing algorithm to select the
active route (or several active routes in the case of multi-path active route (or several active routes in the case of multi-path
routing). routing).
core routing data model: YANG data model resulting from the core routing data model: YANG data model resulting from the
combination of "ietf-routing", "ietf-ipv4-unicast-routing" and combination of "ietf-routing", "ietf-ipv4-unicast-routing" and
"ietf-ipv6-unicast-routing" modules. "ietf-ipv6-unicast-routing" modules.
skipping to change at page 5, line 16 skipping to change at page 5, line 7
prefix, then it is up to the routing algorithm to select the prefix, then it is up to the routing algorithm to select the
active route (or several active routes in the case of multi-path active route (or several active routes in the case of multi-path
routing). routing).
core routing data model: YANG data model resulting from the core routing data model: YANG data model resulting from the
combination of "ietf-routing", "ietf-ipv4-unicast-routing" and combination of "ietf-routing", "ietf-ipv4-unicast-routing" and
"ietf-ipv6-unicast-routing" modules. "ietf-ipv6-unicast-routing" modules.
direct route: a route to a directly connected network. direct route: a route to a directly connected network.
2.2. Prefixes in Data Node Names 2.2. Tree Diagrams
A simplified graphical representation of the complete data tree is
presented in Appendix A, and similar diagrams of its various subtrees
appear in the main text. The meaning of the symbols in these
diagrams is as follows:
o Brackets "[" and "]" enclose list keys.
o Abbreviations before data node names: "rw" means configuration
(read-write) and "ro" state data (read-only).
o Symbols after data node names: "?" means an optional node and "*"
denotes a "leaf-list".
o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not
shown.
2.3. Prefixes in Data Node Names
In this document, names of data nodes, RPC methods and other data In this document, names of data nodes, RPC methods and other data
model objects are used mostly without a prefix, as long as it is model objects are used mostly without a prefix, as long as it is
clear from the context in which YANG module each name is defined. clear from the context in which YANG module each name is defined.
Otherwise, names are prefixed using the standard prefix associated Otherwise, names are prefixed using the standard prefix associated
with the corresponding YANG module, as shown in Table 1. with the corresponding YANG module, as shown in Table 1.
+--------+---------------------------+--------------+ +--------+---------------------------+--------------+
| Prefix | YANG module | Reference | | Prefix | YANG module | Reference |
+--------+---------------------------+--------------+ +--------+---------------------------+--------------+
| ianaaf | iana-afn-safi | [IANA-IF-AF] | | ianaaf | iana-afn-safi | [IANA-IF-AF] |
| | | | | | | |
| if | ietf-interfaces | [YANG-IF] | | if | ietf-interfaces | [YANG-IF] |
| | | | | | | |
| ip | ietf-ip | [YANG-IP] | | ip | ietf-ip | [YANG-IP] |
| | | | | | | |
| rip | example-rip | Appendix A | | rip | example-rip | Appendix B |
| | | | | | | |
| rt | ietf-routing | Section 6 | | rt | ietf-routing | Section 6 |
| | | | | | | |
| v4ur | ietf-ipv4-unicast-routing | Section 7 | | v4ur | ietf-ipv4-unicast-routing | Section 7 |
| | | | | | | |
| v6ur | ietf-ipv6-unicast-routing | Section 8 | | v6ur | ietf-ipv6-unicast-routing | Section 8 |
| | | | | | | |
| yang | ietf-yang-types | [RFC6021] | | yang | ietf-yang-types | [RFC6021] |
| | | | | | | |
| inet | ietf-inet-types | [RFC6021] | | inet | ietf-inet-types | [RFC6021] |
skipping to change at page 7, line 12 skipping to change at page 8, line 12
flexible enough to facilitate such a mapping and accommodate data flexible enough to facilitate such a mapping and accommodate data
models with different logic. models with different 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. The The core routing data model consists of three YANG modules. The
first module, "ietf-routing", defines the generic components of a first module, "ietf-routing", defines the generic components of a
routing system. The other two modules, "ietf-ipv4-unicast-routing" routing system. The other two modules, "ietf-ipv4-unicast-routing"
and "ietf-ipv6-unicast-routing", augment the "ietf-routing" module and "ietf-ipv6-unicast-routing", augment the "ietf-routing" module
with additional data nodes that are needed for IPv4 and IPv6 unicast with additional data nodes that are needed for IPv4 and IPv6 unicast
routing, respectively. The combined data hierarchy is shown in routing, respectively. An abridged view of the data hierarchy is
Figure 1, where brackets enclose list keys, "rw" means configuration, given in Figure 1. See Appendix A for the complete data tree.
"ro" operational state data, and "?" means optional node.
Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
+--rw routing +--rw routing
+--rw router [name] +--rw router [name]
| +--rw name | +--rw name
| +--rw type? | +--rw type?
| +--rw enabled? | +--rw enabled?
| +--rw router-id? | +--rw router-id?
| +--rw description? | +--rw description?
| +--rw main-routing-tables | +--rw main-routing-tables
| | +--rw main-routing-table [address-family safi] | | +--rw main-routing-table [address-family safi]
| | +--rw address-family | | +--rw address-family
| | +--rw safi | | +--rw safi
| | +--rw name? | | +--rw name?
| +--rw interfaces | +--rw interfaces
| | +--rw interface [name] | | +--rw interface [name]
| | +--rw name | | +--rw name
| | +--rw v6ur:ipv6-router-advertisements | | +--rw v6ur:ipv6-router-advertisements
| | +--rw v6ur:send-advertisements? | | ...
| | +--rw v6ur:max-rtr-adv-interval?
| | +--rw v6ur:min-rtr-adv-interval?
| | +--rw v6ur:managed-flag?
| | +--rw v6ur:other-config-flag?
| | +--rw v6ur:link-mtu?
| | +--rw v6ur:reachable-time?
| | +--rw v6ur:retrans-timer?
| | +--rw v6ur:cur-hop-limit?
| | +--rw v6ur:default-lifetime?
| | +--rw v6ur:prefix-list
| | +--rw v6ur:prefix [prefix-spec]
| | +--rw v6ur:prefix-spec
| | +--rw (control-adv-prefixes)?
| | +--:(no-advertise)
| | | +--rw v6ur:no-advertise?
| | +--:(advertise)
| | +--rw v6ur:valid-lifetime?
| | +--rw v6ur:on-link-flag?
| | +--rw v6ur:preferred-lifetime?
| | +--rw v6ur:autonomous-flag?
| +--rw routing-protocols | +--rw routing-protocols
| +--rw routing-protocol [name] | +--rw routing-protocol [name]
| +--rw name | +--rw name
| +--rw description? | +--rw description?
| +--rw enabled? | +--rw enabled?
| +--rw type | +--rw type
| +--rw connected-routing-tables | +--rw connected-routing-tables
| | +--rw connected-routing-table [name] | | ...
| | +--rw name
| | +--rw import-filter?
| | +--rw export-filter?
| +--rw static-routes | +--rw static-routes
| +--rw v4ur:ipv4 | ...
| | +--rw v4ur:route [id]
| | +--rw v4ur:id
| | +--rw v4ur:description?
| | +--rw v4ur:outgoing-interface?
| | +--rw v4ur:dest-prefix
| | +--rw v4ur:next-hop?
| +--rw v6ur:ipv6
| +--rw v6ur:route [id]
| +--rw v6ur:id
| +--rw v6ur:description?
| +--rw v6ur:outgoing-interface?
| +--rw v6ur:dest-prefix
| +--rw v6ur:next-hop?
+--rw routing-tables +--rw routing-tables
| +--rw routing-table [name] | +--rw routing-table [name]
| +--rw name | +--rw name
| +--rw address-family | +--rw address-family
| +--rw safi | +--rw safi
| +--rw description? | +--rw description?
| +--ro routes | +--ro routes
| | +--ro route | | +--ro route
| | +--ro outgoing-interface? | | ...
| | +--ro source-protocol
| | +--ro last-updated?
| | +--ro v4ur:dest-prefix?
| | +--ro v4ur:next-hop?
| | +--ro v6ur:dest-prefix?
| | +--ro v6ur:next-hop?
| +--rw recipient-routing-tables | +--rw recipient-routing-tables
| +--rw recipient-routing-table [name] | +--rw recipient-routing-table [name]
| +--rw name | ...
| +--rw filter?
|
|
+--rw route-filters +--rw route-filters
+--rw route-filter [name] +--rw route-filter [name]
+--rw name +--rw name
+--rw description? +--rw description?
+--rw type +--rw type
Figure 1: Data hierarchy of the core routing data model. Figure 1: Data hierarchy of the core routing data model.
As can be seen from Figure 1, the core routing data model introduces As can be seen from Figure 1, the core routing data model introduces
several generic components of a routing framework: routers, routing several generic components of a routing framework: routers, routing
tables containing routes, routing protocols and route filters. The tables containing lists of routes, routing protocols and route
following subsections describe these components in more detail. filters. The following subsections describe these components in more
detail.
By combining the components in various ways, and possibly augmenting By combining the components in various ways, and possibly augmenting
them with appropriate contents defined in other modules, various them with appropriate contents defined in other modules, various
routing setups can be realized. routing setups can be realized.
+--------+ +--------+
| direct | +---+ +--------------+ +---+ +--------------+ | direct | +---+ +--------------+ +---+ +--------------+
| routes |--->| F |--->| |<---| F |<---| | | routes |--->| F |--->| |<---| F |<---| |
+--------+ +---+ | main | +---+ | additional | +--------+ +---+ | main | +---+ | additional |
| routing | | routing | | routing | | routing |
skipping to change at page 9, line 42 skipping to change at page 10, line 33
+---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+
| F | | F | | F | | F | | F | | F | | F | | F |
+---+ +---+ +---+ +---+ +---+ +---+ +---+ +---+
^ | ^ | ^ | ^ |
| v | v | v | v
+----------+ +----------+ +----------+ +----------+
| routing | | routing | | routing | | routing |
| protocol | | protocol | | protocol | | protocol |
+----------+ +----------+ +----------+ +----------+
Figure 2: Example setup of the routing subsystem Figure 2: Example setup of a routing system
The example in Figure 2 shows a typical (though certainly not the The example in Figure 2 shows a typical (though certainly not the
only possible) organization of a more complex routing subsystem for a only possible) organization of a more complex routing subsystem for a
single address family. Several of its features are worth mentioning: single address family. Several of its features are worth mentioning:
o Along with the main routing table, which must always be present, o Along with the main routing table, which must always be present,
an additional routing table is configured. an additional routing table is configured.
o Each routing protocol instance, including the "static" and o Each routing protocol instance, including the "static" and
"direct" pseudo-protocols, is connected to one routing table with "direct" pseudo-protocols, is connected to one routing table with
skipping to change at page 10, line 26 skipping to change at page 11, line 15
4.1. Router 4.1. Router
Each router instance in the core routing data model represents a Each router instance in the core routing data model represents a
logical router. The exact semantics of this term is left to logical router. The exact semantics of this term is left to
implementations. For example, router instances may be completely implementations. For example, router instances may be completely
isolated virtual routers or, alternatively, they may internally share isolated virtual routers or, alternatively, they may internally share
certain information. certain information.
An implementation MAY support multiple types of logical routers An implementation MAY support multiple types of logical routers
simultaneously. Instances of all router types are organized as simultaneously. Instances of all router types are organized as
entries of the same flat "router" list. In order to distinguish entries of the same flat "router" list. In order to discriminate
router instances belonging to the same type, the "type" leaf is router instances belonging to different types, the "type" leaf is
defined as a child of the "router" node. defined as a child of the "router" node.
An implementation MAY pose restrictions on allowed router types and An implementation MAY pose restrictions on allowed router types and
on the number of supported instances for each type. For example, a on the number of supported instances for each type. For example, a
simple router implementation may support only one router instance of simple router implementation may support only one router instance of
the default type "standard-router". the default type "standard-router".
Each network layer interface has to be assigned to one or more router Each network layer interface has to be assigned to one or more router
instances in order to be able to participate in packet forwarding, instances in order to be able to participate in packet forwarding,
routing protocols and other operations of those router instances. routing protocols and other operations of those router instances.
The assignment is accomplished by creating a corresponding entry in The assignment is accomplished by creating a corresponding entry in
the list of router interfaces ("rt:interface"). The key of the list the list of router interfaces ("rt:interface"). The key of the list
entry MUST be the name of a configured network layer interface, i.e., entry MUST be the name of a configured network layer interface, i.e.,
the value of a node /if:interfaces/if:interface/if:name defined in the value of a node /if:interfaces/if:interface/if:name defined in
the "ietf-interfaces" module [YANG-IF]. the "ietf-interfaces" module [YANG-IF].
In YANG terms, the list of router interfaces is modeled as the "list" In YANG terms, the list of router interfaces is modeled as the "list"
node rather than "leaf-list" in order to allow for adding, via node rather than "leaf-list" in order to allow for adding, via
augmentation, other configuration or operational state data related augmentation, other configuration or state data related to the
to the corresponding router interface. corresponding router interface.
Implementations MAY specify additional rules for the assignment of Implementations MAY specify additional rules for the assignment of
interfaces to logical routers. For example, it may be required that interfaces to logical routers. For example, it may be required that
the sets of interfaces assigned to different logical routers be the sets of interfaces assigned to different logical routers be
disjoint. disjoint.
4.1.1. Configuration of IPv6 Router Interfaces 4.1.1. Configuration of IPv6 Router Interfaces
The module "ietf-ipv6-unicast-routing" augments the definition of the The module "ietf-ipv6-unicast-routing" augments the definition of the
data node "rt:interface" with definitions of the following data node "rt:interface" with definitions of the following
skipping to change at page 11, line 31 skipping to change at page 12, line 20
o link-mtu, o link-mtu,
o reachable-time, o reachable-time,
o retrans-timer, o retrans-timer,
o cur-hop-limit, o cur-hop-limit,
o default-lifetime, o default-lifetime,
o prefix-list: a list of prefixes to be advertised. The following o prefix-list: a list of prefixes to be advertised.
parameters are associated with each prefix in the list:
The following parameters are associated with each prefix in the
list:
* valid-lifetime, * valid-lifetime,
* on-link-flag, * on-link-flag,
* preferred-lifetime, * preferred-lifetime,
* autonomous-flag. * autonomous-flag.
The definitions and descriptions of the above parameters can be found The definitions and descriptions of the above parameters can be found
in the text of the module "ietf-ipv6-unicast-routing" (Section 8). in the text of the module "ietf-ipv6-unicast-routing" (Section 8).
NOTES: NOTES:
1. The "IsRouter" flag, which is also required by [RFC4861], is 1. The "IsRouter" flag, which is also required by [RFC4861], is
implemented in the "ietf-ip" module [YANG-IP] (leaf "ip:ip- implemented in the "ietf-ip" module [YANG-IP] (leaf "ip:
forwarding"). forwarding").
2. The original specification [RFC4861] allows the implementations 2. The original specification [RFC4861] allows the implementations
to decide whether the "valid-lifetime" and "preferred-lifetime" to decide whether the "valid-lifetime" and "preferred-lifetime"
parameters remain the same in consecutive advertisements, or parameters remain the same in consecutive advertisements, or
decrement in real time. However, the latter behavior seems decrement in real time. However, the latter behavior seems
problematic because the values might be reset again to the problematic because the values might be reset again to the
(higher) configured values after a configuration is reloaded. (higher) configured values after a configuration is reloaded.
Moreover, no implementation is known to use the decrementing Moreover, no implementation is known to use the decrementing
behavior. The "ietf-ipv6-unicast-routing" module therefore behavior. The "ietf-ipv6-unicast-routing" module therefore
assumes the former behavior with constant values. assumes the former behavior with constant values.
4.2. Routes 4.2. Routes
Routes are basic units of information in a routing system. The core Routes are basic elements of information in a routing system. The
routing data model defines only the following minimal set of route core routing data model defines only the following minimal set of
attributes: route attributes:
o "destination-prefix": IP prefix specifying the set of destination o "destination-prefix": IP prefix specifying the set of destination
addresses for which the route may be used. This attribute is addresses for which the route may be used. This attribute is
mandatory. mandatory.
o "next-hop": IP address of an adjacent router or host to which o "next-hop": IP address of an adjacent router or host to which
packets with destination addresses belonging to "destination- packets with destination addresses belonging to "destination-
prefix" should be sent. prefix" should be sent.
o "outgoing-interface": network interface that should be used for o "outgoing-interface": network interface that should be used for
sending packets with destination addresses belonging to sending packets with destination addresses belonging to
"destination-prefix". "destination-prefix".
The above list of route attributes suffices for a simple static The above list of route attributes suffices for a simple static
routing configuration. It is expected that future modules defining routing configuration. It is expected that future modules defining
routing protocols will add other route attributes such as metrics or routing protocols will add other route attributes such as metrics or
preferences. preferences.
Routes and their attributes are used both in configuration data, for Routes and their attributes are used both in configuration data, for
example as manually configured static routes, and in operational example as manually configured static routes, and in state data, for
state data, for example as entries in routing tables. example as entries in routing tables.
4.3. Routing Tables 4.3. Routing Tables
Routing tables are lists of routes complemented with administrative Routing tables are lists of routes complemented with administrative
data, namely: data, namely:
o "source-protocol": name of the routing protocol from which the o "source-protocol": name of the routing protocol from which the
route was originally obtained. route was originally obtained.
o "last-updated": the date and time when the route was last updated, o "last-updated": the date and time when the route was last updated,
or inserted into the routing table. or inserted into the routing table.
Each routing table may contain only routes of the same address Each routing table must contain only routes of the same address
family. Address family information consists of two parameters - family. Address family information consists of two parameters -
"address-family" and "safi" (Subsequent Address Family Identifier, "address-family" and "safi" (Subsequent Address Family Identifier,
SAFI). The permitted values for these two parameters are defined by SAFI). The permitted values for these two parameters are defined by
IANA and represented using YANG enumeration types "ianaaf:address- IANA and represented using YANG enumeration types "ianaaf:address-
family" and "ianaaf:subsequent-address-family" [IANA-IF-AF]. family" and "ianaaf:subsequent-address-family" [IANA-IF-AF].
In the core routing data model, the "routing-table" node represents In the core routing data model, the "routing-table" node represents
configuration while the descendant list of routes is defined as configuration while the descendant list of routes is defined as state
operational state data. The contents of route lists are controlled data. The contents of route lists are controlled and manipulated by
and manipulated by routing protocol operations which may result in routing protocol operations which may result in route additions,
route additions, removals and modifications. This also includes removals and modifications. This also includes manipulations via the
manipulations via the "static" and/or "direct" pseudo-protocols, see "static" and/or "direct" pseudo-protocols, see Section 4.4.1.
Section 4.4.1.
One or more routing tables MUST be configured for each address family
supported by the server. Each router instance MUST designate, for
every address family that the router instance supports, exactly one
routing table as its main routing table. This is accomplished by
creating an entry in the "main-routing-table" list, which contains a
reference to the routing table that is selected as main.
Main routing tables serve the following purposes:
o The router instance always installs direct routes for an address
family to that address family's main routing table.
o By default, a routing protocol SHOULD be connected to the main In order to activate an address family for use within a router
routing table of each address family supported by that routing instance, a client configures an entry of the list /routing/router/
protocol. See Section 4.4 for further explanation. main-routing-tables/main-routing-table. This entry contains a
reference to a routing table which henceforth serves as the so-called
main routing table for the router instance and address family.
Section 4.4 explains the role of main routing tables.
Routing tables are global, which means that a configured routing Routing tables are global, which means that a configured routing
table may be used by any or all router instances. table may be used by any or all router instances.
Server implementations MAY pose restrictions regarding the number of Server implementations MAY pose restrictions regarding the number of
supported routing tables, and rules for configuration and use of supported routing tables, and rules for configuration and use of
routing tables. For example: routing tables. For example:
o A server may support no more than one routing table per address o A server may support no more than one routing table per address
family. family.
o Router instances (of a certain type) may not be allowed to share o Router instances (of a certain type) may not be allowed to share
routing tables, i.e., each routing table is used by no more than routing tables, i.e., each routing table is used by no more than
one router instance. one router instance.
For servers supporting multiple routing tables per address family, For servers supporting multiple routing tables per address family,
additional tables can be configured by creating new entries in the additional tables can be configured by creating new entries in the
"routing-table" list, either as a part of factory-default "routing-table" list, either as a part of factory-default
configuration, or by a client's action. configuration, or by a client's action.
The way how the routing system uses information from routing tables The way how a routing system uses information from routing tables for
for actual packet forwarding is outside the scope of this document. actual packet forwarding is outside the scope of this document.
Every routing table can serve as a source of routes for other routing Every routing table can serve as a source of routes for other routing
tables. To achieve this, one or more recipient routing tables may be tables. To achieve this, one or more recipient routing tables may be
specified in the configuration of the source routing table. specified in the configuration of the source routing table.
Optionally, a route filter may be configured for any or all recipient Optionally, a route filter may be configured for any or all recipient
routing tables. Such a route filter then selects and/or manipulates routing tables. Such a route filter then selects and/or manipulates
the routes that are passed on between the source and recipient the routes that are passed between the source and recipient routing
routing table. table.
A routing table MUST NOT appear among its own recipient routing A routing table MUST NOT appear among its own recipient routing
tables. A recipient routing table also MUST be of the same address tables. A recipient routing table also MUST be of the same address
family as its source routing table.Consequently, configuration of family as its source routing table. Consequently, configuration of
recipient routing tables makes sense only for servers supporting recipient routing tables makes sense only for servers supporting
multiple routing tables per address family. Servers supporting only multiple routing tables per address family. Servers supporting only
one routing table per address family MAY therefore decide to remove one routing table per address family MAY therefore decide to remove
the container "recipient-routing-tables", together with its contents, the container "recipient-routing-tables", together with its contents,
from the data model. from the data model.
4.4. Routing Protocols 4.4. Routing Protocols
The core routing data model provides an open-ended framework for The core routing data model provides an open-ended framework for
defining multiple routing protocol instances within each router defining multiple routing protocol instances within each router
instance. Each routing protocol instance MUST be assigned a type, instance. Each routing protocol instance MUST be assigned a type,
which is an identity derived from the "rt:routing-protocol" base which is an identity derived from the "rt:routing-protocol" base
identity. The core routing data model defines two identities for the identity. The core routing data model defines two identities for the
direct and static pseudo-protocols (Section 4.4.1). direct and static pseudo-protocols (Section 4.4.1).
Each routing protocol instance is connected to exactly one routing Each routing protocol instance is connected to exactly one routing
table for each address family that the routing protocol instance table for each address family that the routing protocol instance
supports. By default, every routing protocol instance SHOULD be supports. Routes learned from the network by a routing protocol are
connected to the main routing table or tables. An implementation MAY normally installed into the connected routing table(s) and,
allow any or all routing protocol instances to be configured to use a conversely, routes from the connected routing table(s) are normally
different routing table. injected into the routing protocol. However, routing protocol
implementations MAY specify rules that restrict this exchange of
routes in either direction (or both directions).
Routes learned from the network by a routing protocol are passed to A routing table is connected to a routing protocol instance by
the connected routing table(s) and vice versa, subject to routing creating a corresponding entry in the "connected-routing-table" list.
protocol specific rules and restrictions. If such an entry is not configured for an address family, then the
main routing table MUST be used as the connected routing table for
this address family.
In addition, two independent route filters (see Section 4.5) may be In addition, two independent route filters (see Section 4.5) may be
defined for a routing protocol instance to control the exchange of configured for each connected routing table to apply client-defined
routes in both directions between the routing protocol instance and policies controlling the exchange of routes in both directions
the connected routing table: between the routing protocol instance and the connected routing
table:
o import filter controls which routes are passed from a routing o import filter controls which routes are passed from the routing
protocol instance to the connected routing table, protocol instance to the connected routing table,
o export filter controls which routes the routing protocol instance o export filter controls which routes the routing protocol instance
may receive from the connected routing table. receives from the connected routing table.
Note that, for historical reasons, the terms import and export are Note that the terms import and export are used from the viewpoint of
used from the viewpoint of a routing table. a routing table.
4.4.1. Routing Pseudo-Protocols 4.4.1. Routing Pseudo-Protocols
The core routing data model defines two special routing protocol The core routing data model defines two special routing protocol
types - "direct" and "static". Both are in fact pseudo-protocols, types - "direct" and "static". Both are in fact pseudo-protocols,
which means that they are confined to the local device and do not which means that they are confined to the local device and do not
exchange any routing information with neighboring routers. Routes exchange any routing information with neighboring routers. Routes
from both "direct" and "static" protocol instances are passed to the from both "direct" and "static" protocol instances are passed to the
connected routing table (subject to route filters, if any), but an connected routing table (subject to route filters, if any), but an
exchange in the opposite direction is not allowed. exchange in the opposite direction is not allowed.
Every router instance MUST implement exactly one instance of the Every router instance MUST implement exactly one instance of the
"direct" pseudo-protocol type. The name of this instance MUST also "direct" pseudo-protocol type. The name of this instance MUST also
be "direct". It is the source of direct routes for all configured be "direct". It is the source of direct routes for all configured
address families. Direct routes are normally supplied by the address families. Direct routes are normally supplied by the
operating system kernel, based on the configuration of network operating system kernel, based on the configuration of network
interface addresses, see Section 5.2. The "direct" pseudoprotocol interface addresses, see Section 5.2. The "direct" pseudo-protocol
MUST always be connected to the main routing tables of all supported MUST always be connected to the main routing tables of all supported
address families. This means that direct routes are always installed address families. Unlike other routing protocol types, this
in the main routing tables. However, direct routes MAY be filtered connection cannot be changed in the configuration. Direct routes MAY
before they appear in the main routing table. be filtered before they appear in the main routing table.
A pseudo-protocol of the type "static" allows for specifying routes A pseudo-protocol of the type "static" allows for specifying routes
manually. It MAY be configured in zero or multiple instances, manually. It MAY be configured in zero or multiple instances,
although a typical configuration will have exactly one instance per although a typical configuration will have exactly one instance per
logical router. logical router.
Static routes are configured within the "static-routes" container,
see Figure 3.
+--rw static-routes
+--rw v4ur:ipv4
| +--rw v4ur:route [id]
| +--rw v4ur:id
| +--rw v4ur:description?
| +--rw v4ur:outgoing-interface?
| +--rw v4ur:dest-prefix
| +--rw v4ur:next-hop?
+--rw v6ur:ipv6
+--rw v6ur:route [id]
+--rw v6ur:id
+--rw v6ur:description?
+--rw v6ur:outgoing-interface?
+--rw v6ur:dest-prefix
+--rw v6ur:next-hop?
Figure 3: Structure of "static-routes" subtree.
4.4.2. Defining New Routing Protocols 4.4.2. Defining New Routing Protocols
It is expected that future YANG modules will create data models for It is expected that future YANG modules will create data models for
additional routing protocol types. Such a new module has to define additional routing protocol types. Such a new module has to define
the protocol-specific configuration and operational state data, and the protocol-specific configuration and state data, and it has to fit
it has to fit it into the core routing framework in the following it into the core routing framework in the following way:
way:
o A new identity MUST be defined for the routing protocol and its o A new identity MUST be defined for the routing protocol and its
base identity MUST be set to "rt:routing-protocol", or to an base identity MUST be set to "rt:routing-protocol", or to an
identity derived from "rt:routing-protocol". identity derived from "rt:routing-protocol".
o Additional route attributes MAY be defined, preferably in one o Additional route attributes MAY be defined, preferably in one
place by means of defining a YANG grouping. The new attributes place by means of defining a YANG grouping. The new attributes
have to be inserted as operational state data by augmenting the have to be inserted as state data by augmenting the definition of
definition of the node the node
/rt:routing-tables/rt:routing-table/rt:route,
and possibly to other places in the configuration, operational /rt:routing-tables/rt:routing-table/rt:route,
state data and RPC input or output.
and possibly to other places in the configuration, state data and
RPC input or output.
o Per-interface configuration parameters can be added by augmenting o Per-interface configuration parameters can be added by augmenting
the data node "rt:interface" (the list of router interfaces). the data node "rt:interface" (the list of router interfaces).
o Other configuration parameters and operational state data can be o Other configuration parameters and state data can be defined by
defined by augmenting the "routing-protocol" data node. augmenting the "routing-protocol" data node.
By using the "when" statement, the augmented per-interface and other By using the "when" statement, the augmented per-interface and other
configuration parameters specific to the new protocol SHOULD be made configuration parameters specific to the new protocol SHOULD be made
conditional and valid only if the value of "rt:type" is equal to the conditional and valid only if the value of "rt:type" is equal to the
new protocol's identity. It is also RECOMMENDED that the protocol- new protocol's identity. It is also RECOMMENDED that the protocol-
specific data be encapsulated in appropriately named containers. specific data be encapsulated in appropriately named containers.
The above steps are implemented by the example YANG module for the The above steps are implemented by the example YANG module for the
RIP routing protocol in Appendix A. First, the module defines a new RIP routing protocol in Appendix B.
identity for the RIP protocol:
identity rip {
base rt:routing-protocol;
description "Identity for the RIP routing protocol.";
}
New route attributes specific to the RIP protocol ("metric" and
"tag") are defined in a grouping and then added to the route
definitions appearing in "routing-table" and in the output part of
the "active-route" RPC method:
grouping route-content {
description
"RIP-specific route content.";
leaf metric {
type rip-metric;
}
leaf tag {
type uint16;
default "0";
description
"This leaf may be used to carry additional info, e.g. AS
number.";
}
}
augment "/rt:routing/rt:routing-tables/rt:routing-table/"
+ "rt:routes/rt:route" {
description
"RIP-specific route components.";
uses route-content;
}
augment "/rt:active-route/rt:output/rt:route" {
description
"Add RIP-specific route content.";
uses route-content;
}
Per-interface configuration data are defined by the following
"augment" statement:
augment "/rt:routing/rt:router/rt:interfaces/rt:interface" {
when "../../rt:routing-protocols/rt:routing-protocol/rt:type = "
+ "'rip:rip'";
container rip {
description
"Per-interface RIP configuration.";
leaf enabled {
type boolean;
default "true";
}
leaf metric {
type rip-metric;
default "1";
}
}
}
Finally, global RIP configuration data are integrated into the "rt:
routing-protocol" node by using the following "augment" statement,
which is again valid only for routing protocol instances whose type
is "rip:rip":
augment "/rt:routing/rt:router/rt:routing-protocols/"
+ "rt:routing-protocol" {
when "rt:type = 'rip:rip'";
container rip {
leaf update-interval {
type uint8 {
range "10..60";
}
units "seconds";
default "30";
description
"Time interval between periodic updates.";
}
}
}
4.5. Route Filters 4.5. Route Filters
The core routing data model provides a skeleton for defining route The core routing data model provides a skeleton for defining route
filters that can be used to restrict the set of routes being filters that can be used to restrict the set of routes being
exchanged between a routing protocol instance and a connected routing exchanged between a routing protocol instance and a connected routing
table, or between a source and a recipient routing table. Route table, or between a source and a recipient routing table. Route
filters may also manipulate routes, i.e., add, delete, or modify filters may also manipulate routes, i.e., add, delete, or modify
their attributes. their attributes.
skipping to change at page 20, line 8 skipping to change at page 19, line 8
o active-route: query the routing system for the active route(s) o active-route: query the routing system for the active route(s)
that are currently used for sending datagrams to a destination that are currently used for sending datagrams to a destination
host whose address is passed as an input parameter. host whose address is passed as an input parameter.
o route-count: retrieve the total number of entries in a routing o route-count: retrieve the total number of entries in a routing
table. table.
5. Interactions with Other YANG Modules 5. Interactions with Other YANG Modules
The semantics of the core routing data model also depend on several The semantics of the core routing data model also depend on several
configuration parameters that are defined in other YANG modules. The configuration parameters that are defined in other YANG modules.
following subsections describe these interactions.
In all cases, the relevant parts of the core routing data model are
disabled but MUST NOT be deleted from the configuration by the
server.
5.1. Module "ietf-interfaces" 5.1. Module "ietf-interfaces"
The following boolean switch is defined in the "ietf-interfaces" YANG The following boolean switch is defined in the "ietf-interfaces" YANG
module [YANG-IF]: module [YANG-IF]:
/if:interfaces/if:interface/if:enabled /if:interfaces/if:interface/if:enabled
If this switch is set to "false" for a given network layer If this switch is set to "false" for a given network layer
interface, the device MUST behave exactly as if that interface was interface, the device MUST behave exactly as if that interface was
skipping to change at page 20, line 36 skipping to change at page 19, line 31
5.2. Module "ietf-ip" 5.2. Module "ietf-ip"
The following boolean switches are defined in the "ietf-ip" YANG The following boolean switches are defined in the "ietf-ip" YANG
module [YANG-IP]: module [YANG-IP]:
/if:interfaces/if:interface/ip:ipv4/ip:enabled /if:interfaces/if:interface/ip:ipv4/ip:enabled
If this switch is set to "false" for a given interface, then all If this switch is set to "false" for a given interface, then all
IPv4 routing functions related to that interface MUST be disabled. IPv4 routing functions related to that interface MUST be disabled.
/if:interfaces/if:interface/ip:ipv4/ip:ip-forwarding /if:interfaces/if:interface/ip:ipv4/ip:forwarding
If this switch is set to "false" for a given interface, then the If this switch is set to "false" for a given interface, then the
forwarding of IPv4 datagrams to and from this interface MUST be forwarding of IPv4 datagrams to and from this interface MUST be
disabled. However, the interface may participate in other routing disabled. However, the interface may participate in other routing
functions, such as routing protocols. functions, such as routing protocols.
/if:interfaces/if:interface/ip:ipv6/ip:enabled /if:interfaces/if:interface/ip:ipv6/ip:enabled
If this switch is set to "false" for a given interface, then all If this switch is set to "false" for a given interface, then all
IPv6 routing functions related to that interface MUST be disabled. IPv6 routing functions related to that interface MUST be disabled.
/if:interfaces/if:interface/ip:ipv6/ip:ip-forwarding /if:interfaces/if:interface/ip:ipv6/ip:forwarding
If this switch is set to "false" for a given interface, then the If this switch is set to "false" for a given interface, then the
forwarding of IPv6 datagrams to and from this interface MUST be forwarding of IPv6 datagrams to and from this interface MUST be
disabled. However, the interface may participate in other routing disabled. However, the interface may participate in other routing
functions, such as routing protocols. functions, such as routing protocols.
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 subnet masks on network layer interfaces. IPv6 addresses and subnet masks on network layer interfaces.
Configuration of these parameters on an enabled interface MUST result Configuration of these parameters on an enabled interface MUST result
in an immediate creation of the corresponding direct route (usually in an immediate creation of the corresponding direct route. The
in the main routing table). Its destination prefix is set according destination prefix of this route is set according to the configured
to the configured IP address and subnet mask, and the interface is IP address and subnet mask, and the interface is set as the outgoing
set as the outgoing interface for that route. interface for that route.
6. Routing YANG Module 6. Routing YANG Module
RFC Ed.: In this section, replace all occurrences of 'XXXX' with the RFC Ed.: In this section, replace all occurrences of 'XXXX' with the
actual RFC number and all occurrences of the revision date below with actual RFC number and all occurrences of the revision date below with
the date of RFC publication (and remove this note). the date of RFC publication (and remove this note).
<CODE BEGINS> file "ietf-routing@2012-10-04.yang" <CODE BEGINS> file "ietf-routing@2012-11-15.yang"
module ietf-routing { module ietf-routing {
namespace "urn:ietf:params:xml:ns:yang:ietf-routing"; 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";
} }
skipping to change at page 23, line 21 skipping to change at page 22, line 21
without modification, is permitted pursuant to, and subject to without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions 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 the This version of this YANG module is part of RFC XXXX; see the
RFC itself for full legal notices. RFC itself for full legal notices.
"; ";
revision 2012-10-04 { revision 2012-11-15 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: A YANG Data Model for Routing Configuration"; "RFC XXXX: A YANG Data Model for Routing Management";
} }
/* Identities */ /* Identities */
identity router-type { identity router-type {
description description
"Base identity from which router type identities are derived. "Base identity from which router type identities are derived.
It is primarily intended for discriminating among different It is primarily intended for discriminating among different
types of logical routers or router virtualization. types of logical routers or router virtualization.
skipping to change at page 24, line 30 skipping to change at page 23, line 30
identity deny-all-route-filter { identity deny-all-route-filter {
base route-filter; base route-filter;
description description
"Route filter that blocks all routes."; "Route filter that blocks all routes.";
} }
identity allow-all-route-filter { identity allow-all-route-filter {
base route-filter; base route-filter;
description description
"Route filter that permits all routes. "Route filter that permits all routes.";
";
} }
/* Type Definitions */ /* Type Definitions */
typedef router-ref { typedef router-ref {
type leafref { type leafref {
path "/rt:routing/rt:router/rt:name"; path "/rt:routing/rt:router/rt:name";
} }
description description
"This type is used for leafs that reference a router "This type is used for leafs that reference a router
instance."; instance.";
} }
typedef routing-table-ref {
type leafref {
path "/rt:routing/rt:routing-tables/rt:routing-table/rt:name";
}
description
"This type is used for leafs that reference a routing table.";
}
typedef route-filter-ref {
type leafref {
path "/rt:routing/rt:route-filters/rt:route-filter/rt:name";
}
description
"This type is used for leafs that reference a route filter.";
}
/* Groupings */ /* Groupings */
grouping afn-safi { grouping afn-safi {
leaf address-family { leaf address-family {
type ianaaf:address-family; type ianaaf:address-family;
mandatory "true"; mandatory "true";
description description
"Address family of routes in the routing table."; "Address family.";
} }
leaf safi { leaf safi {
type ianaaf:subsequent-address-family; type ianaaf:subsequent-address-family;
mandatory "true"; mandatory "true";
description description
"Subsequent address family identifier of routes in the "Subsequent address family.";
routing table.";
} }
description description
"This grouping provides two parameters specifying address "This grouping provides two parameters specifying address
family and subsequent address family."; family and subsequent address family.";
} }
grouping route-content { grouping route-content {
description description
"Generic parameters of routes."; "Generic parameters of routes.";
leaf outgoing-interface { leaf outgoing-interface {
skipping to change at page 25, line 38 skipping to change at page 25, line 4
/* RPC Methods */ /* RPC Methods */
rpc active-route { rpc active-route {
description description
"Return the active route (or multiple routes, in the case of "Return the active route (or multiple routes, in the case of
multi-path routing) to a destination address. multi-path routing) to a destination address.
Parameters Parameters
1. 'router-name', 1. 'router-name',
2. 'destination-address'. 2. 'destination-address'.
If the router instance with 'router-name' doesn't exist, then If the router instance with 'router-name' doesn't exist, then
this operation shall fail with error-tag 'data-missing' and this operation SHALL fail with error-tag 'data-missing' and
error-app-tag 'router-not-found'. error-app-tag 'router-not-found'.
If no active route for 'destination-address' exists, no output If no active route for 'destination-address' exists, no output
is returned - the server shall send an <rpc-reply> containing is returned - the server SHALL send an <rpc-reply> containing
a single element <ok>. a single element <ok>.
"; ";
input { input {
leaf router-name { leaf router-name {
type router-ref; type router-ref;
mandatory "true"; mandatory "true";
description description
"Name of the router instance whose forwarding information "Name of the router instance whose forwarding information
base is being queried."; base is being queried.";
} }
container destination-address { container destination-address {
uses afn-safi; uses afn-safi;
description description
"Network layer destination address. "Network layer destination address.
Address family specific modules must augment this Address family specific modules MUST augment this
container with a leaf named 'address'. container with a leaf named 'address'.
"; ";
} }
} }
output { output {
list route { list route {
uses afn-safi; uses afn-safi;
uses route-content; uses route-content;
description description
"Route contents specific for each address family should be "List of active routes.
defined through augmenting.";
Route contents specific for each address family is
expected be defined through augmenting.
";
} }
} }
} }
rpc route-count { rpc route-count {
description description
"Return the current number of routes in a routing table. "Return the current number of routes in a routing table.
Parameters: Parameters:
1. 'routing-table-name'. 1. 'routing-table-name'.
If the routing table with the name specified in If the routing table with the name specified in
'routing-table-name' doesn't exist, then this operation shall 'routing-table-name' doesn't exist, then this operation SHALL
fail with error-tag 'data-missing' and error-app-tag fail with error-tag 'data-missing' and error-app-tag
'routing-table-not-found'. 'routing-table-not-found'.
"; ";
input { input {
leaf routing-table { leaf routing-table {
type leafref { type routing-table-ref;
path "/routing/routing-tables/routing-table/name";
}
mandatory "true"; mandatory "true";
description description
"Name of the routing table."; "Name of the routing table.";
} }
} }
output { output {
leaf number-of-routes { leaf number-of-routes {
type uint32; type uint32;
mandatory "true"; mandatory "true";
description description
"Number of routes in the routing table."; "Number of routes in the routing table.";
} }
} }
} }
skipping to change at page 27, line 23 skipping to change at page 26, line 37
} }
} }
/* Data Nodes */ /* Data Nodes */
container routing { container routing {
description description
"Routing parameters."; "Routing parameters.";
list router { list router {
key "name"; key "name";
unique "router-id";
description description
"Each list entry is a container for configuration and "Each list entry is a container for configuration and state
operational state data of a single (logical) router. data of a single (logical) router instance.
Network layer interfaces assigned to the router must have
their entries in the 'interfaces' list.
"; ";
leaf name { leaf name {
type string; type string;
description description
"An arbitrary name of the router instance."; "An arbitrary name of the router instance.";
} }
leaf type { leaf type {
type identityref { type identityref {
base router-type; base router-type;
} }
default "rt:standard-router"; default "rt:standard-router";
description description
"This leaf specifies the router type. "This leaf specifies the router type.
It is primarily intended as a means for discriminating It is primarily intended as a means for discriminating
among different types of logical routers, route among different types of logical routers, route
virtualization, master-slave arrangements etc., while virtualization, master-slave arrangements etc., while
keeping all such router instances in the same flat list. keeping all such router instances in the same flat list.
Standard router instances should use the default value.
"; ";
} }
leaf enabled { leaf enabled {
type boolean; type boolean;
default "true"; default "true";
description description
"Enable/disable the router instance. "Enable/disable the router instance.
If this parameter is false, the parent router instance is If this parameter is false, the parent router instance is
disabled, despite any other configuration that might be disabled, despite any other configuration that might be
present. present.
"; ";
} }
leaf router-id { leaf router-id {
type inet:ipv4-address; type inet:ipv4-address;
description description
"Global router ID in the form of an IPv4 address. "Global router ID in the form of an IPv4 address.
An implementation may select a value if this parameter is An implementation MAY select a value if this parameter is
not configured. not configured.
Routing protocols may override this global parameter Routing protocols MAY override this global parameter
inside their configuration. inside their configuration.
"; ";
} }
leaf description { leaf description {
type string; type string;
description description
"Textual description of the router."; "Textual description of the router.";
} }
container main-routing-tables { container main-routing-tables {
description description
"Main routing tables used by the router instance."; "Main routing tables used by the router instance.";
list main-routing-table { list main-routing-table {
must "address-family=//routing/routing-tables/" must "address-family=/routing/routing-tables/"
+ "routing-table[name=current()/name]/" + "routing-table[name=current()/name]/"
+ "address-family and safi=//routing/routing-tables/" + "address-family and safi=/routing/routing-tables/"
+ "routing-table[name=current()/name]/safi" { + "routing-table[name=current()/name]/safi" {
error-message "Address family mismatch."; error-message "Address family mismatch.";
description description
"The entry's address family must match that of the "The entry's address family MUST match that of the
referenced routing table."; referenced routing table.";
} }
key "address-family safi"; key "address-family safi";
description description
"Each list entry specifies the main routing table for one "Each list entry specifies the main routing table for one
address family. address family.
The main routing table receives direct routes, and all The main routing table is operationally connected to all
routing protocols should be connected to the main routing protocols for which a connected routing table
routing table(s) by default. has not been explicitly configured.
The 'direct' pseudo-protocol is always connected to the
main routing table.
Address families that don't have their entry in this Address families that don't have their entry in this
list must not be used in the rest of the router instance list MUST NOT be used in the rest of the router instance
configuration. configuration.
"; ";
uses afn-safi; uses afn-safi;
leaf name { leaf name {
type leafref { type routing-table-ref;
path "/routing/routing-tables/routing-table/name";
}
description description
"Name of an existing routing table to be used as the "Name of an existing routing table to be used as the
main routing table for the given router and address main routing table for the given router instance and
family."; address family.";
} }
} }
} }
container interfaces { container interfaces {
description description
"Router interface parameters."; "Router interface parameters.";
list interface { list interface {
key "name"; key "name";
description description
"List of network layer interfaces assigned to the router "List of network layer interfaces assigned to the router
skipping to change at page 30, line 31 skipping to change at page 29, line 40
} }
mandatory "true"; mandatory "true";
description description
"Type of the routing protocol - an identity derived "Type of the routing protocol - an identity derived
from the 'routing-protocol' base identity."; from the 'routing-protocol' base identity.";
} }
container connected-routing-tables { container connected-routing-tables {
description description
"Container for connected routing tables."; "Container for connected routing tables.";
list connected-routing-table { list connected-routing-table {
must "not(//routing/routing-tables/" must "not(/routing/routing-tables/"
+ "routing-table[name=current()/" + "routing-table[name=current()/"
+ "preceding-sibling::connected-routing-table/" + "preceding-sibling::connected-routing-table/"
+ "name]/address-family=//routing/routing-tables/" + "name]/address-family=/routing/routing-tables/"
+ "routing-table[name=current()/name]/" + "routing-table[name=current()/name]/"
+ "address-family and //routing/routing-tables/" + "address-family and /routing/routing-tables/"
+ "routing-table[name=current()/" + "routing-table[name=current()/"
+ "preceding-sibling::connected-routing-table/" + "preceding-sibling::connected-routing-table/"
+ "name]/safi=//routing/routing-tables/" + "name]/safi=/routing/routing-tables/"
+ "routing-table[name=current()/name]/safi)" { + "routing-table[name=current()/name]/safi)" {
error-message "Duplicate address family for " error-message "Duplicate address family for "
+ "connected routing table."; + "connected routing tables.";
description description
"For each AFN/SAFI pair there may be at most one "For each AFN/SAFI pair there MUST NOT be more than
connected routing table."; one connected routing table.";
} }
key "name"; key "name";
description description
"List of routing tables to which the routing protocol "List of routing tables to which the routing protocol
instance is connected. instance is connected (at most one routing table per
address family).
If no connected routing table is defined for an If no connected routing table is configured for an
address family, the routing protocol should be address family, the routing protocol MUST be
connected by default to the main routing table for operationally connected to the main routing table
that address family. for that address family.
"; ";
leaf name { leaf name {
type leafref { must "../../../type != 'rt:direct' or "
path "/routing/routing-tables/routing-table/name"; + "../../../../../main-routing-tables/ "
+ "main-routing-table/name=." {
error-message "The 'direct' protocol can be "
+ "connected only to a main routing "
+ "table.";
description
"For the 'direct' pseudo-protocol, the connected
routing table must always be a main routing
table.";
} }
type routing-table-ref;
description description
"Name of an existing routing table."; "Name of an existing routing table.";
} }
leaf import-filter { leaf import-filter {
type leafref { type route-filter-ref;
path "/routing/route-filters/route-filter/name";
}
description description
"Reference to a route filter that is used for "Reference to a route filter that is used for
filtering routes passed from this routing protocol filtering routes passed from this routing protocol
instance to the routing table specified by the instance to the routing table specified by the
'name' sibling node. 'name' sibling node.
If this leaf is not present, the behavior is If this leaf is not present, the behavior is
protocol-specific, but typically it means that all protocol-specific, but typically it means that all
routes are accepted. routes are accepted.
"; ";
} }
leaf export-filter { leaf export-filter {
type leafref { type route-filter-ref;
path "/routing/route-filters/route-filter/name";
}
description description
"Reference to a route filter that is used for "Reference to a route filter that is used for
filtering routes passed from the routing table filtering routes passed from the routing table
specified by the 'name' sibling node to this specified by the 'name' sibling node to this
routing protocol instance. routing protocol instance.
If this leaf is not present, the behavior is If this leaf is not present, the behavior is
protocol-specific - typically it means that all protocol-specific - typically it means that all
routes are accepted. routes are accepted.
skipping to change at page 32, line 12 skipping to change at page 31, line 27
} }
container static-routes { container static-routes {
when "../type='rt:static'" { when "../type='rt:static'" {
description description
"This container is only valid for the 'static' "This container is only valid for the 'static'
routing protocol."; routing protocol.";
} }
description description
"Configuration of 'static' pseudo-protocol. "Configuration of 'static' pseudo-protocol.
Address family specific modules should augment this Address family specific modules augment this node with
node with lists of routes. their lists of routes.
"; ";
} }
} }
} }
} }
container routing-tables { container routing-tables {
description description
"Container for configured routing tables."; "Container for configured routing tables.";
list routing-table { list routing-table {
key "name"; key "name";
description description
"Each entry represents a routing table identified by the "Each entry represents a routing table identified by the
'name' key. All routes in a routing table must have the 'name' key. All routes in a routing table MUST belong to
same AFN and SAFI."; the same address family.";
leaf name { leaf name {
type string; type string;
description description
"An arbitrary name of the routing table."; "An arbitrary name of the routing table.";
} }
uses afn-safi; uses afn-safi;
leaf description { leaf description {
type string; type string;
description description
"Textual description of the routing table."; "Textual description of the routing table.";
} }
container routes { container routes {
config "false"; config "false";
description description
"Current contents of the routing table (operational state "Current contents of the routing table (state data).";
data).";
list route { list route {
description description
"A routing table entry. This data node must augmented "A routing table entry. This data node MUST be
with information specific for routes of each address augmented with information specific for routes of each
family."; address family.";
uses route-content; uses route-content;
leaf source-protocol { leaf source-protocol {
type leafref { type string;
path "/routing/router/routing-protocols/"
+ "routing-protocol/name";
}
mandatory "true"; mandatory "true";
description description
"The name of an existing routing protocol instance 'Routing protocol instance from which the route
from which the route comes."; originated.
It must be either "direct" or the name of a
configured routing protocol instance.
';
} }
leaf last-updated { leaf last-updated {
type yang:date-and-time; type yang:date-and-time;
description description
"Time stamp of the last modification of the route. If "Time stamp of the last modification of the route. If
the route was never modified, it is the time when the route was never modified, it is the time when
the route was inserted into the routing table."; the route was inserted into the routing table.";
} }
} }
} }
container recipient-routing-tables { container recipient-routing-tables {
description description
"Container for recipient routing tables."; "Container for recipient routing tables.";
list recipient-routing-table { list recipient-routing-table {
must "name != ../../name" { must "name != ../../name" {
error-message "Source and recipient routing tables " error-message "Source and recipient routing tables "
+ "are identical."; + "are identical.";
description description
"A routing table must not appear among its recipient "A routing table MUST NOT appear among its recipient
routing tables."; routing tables.";
} }
must "//routing/routing-tables/" must "/routing/routing-tables/"
+ "routing-table[name=current()/name]/" + "routing-table[name=current()/name]/"
+ "address-family=../../address-family and //routing/" + "address-family=../../address-family and /routing/"
+ "routing-tables/routing-table[name=current()/name]/" + "routing-tables/routing-table[name=current()/name]/"
+ "safi=../../safi" { + "safi=../../safi" {
error-message "Address family mismatch."; error-message "Address family mismatch.";
description description
"Address family of the recipient routing table must "Address family of the recipient routing table MUST
match the source table."; match the source table.";
} }
key "name"; key "name";
description description
"List of routing tables that receive routes from this "List of routing tables that receive routes from this
routing table."; routing table.";
leaf name { leaf name {
type leafref { type routing-table-ref;
path "/routing/routing-tables/routing-table/name";
}
description description
"The name of the recipient routing table."; "The name of the recipient routing table.";
} }
leaf filter { leaf filter {
type leafref { type route-filter-ref;
path "/routing/route-filters/route-filter/name";
}
description description
"A route filter which is applied to the routes passed "A route filter which is applied to the routes passed
on to the recipient routing table."; to the recipient routing table.";
} }
} }
} }
} }
} }
container route-filters { container route-filters {
description description
"Container for configured route filters."; "Container for configured route filters.";
list route-filter { list route-filter {
key "name"; key "name";
skipping to change at page 36, line 11 skipping to change at page 35, line 11
} }
<CODE ENDS> <CODE ENDS>
7. IPv4 Unicast Routing YANG Module 7. IPv4 Unicast Routing YANG Module
RFC Ed.: In this section, replace all occurrences of 'XXXX' with the RFC Ed.: In this section, replace all occurrences of 'XXXX' with the
actual RFC number and all occurrences of the revision date below with actual RFC number and all occurrences of the revision date below with
the date of RFC publication (and remove this note). the date of RFC publication (and remove this note).
<CODE BEGINS> file "ietf-ipv4-unicast-routing@2012-10-04.yang" <CODE BEGINS> file "ietf-ipv4-unicast-routing@2012-11-15.yang"
module ietf-ipv4-unicast-routing { module ietf-ipv4-unicast-routing {
namespace "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing"; namespace "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing";
prefix "v4ur"; prefix "v4ur";
import ietf-routing { import ietf-routing {
prefix "rt"; prefix "rt";
} }
skipping to change at page 36, line 46 skipping to change at page 35, line 46
WG Chair: Juergen Schoenwaelder WG Chair: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de> <mailto:j.schoenwaelder@jacobs-university.de>
Editor: Ladislav Lhotka Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz> <mailto:lhotka@nic.cz>
"; ";
description description
"This YANG module augments the 'ietf-routing' module with basic "This YANG module augments the 'ietf-routing' module with basic
configuration and operational state data for IPv4 unicast configuration and state data for IPv4 unicast routing.
routing.
Copyright (c) 2012 IETF Trust and the persons identified as Copyright (c) 2012 IETF Trust and the persons identified as
authors of the code. All rights reserved. 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 to without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions 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 the This version of this YANG module is part of RFC XXXX; see the
RFC itself for full legal notices. RFC itself for full legal notices.
"; ";
revision 2012-10-04 { revision 2012-11-15 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: A YANG Data Model for Routing Configuration"; "RFC XXXX: A YANG Data Model for Routing Management";
} }
/* Groupings */ /* Groupings */
grouping route-content { grouping route-content {
description description
"Parameters of IPv4 unicast routes."; "Parameters of IPv4 unicast routes.";
leaf dest-prefix { leaf dest-prefix {
type inet:ipv4-prefix; type inet:ipv4-prefix;
description description
skipping to change at page 39, line 5 skipping to change at page 38, line 4
} }
leaf description { leaf description {
type string; type string;
description description
"Textual description of the route."; "Textual description of the route.";
} }
uses rt:route-content; uses rt:route-content;
uses route-content { uses route-content {
refine "dest-prefix" { refine "dest-prefix" {
mandatory "true"; mandatory "true";
} }
} }
} }
} }
} }
augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/" augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/"
+ "rt:route" { + "rt:route" {
when "../../rt:address-family='ipv4' and " when "../../rt:address-family = 'ipv4' and ../../rt:safi = "
+ "../../rt:safi='nlri-unicast'" { + "'nlri-unicast'" {
description description
"This augment is valid only for IPv4 unicast."; "This augment is valid only for IPv4 unicast.";
} }
description description
"This augment defines the content of IPv4 unicast routes."; "This augment defines the content of IPv4 unicast routes.";
uses route-content; uses route-content;
} }
} }
<CODE ENDS> <CODE ENDS>
8. IPv6 Unicast Routing YANG Module 8. IPv6 Unicast Routing YANG Module
RFC Ed.: In this section, replace all occurrences of 'XXXX' with the RFC Ed.: In this section, replace all occurrences of 'XXXX' with the
actual RFC number and all occurrences of the revision date below with actual RFC number and all occurrences of the revision date below with
the date of RFC publication (and remove this note). the date of RFC publication (and remove this note).
<CODE BEGINS> file "ietf-ipv6-unicast-routing@2012-10-04.yang" <CODE BEGINS> file "ietf-ipv6-unicast-routing@2012-11-15.yang"
module ietf-ipv6-unicast-routing { module ietf-ipv6-unicast-routing {
namespace "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing"; namespace "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing";
prefix "v6ur"; prefix "v6ur";
import ietf-routing { import ietf-routing {
prefix "rt"; prefix "rt";
} }
skipping to change at page 41, line 5 skipping to change at page 40, line 5
WG Chair: Juergen Schoenwaelder WG Chair: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de> <mailto:j.schoenwaelder@jacobs-university.de>
Editor: Ladislav Lhotka Editor: Ladislav Lhotka
<mailto:lhotka@nic.cz> <mailto:lhotka@nic.cz>
"; ";
description description
"This YANG module augments the 'ietf-routing' module with basic "This YANG module augments the 'ietf-routing' module with basic
configuration and operational state data for IPv6 unicast configuration and state data for IPv6 unicast routing.
routing.
Copyright (c) 2012 IETF Trust and the persons identified as Copyright (c) 2012 IETF Trust and the persons identified as
authors of the code. All rights reserved. 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 to without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions 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 the This version of this YANG module is part of RFC XXXX; see the
RFC itself for full legal notices. RFC itself for full legal notices.
"; ";
revision 2012-10-04 { revision 2012-11-15 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: A YANG Data Model for Routing Configuration"; "RFC XXXX: A YANG Data Model for Routing Management";
} }
/* Groupings */ /* Groupings */
grouping route-content { grouping route-content {
description description
"Specific parameters of IPv6 unicast routes."; "Specific parameters of IPv6 unicast routes.";
leaf dest-prefix { leaf dest-prefix {
type inet:ipv6-prefix; type inet:ipv6-prefix;
description description
skipping to change at page 42, line 40 skipping to change at page 41, line 38
+ "ip:enabled='true'" { + "ip:enabled='true'" {
description description
"This augment is only valid for router interfaces with "This augment is only valid for router interfaces with
enabled IPv6."; enabled IPv6.";
} }
description description
"IPv6-specific parameters of router interfaces."; "IPv6-specific parameters of router interfaces.";
container ipv6-router-advertisements { container ipv6-router-advertisements {
description description
"Parameters of IPv6 Router Advertisements."; "Parameters of IPv6 Router Advertisements.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6).";
leaf send-advertisements { leaf send-advertisements {
type boolean; type boolean;
default "false"; default "false";
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.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvSendAdvertisements.";
} }
leaf max-rtr-adv-interval { leaf max-rtr-adv-interval {
type uint16 { type uint16 {
range "4..1800"; range "4..1800";
} }
units "seconds"; units "seconds";
default "600"; default "600";
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.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
MaxRtrAdvInterval.";
} }
leaf min-rtr-adv-interval { leaf min-rtr-adv-interval {
type uint16 { type uint16 {
range "3..1350"; range "3..1350";
} }
must ". <= 0.75 * ../max-rtr-adv-interval" { must ". <= 0.75 * ../max-rtr-adv-interval" {
description description
"The value must be no greater than "The value MUST NOT be greater than 75 % of
3/4*max-rtr-adv-interval."; 'max-rtr-adv-interval'.";
} }
units "seconds"; units "seconds";
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.
Must be no greater than 0.75 * max-rtr-adv-interval. The default value to be used operationally if this leaf is
not configured is determined as follows:
Its default value is dynamic:
- if max-rtr-adv-interval >= 9 seconds, the default value - if max-rtr-adv-interval >= 9 seconds, the default value
is 0.33 * max-rtr-adv-interval; is 0.33 * max-rtr-adv-interval;
- otherwise it is 0.75 * max-rtr-adv-interval. - otherwise it is 0.75 * max-rtr-adv-interval.
"; ";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
MinRtrAdvInterval.";
} }
leaf managed-flag { leaf managed-flag {
type boolean; type boolean;
default "false"; default "false";
description description
"The boolean value to be placed in the 'Managed address "The boolean value to be placed in the 'Managed address
configuration' flag field in the Router Advertisement."; configuration' flag field in the Router Advertisement.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvManagedFlag.";
} }
leaf other-config-flag { leaf other-config-flag {
type boolean; type boolean;
default "false"; default "false";
description description
"The boolean value to be placed in the 'Other "The boolean value to be placed in the 'Other
configuration' flag field in the Router Advertisement."; configuration' flag field in the Router Advertisement.";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvOtherConfigFlag.";
} }
leaf link-mtu { leaf link-mtu {
type uint32; type uint32;
default "0"; default "0";
description description
"The value to be placed in MTU options sent by the router. "The value to be placed in MTU options sent by the router.
A value of zero indicates that no MTU options are sent."; 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 { leaf reachable-time {
type uint32 { type uint32 {
range "0..3600000"; range "0..3600000";
} }
units "milliseconds"; units "milliseconds";
default "0"; default "0";
description description
"The value to be placed in the Reachable Time field in the "The value to be placed in the Reachable Time field in the
Router Advertisement messages sent by the router. The Router Advertisement messages sent by the router. The
value zero means unspecified (by this router)."; value zero means unspecified (by this router).";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvReachableTime.";
} }
leaf retrans-timer { leaf retrans-timer {
type uint32; type uint32;
units "milliseconds"; units "milliseconds";
default "0"; default "0";
description description
"The value to be placed in the Retrans Timer field in the "The value to be placed in the Retrans Timer field in the
Router Advertisement messages sent by the router. The Router Advertisement messages sent by the router. The
value zero means unspecified (by this router)."; value zero means unspecified (by this router).";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvRetransTimer.";
} }
leaf cur-hop-limit { leaf cur-hop-limit {
type uint8; type uint8;
default "64"; default "64";
description description
"The default value to be placed in the Cur Hop Limit field "The default value to be placed in the Cur Hop Limit field
in the Router Advertisement messages sent by the router. in the Router Advertisement messages sent by the router.
The value should be set to the current diameter of the The value should be set to the current diameter of the
Internet. The value zero means unspecified (by this Internet. The value zero means unspecified (by this
router). router).
The default should be set to the value specified in IANA The default SHOULD be set to the value specified in IANA
Assigned Numbers that was in effect at the time of Assigned Numbers that was in effect at the time of
implementation. implementation.
"; ";
reference reference
"IANA: IP Parameters, "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
http://www.iana.org/assignments/ip-parameters"; AdvCurHopLimit.
IANA: IP Parameters,
http://www.iana.org/assignments/ip-parameters
";
} }
leaf default-lifetime { leaf default-lifetime {
type uint16 { type uint16 {
range "0..9000"; range "0..9000";
} }
units "seconds"; units "seconds";
description description
"The value to be placed in the Router Lifetime field of "The value to be placed in the Router Lifetime field of
Router Advertisements sent from the interface, in seconds. Router Advertisements sent from the interface, in seconds.
MUST be either zero or between max-rtr-adv-interval and MUST be either zero or between max-rtr-adv-interval and
9000 seconds. A value of zero indicates that the router is 9000 seconds. A value of zero indicates that the router is
not to be used as a default router. These limits may be not to be used as a default router. These limits may be
overridden by specific documents that describe how IPv6 overridden by specific documents that describe how IPv6
operates over different link layers. operates over different link layers.
The default value is dynamic and should be set to 3 * The default value is dynamic and SHOULD be set to 3 *
max-rtr-adv-interval. max-rtr-adv-interval.
"; ";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvDefaultLifeTime.";
} }
container prefix-list { container prefix-list {
description description
"A list of prefixes to be placed in Prefix Information "A list of prefixes to be placed in Prefix Information
options in Router Advertisement messages sent from the options in Router Advertisement messages sent from the
interface. interface.
By default, all prefixes that the router advertises via By default, all prefixes that the router advertises via
routing protocols as being on-link for the interface from routing protocols as being on-link for the interface from
which the advertisement is sent. The link-local prefix which the advertisement is sent. The link-local prefix
should not be included in the list of advertised prefixes. SHOULD NOT be included in the list of advertised prefixes.
"; ";
reference
"RFC 4861: Neighbor Discovery for IP version 6 (IPv6) -
AdvPrefixList.";
list prefix { list prefix {
key "prefix-spec"; key "prefix-spec";
description description
"Advertised prefix entry."; "Advertised prefix entry.";
leaf prefix-spec { leaf prefix-spec {
type inet:ipv6-prefix; type inet:ipv6-prefix;
description description
"IPv6 address prefix."; "IPv6 address prefix.";
} }
choice control-adv-prefixes { choice control-adv-prefixes {
default "advertise"; default "advertise";
description description
"The prefix either may be explicitly removed from the "The prefix either may be explicitly removed from the
set of advertised prefixes, or parameters with which set of advertised prefixes, or parameters with which
it is advertised may be specified (default case)."; it is advertised may be specified (default case).";
leaf no-advertise { leaf no-advertise {
type empty; type empty;
description description
"The prefix will not be advertised. "The prefix will not be advertised.
This may be used for removing the prefix from the This can be used for removing the prefix from the
default set of advertised prefixes. default set of advertised prefixes.
"; ";
} }
case advertise { case advertise {
leaf valid-lifetime { leaf valid-lifetime {
type uint32; type uint32;
units "seconds"; units "seconds";
default "2592000"; default "2592000";
description description
"The value to be placed in the Valid Lifetime in "The value to be placed in the Valid Lifetime in
the Prefix Information option, in seconds. The the Prefix Information option, in seconds. The
designated value of all 1's (0xffffffff) designated value of all 1's (0xffffffff)
represents infinity. represents infinity.
"; ";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvValidLifetime.";
} }
leaf on-link-flag { leaf on-link-flag {
type boolean; type boolean;
default "true"; default "true";
description description
"The value to be placed in the on-link flag "The value to be placed in the on-link flag
('L-bit') field in the Prefix Information ('L-bit') field in the Prefix Information
option."; option.";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvOnLinkFlag.";
} }
leaf preferred-lifetime { leaf preferred-lifetime {
type uint32; type uint32;
units "seconds"; units "seconds";
must ". <= ../valid-lifetime" { must ". <= ../valid-lifetime" {
description description
"This value must not be larger than "This value MUST NOT be greater than
valid-lifetime."; valid-lifetime.";
} }
default "604800"; default "604800";
description description
"The value to be placed in the Preferred Lifetime "The value to be placed in the Preferred Lifetime
in the Prefix Information option, in seconds. The in the Prefix Information option, in seconds. The
designated value of all 1's (0xffffffff) designated value of all 1's (0xffffffff)
represents infinity. represents infinity.
"; ";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvPreferredLifetime.";
} }
leaf autonomous-flag { leaf autonomous-flag {
type boolean; type boolean;
default "true"; default "true";
description description
"The value to be placed in the Autonomous Flag "The value to be placed in the Autonomous Flag
field in the Prefix Information option."; field in the Prefix Information option.";
reference
"RFC 4861: Neighbor Discovery for IP version 6
(IPv6) - AdvAutonomousFlag.";
} }
} }
} }
} }
} }
} }
} }
augment "/rt:routing/rt:router/rt:routing-protocols/" augment "/rt:routing/rt:router/rt:routing-protocols/"
+ "rt:routing-protocol/rt:static-routes" { + "rt:routing-protocol/rt:static-routes" {
description description
"This augment defines the configuration of the 'static' "This augment defines the configuration of the 'static'
pseudo-protocol with data specific for IPv6 unicast."; pseudo-protocol with data specific for IPv6 unicast.";
container ipv6 { container ipv6 {
description description
"Configuration of a 'static' pseudo-protocol instance "Configuration of a 'static' pseudo-protocol instance
consists of a list of routes."; consists of a list of routes.";
list route { list route {
key "id"; key "id";
ordered-by "user"; ordered-by "user";
description description
"A user-ordered list of static routes."; "A user-ordered list of static routes.";
leaf id { leaf id {
skipping to change at page 47, line 46 skipping to change at page 47, line 42
refine "dest-prefix" { refine "dest-prefix" {
mandatory "true"; mandatory "true";
} }
} }
} }
} }
} }
augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/" augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/"
+ "rt:route" { + "rt:route" {
when "../../rt:address-family='ipv6' and " when "../../rt:address-family = 'ipv6' and ../../rt:safi = "
+ "../../rt:safi='nlri-unicast'" { + "'nlri-unicast'" {
description description
"This augment is valid only for IPv6 unicast."; "This augment is valid only for IPv6 unicast.";
} }
description description
"This augment defines the content of IPv6 unicast routes."; "This augment defines the content of IPv6 unicast routes.";
uses route-content; uses route-content;
} }
} }
<CODE ENDS> <CODE ENDS>
9. IANA Considerations 9. IANA Considerations
RFC Ed.: In this section, replace all occurrences of 'XXXX' with the RFC Ed.: In this section, replace all occurrences of 'XXXX' with the
actual RFC number (and remove this note). actual RFC number (and remove this note).
This document registers the following namespace URIs in the IETF XML This document registers the following namespace URIs in the IETF XML
registry [RFC3688]: registry [RFC3688]:
skipping to change at page 51, line 7 skipping to change at page 51, line 7
------------------------------------------------------------------- -------------------------------------------------------------------
name: ietf-ipv6-unicast-routing name: ietf-ipv6-unicast-routing
namespace: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing namespace: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing
prefix: v6ur prefix: v6ur
reference: RFC XXXX reference: RFC XXXX
------------------------------------------------------------------- -------------------------------------------------------------------
10. Security Considerations 10. Security Considerations
The YANG modules defined in this document are designed to be accessed Configuration and state data conforming to the core routing data
via the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the model (defined in this document) are designed to be accessed via the
secure transport layer and the mandatory-to-implement secure NETCONF protocol [RFC6241]. The lowest NETCONF layer is the secure
transport is SSH [RFC6242]. transport layer and the mandatory-to-implement secure transport is
SSH [RFC6242].
A number of data nodes defined in the YANG modules are writable/ A number of data nodes defined in the YANG modules belonging to the
creatable/deletable (i.e., "config true" in YANG terms, which is the core routing data model are writable/creatable/deletable (i.e.,
default). These data nodes may be considered sensitive or vulnerable "config true" in YANG terms, which is the default). These data nodes
in some network environments. Write operations to these data nodes, may be considered sensitive or vulnerable in some network
such as "edit-config", can have negative effects on the network if environments. Write operations to these data nodes, such as "edit-
the protocol operations are not properly protected. config", can have negative effects on the network if the protocol
operations are not properly protected.
The vulnerable "config true" subtrees and data nodes are the The vulnerable "config true" subtrees and data nodes are the
following: following:
/rt:routing/rt:router/rt:interfaces/rt:interface This list assigns a /routing/router/interfaces/interface This list assigns a network
network layer interface to a router instance and may also specify layer interface to a router instance and may also specify
interface parameters related to routing. interface parameters related to routing.
/rt:routing/rt:router/rt:routing-protocols/rt:routing-protocol This /routing/router/routing-protocols/routing-protocol This list
list specifies the routing protocols configured on a device. specifies the routing protocols configured on a device.
/rt:routing/rt:route-filters/rt:route-filter This list specifies the /routing/route-filters/route-filter This list specifies the
configured route filters which represent administrative policies configured route filters which represent administrative policies
for redistributing and modifying routing information. for redistributing and modifying routing information.
/routing/routing-tables/routing-table This list specifies the
configured routing tables used by the device.
Unauthorized access to any of these lists can adversely affect the Unauthorized access to any of these lists can adversely affect the
routing subsystem of both the local device and the network. This may routing subsystem of both the local device and the network. This may
lead to network malfunctions, delivery of packets to inappropriate lead to network malfunctions, delivery of packets to inappropriate
destinations and other problems. destinations and other problems.
11. Acknowledgments 11. Acknowledgments
The author wishes to thank Martin Bjorklund, Joel Halpern, The author wishes to thank Martin Bjorklund, Joel Halpern,
Wes Hardaker, Andrew McGregor, Thomas Morin, Tom Petch, Wes Hardaker, Andrew McGregor, Thomas Morin, Tom Petch,
Juergen Schoenwaelder, Phil Shafer, Dave Thaler and Yi Yang for their Bruno Rijsman, Juergen Schoenwaelder, Phil Shafer, Dave Thaler and
helpful comments and suggestions. Yi Yang for their helpful comments and suggestions.
12. References 12. References
12.1. Normative References 12.1. Normative References
[IANA-IF-AF] [IANA-IF-AF]
Bjorklund, M., "IANA Interface Type and Address Family Bjorklund, M., "IANA Interface Type and Address Family
YANG Modules", draft-ietf-netmod-iana-if-type-04 (work in YANG Modules", draft-ietf-netmod-iana-if-type-04 (work in
progress), June 2012. progress), June 2012.
skipping to change at page 53, line 36 skipping to change at page 53, line 36
September 2010. September 2010.
[RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6021, September 2010. RFC 6021, September 2010.
[RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
Bierman, "NETCONF Configuration Protocol", RFC 6241, Bierman, "NETCONF Configuration Protocol", RFC 6241,
June 2011. June 2011.
[YANG-IF] Bjorklund, M., "A YANG Data Model for Interface [YANG-IF] Bjorklund, M., "A YANG Data Model for Interface
Configuration", draft-ietf-netmod-interfaces-cfg-06 (work Configuration", draft-ietf-netmod-interfaces-cfg-08 (work
in progress), September 2012. in progress), November 2012.
[YANG-IP] Bjorklund, M., "A YANG Data Model for IP Configuration", [YANG-IP] Bjorklund, M., "A YANG Data Model for IP Configuration",
draft-ietf-netmod-ip-cfg-06 (work in progress), draft-ietf-netmod-ip-cfg-07 (work in progress),
September 2012. November 2012.
12.2. Informative References 12.2. Informative References
[RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG [RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG
Data Model Documents", RFC 6087, January 2011. Data Model Documents", RFC 6087, January 2011.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011. Shell (SSH)", RFC 6242, June 2011.
Appendix A. Example: Adding a New Routing Protocol Appendix A. The Complete Data Tree
This appendix presents the complete data tree of the core routing
data model. See Section 2.2 for an explanation of symbols. Data
type of every leaf node is shown near the right end of the
corresponding line.
+--rw routing
+--rw router [name]
| +--rw name string
| +--rw type? identityref
| +--rw enabled? boolean
| +--rw router-id? inet:ipv4-address
| +--rw description? string
| +--rw main-routing-tables
| | +--rw main-routing-table [address-family safi]
| | +--rw address-family ianaaf:address-family
| | +--rw safi ianaaf:subsequent-address-family
| | +--rw name? routing-table-ref
| +--rw interfaces
| | +--rw interface [name]
| | +--rw name if:interface-ref
| | +--rw v6ur:ipv6-router-advertisements
| | +--rw v6ur:send-advertisements? boolean
| | +--rw v6ur:max-rtr-adv-interval? uint16
| | +--rw v6ur:min-rtr-adv-interval? uint16
| | +--rw v6ur:managed-flag? boolean
| | +--rw v6ur:other-config-flag? boolean
| | +--rw v6ur:link-mtu? uint32
| | +--rw v6ur:reachable-time? uint32
| | +--rw v6ur:retrans-timer? uint32
| | +--rw v6ur:cur-hop-limit? uint8
| | +--rw v6ur:default-lifetime? uint16
| | +--rw v6ur:prefix-list
| | +--rw v6ur:prefix [prefix-spec]
| | +--rw v6ur:prefix-spec inet:ipv6-prefix
| | +--rw (control-adv-prefixes)?
| | +--:(no-advertise)
| | | +--rw v6ur:no-advertise? empty
| | +--:(advertise)
| | +--rw v6ur:valid-lifetime? uint32
| | +--rw v6ur:on-link-flag? boolean
| | +--rw v6ur:preferred-lifetime? uint32
| | +--rw v6ur:autonomous-flag? boolean
| +--rw routing-protocols
| +--rw routing-protocol [name]
| +--rw name string
| +--rw description? string
| +--rw enabled? boolean
| +--rw type identityref
| +--rw connected-routing-tables
| | +--rw connected-routing-table [name]
| | +--rw name routing-table-ref
| | +--rw import-filter? route-filter-ref
| | +--rw export-filter? route-filter-ref
| +--rw static-routes
| +--rw v4ur:ipv4
| | +--rw v4ur:route [id]
| | +--rw v4ur:id uint32
| | +--rw v4ur:description? string
| | +--rw v4ur:outgoing-interface? if:interface-ref
| | +--rw v4ur:dest-prefix inet:ipv4-prefix
| | +--rw v4ur:next-hop? inet:ipv4-address
| +--rw v6ur:ipv6
| +--rw v6ur:route [id]
| +--rw v6ur:id uint32
| +--rw v6ur:description? string
| +--rw v6ur:outgoing-interface? if:interface-ref
| +--rw v6ur:dest-prefix inet:ipv6-prefix
| +--rw v6ur:next-hop? inet:ipv6-address
+--rw routing-tables
| +--rw routing-table [name]
| +--rw name string
| +--rw address-family ianaaf:address-family
| +--rw safi ianaaf:subsequent-address-family
| +--rw description? string
| +--ro routes
| | +--ro route
| | +--ro outgoing-interface? if:interface-ref
| | +--ro source-protocol string
| | +--ro last-updated? yang:date-and-time
| | +--ro v4ur:dest-prefix? inet:ipv4-prefix
| | +--ro v4ur:next-hop? inet:ipv4-address
| | +--ro v6ur:dest-prefix? inet:ipv6-prefix
| | +--ro v6ur:next-hop? inet:ipv6-address
| +--rw recipient-routing-tables
| +--rw recipient-routing-table [name]
| +--rw name routing-table-ref
| +--rw filter? route-filter-ref
+--rw route-filters
+--rw route-filter [name]
+--rw name string
+--rw description? string
+--rw type identityref
Appendix B. Example: Adding a New Routing 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 routing protocol. The YANG module extended to support a new routing protocol. The YANG module
"example-rip" shown below is intended only as an illustration rather "example-rip" shown below is intended only as an illustration rather
than a real definition of a data model for the RIP routing protocol. than a real definition of a data model for the RIP routing protocol.
For the sake of brevity, we do not follow all the guidelines For the sake of brevity, we do not follow all the guidelines
specified in [RFC6087]. See also Section 4.4.2. specified in [RFC6087]. See also Section 4.4.2.
<CODE BEGINS> file "example-rip@2012-10-04.yang"
module example-rip { module example-rip {
namespace "http://example.com/rip"; namespace "http://example.com/rip";
prefix "rip"; prefix "rip";
import ietf-routing { import ietf-routing {
prefix "rt"; prefix "rt";
} }
skipping to change at page 54, line 40 skipping to change at page 56, line 38
} }
typedef rip-metric { typedef rip-metric {
type uint8 { type uint8 {
range "0..16"; range "0..16";
} }
} }
grouping route-content { grouping route-content {
description description
"RIP-specific route content."; "This grouping defines RIP-specific route attributes.";
leaf metric { leaf metric {
type rip-metric; type rip-metric;
} }
leaf tag { leaf tag {
type uint16; type uint16;
default "0"; default "0";
description description
"This leaf may be used to carry additional info, e.g. AS "This leaf may be used to carry additional info, e.g. AS
number."; number.";
} }
skipping to change at page 55, line 4 skipping to change at page 56, line 50
type rip-metric; type rip-metric;
} }
leaf tag { leaf tag {
type uint16; type uint16;
default "0"; default "0";
description description
"This leaf may be used to carry additional info, e.g. AS "This leaf may be used to carry additional info, e.g. AS
number."; number.";
} }
} }
augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/" augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/"
+ "rt:route" { + "rt:route" {
description description
"RIP-specific route components."; "RIP-specific route attributes.";
uses route-content; uses route-content;
} }
augment "/rt:active-route/rt:output/rt:route" { augment "/rt:active-route/rt:output/rt:route" {
description description
"Add RIP-specific route content."; "RIP-specific route attributes.";
uses route-content; uses route-content;
} }
augment "/rt:routing/rt:router/rt:interfaces/rt:interface" { augment "/rt:routing/rt:router/rt:interfaces/rt:interface" {
when "../../rt:routing-protocols/rt:routing-protocol/rt:type = " when "../../rt:routing-protocols/rt:routing-protocol/rt:type = "
+ "'rip:rip'"; + "'rip:rip'" {
description
'This augment is only valid for a routing protocol instance
of type "rip".';
}
container rip { container rip {
description description
"Per-interface RIP configuration."; "Per-interface RIP configuration.";
leaf enabled { leaf enabled {
type boolean; type boolean;
default "true"; default "true";
} }
leaf metric { leaf metric {
type rip-metric; type rip-metric;
default "1"; default "1";
} }
} }
} }
augment "/rt:routing/rt:router/rt:routing-protocols/" augment "/rt:routing/rt:router/rt:routing-protocols/"
+ "rt:routing-protocol" { + "rt:routing-protocol" {
when "rt:type = 'rip:rip'"; when "rt:type = 'rip:rip'" {
description
'This augment is only valid for a routing protocol instance
of type "rip".';
}
container rip { container rip {
description
"Global RIP configuration.";
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.";
} }
} }
} }
} }
<CODE ENDS> Appendix C. Example: NETCONF <get> Reply
Appendix B. Example: NETCONF <get> Reply
This section contains a sample reply to the NETCONF <get> message, This section contains a sample reply to the NETCONF <get> message,
which could be sent by a server supporting (i.e., advertising them in which could be sent by a server supporting (i.e., advertising them in
the NETCONF <hello> message) the following YANG modules: the NETCONF <hello> message) the following YANG modules:
o ietf-interfaces [YANG-IF], o ietf-interfaces [YANG-IF],
o ietf-ip [YANG-IP], o ietf-ip [YANG-IP],
o ietf-routing (Section 6), o ietf-routing (Section 6),
o ietf-ipv4-unicast-routing (Section 7), o ietf-ipv4-unicast-routing (Section 7),
o ietf-ipv6-unicast-routing (Section 8). o ietf-ipv6-unicast-routing (Section 8).
We assume a simple network setup as shown in Figure 3: router "A" We assume a simple network setup as shown in Figure 4: router "A"
uses static default routes with the "ISP" router as the next hop. uses static default routes with the "ISP" router as the next hop.
IPv6 router advertisements are configured only on the "eth1" IPv6 router advertisements are configured only on the "eth1"
interface and disabled on the upstream "eth0" interface. interface and disabled on the upstream "eth0" interface.
+-----------------+ +-----------------+
| | | |
| Router ISP | | Router ISP |
| | | |
+--------+--------+ +--------+--------+
|2001:db8:0:1::2 |2001:db8:0:1::2
skipping to change at page 56, line 46 skipping to change at page 59, line 46
eth0|192.0.2.1 eth0|192.0.2.1
+--------+--------+ +--------+--------+
| | | |
| Router A | | Router A |
| | | |
+--------+--------+ +--------+--------+
eth1|198.51.100.1 eth1|198.51.100.1
|2001:db8:0:2::1 |2001:db8:0:2::1
| |
Figure 3: Example network configuration Figure 4: Example network configuration
A reply to the NETCONF <get> message sent by router "A" would then be A reply to the NETCONF <get> message sent by router "A" would then be
as follows: as follows:
<?xml version="1.0"?> <?xml version="1.0"?>
<rpc-reply <rpc-reply
message-id="101" message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:v4ur="urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing" xmlns:v4ur="urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing"
xmlns:v6ur="urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing" xmlns:v6ur="urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing"
skipping to change at page 58, line 42 skipping to change at page 61, line 42
<v6ur:prefix-list> <v6ur:prefix-list>
<v6ur:prefix> <v6ur:prefix>
<v6ur:prefix-spec>2001:db8:0:2::/64</v6ur:prefix-spec> <v6ur:prefix-spec>2001:db8:0:2::/64</v6ur:prefix-spec>
</v6ur:prefix> </v6ur:prefix>
</v6ur:prefix-list> </v6ur:prefix-list>
</v6ur:ipv6-router-advertisements> </v6ur:ipv6-router-advertisements>
</rt:interface> </rt:interface>
</rt:interfaces> </rt:interfaces>
<rt:routing-protocols> <rt:routing-protocols>
<rt:routing-protocol> <rt:routing-protocol>
<rt:name>direct</rt:name>
<rt:type>rt:direct</rt:type>
</rt:routing-protocol>
<rt:routing-protocol>
<rt:name>st0</rt:name> <rt:name>st0</rt:name>
<rt:description> <rt:description>
Static routing is used for the internal network. Static routing is used for the internal network.
</rt:description> </rt:description>
<rt:type>rt:static</rt:type> <rt:type>rt:static</rt:type>
<rt:static-routes> <rt:static-routes>
<v4ur:ipv4> <v4ur:ipv4>
<v4ur:route> <v4ur:route>
<v4ur:id>1</v4ur:id> <v4ur:id>1</v4ur:id>
<v4ur:dest-prefix>0.0.0.0/0</v4ur:dest-prefix> <v4ur:dest-prefix>0.0.0.0/0</v4ur:dest-prefix>
skipping to change at page 59, line 18 skipping to change at page 62, line 15
</v4ur:route> </v4ur:route>
</v4ur:ipv4> </v4ur:ipv4>
<v6ur:ipv6> <v6ur:ipv6>
<v6ur:route> <v6ur:route>
<v6ur:id>1</v6ur:id> <v6ur:id>1</v6ur:id>
<v6ur:dest-prefix>::/0</v6ur:dest-prefix> <v6ur:dest-prefix>::/0</v6ur:dest-prefix>
<v6ur:next-hop>2001:db8:0:1::2</v6ur:next-hop> <v6ur:next-hop>2001:db8:0:1::2</v6ur:next-hop>
</v6ur:route> </v6ur:route>
</v6ur:ipv6> </v6ur:ipv6>
</rt:static-routes> </rt:static-routes>
<rt:connected-routing-tables>
<rt:connected-routing-table>
<rt:name>ipv4-unicast</rt:name>
</rt:connected-routing-table>
<rt:connected-routing-table>
<rt:name>ipv6-unicast</rt:name>
</rt:connected-routing-table>
</rt:connected-routing-tables>
</rt:routing-protocol> </rt:routing-protocol>
</rt:routing-protocols> </rt:routing-protocols>
</rt:router> </rt:router>
<rt:routing-tables> <rt:routing-tables>
<rt:routing-table> <rt:routing-table>
<rt:name>ipv4-unicast</rt:name> <rt:name>ipv4-unicast</rt:name>
<rt:address-family>ipv4</rt:address-family> <rt:address-family>ipv4</rt:address-family>
<rt:safi>nlri-unicast</rt:safi> <rt:safi>nlri-unicast</rt:safi>
<rt:routes> <rt:routes>
<rt:route> <rt:route>
skipping to change at page 61, line 5 skipping to change at page 64, line 5
<rt:source-protocol>st0</rt:source-protocol> <rt:source-protocol>st0</rt:source-protocol>
<rt:last-updated>2012-10-02T18:02:45+01:00</rt:last-updated> <rt:last-updated>2012-10-02T18:02:45+01:00</rt:last-updated>
</rt:route> </rt:route>
</rt:routes> </rt:routes>
</rt:routing-table> </rt:routing-table>
</rt:routing-tables> </rt:routing-tables>
</rt:routing> </rt:routing>
</data> </data>
</rpc-reply> </rpc-reply>
Appendix C. Change Log Appendix D. Change Log
RFC Editor: remove this section upon publication as an RFC. RFC Editor: remove this section upon publication as an RFC.
C.1. Changes Between Versions -04 and -05 D.1. Changes Between Versions -05 and -06
o Document title changed: "Configuration" was replaced by
"Management".
o New typedefs "routing-table-ref" and "route-filter-ref".
o Double slashes "//" were removed from XPath expressions and
replaced with the single "/".
o Removed uniqueness requirement for "router-id".
o Complete data tree is now in Appendix A.
o Changed type of "source-protocol" from "leafref" to "string".
o Clarified the relationship between routing protocol instances and
connected routing tables.
o Added a must constraint saying that a routing table connected to
the direct pseudo-protocol must not be a main routing table.
D.2. Changes Between Versions -04 and -05
o Routing tables are now global, i.e., "routing-tables" is a child o Routing tables are now global, i.e., "routing-tables" is a child
of "routing" rather than "router". of "routing" rather than "router".
o "must" statement for "static-routes" changed to "when". o "must" statement for "static-routes" changed to "when".
o Added "main-routing-tables" containing references to main routing o Added "main-routing-tables" containing references to main routing
tables for each address family. tables for each address family.
o Removed the defaults for "address-family" and "safi" and made them o Removed the defaults for "address-family" and "safi" and made them
skipping to change at page 61, line 44 skipping to change at page 65, line 19
o The "direct" pseudo-protocol is always connected to main routing o The "direct" pseudo-protocol is always connected to main routing
tables. tables.
o Entries in the list of connected routing tables renamed from o Entries in the list of connected routing tables renamed from
"routing-table" to "connected-routing-table". "routing-table" to "connected-routing-table".
o Added "must" constraint saying that a routing table must not be o Added "must" constraint saying that a routing table must not be
its own recipient. its own recipient.
C.2. Changes Between Versions -03 and -04 D.3. Changes Between Versions -03 and -04
o Changed "error-tag" for both RPC methods from "missing element" to o Changed "error-tag" for both RPC methods from "missing element" to
"data-missing". "data-missing".
o Removed the decrementing behavior for advertised IPv6 prefix o Removed the decrementing behavior for advertised IPv6 prefix
parameters "valid-lifetime" and "preferred-lifetime". parameters "valid-lifetime" and "preferred-lifetime".
o Changed the key of the static route lists from "seqno" to "id" o Changed the key of the static route lists from "seqno" to "id"
because the routes needn't be sorted. because the routes needn't be sorted.
o Added 'must' constraint saying that "preferred-lifetime" must not o Added 'must' constraint saying that "preferred-lifetime" must not
be greater than "valid-lifetime". be greater than "valid-lifetime".
C.3. Changes Between Versions -02 and -03 D.4. Changes Between Versions -02 and -03
o Module "iana-afn-safi" moved to I-D "iana-if-type". o Module "iana-afn-safi" moved to I-D "iana-if-type".
o Removed forwarding table. o Removed forwarding table.
o RPC "get-route" changed to "active-route". Its output is a list o RPC "get-route" changed to "active-route". Its output is a list
of routes (for multi-path routing). of routes (for multi-path routing).
o New RPC "route-count". o New RPC "route-count".
skipping to change at page 62, line 43 skipping to change at page 66, line 18
"ietf-ip". "ietf-ip".
o Added "router-id" leaf. o Added "router-id" leaf.
o Specified the names for IPv4/IPv6 unicast main routing tables. o Specified the names for IPv4/IPv6 unicast main routing tables.
o Route parameter "last-modified" changed to "age". o Route parameter "last-modified" changed to "age".
o Added container "recipient-routing-tables". o Added container "recipient-routing-tables".
C.4. Changes Between Versions -01 and -02 D.5. Changes Between Versions -01 and -02
o Added module "ietf-ipv6-unicast-routing". o Added module "ietf-ipv6-unicast-routing".
o The example in Appendix B now uses IP addresses from blocks o The example in Appendix C now uses IP addresses from blocks
reserved for documentation. reserved for documentation.
o Direct routes appear by default in the forwarding table. o Direct routes appear by default in the forwarding table.
o Network layer interfaces must be assigned to a router instance. o Network layer interfaces must be assigned to a router instance.
Additional interface configuration may be present. Additional interface configuration may be present.
o The "when" statement is only used with "augment", "must" is used o The "when" statement is only used with "augment", "must" is used
elsewhere. elsewhere.
o Additional "must" statements were added. o Additional "must" statements were added.
o The "route-content" grouping for IPv4 and IPv6 unicast now o The "route-content" grouping for IPv4 and IPv6 unicast now
includes the material from the "ietf-routing" version via "uses includes the material from the "ietf-routing" version via "uses
rt:route-content". rt:route-content".
o Explanation of symbols in the tree representation of data model o Explanation of symbols in the tree representation of data model
hierarchy. hierarchy.
C.5. Changes Between Versions -00 and -01 D.6. Changes Between Versions -00 and -01
o AFN/SAFI-independent stuff was moved to the "ietf-routing" module. o AFN/SAFI-independent stuff was moved to the "ietf-routing" module.
o Typedefs for AFN and SAFI were placed in a separate "iana-afn- o Typedefs for AFN and SAFI were placed in a separate "iana-afn-
safi" module. safi" module.
o Names of some data nodes were changed, in particular "routing- o Names of some data nodes were changed, in particular "routing-
process" is now "router". process" is now "router".
o The restriction of a single AFN/SAFI per router was lifted. o The restriction of a single AFN/SAFI per router was lifted.
 End of changes. 176 change blocks. 
438 lines changed or deleted 513 lines changed or added

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