--- 1/draft-ietf-netmod-routing-cfg-12.txt 2014-01-10 06:14:33.870148951 -0800 +++ 2/draft-ietf-netmod-routing-cfg-13.txt 2014-01-10 06:14:34.014152641 -0800 @@ -1,18 +1,18 @@ NETMOD L. Lhotka Internet-Draft CZ.NIC -Intended status: Standards Track November 07, 2013 -Expires: May 11, 2014 +Intended status: Standards Track January 10, 2014 +Expires: July 14, 2014 A YANG Data Model for Routing Management - draft-ietf-netmod-routing-cfg-12 + draft-ietf-netmod-routing-cfg-13 Abstract This document contains a specification of three YANG modules. Together they form the core routing data model which serves as a framework for configuring and managing a routing subsystem. It is expected that these modules will be augmented by additional YANG modules defining data models for individual routing protocols and other related functions. The core routing data model provides common building blocks for such extensions - routing instances, routes, @@ -26,25 +26,25 @@ Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." - This Internet-Draft will expire on May 11, 2014. + This Internet-Draft will expire on July 14, 2014. Copyright Notice - Copyright (c) 2013 IETF Trust and the persons identified as the + Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as @@ -68,73 +68,76 @@ 5.3. Routing Information Base (RIB) . . . . . . . . . . . . . . 16 5.3.1. Multiple RIBs per Address Family . . . . . . . . . . . 17 5.4. Routing Protocol . . . . . . . . . . . . . . . . . . . . . 17 5.4.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . . 18 5.4.2. Defining New Routing Protocols . . . . . . . . . . . . 20 5.5. Route Filter . . . . . . . . . . . . . . . . . . . . . . . 21 5.6. RPC Operations . . . . . . . . . . . . . . . . . . . . . . 22 6. Interactions with Other YANG Modules . . . . . . . . . . . . . 23 6.1. Module "ietf-interfaces" . . . . . . . . . . . . . . . . . 23 6.2. Module "ietf-ip" . . . . . . . . . . . . . . . . . . . . . 23 - 7. Routing YANG Module . . . . . . . . . . . . . . . . . . . . . 25 - 8. IPv4 Unicast Routing YANG Module . . . . . . . . . . . . . . . 47 - 9. IPv6 Unicast Routing YANG Module . . . . . . . . . . . . . . . 54 + 7. Routing Management YANG Module . . . . . . . . . . . . . . . . 25 + 8. IPv4 Unicast Routing Management YANG Module . . . . . . . . . 47 + 9. IPv6 Unicast Routing Management YANG Module . . . . . . . . . 54 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 69 11. Security Considerations . . . . . . . . . . . . . . . . . . . 71 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 72 13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 73 13.1. Normative References . . . . . . . . . . . . . . . . . . . 73 13.2. Informative References . . . . . . . . . . . . . . . . . . 73 Appendix A. The Complete Data Trees . . . . . . . . . . . . . . . 74 A.1. Configuration Data . . . . . . . . . . . . . . . . . . . . 74 A.2. Operational State Data . . . . . . . . . . . . . . . . . . 76 - Appendix B. Example: Adding a New Routing Protocol . . . . . . . 78 - Appendix C. Example: NETCONF Reply . . . . . . . . . . . . 81 - Appendix D. Change Log . . . . . . . . . . . . . . . . . . . . . 87 - D.1. Changes Between Versions -11 and -12 . . . . . . . . . . . 87 - D.2. Changes Between Versions -10 and -11 . . . . . . . . . . . 87 - D.3. Changes Between Versions -09 and -10 . . . . . . . . . . . 87 - D.4. Changes Between Versions -08 and -09 . . . . . . . . . . . 88 - D.5. Changes Between Versions -07 and -08 . . . . . . . . . . . 88 - D.6. Changes Between Versions -06 and -07 . . . . . . . . . . . 88 - D.7. Changes Between Versions -05 and -06 . . . . . . . . . . . 88 - D.8. Changes Between Versions -04 and -05 . . . . . . . . . . . 89 - D.9. Changes Between Versions -03 and -04 . . . . . . . . . . . 90 - D.10. Changes Between Versions -02 and -03 . . . . . . . . . . . 90 - D.11. Changes Between Versions -01 and -02 . . . . . . . . . . . 91 - D.12. Changes Between Versions -00 and -01 . . . . . . . . . . . 91 - Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 92 + Appendix B. Minimum Implementation . . . . . . . . . . . . . . . 78 + Appendix C. Example: Adding a New Routing Protocol . . . . . . . 79 + Appendix D. Example: NETCONF Reply . . . . . . . . . . . . 82 + Appendix E. Change Log . . . . . . . . . . . . . . . . . . . . . 89 + E.1. Changes Between Versions -12 and -13 . . . . . . . . . . . 89 + E.2. Changes Between Versions -11 and -12 . . . . . . . . . . . 89 + E.3. Changes Between Versions -10 and -11 . . . . . . . . . . . 90 + E.4. Changes Between Versions -09 and -10 . . . . . . . . . . . 90 + E.5. Changes Between Versions -08 and -09 . . . . . . . . . . . 90 + E.6. Changes Between Versions -07 and -08 . . . . . . . . . . . 91 + E.7. Changes Between Versions -06 and -07 . . . . . . . . . . . 91 + E.8. Changes Between Versions -05 and -06 . . . . . . . . . . . 91 + E.9. Changes Between Versions -04 and -05 . . . . . . . . . . . 92 + E.10. Changes Between Versions -03 and -04 . . . . . . . . . . . 92 + E.11. Changes Between Versions -02 and -03 . . . . . . . . . . . 93 + E.12. Changes Between Versions -01 and -02 . . . . . . . . . . . 93 + E.13. Changes Between Versions -00 and -01 . . . . . . . . . . . 94 + Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 95 1. Introduction This document contains a specification of the following YANG modules: o Module "ietf-routing" provides generic components of a routing data model. o Module "ietf-ipv4-unicast-routing" augments the "ietf-routing" module with additional data specific to IPv4 unicast. o Module "ietf-ipv6-unicast-routing" augments the "ietf-routing" module with additional data specific to IPv6 unicast, including the router configuration variables required by [RFC4861]. These modules together define the so-called core routing data model, which is proposed as a basis for the development of data models for configuration and management of more sophisticated routing systems. While these three modules can be directly used for simple IP devices - with static routing, their main purpose is to provide essential - building blocks for more complicated setups involving multiple - routing protocols, multicast routing, additional address families, - and advanced functions such as route filtering or policy routing. To - this end, it is expected that the core routing data model will be - augmented by numerous modules developed by other IETF working groups. + with static routing (see Appendix B), their main purpose is to + provide essential building blocks for more complicated setups + involving multiple routing protocols, multicast routing, additional + address families, and advanced functions such as route filtering or + policy routing. To this end, it is expected that the core routing + data model will be augmented by numerous modules developed by other + IETF working groups. 2. Terminology and Notation The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119]. The following terms are defined in [RFC6241]: o client @@ -165,28 +168,29 @@ o RPC operation 2.1. Glossary of New Terms active route: a route that is actually used for sending packets. If there are multiple candidate routes with a matching destination prefix, then it is up to the routing algorithm to select the active route. - core routing data model: YANG data model resulting from the - combination of "ietf-routing", "ietf-ipv4-unicast-routing" and - "ietf-ipv6-unicast-routing" modules. + core routing data model: YANG data model comprising "ietf-routing", + "ietf-ipv4-unicast-routing" and "ietf-ipv6-unicast-routing" + modules. direct route: a route to a directly connected network. - routing information base (RIB): An object containing routes together - with other information. See Section 5.3 for details. + routing information base (RIB): An object containing a list of + routes together with other information. See Section 5.3 for + details. system-controlled entry: An entry of a list in operational state data ("config false") that is created by the system independently of what has been explicitly configured. See Section 4.1 for details. user-controlled entry: An entry of a list in operational state data ("config false") that is created and deleted as a direct consequence of certain configuration changes. See Section 4.1 for details. @@ -281,21 +285,21 @@ +--rw routing +--rw routing-instance* [name] | +--rw name | +--rw type? | +--rw enabled? | +--rw router-id? | +--rw description? | +--rw default-ribs | | +--rw default-rib* [address-family] | | +--rw address-family - | | +--rw name + | | +--rw rib-name | +--rw interfaces | | +--rw interface* [name] | | +--rw name | | +--rw v6ur:ipv6-router-advertisements | | ... | +--rw routing-protocols | +--rw routing-protocol* [name] | +--rw name | +--rw description? | +--rw enabled? @@ -316,48 +320,48 @@ +--rw route-filter* [name] +--rw name +--rw description? +--rw type Figure 1: Configuration data hierarchy. +--ro routing-state +--ro routing-instance* [name] | +--ro name - | +--ro id? + | +--ro id | +--ro type? | +--ro router-id? | +--ro default-ribs | | +--ro default-rib* [address-family] | | +--ro address-family - | | +--ro rib-id + | | +--ro rib-name | +--ro interfaces | | +--ro interface* [name] | | +--ro name | | +--ro v6ur:ipv6-router-advertisements | | ... | +--ro routing-protocols | +--ro routing-protocol* [name] | +--ro name | +--ro type | +--ro connected-ribs | ... +--ro ribs | +--ro rib* [name] | +--ro name - | +--ro id? + | +--ro id | +--ro address-family | +--ro routes - | | +--ro route* + | | +--ro route* [id] | | ... | +--ro recipient-ribs - | +--ro recipient-rib* [rib-id] + | +--ro recipient-rib* [rib-name] | ... +--ro route-filters +--ro route-filter* [name] +--ro name +--ro type Figure 2: Operational state data hierarchy. As can be seen from Figures 1 and 2, the core routing data model introduces several generic components of a routing framework: routing @@ -419,31 +423,31 @@ In such a list, the server creates the required item as a so-called system-controlled entry in operational state data, i.e., inside the "routing-state" container. Additional entries may be created in the configuration by the user via the NETCONF protocol. These are so-called user-controlled entries. If the server accepts a configured user-controlled entry, then this entry also appears in the operational state version of the list. - Both versions of the list (in operational state data and - configuration) use the "name" leaf as their key. + Corresponding entries in both versions of the list (in operational + state data and configuration) have the same value of the list key. The user may also provide supplemental configuration of system- controlled entries. To do so, the user creates a new entry in the configuration with the desired contents. In order to bind this entry with the corresponding entry in the operational state list, the key of the configuration entry has to be set to the same value as the key of the state entry. - An example can be seen in Appendix C: the "/routing-state/ + An example can be seen in Appendix D: the "/routing-state/ routing-instance" list has a single system-controlled entry whose "name" key has the value "rtr0". This entry is configured by the "/routing/routing-instance" entry whose "name" key is also "rtr0". Deleting a user-controlled entry from the configuration list results in the removal of the corresponding entry in the operational state list. In contrast, if a system-controlled entry is deleted from the configuration list, only the extra configuration specified in that entry is removed but the corresponding operational state entry remains in the list. @@ -455,43 +459,41 @@ devices, some parts and options of the data model are not needed and would represent unnecessary complications for the implementation. Therefore, the core routing data model makes the advanced functionality optional by means of two YANG features: o "multiple-ribs" - indicates that the device supports multiple RIBs per address family, routing protocols connected to non-default RIBs, and RIBs configured as receivers of routes from other RIBs. o "multipath-routes" - indicates that the device supports routes - with multiple nexthops. + with multiple next-hops. See the "ietf-routing" module for details. 5. Basic Building Blocks This section describes the essential components of the core routing data model. 5.1. Routing Instance Each routing instance in the core routing data model represents a logical router. The exact semantics of this term are left to implementations. For example, routing instances may be completely isolated virtual routers or, alternatively, they may internally share certain information. - A routing instance together with its operational status is - represented as an entry of the list "/routing-state/ - routing-instance", and identified by a unique numeric identifier. - Configuration of that router instance appears as entry of the list - "/routing/routing-instance" whose key is a routing instance name - selected by the client. + A routing instance together with its operational state is represented + as an entry of the list "/routing-state/routing-instance", and + identified by a unique name. Configuration of that router instance + appears as an entry of the list "/routing/routing-instance". An implementation MAY support multiple types of logical routers simultaneously. Instances of all routing instance types are organized as entries of the same flat "routing-instance" list. In order to discriminate routing instances belonging to different types, the "type" leaf is defined as a child of the "routing-instance" node. An implementation MAY create one or more system-controlled routing instances, and MAY also pose restrictions on allowed routing instance types and on the number of supported instances for each type. For @@ -553,21 +555,21 @@ * valid-lifetime, * on-link-flag, * preferred-lifetime, * autonomous-flag. The definitions and descriptions of the above parameters can be found - in the text of the module "ietf-ipv6-unicast-routing" (Section 9). + in the module "ietf-ipv6-unicast-routing" (Section 9). NOTES: 1. The "IsRouter" flag, which is also required by [RFC4861], is implemented in the "ietf-ip" module [YANG-IP] (leaf "ip: forwarding"). 2. The original specification [RFC4861] allows the implementations to decide whether the "valid-lifetime" and "preferred-lifetime" parameters remain the same in consecutive advertisements, or @@ -581,21 +583,21 @@ 5.2. Route Routes are basic elements of information in a routing system. The core routing data model defines only the following minimal set of route attributes: o destination prefix: IP prefix specifying the set of destination addresses for which the route may be used. This attribute is mandatory. - o next hop or action: outgoing interface, IP address of one or more + o next-hop or action: outgoing interface, IP address of one or more adjacent routers to which a packet should be forwarded, or a special action such as discarding the packet. The above list of route attributes suffices for a simple static routing configuration. It is expected that future modules defining routing protocols will add other route attributes such as metrics or preferences. Routes and their attributes are used both in configuration data, for example as manually configured static routes, and in operational @@ -620,28 +622,28 @@ represented as entries of the list "/routing-state/ribs/rib". The contents of RIBs are controlled and manipulated by routing protocol operations which may result in route additions, removals and modifications. This also includes manipulations via the "static" and/or "direct" pseudo-protocols, see Section 5.4.1. RIBs are global, which means that a RIB may be used by any or all routing instances. However, an implementation MAY specify rules and restrictions for sharing RIBs among routing instances. - Each routing instance must have, for every supported address family, - one RIB selected as the so-called default RIB. This selection is + Each routing instance has, for every supported address family, one + RIB selected as the so-called default RIB. This selection is recorded in the list "default-rib". The role of default RIBs is explained in Section 5.4. Simple router implementations that do not advertise the feature "multiple-ribs" will typically create one system-controlled RIB per - supported address family, and declare it as a default RIB (via a + supported address family, and declare it as the default RIB (via a system-controlled entry of the "default-rib" list). 5.3.1. Multiple RIBs per Address Family More complex router implementations advertising the "multiple-ribs" feature support multiple RIBs per address family that can be used for policy routing and other purposes. Every RIB can then serve as a source of routes for other RIBs of the same address family. To achieve this, one or more recipient RIBs may be specified in the configuration of the source RIB. Optionally, a route filter may be @@ -694,70 +696,71 @@ The core routing data model defines two special routing protocol types - "direct" and "static". Both are in fact pseudo-protocols, which means that they are confined to the local device and do not exchange any routing information with neighboring routers. Routes from both "direct" and "static" protocol instances are passed to the connected RIB (subject to route filters, if any), but an exchange in the opposite direction is not allowed. Every routing instance MUST implement exactly one instance of the - "direct" pseudo-protocol type. The name of this instance MUST also - be "direct". It is the source of direct routes for all configured - address families. Direct routes are normally supplied by the - operating system kernel, based on the configuration of network + "direct" pseudo-protocol type. It is the source of direct routes for + all configured address families. Direct routes are normally supplied + by the operating system kernel, based on the configuration of network interface addresses, see Section 6.2. The "direct" pseudo-protocol MUST always be connected to the default RIBs of all supported address families. Unlike other routing protocol types, this connection cannot be changed in the configuration. Direct routes MAY be filtered before they appear in the default RIB. A pseudo-protocol of the type "static" allows for specifying routes manually. It MAY be configured in zero or multiple instances, although a typical configuration will have exactly one instance per routing instance. Static routes are configured within the "static-routes" container, see Figure 4. +--rw static-routes +--rw v4ur:ipv4 | +--rw v4ur:route* [id] | +--rw v4ur:id | +--rw v4ur:description? | +--rw v4ur:destination-prefix - | +--rw (nexthop-options) - | +--:(special-nexthop) - | | +--rw v4ur:special-nexthop? - | +--:(simple-nexthop) - | | +--rw v4ur:gateway? + | +--rw (next-hop-options) + | +--:(special-next-hop) + | | +--rw v4ur:special-next-hop? + | +--:(simple-next-hop) + | | +--rw v4ur:next-hop? | | +--rw v4ur:outgoing-interface? - | +--:(nexthop-list) {rt:multipath-routes}? - | +--rw v4ur:nexthop* [id] + | +--:(next-hop-list) {rt:multipath-routes}? + | +--rw v4ur:next-hop-list + | +--rw v4ur:next-hop* [id] | +--rw v4ur:id | +--rw v4ur:address? | +--rw v4ur:outgoing-interface? | +--rw v4ur:priority? | +--rw v4ur:weight? +--rw v6ur:ipv6 +--rw v6ur:route* [id] +--rw v6ur:id +--rw v6ur:description? +--rw v6ur:destination-prefix - +--rw (nexthop-options) - +--:(special-nexthop) - | +--rw v6ur:special-nexthop? - +--:(simple-nexthop) - | +--rw v6ur:gateway? + +--rw (next-hop-options) + +--:(special-next-hop) + | +--rw v6ur:special-next-hop? + +--:(simple-next-hop) + | +--rw v6ur:next-hop? | +--rw v6ur:outgoing-interface? - +--:(nexthop-list) {rt:multipath-routes}? - +--rw v6ur:nexthop* [id] + +--:(next-hop-list) {rt:multipath-routes}? + +--rw v6ur:next-hop-list + +--rw v6ur:next-hop* [id] +--rw v6ur:id +--rw v6ur:address? +--rw v6ur:outgoing-interface? +--rw v6ur:priority? +--rw v6ur:weight? Figure 4: Structure of "static-routes" subtree. 5.4.2. Defining New Routing Protocols @@ -793,21 +796,21 @@ in the list of routing instance interfaces (rt:interface). By using the "when" statement, the augmented configuration parameters and state data specific to the new protocol SHOULD be made conditional and valid only if the value of "rt:type" or "rt:source- protocol" is equal to the new protocol's identity. It is also RECOMMENDED that protocol-specific data nodes be encapsulated in appropriately named containers. The above steps are implemented by the example YANG module for the - RIP routing protocol in Appendix B. + RIP routing protocol in Appendix C. 5.5. Route Filter The core routing data model provides a skeleton for defining route filters that can be used to restrict the set of routes being exchanged between a routing protocol instance and a connected RIB, or between a source and a recipient RIB. Route filters may also manipulate routes, i.e., add, delete, or modify their attributes. Route filters are global, which means that a configured route filter @@ -829,21 +832,21 @@ will be developed separately. Each route filter is identified by a unique name. Its type MUST be specified by the "type" identity reference - this opens the space for multiple route filtering framework implementations. 5.6. RPC Operations The "ietf-routing" module defines two RPC operations: - o active-route: query the routing system for the active route that + o active-route: query a routing instance for the active route that is currently used for sending datagrams to a destination host whose address is passed as an input parameter. o route-count: retrieve the total number of entries in a RIB. 6. Interactions with Other YANG Modules The semantics of the core routing data model also depend on several configuration parameters that are defined in other YANG modules. @@ -890,27 +893,27 @@ IPv6 routing functions, such as routing protocols. In addition, the "ietf-ip" module allows for configuring IPv4 and IPv6 addresses and network prefixes or masks on network layer interfaces. Configuration of these parameters on an enabled interface MUST result in an immediate creation of the corresponding direct route. The destination prefix of this route is set according to the configured IP address and network prefix/mask, and the interface is set as the outgoing interface for that route. -7. Routing YANG Module +7. Routing Management YANG Module RFC Ed.: In this section, replace all occurrences of 'XXXX' with the actual RFC number and all occurrences of the revision date below with the date of RFC publication (and remove this note). - file "ietf-routing@2013-11-07.yang" + file "ietf-routing@2014-01-10.yang" module ietf-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-routing"; prefix "rt"; import ietf-yang-types { prefix "yang"; } @@ -926,67 +929,64 @@ "WG Web: WG List: WG Chair: David Kessens WG Chair: Juergen Schoenwaelder Editor: Ladislav Lhotka - - "; + "; description "This YANG module defines essential components for the management of a routing subsystem. Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the - RFC itself for full legal notices. - "; + RFC itself for full legal notices."; - revision 2013-11-07 { + revision 2014-01-10 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Management"; } /* Features */ feature multiple-ribs { description "This feature indicates that the device supports multiple RIBS per address family, and the framework for passing routes - between RIBs, or between routing protocols and RIBs. + between RIBs. Devices that do not support this feature MUST provide exactly one system-controlled RIB per supported address family. These RIBs then appear as entries of the list - /routing-state/ribs/rib. - "; + /routing-state/ribs/rib."; } feature multipath-routes { description "This feature indicates that the device supports multipath - routes that have a list of nexthops."; + routes that have a list of next-hops."; } /* Identities */ identity address-family { description "Base identity from which identities describing address families are derived."; } @@ -1001,22 +1000,21 @@ description "This identity represents IPv6 address family."; } identity routing-instance-type { description "Base identity from which identities describing routing instance types are derived. It is primarily intended for discriminating among different - types of logical routers or router virtualization. - "; + types of logical routers or router virtualization."; } identity standard-routing-instance { base routing-instance-type; description "This identity represents a default routing instance."; } identity routing-protocol { description @@ -1059,44 +1058,43 @@ type leafref { path "/rt:routing/rt:routing-instance/rt:name"; } description "This type is used for leafs that reference a routing instance configuration."; } typedef routing-instance-state-ref { type leafref { - path "/rt:routing-state/rt:routing-instance/rt:id"; + path "/rt:routing-state/rt:routing-instance/rt:name"; } description "This type is used for leafs that reference state data of a routing instance."; } typedef rib-ref { type leafref { path "/rt:routing/rt:ribs/rt:rib/rt:name"; } description "This type is used for leafs that reference a RIB configuration."; } typedef rib-state-ref { type leafref { - path "/rt:routing-state/rt:ribs/rt:rib/rt:id"; + path "/rt:routing-state/rt:ribs/rt:rib/rt:name"; } description "This type is used for leafs that reference a RIB in state data."; - } 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 configuration."; } @@ -1122,62 +1120,67 @@ base address-family; } mandatory "true"; description "Address family."; } } grouping state-entry-id { description - "This grouping defines a unique identifier of entries in + "This grouping defines a unique identifier for entries in several operational state lists."; leaf id { - type uint64 { - range "1..max"; - } + type uint64; description "Unique numerical identifier of a list entry in operational - state."; + state. It may be used by protocols or tools that inspect + and/or manipulate operational state data and prefer + fixed-size integers as list entry handles. + + These identifiers are always ephemeral, i.e., they may + change after a reboot."; } } grouping router-id { description "This grouping provides the definition of router ID."; leaf router-id { type yang:dotted-quad; description - "Router ID - 32-bit number in the form of a dotted quad."; + "Router ID - 32-bit number in the form of a dotted quad. Some + protocols use this parameter for identifying a router to its + neighbors."; } } grouping outgoing-interface { description "This grouping defines the outgoing interface for use in - nexthops."; + next-hops."; leaf outgoing-interface { type leafref { path "/routing-state/routing-instance/interfaces/interface/" + "name"; } description "Name of the outgoing interface."; } } - grouping special-nexthop { + grouping special-next-hop { description - "This grouping provides the leaf for specifying special nexthop - options."; - leaf special-nexthop { + "This grouping provides the leaf for specifying special + next-hop options."; + leaf special-next-hop { type enumeration { enum blackhole { description "Silently discard the packet."; } enum unreachable { description "Discard the packet and notify the sender with an error message indicating that the destination host is unreachable."; @@ -1180,103 +1183,102 @@ description "Discard the packet and notify the sender with an error message indicating that the destination host is unreachable."; } enum prohibit { description "Discard the packet and notify the sender with an error message indicating that the communication is administratively prohibited."; - } enum receive { description "The packet will be received by the local network device."; } } description - "Special nexthop options."; + "Special next-hop options."; } } - grouping nexthop-classifiers { + grouping next-hop-classifiers { description - "This grouping provides two nexthop classifiers."; + "This grouping provides two next-hop classifiers."; leaf priority { type enumeration { enum primary { value "1"; description - "Primary nexthop."; + "Primary next-hop."; } enum backup { value "2"; description - "Backup nexthop."; + "Backup next-hop."; } } default "primary"; description "Simple priority for distinguishing between primary and - backup nexthops. + backup next-hops. - Backup nexthops are used if and only if no primary nexthops - are reachable. - "; + Backup next-hops are used if and only if no primary + next-hops are reachable."; } leaf weight { type uint8; - must ". = 0 or not(../../nexthop/weight = 0)" { + must ". = 0 or not(../../next-hop/weight = 0)" { error-message "Illegal combination of zero and non-zero " - + "nexthop weights."; + + "next-hop weights."; description - "Nexthop weights must be either all zero (equal + "Next-hop weights must be either all zero (equal load-balancing) or all non-zero."; } default "0"; description - "This parameter specifies the weight of the nexthop for load + "This parameter specifies the weight of the next-hop for load balancing. The number specifies the relative fraction of the - traffic that will use the corresponding nexthop. + traffic that will use the corresponding next-hop. The default value of 0 represents equal load-balancing. - If both primary and backup nexthops are present, then the - weights for each priority level are used separately. - "; + If both primary and backup next-hops are present, then the + weights for each priority level are used separately."; } } - grouping nexthop-content { + grouping next-hop-content { description - "Generic parameters of nexthops in routes."; - choice nexthop-options { + "Generic parameters of next-hops in routes."; + choice next-hop-options { mandatory "true"; description - "Options for expressing the nexthop in routes."; - case special-nexthop { - uses special-nexthop; + "Options for expressing the next-hop in routes."; + case special-next-hop { + uses special-next-hop; } - case simple-nexthop { + case simple-next-hop { uses outgoing-interface; } - case nexthop-list { + case next-hop-list { if-feature multipath-routes; - list nexthop { - unique "id"; + container next-hop-list { + list next-hop { + key "id"; description - "An entry of a nexthop list."; + "An entry of a next-hop list."; uses state-entry-id; uses outgoing-interface; - uses nexthop-classifiers; + uses next-hop-classifiers; + } } } } } grouping route-metadata { description "Route metadata."; leaf source-protocol { type identityref { @@ -1304,69 +1306,73 @@ "Operational state of the routing subsystem."; list routing-instance { key "name"; unique "id"; description "Each list entry is a container for operational state data of a routing instance. An implementation MAY create one or more system-controlled instances, other user-controlled instances MAY be created by - configuration. - "; + configuration."; leaf name { type string; description "The name of the routing instance. - "; + + For system-controlled instances the name is persistent, + i.e., it SHOULD NOT change across reboots."; + } + uses state-entry-id { + refine "id" { + mandatory "true"; + } } - uses state-entry-id; leaf type { type identityref { base routing-instance-type; } default "rt:standard-routing-instance"; description "The routing instance type, primarily intended for discriminating among different types of logical routers, route virtualization, master-slave arrangements etc., - while keeping all routing instances in the same flat list. - "; + while keeping all routing instances in the same flat + list."; } uses router-id { description "Global router ID. An implementation may choose a value if none is configured. - Routing protocols MAY override this global parameter. - "; + Routing protocols that use router ID MAY override this + global parameter."; } container default-ribs { description "Default RIBs used by the routing instance."; list default-rib { key "address-family"; description "Each list entry specifies the default RIB for one address family. The default RIB is operationally connected to all routing protocols for which a connected RIB has not been explicitly configured. The 'direct' pseudo-protocol is always connected to the - default RIBs. - "; + default RIBs."; uses address-family; - leaf rib-id { + leaf rib-name { type rib-state-ref; mandatory "true"; description "Name of an existing RIB to be used as the default RIB for the given routing instance and address family."; } } } container interfaces { description @@ -1385,129 +1391,137 @@ } } } container routing-protocols { description "Container for the list of routing protocol instances."; list routing-protocol { key "name"; description "Operational state of a routing protocol instance. - "; + + An implementation MUST provide exactly one + system-controlled instance of the type 'direct'. Other + instances MAY be created by configuration."; leaf name { type string; description - "The name of the routing protocol instance."; + "The name of the routing protocol instance. + + For system-controlled instances this name is + persistent, i.e., it SHOULD NOT change across + reboots."; } leaf type { type identityref { base routing-protocol; } mandatory "true"; description "Type of the routing protocol."; } container connected-ribs { - if-feature multiple-ribs; description - "Container for connected RIBs. - "; + "Container for connected RIBs."; list connected-rib { - key "rib-id"; + key "rib-name"; description "List of RIBs to which the routing protocol instance - is connected (at most one RIB per address family). - "; - leaf rib-id { + is connected (at most one RIB per address + family)."; + + leaf rib-name { type rib-state-ref; description "Name of an existing RIB."; } leaf import-filter { type route-filter-state-ref; description "Reference to a route filter that is used for filtering routes passed from this routing protocol - instance to the RIB specified by the 'name' + instance to the RIB specified by the 'rib-name' sibling node. If this leaf is not present, the behavior is protocol-specific, but typically it means that all - routes are accepted. - "; + routes are accepted."; } leaf export-filter { type route-filter-state-ref; description "Reference to a route filter that is used for filtering routes passed from the RIB specified by - the 'name' sibling node to this routing protocol - instance. + the 'rib-name' sibling node to this routing + protocol instance. If this leaf is not present, the behavior is protocol-specific - typically it means that all routes are accepted. The 'direct' and 'static' pseudo-protocols accept - no routes from any RIB. - "; + no routes from any RIB."; } } } } } } container ribs { description "Container for RIBs."; list rib { key "name"; unique "id"; description "Each entry represents a RIB identified by the 'name' key. All routes in a RIB MUST belong to the same address family. - The server MUST create the default RIB for each address - family, and MAY create other RIBs. Additional RIBs MAY be - created in the configuration. - "; + The server MUST provide a system-controlled default RIB + for each address family, and MAY provide other + system-controlled RIBs. Additional RIBs MAY be created in + the configuration."; leaf name { type string; description "The name of the RIB."; } - uses state-entry-id; + uses state-entry-id { + refine "id" { + mandatory "true"; + } + } uses address-family; container routes { description "Current contents of the RIB."; list route { - unique "id"; + key "id"; description "A RIB route entry. This data node MUST be augmented with information specific for routes of each address family."; uses state-entry-id; - uses nexthop-content; + uses next-hop-content; uses route-metadata; } } container recipient-ribs { if-feature multiple-ribs; description "Container for recipient RIBs."; list recipient-rib { - key "rib-id"; + key "rib-name"; description "List of RIBs that receive routes from this RIB."; - leaf rib-id { + leaf rib-name { type rib-state-ref; description "The name of the recipient RIB."; } leaf filter { type route-filter-state-ref; description "A route filter which is applied to the routes passed to the recipient RIB."; } @@ -1519,22 +1534,21 @@ description "Container for route filters."; list route-filter { key "name"; description "Route filters are used for filtering and/or manipulating routes that are passed between a routing protocol and a RIB and vice versa, or between two RIBs. It is expected that other modules augment this list with - contents specific for a particular route filter type. - "; + contents specific for a particular route filter type."; leaf name { type string; description "The name of the route filter."; } leaf type { type identityref { base route-filter; } mandatory "true"; @@ -1547,87 +1561,83 @@ } /* Configuration Data */ container routing { description "Configuration parameters for the routing subsystem."; list routing-instance { key "name"; description - "Configuration of a routing instance. - "; + "Configuration of a routing instance."; leaf name { type string; description "The name of the routing instance. For system-controlled entries, the value of this leaf must be the same as the name of the corresponding entry in state data. For user-controlled entries, an arbitrary name can be - used. - "; + used."; } leaf type { type identityref { base routing-instance-type; } default "rt:standard-routing-instance"; description "The type of the routing instance."; } leaf enabled { type boolean; default "true"; description "Enable/disable the routing instance. If this parameter is false, the parent routing instance is disabled and does not appear in operational state data, - despite any other configuration that might be present. - "; + despite any other configuration that might be present."; } uses router-id { description "Configuration of the global router ID."; } leaf description { type string; description "Textual description of the routing instance."; } container default-ribs { if-feature multiple-ribs; description "Configuration of the default RIBs used by the routing instance. The default RIB for an addressed family if by default connected to all routing protocol instances supporting - that address family, and always receives direct routes. - "; + that address family, and always receives direct routes."; list default-rib { must "address-family=/routing/ribs/rib[name=current()/" - + "name]/address-family" { + + "rib-name]/address-family" { error-message "Address family mismatch."; description "The entry's address family MUST match that of the referenced RIB."; } key "address-family"; description "Each list entry configures the default RIB for one address family."; uses address-family; - leaf name { + leaf rib-name { type string; mandatory "true"; description "Name of an existing RIB to be used as the default RIB for the given routing instance and address family."; } } } container interfaces { description @@ -1666,62 +1676,59 @@ } leaf enabled { type boolean; default "true"; description "Enable/disable the routing protocol instance. If this parameter is false, the parent routing protocol instance is disabled and does not appear in operational state data, despite any other - configuration that might be present. - "; + configuration that might be present."; } leaf type { type identityref { base routing-protocol; } mandatory "true"; description "Type of the routing protocol - an identity derived from the 'routing-protocol' base identity."; } container connected-ribs { if-feature multiple-ribs; description - "Configuration of connected RIBs. - "; + "Configuration of connected RIBs."; list connected-rib { must "not(/routing/ribs/rib[name=current()/" + "preceding-sibling::connected-rib/" - + "name and address-family=/routing/ribs/" - + "rib[name=current()/name]/address-family])" { + + "rib-name and address-family=/routing/ribs/" + + "rib[name=current()/rib-name]/address-family])" { error-message "Duplicate address family for connected RIBs."; description "For each address family, there MUST NOT be more than one connected RIB."; } key "rib-name"; description "List of RIBs to which the routing protocol instance is connected (at most one RIB per address family). If no connected RIB is configured for an address family, the routing protocol is connected to the - default RIB for that address family. - "; + default RIB for that address family."; leaf rib-name { type rib-ref; must "../../../type != 'rt:direct' or " + "../../../../../default-ribs/ " - + "default-rib/name=." { + + "default-rib/rib-name=." { error-message "The 'direct' protocol can be " + "connected only to a default RIB."; description "For the 'direct' pseudo-protocol, the connected RIB must always be a default RIB."; } description "Name of an existing RIB."; } leaf import-filter { @@ -1739,72 +1746,68 @@ container static-routes { when "../type='rt:static'" { description "This container is only valid for the 'static' routing protocol."; } description "Configuration of the 'static' pseudo-protocol. Address family specific modules augment this node with - their lists of routes. - "; + their lists of routes."; } } } } container ribs { description "Configured RIBs."; list rib { key "name"; description "Each entry represents a configured RIB identified by the 'name' key. Entries having the same key as a system-controlled entry of the list /routing-state/ribs/rib are used for configuring parameters of that entry. Other entries define - additional user-controlled RIBs. - "; - + additional user-controlled RIBs."; leaf name { type string; description "The name of the RIB. For system-controlled entries, the value of this leaf must be the same as the name of the corresponding entry in state data. For user-controlled entries, an arbitrary name can be - used. - "; + used."; } uses address-family; leaf description { type string; description "Textual description of the RIB."; } container recipient-ribs { if-feature multiple-ribs; description "Configuration of recipient RIBs."; list recipient-rib { - must "name != ../../name" { + must "rib-name != ../../name" { error-message "Source and recipient RIBs are identical."; description "A RIB MUST NOT appear among its recipient RIBs."; } - must "/routing/ribs/rib[name=current()/name]/" + must "/routing/ribs/rib[name=current()/rib-name]/" + "address-family=../../address-family" { error-message "Address family mismatch."; description "Address family of the recipient RIB MUST match that of the source RIB."; } key "rib-name"; description "Each entry configures a recipient RIB."; leaf rib-name { @@ -1849,102 +1852,98 @@ } } } } /* RPC methods */ rpc active-route { description "Return the active route that a routing-instance uses for - sending packets to a destination address. - "; + sending packets to a destination address."; input { - leaf routing-instance-id { + leaf routing-instance-name { type routing-instance-state-ref; mandatory "true"; description - "Identifier of the routing instance whose forwarding - information base is being queried. + "Name of the routing instance whose forwarding information + base is being queried. - If the routing instance with 'id' equal to - 'routing-instance-id' doesn't exist, then this operation - SHALL fail with error-tag 'data-missing' and error-app-tag - 'routing-instance-not-found'. - "; + If the routing instance with name equal to the value of + this parameter doesn't exist, then this operation SHALL + fail with error-tag 'data-missing' and error-app-tag + 'routing-instance-not-found'."; } container destination-address { description "Network layer destination address. Address family specific modules MUST augment this - container with a leaf named 'address'. - "; + container with a leaf named 'address'."; uses address-family; } } output { container route { description "The active route for the specified destination. If the routing instance has no active route for the destination address, no output is returned - the server SHALL send an containing a single element . Address family specific modules MUST augment this list - with appropriate route contents. - "; + with appropriate route contents."; uses address-family; - uses nexthop-content; + uses next-hop-content; uses route-metadata; } } } rpc route-count { description - "Return the current number of routes in a RIB. - - If the RIB with 'id' equal to 'rib-id' doesn't exist, then - this operation SHALL fail with error-tag 'data-missing' and - error-app-tag 'rib-not-found'. - "; + "Return the current number of routes in a RIB."; input { - leaf rib-id { + leaf rib-name { type rib-state-ref; mandatory "true"; description - "Identifier of the RIB."; + "Name of the RIB. + + If the RIB with name equal to the value of this parameter + doesn't exist, then this operation SHALL fail with + error-tag 'data-missing' and error-app-tag + 'rib-not-found'."; } } output { leaf number-of-routes { type uint64; mandatory "true"; description "Number of routes in the RIB."; } } } } -8. IPv4 Unicast Routing YANG Module +8. IPv4 Unicast Routing Management YANG Module RFC Ed.: In this section, replace all occurrences of 'XXXX' with the actual RFC number and all occurrences of the revision date below with the date of RFC publication (and remove this note). - file "ietf-ipv4-unicast-routing@2013-11-07.yang" + file "ietf-ipv4-unicast-routing@2014-01-10.yang" module ietf-ipv4-unicast-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing"; prefix "v4ur"; import ietf-routing { prefix "rt"; } @@ -1960,43 +1959,41 @@ "WG Web: WG List: WG Chair: David Kessens WG Chair: Juergen Schoenwaelder Editor: Ladislav Lhotka - - "; + "; description "This YANG module augments the 'ietf-routing' module with basic configuration and operational state data for IPv4 unicast routing. Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the - RFC itself for full legal notices. - "; + RFC itself for full legal notices."; - revision 2013-11-07 { + revision 2014-01-10 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Management"; } /* Identities */ identity ipv4-unicast { base rt:ipv4; @@ -2014,48 +2011,51 @@ description "This leaf augments an IPv4 unicast route."; leaf destination-prefix { type inet:ipv4-prefix; description "IPv4 destination prefix."; } } augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/" - + "rt:nexthop-options/rt:simple-nexthop" { + + "rt:next-hop-options/rt:simple-next-hop" { when "../../rt:address-family = 'v4ur:ipv4-unicast'" { description "This augment is valid only for IPv4 unicast."; } description - "This leaf augments the 'simple-nexthop' case of IPv4 unicast + "This leaf augments the 'simple-next-hop' case of IPv4 unicast routes."; - leaf gateway { + + leaf next-hop { type inet:ipv4-address; description - "IPv4 address of the gateway."; + "IPv4 address of the next-hop."; } } augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/" - + "rt:nexthop-options/rt:nexthop-list/rt:nexthop" { - when "../../../rt:address-family = 'v4ur:ipv4-unicast'" { + + "rt:next-hop-options/rt:next-hop-list/rt:next-hop-list/" + + "rt:next-hop" { + when "../../../../rt:address-family = 'v4ur:ipv4-unicast'" { description "This augment is valid only for IPv4 unicast."; } + if-feature rt:multipath-routes; description - "This leaf augments the 'nexthop-list' case of IPv4 unicast + "This leaf augments the 'next-hop-list' case of IPv4 unicast routes."; leaf address { type inet:ipv4-address; description - "IPv4 address of the nexthop."; + "IPv4 address of the next-hop."; } } /* Configuration data */ augment "/rt:routing/rt:routing-instance/rt:routing-protocols/" + "rt:routing-protocol/rt:static-routes" { description "This augment defines the configuration of the 'static' pseudo-protocol with data specific to IPv4 unicast."; @@ -2068,94 +2068,92 @@ ordered-by "user"; description "A user-ordered list of static routes."; leaf id { type uint32 { range "1..max"; } description "Unique numeric identifier of the route. - This value is unrelated to system-assigned keys of - routes in RIBs. - "; + This value is unrelated to system-assigned 'id' + parameters of routes in RIBs."; } leaf description { type string; description "Textual description of the route."; } leaf destination-prefix { type inet:ipv4-prefix; mandatory "true"; description "IPv4 destination prefix."; } - choice nexthop-options { + choice next-hop-options { mandatory "true"; description - "Options for expressing the nexthop in static routes."; - case special-nexthop { - uses rt:special-nexthop; + "Options for expressing the next-hop in static routes."; + case special-next-hop { + uses rt:special-next-hop; } - case simple-nexthop { - leaf gateway { + case simple-next-hop { + leaf next-hop { type inet:ipv4-address; description - "IPv4 address of the gateway."; + "IPv4 address of the next-hop."; } leaf outgoing-interface { type leafref { path "../../../../../../rt:interfaces/rt:interface/" + "rt:name"; } description "Name of the outgoing interface. - Only interfaces configured for the parent routing - instance can be given. - "; + Only interfaces configured for the ancestor routing + instance can be given."; } } - case nexthop-list { + case next-hop-list { if-feature rt:multipath-routes; - list nexthop { + container next-hop-list { + list next-hop { key "id"; description - "An entry of a nexthop list."; + "An entry of a next-hop list."; leaf id { type uint32; description "Unique numeric identifier of the entry. - This value is unrelated to system-assigned keys of - nexthops in RIBs. - "; + This value is unrelated to system-assigned 'id' + parameters of next-hops in RIBs."; } leaf address { type inet:ipv4-address; description - "IPv4 address of the nexthop."; + "IPv4 address of the next-hop."; } leaf outgoing-interface { type leafref { - path "../../../../../../../rt:interfaces/" + path "../../../../../../../../rt:interfaces/" + "rt:interface/rt:name"; } description "Name of the outgoing interface. - Only interfaces configured for the parent routing - instance can be given. - "; + Only interfaces configured for the ancestor + routing instance can be given."; + } + uses rt:next-hop-classifiers; } - uses rt:nexthop-classifiers; } } } } } } /* RPC methods */ augment "/rt:active-route/rt:input/rt:destination-address" { @@ -2182,64 +2178,62 @@ description "This leaf augments the reply to the 'rt:active-route' operation."; leaf destination-prefix { type inet:ipv4-prefix; description "IPv4 destination prefix."; } } - augment "/rt:active-route/rt:output/rt:route/rt:nexthop-options/" - + "rt:simple-nexthop" { + augment "/rt:active-route/rt:output/rt:route/rt:next-hop-options/" + + "rt:simple-next-hop" { when "rt:address-family='v4ur:ipv4-unicast'" { description "This augment is valid only for IPv4 unicast."; } description - "This leaf augments the 'simple-nexthop' case in the reply to + "This leaf augments the 'simple-next-hop' case in the reply to the 'rt:active-route' operation."; - leaf gateway { + leaf next-hop { type inet:ipv4-address; description - "IPv4 address of the gateway."; + "IPv4 address of the next-hop."; } } - augment "/rt:active-route/rt:output/rt:route/rt:nexthop-options/" - + "rt:nexthop-list/rt:nexthop" { - when "../rt:address-family='v4ur:ipv4-unicast'" { + augment "/rt:active-route/rt:output/rt:route/rt:next-hop-options/" + + "rt:next-hop-list/rt:next-hop-list/rt:next-hop" { + when "../../rt:address-family='v4ur:ipv4-unicast'" { description "This augment is valid only for IPv4 unicast."; } if-feature rt:multipath-routes; description - "This leaf augments the 'nexthop-list' case in the reply to the - 'rt:active-route' operation."; + "This leaf augments the 'next-hop-list' case in the reply to + the 'rt:active-route' operation."; leaf address { type inet:ipv4-address; description - "IPv4 address of the nexthop."; + "IPv4 address of the next-hop."; } - } } - -9. IPv6 Unicast Routing YANG Module +9. IPv6 Unicast Routing Management YANG Module RFC Ed.: In this section, replace all occurrences of 'XXXX' with the actual RFC number and all occurrences of the revision date below with the date of RFC publication (and remove this note). - file "ietf-ipv6-unicast-routing@2013-11-07.yang" + file "ietf-ipv6-unicast-routing@2014-01-10.yang" module ietf-ipv6-unicast-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing"; prefix "v6ur"; import ietf-routing { prefix "rt"; } @@ -2263,73 +2257,64 @@ "WG Web: WG List: WG Chair: David Kessens WG Chair: Juergen Schoenwaelder Editor: Ladislav Lhotka - - "; + "; description "This YANG module augments the 'ietf-routing' module with basic configuration and operational state data for IPv6 unicast routing. Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the - RFC itself for full legal notices. - "; + RFC itself for full legal notices."; - revision 2013-11-07 { + revision 2014-01-10 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Management"; } /* Identities */ identity ipv6-unicast { base rt:ipv6; description "This identity represents the IPv6 unicast address family."; } /* Operational state data */ augment "/rt:routing-state/rt:routing-instance/rt:interfaces/" + "rt:interface" { - when "/if:interfaces/if:interface[if:name=current()/rt:name]/" - + "ip:ipv6/ip:enabled='true'" { - description - "This augment is only valid for router interfaces with - enabled IPv6."; - } description "IPv6-specific parameters of router interfaces."; container ipv6-router-advertisements { description "Parameters of IPv6 Router Advertisements."; - leaf send-advertisements { type boolean; default "false"; description "A flag indicating whether or not the router sends periodic Router Advertisements and responds to Router Solicitations."; reference "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - AdvSendAdvertisements."; @@ -2355,22 +2340,21 @@ description "The minimum time allowed between sending unsolicited multicast Router Advertisements from the interface. The default value to be used operationally if this leaf is not configured is determined as follows: - if max-rtr-adv-interval >= 9 seconds, the default value 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 { type boolean; default "false"; description "The boolean value to be placed in the 'Managed address configuration' flag field in the Router Advertisement."; @@ -2429,85 +2413,81 @@ default "64"; description "The default value to be placed in the Cur Hop Limit field in the Router Advertisement messages sent by the router. The value should be set to the current diameter of the Internet. The value zero means unspecified (by this router). The default SHOULD be set to the value specified in IANA Assigned Numbers that was in effect at the time of - implementation. - "; + implementation."; reference "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - AdvCurHopLimit. IANA: IP Parameters, - http://www.iana.org/assignments/ip-parameters - "; + http://www.iana.org/assignments/ip-parameters"; } leaf default-lifetime { type uint16 { range "0..9000"; } units "seconds"; description "The value to be placed in the Router Lifetime field of Router Advertisements sent from the interface, in seconds. MUST be either zero or between max-rtr-adv-interval and 9000 seconds. A value of zero indicates that the router is not to be used as a default router. These limits may be overridden by specific documents that describe how IPv6 operates over different link layers. If this parameter is not configured, a value of 3 * - max-rtr-adv-interval SHOULD be used. - "; + max-rtr-adv-interval SHOULD be used."; reference "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - AdvDefaultLifeTime."; } container prefix-list { description "A list of prefixes that are placed in Prefix Information options in Router Advertisement messages sent from the interface. By default, these are all prefixes that the router advertises via routing protocols as being on-link for the interface from which the advertisement is sent. The link-local prefix SHOULD NOT be included in the list - of advertised prefixes. - "; + of advertised prefixes."; + reference "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - AdvPrefixList."; list prefix { key "prefix-spec"; description "Advertised prefix entry with parameters."; leaf prefix-spec { type inet:ipv6-prefix; description "IPv6 address prefix."; } leaf valid-lifetime { type uint32; units "seconds"; default "2592000"; description "The value to be placed in the Valid Lifetime in the Prefix Information option. The designated value of all - 1's (0xffffffff) represents infinity. - "; + 1's (0xffffffff) represents infinity."; reference "RFC 4861: Neighbor Discovery for IP version 6 (IPv6) - AdvValidLifetime."; } leaf on-link-flag { type boolean; default "true"; description "The value to be placed in the on-link flag ('L-bit') field in the Prefix Information option."; @@ -2551,48 +2531,50 @@ description "This leaf augments an IPv6 unicast route."; leaf destination-prefix { type inet:ipv6-prefix; description "IPv6 destination prefix."; } } augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/" - + "rt:nexthop-options/rt:simple-nexthop" { + + "rt:next-hop-options/rt:simple-next-hop" { when "../../rt:address-family = 'v6ur:ipv6-unicast'" { description "This augment is valid only for IPv6 unicast."; } description - "This leaf augments the 'simple-nexthop' case of IPv6 unicast + "This leaf augments the 'simple-next-hop' case of IPv6 unicast routes."; - leaf gateway { + leaf next-hop { type inet:ipv6-address; description - "IPv6 address of the gateway."; + "IPv6 address of the next-hop."; } } augment "/rt:routing-state/rt:ribs/rt:rib/rt:routes/rt:route/" - + "rt:nexthop-options/rt:nexthop-list/rt:nexthop" { - when "../../../rt:address-family = 'v6ur:ipv6-unicast'" { + + "rt:next-hop-options/rt:next-hop-list/rt:next-hop-list/" + + "rt:next-hop" { + when "../../../../rt:address-family = 'v6ur:ipv6-unicast'" { description "This augment is valid only for IPv6 unicast."; } + if-feature rt:multipath-routes; description - "This leaf augments the 'nexthop-list' case of IPv6 unicast + "This leaf augments the 'next-hop-list' case of IPv6 unicast routes."; leaf address { type inet:ipv6-address; description - "IPv6 address of the nexthop."; + "IPv6 address of the next-hop."; } } /* Configuration data */ augment "/rt:routing/rt:routing-instance/rt:interfaces/rt:interface" { when "/if:interfaces/if:interface[if:name=current()/rt:name]/" + "ip:ipv6/ip:enabled='true'" { description @@ -2600,22 +2582,21 @@ enabled IPv6."; } description "Configuration of IPv6-specific parameters of router interfaces."; container ipv6-router-advertisements { description "Configuration of IPv6 Router Advertisements. See the corresponding parameters under /rt:routing-state for - detailed descriptions and references. - "; + detailed descriptions and references."; leaf send-advertisements { type boolean; default "false"; description "A flag indicating whether or not the router sends periodic Router Advertisements and responds to Router Solicitations."; } leaf max-rtr-adv-interval { type uint16 { @@ -2632,22 +2613,21 @@ range "3..1350"; } units "seconds"; must ". <= 0.75 * ../max-rtr-adv-interval" { description "The value MUST NOT be greater than 75 % of 'max-rtr-adv-interval'."; } description "The minimum time allowed between sending unsolicited - multicast Router Advertisements from the interface. - "; + multicast Router Advertisements from the interface."; } leaf managed-flag { type boolean; default "false"; description "The boolean value to be placed in the 'Managed address configuration' flag field in the Router Advertisement."; } leaf other-config-flag { type boolean; @@ -2681,43 +2662,42 @@ description "The value to be placed in the Retrans Timer field in the Router Advertisement messages sent by the router. The value zero means unspecified (by this router)."; } leaf cur-hop-limit { type uint8; default "64"; description "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."; } leaf default-lifetime { type uint16 { range "0..9000"; } units "seconds"; description "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."; } container prefix-list { description "Configuration of prefixes to be placed in Prefix Information options in Router Advertisement messages sent from the interface. Prefixes that are advertised by default but do not have their entries in the child 'prefix' list are advertised - with the default values of all parameters. - "; + with the default values of all parameters."; list prefix { key "prefix-spec"; description "Advertised prefix entry."; leaf prefix-spec { type inet:ipv6-prefix; description "IPv6 address prefix."; } choice control-adv-prefixes { @@ -2725,22 +2705,21 @@ description "The prefix either may be explicitly removed from the set of advertised prefixes, or parameters with which it is advertised may be specified (default case)."; leaf no-advertise { type empty; description "The prefix will not be advertised. This can be used for removing the prefix from the - default set of advertised prefixes. - "; + default set of advertised prefixes."; } case advertise { leaf valid-lifetime { type uint32; units "seconds"; default "2592000"; description "The value to be placed in the Valid Lifetime in the Prefix Information option."; } @@ -2793,95 +2773,92 @@ ordered-by "user"; description "A user-ordered list of static routes."; leaf id { type uint32 { range "1..max"; } description "Unique numeric identifier of the route. - This value is unrelated to system-assigned keys of - routes in RIBs. - "; - + This value is unrelated to system-assigned 'id' + parameters of routes in RIBs."; } leaf description { type string; description "Textual description of the route."; } leaf destination-prefix { type inet:ipv6-prefix; mandatory "true"; description "IPv6 destination prefix."; } - choice nexthop-options { + choice next-hop-options { mandatory "true"; description - "Options for expressing the nexthop in static routes."; - case special-nexthop { - uses rt:special-nexthop; + "Options for expressing the next-hop in static routes."; + case special-next-hop { + uses rt:special-next-hop; } - case simple-nexthop { - leaf gateway { + case simple-next-hop { + leaf next-hop { type inet:ipv6-address; description - "IPv6 address of the gateway."; + "IPv6 address of the next-hop."; } leaf outgoing-interface { type leafref { path "../../../../../../rt:interfaces/rt:interface/" + "rt:name"; } description "Name of the outgoing interface. - Only interfaces configured for the parent routing - instance can be given. - "; + Only interfaces configured for the ancestor routing + instance can be given."; } } - case nexthop-list { + case next-hop-list { if-feature rt:multipath-routes; - list nexthop { + container next-hop-list { + list next-hop { key "id"; description - "An entry of a nexthop list."; + "An entry of a next-hop list."; leaf id { type uint32; description "Unique numeric identifier of the entry. - This value is unrelated to system-assigned keys of - nexthops in RIBs. - "; + This value is unrelated to system-assigned 'id' + parameters of next-hops in RIBs."; } leaf address { type inet:ipv6-address; description - "IPv6 address of the nexthop."; + "IPv6 address of the next-hop."; } leaf outgoing-interface { type leafref { - path "../../../../../../../rt:interfaces/" + path "../../../../../../../../rt:interfaces/" + "rt:interface/rt:name"; } description "Name of the outgoing interface. - Only interfaces configured for the parent routing - instance can be given. - "; + Only interfaces configured for the ancestor + routing instance can be given."; + } + uses rt:next-hop-classifiers; } - uses rt:nexthop-classifiers; } } } } } } /* RPC methods */ augment "/rt:active-route/rt:input/rt:destination-address" { @@ -2907,50 +2884,50 @@ description "This leaf augments the reply to the 'rt:active-route' operation."; leaf destination-prefix { type inet:ipv6-prefix; description "IPv6 destination prefix."; } } - augment "/rt:active-route/rt:output/rt:route/rt:nexthop-options/" - + "rt:simple-nexthop" { + augment "/rt:active-route/rt:output/rt:route/rt:next-hop-options/" + + "rt:simple-next-hop" { when "rt:address-family='v6ur:ipv6-unicast'" { description "This augment is valid only for IPv6 unicast."; } description - "This leaf augments the 'simple-nexthop' case in the reply to + "This leaf augments the 'simple-next-hop' case in the reply to the 'rt:active-route' operation."; - leaf gateway { + leaf next-hop { type inet:ipv6-address; description - "IPv6 address of the gateway."; + "IPv6 address of the next-hop."; } } - augment "/rt:active-route/rt:output/rt:route/rt:nexthop-options/" - + "rt:nexthop-list/rt:nexthop" { - when "../rt:address-family='v6ur:ipv6-unicast'" { + augment "/rt:active-route/rt:output/rt:route/rt:next-hop-options/" + + "rt:next-hop-list/rt:next-hop-list/rt:next-hop" { + when "../../rt:address-family='v6ur:ipv6-unicast'" { description "This augment is valid only for IPv6 unicast."; } if-feature rt:multipath-routes; description - "This leaf augments the 'nexthop-list' case in the reply to the - 'rt:active-route' operation."; + "This leaf augments the 'next-hop-list' case in the reply to + the 'rt:active-route' operation."; leaf address { type inet:ipv6-address; description - "IPv6 address of the nexthop."; + "IPv6 address of the next-hop."; } } } 10. IANA Considerations RFC Ed.: In this section, replace all occurrences of 'XXXX' with the actual RFC number (and remove this note). @@ -3071,26 +3048,26 @@ September 2010. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. Bierman, "NETCONF Configuration Protocol", RFC 6241, June 2011. [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, July 2013. [YANG-IF] Bjorklund, M., "A YANG Data Model for Interface - Management", draft-ietf-netmod-interfaces-cfg-13 (work in - progress), November 2013. + Management", draft-ietf-netmod-interfaces-cfg-15 (work in + progress), December 2013. [YANG-IP] Bjorklund, M., "A YANG Data Model for IP Management", - draft-ietf-netmod-ip-cfg-11 (work in progress), - October 2013. + draft-ietf-netmod-ip-cfg-12 (work in progress), + January 2014. 13.2. Informative References [RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG Data Model Documents", RFC 6087, January 2011. [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, June 2011. Appendix A. The Complete Data Trees @@ -3107,21 +3084,21 @@ +--rw routing +--rw routing-instance* [name] | +--rw name string | +--rw type? identityref | +--rw enabled? boolean | +--rw router-id? yang:dotted-quad | +--rw description? string | +--rw default-ribs {multiple-ribs}? | | +--rw default-rib* [address-family] | | +--rw address-family identityref - | | +--rw name string + | | +--rw rib-name string | +--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 @@ -3150,49 +3127,51 @@ | | +--rw connected-rib* [rib-name] | | +--rw rib-name rib-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:destination-prefix inet:ipv4-prefix - | | +--rw (nexthop-options) - | | +--:(special-nexthop) - | | | +--rw v4ur:special-nexthop? enumeration - | | +--:(simple-nexthop) - | | | +--rw v4ur:gateway? inet:ipv4-address + | | +--rw (next-hop-options) + | | +--:(special-next-hop) + | | | +--rw v4ur:special-next-hop? enumeration + | | +--:(simple-next-hop) + | | | +--rw v4ur:next-hop? inet:ipv4-address | | | +--rw v4ur:outgoing-interface? leafref - | | +--:(nexthop-list) {rt:multipath-routes}? - | | +--rw v4ur:nexthop* [id] + | | +--:(next-hop-list) {rt:multipath-routes}? + | | +--rw v4ur:next-hop-list + | | +--rw v4ur:next-hop* [id] | | +--rw v4ur:id uint32 - | | +--rw v4ur:address? inet:ipv4-address - | | +--rw v4ur:outgoing-interface? leafref + | | +--rw v4ur:address? + | | +--rw v4ur:outgoing-interface? | | +--rw v4ur:priority? enumeration | | +--rw v4ur:weight? uint8 | +--rw v6ur:ipv6 | +--rw v6ur:route* [id] | +--rw v6ur:id uint32 | +--rw v6ur:description? string | +--rw v6ur:destination-prefix inet:ipv6-prefix - | +--rw (nexthop-options) - | +--:(special-nexthop) - | | +--rw v6ur:special-nexthop? enumeration - | +--:(simple-nexthop) - | | +--rw v6ur:gateway? inet:ipv6-address + | +--rw (next-hop-options) + | +--:(special-next-hop) + | | +--rw v6ur:special-next-hop? enumeration + | +--:(simple-next-hop) + | | +--rw v6ur:next-hop? inet:ipv6-address | | +--rw v6ur:outgoing-interface? leafref - | +--:(nexthop-list) {rt:multipath-routes}? - | +--rw v6ur:nexthop* [id] + | +--:(next-hop-list) {rt:multipath-routes}? + | +--rw v6ur:next-hop-list + | +--rw v6ur:next-hop* [id] | +--rw v6ur:id uint32 - | +--rw v6ur:address? inet:ipv6-address - | +--rw v6ur:outgoing-interface? leafref + | +--rw v6ur:address? + | +--rw v6ur:outgoing-interface? | +--rw v6ur:priority? enumeration | +--rw v6ur:weight? uint8 +--rw ribs | +--rw rib* [name] | +--rw name string | +--rw address-family identityref | +--rw description? string | +--rw recipient-ribs {multiple-ribs}? | +--rw recipient-rib* [rib-name] | +--rw rib-name rib-ref @@ -3201,27 +3180,27 @@ +--rw route-filter* [name] +--rw name string +--rw description? string +--rw type identityref A.2. Operational State Data +--ro routing-state +--ro routing-instance* [name] | +--ro name string - | +--ro id? uint64 + | +--ro id uint64 | +--ro type? identityref | +--ro router-id? yang:dotted-quad | +--ro default-ribs | | +--ro default-rib* [address-family] | | +--ro address-family identityref - | | +--ro rib-id rib-state-ref + | | +--ro rib-name rib-state-ref | +--ro interfaces | | +--ro interface* [name] | | +--ro name if:interface-state-ref | | +--ro v6ur:ipv6-router-advertisements | | +--ro v6ur:send-advertisements? boolean | | +--ro v6ur:max-rtr-adv-interval? uint16 | | +--ro v6ur:min-rtr-adv-interval? uint16 | | +--ro v6ur:managed-flag? boolean | | +--ro v6ur:other-config-flag? boolean | | +--ro v6ur:link-mtu? uint32 @@ -3233,62 +3212,102 @@ | | +--ro v6ur:prefix* [prefix-spec] | | +--ro v6ur:prefix-spec inet:ipv6-prefix | | +--ro v6ur:valid-lifetime? uint32 | | +--ro v6ur:on-link-flag? boolean | | +--ro v6ur:preferred-lifetime? uint32 | | +--ro v6ur:autonomous-flag? boolean | +--ro routing-protocols | +--ro routing-protocol* [name] | +--ro name string | +--ro type identityref - | +--ro connected-ribs {multiple-ribs}? - | +--ro connected-rib* [rib-id] - | +--ro rib-id rib-state-ref + | +--ro connected-ribs + | +--ro connected-rib* [rib-name] + | +--ro rib-name rib-state-ref | +--ro import-filter? route-filter-state-ref | +--ro export-filter? route-filter-state-ref +--ro ribs | +--ro rib* [name] | +--ro name string - | +--ro id? uint64 + | +--ro id uint64 | +--ro address-family identityref | +--ro routes - | | +--ro route* - | | +--ro id? uint64 - | | +--ro (nexthop-options) - | | | +--:(special-nexthop) - | | | | +--ro special-nexthop? enumeration - | | | +--:(simple-nexthop) + | | +--ro route* [id] + | | +--ro id uint64 + | | +--ro (next-hop-options) + | | | +--:(special-next-hop) + | | | | +--ro special-next-hop? enumeration + | | | +--:(simple-next-hop) | | | | +--ro outgoing-interface? leafref - | | | | +--ro v4ur:gateway? inet:ipv4-address - | | | | +--ro v6ur:gateway? inet:ipv6-address - | | | +--:(nexthop-list) {multipath-routes}? - | | | +--ro nexthop* - | | | +--ro id? uint64 + | | | | +--ro v4ur:next-hop? inet:ipv4-address + | | | | +--ro v6ur:next-hop? inet:ipv6-address + | | | +--:(next-hop-list) {multipath-routes}? + | | | +--ro next-hop-list + | | | +--ro next-hop* [id] + | | | +--ro id uint64 | | | +--ro outgoing-interface? leafref | | | +--ro priority? enumeration | | | +--ro weight? uint8 | | | +--ro v4ur:address? inet:ipv4-address | | | +--ro v6ur:address? inet:ipv6-address | | +--ro source-protocol identityref | | +--ro last-updated? yang:date-and-time | | +--ro v4ur:destination-prefix? inet:ipv4-prefix | | +--ro v6ur:destination-prefix? inet:ipv6-prefix | +--ro recipient-ribs {multiple-ribs}? - | +--ro recipient-rib* [rib-id] - | +--ro rib-id rib-state-ref + | +--ro recipient-rib* [rib-name] + | +--ro rib-name rib-state-ref | +--ro filter? route-filter-state-ref +--ro route-filters +--ro route-filter* [name] +--ro name string +--ro type identityref -Appendix B. Example: Adding a New Routing Protocol +Appendix B. Minimum Implementation + + Some parts and options of the core routing model, such as route + filters or multiple routing tables, are intended only for advanced + routers. This appendix gives basic non-normative guidelines for + implementing a bare minimum of available functions. Such an + implementation may be used for hosts or very simple routers. + + A minimum implementation will provide a single system-controlled + routing instance, and will not allow clients to create any user- + controlled instances. + + Typically, neither of the features defined in the "ietf-routing" + module ("multiple-ribs" and "multipath-routes") will be supported. + This means that: + + o A single system-controlled RIB (routing table) is available for + each supported address family - IPv4, IPv6 or both. These RIBs + are the default RIBs, so they will also appear as system- + controlled entries of the "default-rib" list in operational state + data. No user-controlled RIBs are allowed. + + o Each route has no more than one "next-hop", "outgoing-interface" + or "special-next-hop". + + In addition to the mandatory instance of the "direct" pseudo- + protocol, a minimum implementation should support configured + instance(s) of the "static" pseudo-protocol. Even with a single RIB + per address family, it may be occasionally useful to be able to + configure multiple "static" instances. For example, a client may + want to configure alternative sets of static routes and activate or + deactivate them by means of configuring appropriate route filters + ("allow-all-route-filter" or "deny-all-route-filter"). + + Platforms with severely constrained resources may use deviations for + restricting the data model, e.g., limiting the number of "static" + routing protocol instances, preventing any route filters to be + configured etc. + +Appendix C. Example: Adding a New Routing Protocol This appendix demonstrates how the core routing data model can be extended to support a new routing protocol. The YANG module "example-rip" shown below is intended only as an illustration rather 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 specified in [RFC6087]. See also Section 5.4.2. module example-rip { @@ -3387,38 +3406,38 @@ } units "seconds"; default "30"; description "Time interval between periodic updates."; } } } } -Appendix C. Example: NETCONF Reply +Appendix D. Example: NETCONF Reply This section contains a sample reply to the NETCONF message, which could be sent by a server supporting (i.e., advertising them in the NETCONF message) the following YANG modules: o ietf-interfaces [YANG-IF], o ietf-ip [YANG-IP], o ietf-routing (Section 7), o ietf-ipv4-unicast-routing (Section 8), o ietf-ipv6-unicast-routing (Section 9). We assume a simple network setup as shown in Figure 5: 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" interface and disabled on the upstream "eth0" interface. +-----------------+ | | | Router ISP | | | +--------+--------+ |2001:db8:0:1::2 |192.0.2.2 @@ -3440,27 +3459,28 @@ A reply to the NETCONF message sent by router "A" would then be as follows: eth0 - ethernetCsmacd + ianaift:ethernetCsmacd Uplink to ISP. 192.0.2.1 24 true @@ -3470,21 +3490,21 @@ 64 true false eth1 - ethernetCsmacd + ianaift:ethernetCsmacd Interface to the internal network. 198.51.100.1 24 true @@ -3496,39 +3516,72 @@ true false eth0 - ethernetCsmacd + ianaift:ethernetCsmacd 00:0C:42:E5:B1:E9 up 2013-07-02T17:11:27+00:58 + + true + 1500 + + 192.0.2.1 + 24 + + + + true + 1500 + + 2001:0db8:0:1::1 + 64 + + eth1 - ethernetCsmacd + ianaift:ethernetCsmacd up 00:0C:42:E5:B1:EA 2013-07-02T17:11:27+00:59 + + + true + 1500 + + 198.51.100.1 + 24 + + + + true + 1500 + + 2001:0db8:0:2::1 + 64 + + rtr0 Router A eth1 @@ -3547,47 +3599,48 @@ st0 Static routing is used for the internal network. rt:static 1 0.0.0.0/0 - 192.0.2.2 + 192.0.2.2 1 ::/0 - 2001:db8:0:1::2 + 2001:db8:0:1::2 rtr0 + 2718281828 192.0.2.1 v4ur:ipv4-unicast - 897932384 + ipv4-master v6ur:ipv6-unicast - 751058209 + ipv6-master eth0 eth1 true @@ -3601,21 +3654,21 @@ st0 rt:static - ipv4-main + ipv4-master 897932384 v4ur:ipv4-unicast 626433832 192.0.2.1/24 eth0 rt:direct 2013-07-02T17:11:27+01:00 @@ -3625,28 +3678,27 @@ 198.51.100.0/24 eth1 rt:direct 2013-07-02T17:11:27+01:00 971693993 0.0.0.0/0 rt:static - 192.0.2.2 + 192.0.2.2 2013-07-02T18:02:45+01:00 - - ipv6-main + ipv6-master 751058209 v6ur:ipv6-unicast 749445923 2001:db8:0:1::/64 eth0 rt:direct @@ -3657,49 +3709,77 @@ 2001:db8:0:2::/64 eth1 rt:direct 2013-07-02T17:11:27+01:00 862089986 ::/0 - 2001:db8:0:1::2 + 2001:db8:0:1::2 rt:static 2013-07-02T18:02:45+01:00 -Appendix D. Change Log +Appendix E. Change Log RFC Editor: remove this section upon publication as an RFC. -D.1. Changes Between Versions -11 and -12 +E.1. Changes Between Versions -12 and -13 + + o Wrote appendix about minimum implementation. + + o Remove "when" statement for IPv6 router interface operational + state - it was dependent on a config value that may not be + present. + + o Extra container for the next-hop list. + + o Names rather than numeric ids are used for referring to list + entries in operational state. + + o Numeric ids are always declared as mandatory and unique. Their + description states that they are ephemeral. + + o Descriptions of "name" keys in operational state lists are + required to be persistent. + + o + + o Removed "if-feature multiple-ribs;" from connected-ribs. + + o "rib-name" instead of "name" is used as the name of leafref nodes. + + o "next-hop" instead of "nexthop" or "gateway" used throughout, both + in node names and text. + +E.2. Changes Between Versions -11 and -12 o Removed feature "advanced-router" and introduced two features instead: "multiple-ribs" and "multipath-routes". o Unified the keys of config and state versions of "routing- instance" and "rib" lists. o Numerical identifiers of state list entries are not keys anymore, but they are constrained using the "unique" statement. o Updated acknowledgements. -D.2. Changes Between Versions -10 and -11 +E.3. Changes Between Versions -10 and -11 o Migrated address families from IANA enumerations to identities. o Terminology and node names aligned with the I2RS RIB model: router -> routing instance, routing table -> RIB. o Introduced uint64 keys for state lists: routing-instance, rib, route, nexthop. o Described the relationship between system-controlled and user- @@ -3709,70 +3789,70 @@ router". o Made nexthop into a choice in order to allow for nexthop-list (I2RS requirement). o Added nexthop-list with entries having priorities (backup) and weights (load balancing). o Updated bibliography references. -D.3. Changes Between Versions -09 and -10 +E.4. Changes Between Versions -09 and -10 o Added subtree for operational state data ("/routing-state"). o Terms "system-controlled entry" and "user-controlled entry" defined and used. o New feature "user-defined-routing-tables". Nodes that are useful only with user-defined routing tables are now conditional. o Added grouping "router-id". o In routing tables, "source-protocol" attribute of routes now reports only protocol type, and its datatype is "identityref". o Renamed "main-routing-table" to "default-routing-table". -D.4. Changes Between Versions -08 and -09 +E.5. Changes Between Versions -08 and -09 o Fixed "must" expresion for "connected-routing-table". o Simplified "must" expression for "main-routing-table". o Moved per-interface configuration of a new routing protocol under 'routing-protocol'. This also affects the 'example-rip' module. -D.5. Changes Between Versions -07 and -08 +E.6. Changes Between Versions -07 and -08 o Changed reference from RFC6021 to RFC6021bis. -D.6. Changes Between Versions -06 and -07 +E.7. Changes Between Versions -06 and -07 - o The contents of in Appendix C was updated: "eth[01]" + o The contents of in Appendix D was updated: "eth[01]" is used as the value of "location", and "forwarding" is on for both interfaces and both IPv4 and IPv6. o The "must" expression for "main-routing-table" was modified to avoid redundant error messages reporting address family mismatch when "name" points to a non-existent routing table. o The default behavior for IPv6 RA prefix advertisements was clarified. o Changed type of "rt:router-id" to "ip:dotted-quad". o Type of "rt:router-id" changed to "yang:dotted-quad". o Fixed missing prefixes in XPath expressions. -D.7. Changes Between Versions -05 and -06 +E.8. 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". @@ -3780,21 +3860,21 @@ 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.8. Changes Between Versions -04 and -05 +E.9. Changes Between Versions -04 and -05 o Routing tables are now global, i.e., "routing-tables" is a child of "routing" rather than "router". o "must" statement for "static-routes" changed to "when". o Added "main-routing-tables" containing references to main routing tables for each address family. o Removed the defaults for "address-family" and "safi" and made them @@ -3815,35 +3895,35 @@ o The "direct" pseudo-protocol is always connected to main routing tables. o Entries in the list of connected routing tables renamed from "routing-table" to "connected-routing-table". o Added "must" constraint saying that a routing table must not be its own recipient. -D.9. Changes Between Versions -03 and -04 +E.10. Changes Between Versions -03 and -04 o Changed "error-tag" for both RPC methods from "missing element" to "data-missing". o Removed the decrementing behavior for advertised IPv6 prefix parameters "valid-lifetime" and "preferred-lifetime". o Changed the key of the static route lists from "seqno" to "id" because the routes needn't be sorted. o Added 'must' constraint saying that "preferred-lifetime" must not be greater than "valid-lifetime". -D.10. Changes Between Versions -02 and -03 +E.11. Changes Between Versions -02 and -03 o Module "iana-afn-safi" moved to I-D "iana-if-type". o Removed forwarding table. o RPC "get-route" changed to "active-route". Its output is a list of routes (for multi-path routing). o New RPC "route-count". @@ -3861,45 +3941,45 @@ "ietf-ip". o Added "router-id" leaf. o Specified the names for IPv4/IPv6 unicast main routing tables. o Route parameter "last-modified" changed to "age". o Added container "recipient-routing-tables". -D.11. Changes Between Versions -01 and -02 +E.12. Changes Between Versions -01 and -02 o Added module "ietf-ipv6-unicast-routing". - o The example in Appendix C now uses IP addresses from blocks + o The example in Appendix D now uses IP addresses from blocks reserved for documentation. o Direct routes appear by default in the forwarding table. o Network layer interfaces must be assigned to a router instance. Additional interface configuration may be present. o The "when" statement is only used with "augment", "must" is used elsewhere. o Additional "must" statements were added. o The "route-content" grouping for IPv4 and IPv6 unicast now includes the material from the "ietf-routing" version via "uses rt:route-content". o Explanation of symbols in the tree representation of data model hierarchy. -D.12. Changes Between Versions -00 and -01 +E.13. Changes Between Versions -00 and -01 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- safi" module. o Names of some data nodes were changed, in particular "routing- process" is now "router". o The restriction of a single AFN/SAFI per router was lifted.