--- 1/draft-ietf-netmod-routing-cfg-04.txt 2012-10-04 12:14:19.785425167 +0200 +++ 2/draft-ietf-netmod-routing-cfg-05.txt 2012-10-04 12:14:19.869476237 +0200 @@ -1,18 +1,18 @@ NETMOD L. Lhotka Internet-Draft CZ.NIC -Intended status: Standards Track July 9, 2012 -Expires: January 10, 2013 +Intended status: Standards Track October 4, 2012 +Expires: April 7, 2013 A YANG Data Model for Routing Configuration - draft-ietf-netmod-routing-cfg-04 + draft-ietf-netmod-routing-cfg-05 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 a routing subsystem. It is therefore 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 configurations - router instances, routes, @@ -26,21 +26,21 @@ 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 January 10, 2013. + This Internet-Draft will expire on April 7, 2013. Copyright Notice Copyright (c) 2012 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 @@ -52,50 +52,49 @@ Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology and Notation . . . . . . . . . . . . . . . . . . . 4 2.1. Glossary of New Terms . . . . . . . . . . . . . . . . . . 4 2.2. Prefixes in Data Node Names . . . . . . . . . . . . . . . 5 3. Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . 6 4. The Design of the Core Routing Data Model . . . . . . . . . . 7 4.1. Router . . . . . . . . . . . . . . . . . . . . . . . . . . 10 - 4.1.1. Configuration of IPv6 Router Interfaces . . . . . . . 10 - 4.2. Route . . . . . . . . . . . . . . . . . . . . . . . . . . 11 + 4.1.1. Configuration of IPv6 Router Interfaces . . . . . . . 11 + 4.2. Routes . . . . . . . . . . . . . . . . . . . . . . . . . . 12 4.3. Routing Tables . . . . . . . . . . . . . . . . . . . . . . 12 - 4.4. Routing Protocols . . . . . . . . . . . . . . . . . . . . 13 - 4.4.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . . 14 - 4.4.2. Defining New Routing Protocols . . . . . . . . . . . . 14 - 4.5. Route Filters . . . . . . . . . . . . . . . . . . . . . . 17 - 4.6. RPC Operations . . . . . . . . . . . . . . . . . . . . . . 18 - 4.6.1. Operation "active-route" . . . . . . . . . . . . . . . 18 - 4.6.2. Operation "route-count" . . . . . . . . . . . . . . . 19 + 4.4. Routing Protocols . . . . . . . . . . . . . . . . . . . . 14 + 4.4.1. Routing Pseudo-Protocols . . . . . . . . . . . . . . . 15 + 4.4.2. Defining New Routing Protocols . . . . . . . . . . . . 15 + 4.5. Route Filters . . . . . . . . . . . . . . . . . . . . . . 18 + 4.6. RPC Operations . . . . . . . . . . . . . . . . . . . . . . 19 5. Interactions with Other YANG Modules . . . . . . . . . . . . . 20 5.1. Module "ietf-interfaces" . . . . . . . . . . . . . . . . . 20 5.2. Module "ietf-ip" . . . . . . . . . . . . . . . . . . . . . 20 6. Routing YANG Module . . . . . . . . . . . . . . . . . . . . . 22 - 7. IPv4 Unicast Routing YANG Module . . . . . . . . . . . . . . . 34 - 8. IPv6 Unicast Routing YANG Module . . . . . . . . . . . . . . . 38 - 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 47 - 10. Security Considerations . . . . . . . . . . . . . . . . . . . 49 - 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 50 - 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 51 - 12.1. Normative References . . . . . . . . . . . . . . . . . . . 51 - 12.2. Informative References . . . . . . . . . . . . . . . . . . 51 - Appendix A. Example: Adding a New Routing Protocol . . . . . . . 52 - Appendix B. Example: Reply to the NETCONF Message . . . . . 55 - Appendix C. Change Log . . . . . . . . . . . . . . . . . . . . . 60 - C.1. Changes Between Versions -03 and -04 . . . . . . . . . . . 60 - C.2. Changes Between Versions -02 and -03 . . . . . . . . . . . 60 - C.3. Changes Between Versions -01 and -02 . . . . . . . . . . . 61 - C.4. Changes Between Versions -00 and -01 . . . . . . . . . . . 61 - Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 62 + 7. IPv4 Unicast Routing YANG Module . . . . . . . . . . . . . . . 36 + 8. IPv6 Unicast Routing YANG Module . . . . . . . . . . . . . . . 40 + 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 49 + 10. Security Considerations . . . . . . . . . . . . . . . . . . . 51 + 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 52 + 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 53 + 12.1. Normative References . . . . . . . . . . . . . . . . . . . 53 + 12.2. Informative References . . . . . . . . . . . . . . . . . . 53 + Appendix A. Example: Adding a New Routing Protocol . . . . . . . 54 + Appendix B. Example: NETCONF Reply . . . . . . . . . . . . 56 + Appendix C. Change Log . . . . . . . . . . . . . . . . . . . . . 61 + C.1. Changes Between Versions -04 and -05 . . . . . . . . . . . 61 + C.2. Changes Between Versions -03 and -04 . . . . . . . . . . . 61 + C.3. Changes Between Versions -02 and -03 . . . . . . . . . . . 62 + C.4. Changes Between Versions -01 and -02 . . . . . . . . . . . 62 + C.5. Changes Between Versions -00 and -01 . . . . . . . . . . . 63 + Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 64 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. @@ -235,23 +234,29 @@ with additional data nodes that are needed for IPv4 and IPv6 unicast routing, respectively. The combined data hierarchy is shown in Figure 1, where brackets enclose list keys, "rw" means configuration, "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 router [name] | +--rw name + | +--rw type? + | +--rw enabled? | +--rw router-id? | +--rw description? - | +--rw enabled? + | +--rw main-routing-tables + | | +--rw main-routing-table [address-family safi] + | | +--rw address-family + | | +--rw safi + | | +--rw name? | +--rw interfaces | | +--rw interface [name] | | +--rw name | | +--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? @@ -264,68 +269,71 @@ | | +--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-protocol [name] + | +--rw routing-protocol [name] + | +--rw name + | +--rw description? + | +--rw enabled? + | +--rw type + | +--rw connected-routing-tables + | | +--rw connected-routing-table [name] | | +--rw name - | | +--rw description? - | | +--rw type - | | +--rw connected-routing-tables - | | | +--rw routing-table [name] - | | | +--rw name - | | | +--rw import-filter? - | | | +--rw export-filter? - | | +--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 import-filter? + | | +--rw export-filter? + | +--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-table [name] | +--rw name - | +--rw address-family? - | +--rw safi? + | +--rw address-family + | +--rw safi | +--rw description? | +--ro routes | | +--ro route | | +--ro outgoing-interface? | | +--ro source-protocol - | | +--ro age + | | +--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-table [name] | +--rw name | +--rw filter? + | + | +--rw route-filters +--rw route-filter [name] +--rw name +--rw description? - +--rw type? + +--rw type Figure 1: Data hierarchy of the core routing data model. As can be seen from Figure 1, the core routing data model introduces several generic components of a routing framework: routers, routing tables containing routes, routing protocols and route filters. The following subsections describe these components in more detail. By combining the components in various ways, and possibly augmenting them with appropriate contents defined in other modules, various @@ -372,38 +380,50 @@ of route filters, denoted by "F" in Figure 2. 4.1. Router Each router instance in the core routing data model represents a logical router. The exact semantics of this term is left to implementations. For example, router instances may be completely isolated virtual routers or, alternatively, they may internally share certain information. - Each network layer interface must be assigned to one or more router + An implementation MAY support multiple types of logical routers + simultaneously. Instances of all router types are organized as + entries of the same flat "router" list. In order to distinguish + router instances belonging to the same type, the "type" leaf is + defined as a child of the "router" node. + + An implementation MAY pose restrictions on allowed router types and + on the number of supported instances for each type. For example, a + simple router implementation may support only one router instance of + the default type "standard-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, routing protocols and other operations of those router instances. The assignment is accomplished by creating a corresponding entry in 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., the value of a node /if:interfaces/if:interface/if:name defined in the "ietf-interfaces" module [YANG-IF]. + 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 + augmentation, other configuration or operational state data related + to the corresponding router interface. + Implementations MAY specify additional rules for the assignment of interfaces to logical routers. For example, it may be required that the sets of interfaces assigned to different logical routers be disjoint. - Apart from the key, each entry of the "rt:interface" list MAY contain - other configuration or operational state data related to the - corresponding router interface. - 4.1.1. Configuration of IPv6 Router Interfaces The module "ietf-ipv6-unicast-routing" augments the definition of the data node "rt:interface" with definitions of the following configuration variables as required by [RFC4861], sec. 6.2.1: o send-advertisements, o max-rtr-adv-interval, @@ -445,21 +466,21 @@ 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 decrement in real time. However, the latter behavior seems problematic because the values might be reset again to the (higher) configured values after a configuration is reloaded. Moreover, no implementation is known to use the decrementing behavior. The "ietf-ipv6-unicast-routing" module therefore assumes the former behavior with constant values. -4.2. Route +4.2. Routes Routes are basic units 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": IP address of an adjacent router or host to which @@ -480,164 +501,185 @@ state data, for example as entries in routing tables. 4.3. Routing Tables Routing tables are lists of routes complemented with administrative data, namely: o "source-protocol": name of the routing protocol from which the route was originally obtained. - o "age": number of seconds since the route was created or last - updated. + o "last-updated": the date and time when the route was last updated, + or inserted into the routing table. Each routing table may contain only routes of the same address family. Address family information consists of two parameters - "address-family" and "safi" (Subsequent Address Family Identifier, SAFI). The permitted values for these two parameters are defined by IANA and represented using YANG enumeration types "ianaaf:address- family" and "ianaaf:subsequent-address-family" [IANA-IF-AF]. In the core routing data model, the "routing-table" node represents configuration while the descendant list of routes is defined as operational state data. The contents of route lists 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 4.4.1. - One routing table MUST be present for each router instance and each - address family supported by that router instance. It is the so- - called main routing table to which all routing protocol instances - supporting the given address family SHOULD be connected by default. - For the two address families that are part of the core routing data - model, the names of the main routing tables SHOULD be as follows: + 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. - o "main-ipv4-unicast" for IPv4 unicast, - o "main-ipv6-unicast" for IPv6 unicast. + Main routing tables serve the following purposes: - Additional routing tables MAY be configured by creating new entries - in the "routing-table" list, either as a part of factory-default - configuration, or by a client's action. + o The router instance always installs direct routes for an address + family to that address family's main routing table. - The naming scheme for additional routing tables, as well as - restrictions on the number and configurability of routing tables are - implementation-specific. + o By default, a routing protocol SHOULD be connected to the main + routing table of each address family supported by that routing + protocol. See Section 4.4 for further explanation. + + Routing tables are global, which means that a configured routing + table may be used by any or all router instances. + + Server implementations MAY pose restrictions regarding the number of + supported routing tables, and rules for configuration and use of + routing tables. For example: + + o A server may support no more than one routing table per address + family. + + 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 + one router instance. + + For servers supporting multiple routing tables per address family, + additional tables can be configured by creating new entries in the + "routing-table" list, either as a part of factory-default + configuration, or by a client's action. The way how the routing system uses information from routing tables - is outside the scope of this document. Typically, implementations - will either use a forwarding table, or perform a direct look-up in - the main routing table in conjunction with a route cache. + for actual packet forwarding is outside the scope of this document. 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 - specified in the configuration of the source routing table. In - addition, a route filter may be configured for each recipient routing - table, which selects and/or manipulates the routes that are passed on - between the source and recipient routing table. + specified in the configuration of the source routing table. + Optionally, a route filter may be configured for any or all recipient + routing tables. Such a route filter then selects and/or manipulates + the routes that are passed on between the source and recipient + routing table. + + A routing table MUST NOT appear among its own recipient routing + tables. A recipient routing table also MUST be of the same address + family as its source routing table.Consequently, configuration of + recipient routing tables makes sense only for servers supporting + multiple routing tables per address family. Servers supporting only + one routing table per address family MAY therefore decide to remove + the container "recipient-routing-tables", together with its contents, + from the data model. 4.4. Routing Protocols The core routing data model provides an open-ended framework for - defining multiple routing protocol instances. Each of them is - identified by a name, which MUST be unique within a router instance. - Each protocol MUST be assigned a type, which MUST be an identity - derived from the "rt:routing-protocol" base identity. The core - routing data model defines two identities for the direct and static - pseudo-protocols (Section 4.4.1). + defining multiple routing protocol instances within each router + instance. Each routing protocol instance MUST be assigned a type, + which is an identity derived from the "rt:routing-protocol" base + identity. The core routing data model defines two identities for the + direct and static pseudo-protocols (Section 4.4.1). Each routing protocol instance is connected to exactly one routing table for each address family that the routing protocol instance supports. By default, every routing protocol instance SHOULD be connected to the main routing table or tables. An implementation MAY allow any or all routing protocol instances to be configured to use a different routing table. Routes learned from the network by a routing protocol are passed to - the connected routing table(s) and vice versa - routes appearing in a - routing table are passed to all routing protocols connected to the - table (except "direct" and "static" pseudo-protocols) and may be - advertised by that protocol to the network. + the connected routing table(s) and vice versa, subject to routing + protocol specific rules and restrictions. - Two independent route filters (see Section 4.5) may be defined for a - routing protocol instance to control the exchange of routes in both - directions between the routing protocol instance and the connected - routing table: + In addition, two independent route filters (see Section 4.5) may be + defined for a routing protocol instance to control the exchange of + routes in both directions between the routing protocol instance and + the connected routing table: o import filter controls which routes are passed from a routing - protocol instance to the routing table, + protocol instance to the connected routing table, o export filter controls which routes the routing protocol instance may receive from the connected routing table. Note that, for historical reasons, the terms import and export are used from the viewpoint of a routing table. 4.4.1. Routing Pseudo-Protocols 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 routing table (subject to route filters, if any), but an exchange in the opposite direction is not allowed. - Every router instance MUST contain 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 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 - interface addresses, see Section 5.2. Direct routes SHOULD by - default appear in the main routing table for each configured address - family. However, using the framework defined in this document, the - target routing table for direct routes MAY be changed by connecting - the "direct" protocol instance to a non-default routing table. - Direct routes can also be filtered before they appear in the routing - table. + interface addresses, see Section 5.2. The "direct" pseudoprotocol + MUST always be connected to the main routing tables of all supported + address families. This means that direct routes are always installed + in the main routing tables. However, direct routes MAY be filtered + before they appear in the main routing table. A pseudo-protocol of the type "static" allows for specifying routes manually. It MAY be configured in zero or multiple instances, - although a typical implementation will have exactly one instance per + although a typical configuration will have exactly one instance per logical router. 4.4.2. Defining New Routing Protocols It is expected that future YANG modules will create data models for additional routing protocol types. Such a new module has to define the protocol-specific configuration and operational state data, and it has to fit it into the core routing framework in the following way: 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 identity derived from "rt:routing-protocol". o Additional route attributes MAY be defined, preferably in one place by means of defining a YANG grouping. The new attributes have to be inserted as operational state data by augmenting the - definition of "rt:route" inside "rt:routing-table", and possibly - to other places in the configuration, operational state data and - RPC input or output. + definition of the node + /rt:routing-tables/rt:routing-table/rt:route, + + and possibly to other places in the configuration, operational + state data and RPC input or output. o Per-interface configuration parameters can be added by augmenting the data node "rt:interface" (the list of router interfaces). o Other configuration parameters and operational state data can be - defined by augmenting the "routing-protocol" data node. By using - the "when" statement, this augment SHOULD be made conditional and - valid only if the value of the "rt:type" child leaf equals to the - new protocol's identity. + defined by augmenting the "routing-protocol" data node. - It is RECOMMENDED that both per-interface and other configuration - data specific to the new protocol be encapsulated in an appropriately - named container. + By using the "when" statement, the augmented per-interface and other + configuration parameters specific to the new protocol SHOULD be made + 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- + specific data be encapsulated in appropriately named containers. The above steps are implemented by the example YANG module for the RIP routing protocol in Appendix A. First, the module defines a new identity for the RIP protocol: identity rip { base rt:routing-protocol; description "Identity for the RIP routing protocol."; } @@ -654,29 +696,22 @@ } leaf tag { type uint16; default "0"; description "This leaf may be used to carry additional info, e.g. AS number."; } } - augment "/rt:routing/rt:router/rt:routing-tables/rt:routing-table/" + augment "/rt:routing/rt:routing-tables/rt:routing-table/" + "rt:routes/rt:route" { - when "../../../../rt:routing-protocols/" - + "rt:routing-protocol[rt:name=current()/rt:source-protocol]/" - + "rt:type='rip:rip'" { - description - "This augment is only valid if the source protocol from which - the route originated is RIP."; - } 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; } @@ -728,21 +762,21 @@ filters that can be used to restrict the set of routes being exchanged between a routing protocol instance and a connected routing table, or between a source and a recipient routing table. 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 may be used by any or all router instances. By itself, the route filtering framework defined in this document - allows for applying only the extreme routing policies which are + allows for applying only two extreme routing policies which are represented by the following pre-defined route filter types: o "deny-all-route-filter": all routes are blocked, o "allow-all-route-filter": all routes are permitted. Note that the latter type is equivalent to no route filter. It is expected that more comprehensive route filtering frameworks will be developed separately. @@ -750,81 +784,37 @@ Each route filter is identified by a name which MUST be unique within the entire configuration. Its type MUST be specified by the "type" identity reference - this opens the space for multiple route filtering framework implementations. The default value for the route filter type is the identity "deny-all-route-filter". 4.6. RPC Operations The "ietf-routing" module defines two RPC operations: - o active-route, - - o route-count. - - Their parameters and semantics are described in the following - subsections. - -4.6.1. Operation "active-route" - - Description: Retrieve one or more active routes from the forwarding - information base (FIB) of a router instance, i.e., the route(s) - that are currently used by that router instance for sending - datagrams to the destination whose address is provided as an input - parameter. - - Parameters: - - router-name: Name of the router instance whose FIB is to be - queried. - - destination-address: Network layer destination address for which - the active routes are requested. - - Positive Response: One or more "route" elements containing the - active route(s). - - Negative Response: - - If the logical router is not found, the server sends an "rpc- - error" message with "error-tag" set to "data-missing", and "error- - app-tag" set to "router-not-found". - - If no route exists for the given destination address, the server - sends an "rpc-error" message with "error-tag" set to "data- - missing" and "error-app-tag" set to "no-route". - -4.6.2. Operation "route-count" - - Description: Retrieve the total number of routes in a routing table. - - Parameters: + o active-route: query the routing system for the active route(s) + that are currently used for sending datagrams to a destination + host whose address is passed as an input parameter. - router-name: Name of the logical router containing the routing + o route-count: retrieve the total number of entries in a routing table. - routing-table: Name of the routing table. - - Positive Response: Element "number-of-routes" containing the - requested nonnegative number. - - Negative Response: If the logical router or the routing table is not - found, the server sends an "rpc-error" message with "error-tag" - set to "data-missing", and "error-app-tag" set to "router-not- - found" or "routing-table-not-found", respectively. - 5. 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. The 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" The following boolean switch is defined in the "ietf-interfaces" YANG module [YANG-IF]: /if:interfaces/if:interface/if:enabled If this switch is set to "false" for a given network layer interface, the device MUST behave exactly as if that interface was not assigned to any logical router at all. @@ -852,41 +842,45 @@ IPv6 routing functions related to that interface MUST be disabled. /if:interfaces/if:interface/ip:ipv6/ip:ip-forwarding If this switch is set to "false" for a given interface, then the forwarding of IPv6 datagrams to and from this interface MUST be disabled. However, the interface may participate in other routing functions, such as routing protocols. In addition, the "ietf-ip" module allows for configuring IPv4 and - IPv6 addresses and subnet masks. Configuration of these parameters - on an enabled interface MUST result in an immediate creation of the - corresponding direct route (usually in the main routing table). Its - destination prefix is set according to the configured IP address and - subnet mask, and the interface is set as the outgoing interface for - that route. + IPv6 addresses and subnet masks on network layer interfaces. + Configuration of these parameters on an enabled interface MUST result + in an immediate creation of the corresponding direct route (usually + in the main routing table). Its destination prefix is set according + to the configured IP address and subnet mask, and the interface is + set as the outgoing interface for that route. 6. Routing 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@2012-07-09.yang" + file "ietf-routing@2012-10-04.yang" module ietf-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-routing"; prefix "rt"; + import ietf-yang-types { + prefix "yang"; + } + import ietf-inet-types { prefix "inet"; } import ietf-interfaces { prefix "if"; } import iana-afn-safi { prefix "ianaaf"; @@ -920,29 +914,44 @@ without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices. "; - revision 2012-07-09 { + revision 2012-10-04 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Configuration"; } /* Identities */ + identity router-type { + description + "Base identity from which router type identities are derived. + + It is primarily intended for discriminating among different + types of logical routers or router virtualization. + "; + } + + identity standard-router { + base router-type; + description + "This identity represents a standard router."; + } + identity routing-protocol { description "Base identity from which routing protocol identities are derived."; } identity direct { base routing-protocol; description "Routing pseudo-protocol which provides routes to directly @@ -982,135 +991,119 @@ description "This type is used for leafs that reference a router instance."; } /* Groupings */ grouping afn-safi { leaf address-family { type ianaaf:address-family; - default "ipv4"; + mandatory "true"; description "Address family of routes in the routing table."; } leaf safi { type ianaaf:subsequent-address-family; - default "nlri-unicast"; + mandatory "true"; description "Subsequent address family identifier of routes in the routing table."; } description "This grouping provides two parameters specifying address family and subsequent address family."; } grouping route-content { description - "Generic parameters of routes. - - A module for an address family should define a specific - version of this grouping containing 'uses rt:route-content'. - "; + "Generic parameters of routes."; leaf outgoing-interface { type if:interface-ref; description "Outgoing interface."; } } /* RPC Methods */ rpc active-route { description "Return the active route (or multiple routes, in the case of multi-path routing) to a destination address. Parameters 1. 'router-name', 2. 'destination-address'. - If the logical router with 'router-name' doesn't exist, then - this operation will fail with error-tag 'missing-element' and + If the router instance with 'router-name' doesn't exist, then + this operation shall fail with error-tag 'data-missing' and error-app-tag 'router-not-found'. - If there is no active route for 'destination-address', then - this operation will fail with error-tag 'data-missing' and - error-app-tag 'no-route'. + If no active route for 'destination-address' exists, no output + is returned - the server shall send an containing + a single element . "; input { leaf router-name { type router-ref; mandatory "true"; description "Name of the router instance whose forwarding information base is being queried."; } container destination-address { uses afn-safi; description "Network layer destination address. - AFN/SAFI-specific modules must augment this container with - a leaf named 'address'. + Address family specific modules must augment this + container with a leaf named 'address'. "; } } output { list route { - min-elements "1"; uses afn-safi; uses route-content; description "Route contents specific for each address family should be defined through augmenting."; } } } rpc route-count { description "Return the current number of routes in a routing table. Parameters: - 1. 'router-name', - - 2. 'routing-table-name'. - - If the logical router with 'router-name' doesn't exist, then - this operation will fail with error-tag 'missing-element' and - error-app-tag 'router-not-found'. + 1. 'routing-table-name'. - If the routing table with 'routing-table-name' doesn't exist, - then this operation will fail with error-tag 'missing-element' - and error-app-tag 'routing-table-not-found'. + If the routing table with the name specified in + 'routing-table-name' doesn't exist, then this operation shall + fail with error-tag 'data-missing' and error-app-tag + 'routing-table-not-found'. "; input { - leaf router-name { - type router-ref; - mandatory "true"; - description - "Name of the router instance containing the routing - table."; - } leaf routing-table { type leafref { - path "/routing/router/routing-tables/routing-table/name"; + path "/routing/routing-tables/routing-table/name"; } mandatory "true"; description "Name of the routing table."; } + } output { leaf number-of-routes { type uint32; mandatory "true"; description "Number of routes in the routing table."; } } } @@ -1117,58 +1110,112 @@ /* Data Nodes */ container routing { description "Routing parameters."; list router { key "name"; unique "router-id"; description - 'Each list entry is a container for configuration and + "Each list entry is a container for configuration and operational state data of a single (logical) router. Network layer interfaces assigned to the router must have - their entries in the "interfaces" list. - '; + their entries in the 'interfaces' list. + "; leaf name { type string; description - "The unique router name."; + "An arbitrary name of the router instance."; + } + leaf type { + type identityref { + base router-type; + } + default "rt:standard-router"; + description + "This leaf specifies the router type. + + It is primarily intended as a means for discriminating + among different types of logical routers, route + virtualization, master-slave arrangements etc., while + keeping all such router instances in the same flat list. + + Standard router instances should use the default value. + "; + } + leaf enabled { + type boolean; + default "true"; + description + "Enable/disable the router instance. + + If this parameter is false, the parent router instance is + disabled, despite any other configuration that might be + present. + "; } leaf router-id { type inet:ipv4-address; description "Global router ID in the form of an IPv4 address. An implementation may select a value if this parameter is not configured. Routing protocols may override this global parameter inside their configuration. "; } leaf description { type string; description "Textual description of the router."; } - leaf enabled { - type boolean; - default "true"; + container main-routing-tables { description - "Enable the router. The default value is 'true'. + "Main routing tables used by the router instance."; + list main-routing-table { + must "address-family=//routing/routing-tables/" + + "routing-table[name=current()/name]/" + + "address-family and safi=//routing/routing-tables/" + + "routing-table[name=current()/name]/safi" { + error-message "Address family mismatch."; + description + "The entry's address family must match that of the + referenced routing table."; + } + key "address-family safi"; + description + "Each list entry specifies the main routing table for one + address family. - If this parameter is false, the parent router instance is - disabled, despite any other configuration that might be - present. + The main routing table receives direct routes, and all + routing protocols should be connected to the main + routing table(s) by default. + + Address families that don't have their entry in this + list must not be used in the rest of the router instance + configuration. "; + uses afn-safi; + leaf name { + type leafref { + path "/routing/routing-tables/routing-table/name"; + } + description + "Name of an existing routing table to be used as the + main routing table for the given router and address + family."; + } + } } container interfaces { description "Router interface parameters."; list interface { key "name"; description "List of network layer interfaces assigned to the router instance."; leaf name { @@ -1183,234 +1230,267 @@ description "Container for the list of configured routing protocol instances."; list routing-protocol { key "name"; description "An instance of a routing protocol."; leaf name { type string; description - "The name of the routing protocol instance."; + "An arbitrary name of the routing protocol instance."; } leaf description { type string; description "Textual description of the routing protocol instance."; } + 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, despite any other + 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-routing-tables { description "Container for connected routing tables."; - list routing-table { - must "not(../../../../routing-tables/" - + "routing-table[rt:name=current()/" - + "preceding-sibling::routing-table/name]/" - + "address-family=../../../../routing-tables/" - + "routing-table[rt:name=current()/name]/" - + "address-family and ../../../../routing-tables/" - + "routing-table[rt:name=current()/" - + "preceding-sibling::routing-table/name]/safi=../" - + "../../../routing-tables/" - + "routing-table[rt:name=current()/name]/safi)" { - error-message "Each routing protocol may have no " - + "more than one connected routing " - + "table for each AFN and SAFI."; + list connected-routing-table { + must "not(//routing/routing-tables/" + + "routing-table[name=current()/" + + "preceding-sibling::connected-routing-table/" + + "name]/address-family=//routing/routing-tables/" + + "routing-table[name=current()/name]/" + + "address-family and //routing/routing-tables/" + + "routing-table[name=current()/" + + "preceding-sibling::connected-routing-table/" + + "name]/safi=//routing/routing-tables/" + + "routing-table[name=current()/name]/safi)" { + error-message "Duplicate address family for " + + "connected routing table."; description "For each AFN/SAFI pair there may be at most one connected routing table."; } key "name"; description "List of routing tables to which the routing protocol instance is connected. If no connected routing table is defined for an address family, the routing protocol should be connected by default to the main routing table for that address family. "; leaf name { type leafref { - path "../../../../../routing-tables/routing-table/" - + "name"; + path "/routing/routing-tables/routing-table/name"; } description - "Reference to an existing routing table."; + "Name of an existing routing table."; } leaf import-filter { type leafref { path "/routing/route-filters/route-filter/name"; } description "Reference to a route filter that is used for filtering routes passed from this routing protocol instance to the routing table specified by the - 'name' sibling node. If this leaf is not present, - the behavior is protocol-specific, but typically - it means that all routes are accepted."; + 'name' sibling node. + + If this leaf is not present, the behavior is + protocol-specific, but typically it means that all + routes are accepted. + "; } leaf export-filter { type leafref { path "/routing/route-filters/route-filter/name"; } description "Reference to a route filter that is used for filtering routes passed from the routing table specified by the '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, - except for the 'direct' and 'static' - pseudo-protocols which accept no routes from any - routing table."; + 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 routing table. + "; } } } container static-routes { - must "../type='rt:static'" { - error-message "Static routes may be configured only " - + "for 'static' routing protocol."; + when "../type='rt:static'" { description "This container is only valid for the 'static' routing protocol."; } description - "Configuration of 'static' pseudo-protocol."; + "Configuration of 'static' pseudo-protocol. + + Address family specific modules should augment this + node with lists of routes. + "; + } } } } container routing-tables { description "Container for configured routing tables."; list routing-table { key "name"; description "Each entry represents a routing table identified by the 'name' key. All routes in a routing table must have the same AFN and SAFI."; leaf name { type string; description - "The name of the routing table."; + "An arbitrary name of the routing table."; } uses afn-safi; leaf description { type string; description "Textual description of the routing table."; } container routes { config "false"; description - "Current contents of the routing table (operational - state data)."; + "Current contents of the routing table (operational state + data)."; list route { description "A routing table entry. This data node must augmented with information specific for routes of each address family."; uses route-content; leaf source-protocol { type leafref { path "/routing/router/routing-protocols/" + "routing-protocol/name"; } mandatory "true"; description - "The name of the routing protocol instance from - which the route comes. This routing protocol must - be configured (automatically or manually) in the - device."; + "The name of an existing routing protocol instance + from which the route comes."; } - leaf age { - type uint32; - units "seconds"; - mandatory "true"; + leaf last-updated { + type yang:date-and-time; description - "The number of seconds since the parent route was - created or last updated."; + "Time stamp of the last modification of the route. If + the route was never modified, it is the time when + the route was inserted into the routing table."; } } } container recipient-routing-tables { description "Container for recipient routing tables."; list recipient-routing-table { + must "name != ../../name" { + error-message "Source and recipient routing tables " + + "are identical."; + description + "A routing table must not appear among its recipient + routing tables."; + } + must "//routing/routing-tables/" + + "routing-table[name=current()/name]/" + + "address-family=../../address-family and //routing/" + + "routing-tables/routing-table[name=current()/name]/" + + "safi=../../safi" { + error-message "Address family mismatch."; + description + "Address family of the recipient routing table must + match the source table."; + } key "name"; description - "A list of routing tables that receive routes from - this routing table."; + "List of routing tables that receive routes from this + routing table."; leaf name { type leafref { - path "/routing/router/routing-tables/" - + "routing-table/name"; + path "/routing/routing-tables/routing-table/name"; } description "The name of the recipient routing table."; + } leaf filter { type leafref { path "/routing/route-filters/route-filter/name"; } description - "A route filter which is applied to the routes - passed on to the recipient routing table."; - } + "A route filter which is applied to the routes passed + on to the recipient routing table."; } } } } } container route-filters { description "Container for configured 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 routing table or vice versa, or between two routing - tables. It is expected that other modules augment this - list with contents specific for a particular route filter - type."; + tables. + + It is expected that other modules augment this list with + contents specific for a particular route filter type. + "; leaf name { type string; description - "The name of the route filter."; + "An arbitrary name of the route filter."; } leaf description { type string; description "Textual description of the route filter."; } leaf type { type identityref { base route-filter; } - default "rt:deny-all-route-filter"; + mandatory "true"; description "Type of the route-filter - an identity derived from the - 'route-filter' base identity. The default value - represents an all-blocking filter."; + 'route-filter' base identity."; } } } + } } 7. IPv4 Unicast Routing 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). @@ -1408,21 +1488,21 @@ } 7. IPv4 Unicast Routing 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@2012-07-09.yang" + file "ietf-ipv4-unicast-routing@2012-10-04.yang" module ietf-ipv4-unicast-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing"; prefix "v4ur"; import ietf-routing { prefix "rt"; } @@ -1446,39 +1526,35 @@ Editor: Ladislav Lhotka "; description "This YANG module augments the 'ietf-routing' module with basic configuration and operational state data for IPv4 unicast routing. - Every implementation must preconfigure a routing table with the - name 'main-ipv4-unicast', which is the main routing table for - IPv4 unicast. - Copyright (c) 2012 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices. "; - revision 2012-07-09 { + revision 2012-10-04 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Configuration"; } /* Groupings */ grouping route-content { description @@ -1537,31 +1613,30 @@ list route { key "id"; ordered-by "user"; description "A user-ordered list of static routes."; leaf id { type uint32 { range "1..max"; } description - 'Numeric identifier of the route. + "Numeric identifier of the route. - It is not required that the routes be sorted according - to their "id". - '; + It is not required that the routes be sorted by their + 'id'. + "; } leaf description { type string; description "Textual description of the route."; - } uses rt:route-content; uses route-content { refine "dest-prefix" { mandatory "true"; } } } } } @@ -1559,42 +1634,42 @@ uses rt:route-content; uses route-content { refine "dest-prefix" { mandatory "true"; } } } } } - augment "/rt:routing/rt:router/rt:routing-tables/rt:routing-table/" - + "rt:routes/rt:route" { + augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/" + + "rt:route" { when "../../rt:address-family='ipv4' and " + "../../rt:safi='nlri-unicast'" { description "This augment is valid only for IPv4 unicast."; } description "This augment defines the content of IPv4 unicast routes."; uses route-content; } } 8. IPv6 Unicast Routing 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@2012-07-09.yang" + file "ietf-ipv6-unicast-routing@2012-10-04.yang" module ietf-ipv6-unicast-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing"; prefix "v6ur"; import ietf-routing { prefix "rt"; } @@ -1626,39 +1701,35 @@ Editor: Ladislav Lhotka "; description "This YANG module augments the 'ietf-routing' module with basic configuration and operational state data for IPv6 unicast routing. - Every implementation must preconfigure a routing table with the - name 'main-ipv6-unicast', which is the main routing table for - IPv6 unicast. - Copyright (c) 2012 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices. "; - revision 2012-07-09 { + revision 2012-10-04 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Configuration"; } /* Groupings */ grouping route-content { description @@ -1701,37 +1774,29 @@ uses route-content; } /* Data nodes */ augment "/rt:routing/rt:router/rt:interfaces/rt:interface" { when "/if:interfaces/if:interface[name=current()/name]/ip:ipv6/" + "ip:enabled='true'" { description "This augment is only valid for router interfaces with - enabled IPv6. - - NOTE: Parameter 'is-router' is not included, it is expected - that it will be implemented by the 'ietf-ip' module. - "; + enabled IPv6."; } description "IPv6-specific parameters of router interfaces."; container ipv6-router-advertisements { description "Parameters of IPv6 Router Advertisements."; reference - "RFC 4861: Neighbor Discovery for IP version 6 (IPv6). - - RFC 4862: IPv6 Stateless Address Autoconfiguration. - "; - + "RFC 4861: Neighbor Discovery for IP version 6 (IPv6)."; 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 { @@ -1740,20 +1806,25 @@ units "seconds"; default "600"; description "The maximum time allowed between sending unsolicited multicast Router Advertisements from the interface."; } leaf min-rtr-adv-interval { type uint16 { range "3..1350"; } + must ". <= 0.75 * ../max-rtr-adv-interval" { + description + "The value must be no greater than + 3/4*max-rtr-adv-interval."; + } units "seconds"; description "The minimum time allowed between sending unsolicited multicast Router Advertisements from the interface. Must be no greater than 0.75 * max-rtr-adv-interval. Its default value is dynamic: - if max-rtr-adv-interval >= 9 seconds, the default value @@ -1937,44 +2006,43 @@ list route { key "id"; ordered-by "user"; description "A user-ordered list of static routes."; leaf id { type uint32 { range "1..max"; } description - 'Numeric identifier of the route. + "Numeric identifier of the route. - It is not required that the routes be sorted according - to their "id". - '; + It is not required that the routes be sorted by their + 'id'. + "; } leaf description { type string; description "Textual description of the route."; } uses rt:route-content; uses route-content { refine "dest-prefix" { mandatory "true"; } } } } } - augment "/rt:routing/rt:router/rt:routing-tables/rt:routing-table/" - + "rt:routes/rt:route" { - + augment "/rt:routing/rt:routing-tables/rt:routing-table/rt:routes/" + + "rt:route" { when "../../rt:address-family='ipv6' and " + "../../rt:safi='nlri-unicast'" { description "This augment is valid only for IPv6 unicast."; } description "This augment defines the content of IPv6 unicast routes."; uses route-content; } } @@ -2054,44 +2122,44 @@ The vulnerable "config true" subtrees and data nodes are the following: /rt:routing/rt:router/rt:interfaces/rt:interface This list assigns a network layer interface to a router instance and may also specify interface parameters related to routing. /rt:routing/rt:router/rt:routing-protocols/rt:routing-protocol This list specifies the routing protocols configured on a device. - /rt:routing/rt:router/rt:route-filters/rt:route-filter This list - specifies the configured route filters which represent the - administrative policies for redistributing and modifying routing - information. + /rt:routing/rt:route-filters/rt:route-filter This list specifies the + configured route filters which represent administrative policies + for redistributing and modifying routing information. Unauthorized access to any of these lists can adversely affect the routing subsystem of both the local device and the network. This may lead to network malfunctions, delivery of packets to inappropriate destinations and other problems. 11. Acknowledgments - The author wishes to thank Martin Bjorklund, Joel Halpern, Thomas - Morin, Tom Petch, Juergen Schoenwaelder, Dave Thaler and Yi Yang for - their helpful comments and suggestions. + The author wishes to thank Martin Bjorklund, Joel Halpern, + Wes Hardaker, Andrew McGregor, Thomas Morin, Tom Petch, + Juergen Schoenwaelder, Phil Shafer, Dave Thaler and Yi Yang for their + helpful comments and suggestions. 12. References 12.1. Normative References [IANA-IF-AF] Bjorklund, M., "IANA Interface Type and Address Family - YANG Modules", draft-ietf-netmod-iana-if-type-02 (work in - progress), April 2012. + YANG Modules", draft-ietf-netmod-iana-if-type-04 (work in + progress), June 2012. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. [RFC4861] Narten, T., Nordmark, E., Simpson, W., and H. Soliman, "Neighbor Discovery for IP version 6 (IPv6)", RFC 4861, September 2007. @@ -2101,45 +2169,45 @@ September 2010. [RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6021, September 2010. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. Bierman, "NETCONF Configuration Protocol", RFC 6241, June 2011. [YANG-IF] Bjorklund, M., "A YANG Data Model for Interface - Configuration", draft-ietf-netmod-interfaces-cfg-04 (work - in progress), April 2012. + Configuration", draft-ietf-netmod-interfaces-cfg-06 (work + in progress), September 2012. [YANG-IP] Bjorklund, M., "A YANG Data Model for IP Configuration", - draft-ietf-netmod-ip-cfg-03 (work in progress), - April 2012. + draft-ietf-netmod-ip-cfg-06 (work in progress), + September 2012. 12.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. 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 4.4.2. - file "example-rip@2012-07-09.yang" + file "example-rip@2012-10-04.yang" module example-rip { namespace "http://example.com/rip"; prefix "rip"; import ietf-routing { prefix "rt"; } @@ -2163,29 +2231,22 @@ 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:router/rt:routing-tables/rt:routing-table/" - + "rt:routes/rt:route" { - when "../../../../rt:routing-protocols/" - + "rt:routing-protocol[rt:name=current()/rt:source-protocol]/" - + "rt:type='rip:rip'" { - description - "This augment is only valid if the source protocol from which - the route originated is RIP."; - } + 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; } @@ -2219,21 +2280,21 @@ default "30"; description "Time interval between periodic updates."; } } } } -Appendix B. Example: Reply to the NETCONF Message +Appendix B. 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 6), @@ -2321,20 +2382,34 @@ false rtr0 + 192.0.2.1 + Router A + + + ipv4 + nlri-unicast + ipv4-unicast + + + ipv6 + nlri-unicast + ipv6-unicast + + eth0 eth1 true @@ -2365,103 +2440,141 @@ 1 ::/0 2001:db8:0:1::2 - - main-ipv4-unicast - - - main-ipv6-unicast - + + ipv4-unicast + + + ipv6-unicast + + - main-ipv4-unicast + ipv4-unicast + ipv4 + nlri-unicast 192.0.2.1/24 eth0 direct - 3512 + 2012-10-02T17:11:27+01:00 198.51.100.0/24 eth1 direct - 3512 + 2012-10-02T17:11:27+01:00 0.0.0.0/0 st0 192.0.2.2 - 2551 + 2012-10-02T18:02:45+01:00 + - main-ipv6-unicast + ipv6-unicast ipv6 nlri-unicast 2001:db8:0:1::/64 eth0 direct - 3513 + 2012-10-02T17:11:27+01:00 2001:db8:0:2::/64 eth1 direct - 3513 + 2012-10-02T17:11:27+01:00 ::/0 2001:db8:0:1::2 st0 - 2550 + 2012-10-02T18:02:45+01:00 - Appendix C. Change Log RFC Editor: remove this section upon publication as an RFC. -C.1. Changes Between Versions -03 and -04 +C.1. 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 + mandatory. + + o Removed the default for route-filter/type and made this leaf + mandatory. + + o If there is no active route for a given destination, the "active- + route" RPC returns no output. + + o Added "enabled" switch under "routing-protocol". + + o Added "router-type" identity and "type" leaf under "router". + + o Route attribute "age" changed to "last-updated", its type is + "yang:date-and-time". + + 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. + +C.2. 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". -C.2. Changes Between Versions -02 and -03 +C.3. 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". @@ -2479,45 +2592,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". -C.3. Changes Between Versions -01 and -02 +C.4. Changes Between Versions -01 and -02 o Added module "ietf-ipv6-unicast-routing". o The example in Appendix B now uses IP addresses from blocks reserved for documentation. - o Direct routes appear by default in the FIB table. + 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. -C.4. Changes Between Versions -00 and -01 +C.5. 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.