A YANG Data Model for Routing Configuration
draft-ietf-netmod-routing-cfg-02
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft that was ultimately published as RFC 8022.
|
|
|---|---|---|---|
| Author | Ladislav Lhotka | ||
| Last updated | 2012-02-20 (Latest revision 2011-09-23) | ||
| Replaces | draft-lhotka-netmod-routing-cfg | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Formats | |||
| Reviews |
GENART Last Call review
(of
-24)
by Brian Carpenter
Ready w/issues
GENART Last Call review
(of
-24)
by Brian Carpenter
Ready w/issues
|
||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | WG Document | |
| Document shepherd | (None) | ||
| IESG | IESG state | Became RFC 8022 (Proposed Standard) | |
| Consensus boilerplate | Unknown | ||
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-ietf-netmod-routing-cfg-02
Internet-Draft YANG Routing Configuration February 2012 value "6"; description "(includes all 802 media plus Ethernet 'canonical format')"; } enum e163 { value "7"; description "E.163"; } enum e164 { value "8"; description "(SMDS, FrameRelay, ATM)"; } enum f69 { value "9"; description "(Telex)"; } enum x121 { value "10"; description "(X.25, Frame Relay)"; } enum ipx { value "11"; description "IPX (Internet Protocol Exchange)"; } enum appleTalk { value "12"; description "Apple Talk"; } enum decnetIV { value "13"; description "DEC Net Phase IV"; } enum banyanVines { value "14"; description "Banyan Vines"; } enum e164withNsap { value "15"; description Lhotka Expires August 23, 2012 [Page 21] Internet-Draft YANG Routing Configuration February 2012 "(E.164 with NSAP format subaddress)"; } enum dns { value "16"; description "(Domain Name System)"; } enum distinguishedName { value "17"; description "(Distinguished Name, per X.500)"; } enum asNumber { value "18"; description "(16-bit quantity, per the AS number space)"; } enum xtpOverIPv4 { value "19"; description "XTP over IP version 4"; } enum xtpOverIpv6 { value "20"; description "XTP over IP version 6"; } enum xtpNativeModeXTP { value "21"; description "XTP native mode XTP"; } enum fibreChannelWWPN { value "22"; description "Fibre Channel World-Wide Port Name"; } enum fibreChannelWWNN { value "23"; description "Fibre Channel World-Wide Node Name"; } enum gwid { value "24"; description "Gateway Identifier"; } enum afi { Lhotka Expires August 23, 2012 [Page 22] Internet-Draft YANG Routing Configuration February 2012 value "25"; description "AFI for L2VPN"; } } description "This typedef is a YANG enumeration of IANA-registered address family numbers (AFN)."; reference "Address Family Numbers. IANA, 2011-01-20. <http://www.iana.org/assignments/address-family-numbers/ address-family-numbers.xml> IANA-ADDRESS-FAMILY-NUMBERS-MIB DEFINITIONS <http://www.iana.org/assignments/ianaaddressfamilynumbers-mib> "; } typedef subsequent-address-family { type enumeration { enum nlri-unicast { value "1"; description "Network Layer Reachability Information used for unicast forwarding"; reference "RFC4760"; } enum nlri-multicast { value "2"; description "Network Layer Reachability Information used for multicast forwarding"; reference "RFC4760"; } enum nlri-mpls { value "4"; description "Network Layer Reachability Information (NLRI) with MPLS Labels"; reference "RFC3107"; } enum mcast-vpn { value "5"; description "MCAST-VPN"; Lhotka Expires August 23, 2012 [Page 23] Internet-Draft YANG Routing Configuration February 2012 reference "draft-ietf-l3vpn-2547bis-mcast-bgp-08"; } enum nlri-dynamic-ms-pw { value "6"; status "obsolete"; description "Network Layer Reachability Information used for Dynamic Placement of Multi-Segment Pseudowires (TEMPORARY - Expires 2008-08-23)"; reference "draft-ietf-pwe3-dynamic-ms-pw-13"; } enum tunnel-safi { value "64"; description "Tunnel SAFI"; reference "draft-nalawade-kapoor-tunnel-safi-05"; } enum vpls { value "65"; description "Virtual Private LAN Service (VPLS)"; reference "RFC4761, RFC6074"; } enum bgp-mdt { value "66"; description "BGP MDT SAFI"; reference "RFC6037"; } enum bgp-4over6 { value "67"; description "BGP 4over6 SAFI"; reference "RFC5747"; } enum bgp-6over4 { value "68"; description "BGP 6over4 SAFI"; reference "mailto:cuiyong&tsinghua.edu.cn"; } Lhotka Expires August 23, 2012 [Page 24] Internet-Draft YANG Routing Configuration February 2012 enum l1vpn-auto-discovery { value "69"; description "Layer-1 VPN auto-discovery information"; reference "draft-ietf-l1vpn-bgp-auto-discovery-05"; } enum mpls-vpn { value "128"; description "MPLS-labeled VPN address"; reference "RFC4364"; } enum multicast-bgp-mpls-vpn { value "129"; description "Multicast for BGP/MPLS IP Virtual Private Networks (VPNs)"; reference "draft-ietf-l3vpn-2547bis-mcast-10, draft-ietf-l3vpn-2547bis-mcast-10"; } enum route-target-constraints { value "132"; description "Route Target constraints"; reference "RFC4684"; } enum ipv4-diss-flow { value "133"; description "IPv4 dissemination of flow specification rules"; reference "RFC5575"; } enum vpnv4-diss-flow { value "134"; description "IPv4 dissemination of flow specification rules"; reference "RFC5575"; } enum vpn-auto-discovery { value "140"; description "VPN auto-discovery"; Lhotka Expires August 23, 2012 [Page 25] Internet-Draft YANG Routing Configuration February 2012 reference "draft-ietf-l3vpn-bgpvpn-auto-09"; } } description "This typedef is a YANG enumeration of IANA-registered subsequent address family identifiers (SAFI)."; reference "Subsequent Address Family Identifiers (SAFI) Parameters. IANA, 2011-03-04. <http://www.iana.org/assignments/safi-namespace/ safi-namespace.xml> "; } } <CODE ENDS> Lhotka Expires August 23, 2012 [Page 26] Internet-Draft YANG Routing Configuration February 2012 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). <CODE BEGINS> file "ietf-routing@2012-02-20.yang" module ietf-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-routing"; prefix "rt"; import ietf-yang-types { prefix "yang"; } import ietf-interfaces { prefix "if"; } import iana-afn-safi { prefix "ianaaf"; } organization "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; contact "WG Web: <http://tools.ietf.org/wg/netmod/> WG List: <mailto:netmod@ietf.org> WG Chair: David Kessens <mailto:david.kessens@nsn.com> WG Chair: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de> Editor: Ladislav Lhotka <mailto:lhotka@nic.cz> "; description "This module contains YANG definitions of essential components that may be used for configuring a routing subsystem. Copyright (c) 2012 IETF Trust and the persons identified as Lhotka Expires August 23, 2012 [Page 27] Internet-Draft YANG Routing Configuration February 2012 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-02-20 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Configuration"; } /* Identities */ 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 connected networks."; } identity static { base routing-protocol; description "Static routing pseudo-protocol."; } identity route-filter { description "Base identity from which all route filters are derived."; } identity deny-all-route-filter { base route-filter; Lhotka Expires August 23, 2012 [Page 28] Internet-Draft YANG Routing Configuration February 2012 description "Route filter that blocks all routes."; } /* Type Definitions */ typedef router-ref { type leafref { path "/rt:routing/rt:router/rt:name"; } 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"; description "Address family of routes in the routing table."; } leaf safi { type ianaaf:subsequent-address-family; default "nlri-unicast"; 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'. "; leaf outgoing-interface { type if:interface-ref; description "Outgoing interface."; } Lhotka Expires August 23, 2012 [Page 29] Internet-Draft YANG Routing Configuration February 2012 } /* RPC Methods */ rpc get-route { description "Query the forwarding information base of a router instance whose name is given as the first parameter 'router-name'. The second parameter 'destination-address' should be augmented in order to support destination addresses of all supported address families. The server returns the route which is currently used for forwarding datagrams to that destination address, or an error message, if no such route exists."; input { leaf router-name { type router-ref; mandatory "true"; description "First parameter: name of the router instance whose forwarding information base is queried."; } container destination-address { uses afn-safi; description "Second parameter: destination address. AFN/SAFI-specific modules must augment this container with a leaf named 'address'. "; } } output { container route { uses afn-safi; description "Contents of the reply specific for each address family should be defined through augmenting."; } } } /* Data Nodes */ container routing { description "Routing parameters."; list router { key "name"; Lhotka Expires August 23, 2012 [Page 30] Internet-Draft YANG Routing Configuration February 2012 unique "interfaces/interface/name"; description "Each list entry is a container for configuration and operational state data of a single (logical) router."; leaf name { type string; description "The unique router name."; } leaf description { type string; description "Textual description of the router."; } leaf enabled { type boolean; default "true"; description "Enable or disable the router. The default value is 'true', which means that the router is enabled."; } container interfaces { description "Router interface parameters."; list interface { key "name"; description "List of logical interfaces assigned to the router instance. Any logical interface can only be assigned to one router instance."; leaf name { type if:interface-ref; description "A reference to the name of a configured logical interface."; } } } container routing-protocols { 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; Lhotka Expires August 23, 2012 [Page 31] Internet-Draft YANG Routing Configuration February 2012 description "The name of the routing protocol instance."; } leaf description { type string; description "Textual description of the routing protocol instance."; } 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[current()/" + "preceding-sibling::routing-table/name]/" + "address-family=../../../../routing-tables/" + "routing-table[current()/name]/" + "address-family and ../../../../routing-tables/" + "routing-table[current()/" + "preceding-sibling::routing-table/name]/safi=../" + "../../../routing-tables/routing-table[current()/" + "name]/safi)" { error-message "Each routing protocol may have no more than one connected routing table for each AFN and SAFI."; 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. Implementation may provide default routing tables for some AFN/SAFI pairs, which are used if the corresponding entry is not configured. "; Lhotka Expires August 23, 2012 [Page 32] Internet-Draft YANG Routing Configuration February 2012 leaf name { type leafref { path "../../../../../routing-tables/routing-table/" + "name"; } description "Reference to an existing routing table."; } leaf import-filter { type leafref { path "../../../../../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."; } leaf export-filter { type leafref { path "../../../../../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."; } } } container static-routes { must "../type='static'" { error-message "Static routes may be configured only for 'static' routing protocol."; description "This container is only valid for the 'static' routing protocol."; } Lhotka Expires August 23, 2012 [Page 33] Internet-Draft YANG Routing Configuration February 2012 description "Configuration of 'static' pseudo-protocol."; } } } 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."; leaf name { type string; description "The name of the route filter."; } leaf description { type string; description "Textual description of the route filter."; } leaf type { type identityref { base route-filter; } default "deny-all-route-filter"; description "Type of the route-filter - an identity derived from the 'route-filter' base identity. The default value represents an all-blocking filter."; } } } 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."; Lhotka Expires August 23, 2012 [Page 34] Internet-Draft YANG Routing Configuration February 2012 leaf name { type string; description "The 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)."; list route { description "A routing table entry. This data node must augmented with information specific for routes of each address family."; leaf source-protocol { type leafref { path "../../../../../routing-protocols/" + "routing-protocol/name"; } 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."; } leaf last-modified { type yang:date-and-time; description "Time stamp of the last modification of the route. If the route was never modified, it is the time when the route was inserted to the routing table."; } } } list recipient-routing-tables { key "recipient-name"; description "A list of routing tables that receive routes from this routing table."; leaf recipient-name { Lhotka Expires August 23, 2012 [Page 35] Internet-Draft YANG Routing Configuration February 2012 type leafref { path "../../../routing-table/name"; } description "The name of the recipient routing table."; } leaf filter { type leafref { path "../../../../route-filters/route-filter/name"; } description "A route filter which is applied to the routes passed on to the recipient routing table."; } } } } } } } <CODE ENDS> Lhotka Expires August 23, 2012 [Page 36] Internet-Draft YANG Routing Configuration February 2012 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). <CODE BEGINS> file "ietf-ipv4-unicast-routing@2012-02-20.yang" module ietf-ipv4-unicast-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing"; prefix "v4ur"; import ietf-routing { prefix "rt"; } import ietf-inet-types { prefix "inet"; } organization "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; contact "WG Web: <http://tools.ietf.org/wg/netmod/> WG List: <mailto:netmod@ietf.org> WG Chair: David Kessens <mailto:david.kessens@nsn.com> WG Chair: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de> Editor: Ladislav Lhotka <mailto:lhotka@nic.cz> "; description "This module augments the 'ietf-routing' module with YANG definitions for basic configuration of IPv4 unicast routing. 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 Lhotka Expires August 23, 2012 [Page 37] Internet-Draft YANG Routing Configuration February 2012 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-02-20 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Configuration"; } /* Groupings */ grouping route-content { description "Parameters of IPv4 unicast routes."; uses rt:route-content; leaf dest-prefix { type inet:ipv4-prefix; description "IPv4 destination prefix."; } leaf next-hop { type inet:ipv4-address; description "IPv4 address of the next hop."; } } /* RPC Methods */ augment "/rt:get-route/rt:input/rt:destination-address" { when "address-family='ipV4' and safi='nlri-unicast'" { description "This augment is valid only for IPv4 unicast."; } description "The 'address' leaf augments the 'rt:destination-address' parameter of the 'rt:get-route' operation."; leaf address { type inet:ipv4-address; description "IPv4 destination address."; Lhotka Expires August 23, 2012 [Page 38] Internet-Draft YANG Routing Configuration February 2012 } } augment "/rt:get-route/rt:output/rt:route" { when "address-family='ipV4' and safi='nlri-unicast'" { description "This augment is valid only for IPv4 unicast."; } description "Contents of the reply to 'rt:get-route' operation."; uses route-content; } /* Data nodes */ augment "/rt:routing/rt:router/rt:routing-protocols/" + "rt:routing-protocol/rt:static-routes" { description "This augment defines the configuration of the 'static' pseudo-protocol with data specific for IPv4 unicast."; container ipv4 { description "Configuration of a 'static' pseudo-protocol instance consists of a list of routes."; list route { key "seqno"; ordered-by "user"; description "A user-ordered list of static routes."; leaf seqno { type uint16; description "Sequential number of the route."; } leaf description { type string; description "Textual description of the route."; } uses route-content; } } } augment "/rt:routing/rt:router/rt:routing-tables/rt:routing-table/" + "rt:routes/rt:route" { when "../../rt:address-family='ipV4' and " + "../../rt:safi='nlri-unicast'" { Lhotka Expires August 23, 2012 [Page 39] Internet-Draft YANG Routing Configuration February 2012 description "This augment is valid only for IPv4 unicast."; } description "This augment defines the content of IPv4 unicast routes."; uses route-content; } } <CODE ENDS> Lhotka Expires August 23, 2012 [Page 40] Internet-Draft YANG Routing Configuration February 2012 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). <CODE BEGINS> file "ietf-ipv6-unicast-routing@2012-02-20.yang" module ietf-ipv6-unicast-routing { namespace "urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing"; prefix "v6ur"; import ietf-routing { prefix "rt"; } import ietf-inet-types { prefix "inet"; } import ietf-interfaces { prefix "if"; } import ietf-ip { prefix "ip"; } organization "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; contact "WG Web: <http://tools.ietf.org/wg/netmod/> WG List: <mailto:netmod@ietf.org> WG Chair: David Kessens <mailto:david.kessens@nsn.com> WG Chair: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de> Editor: Ladislav Lhotka <mailto:lhotka@nic.cz> "; description Lhotka Expires August 23, 2012 [Page 41] Internet-Draft YANG Routing Configuration February 2012 "This module augments the 'ietf-routing' module with YANG definitions for basic configuration of IPv6 unicast routing. 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-02-20 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for Routing Configuration"; } /* Groupings */ grouping route-content { description "Specific parameters of IPv6 unicast routes."; uses rt:route-content; leaf dest-prefix { type inet:ipv6-prefix; description "IPv6 destination prefix."; } leaf next-hop { type inet:ipv6-address; description "IPv6 address of the next hop."; } } /* RPC Methods */ augment "/rt:get-route/rt:input/rt:destination-address" { when "address-family='ipV6' and safi='nlri-unicast'" { description "This augment is valid only for IPv6 unicast."; Lhotka Expires August 23, 2012 [Page 42] Internet-Draft YANG Routing Configuration February 2012 } description "The 'address' leaf augments the 'rt:destination-address' parameter of the 'rt:get-route' operation."; leaf address { type inet:ipv6-address; description "IPv6 destination address."; } } augment "/rt:get-route/rt:output/rt:route" { when "address-family='ipV6' and safi='nlri-unicast'" { description "This augment is valid only for IPv6 unicast."; } description "Contents of the reply to 'rt:get-route' operation."; 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. "; } 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. "; leaf send-advertisements { type boolean; default "false"; description Lhotka Expires August 23, 2012 [Page 43] Internet-Draft YANG Routing Configuration February 2012 "A flag indicating whether or not the router sends periodic Router Advertisements and responds to Router Solicitations."; } leaf max-rtr-adv-interval { type uint16 { range "4..1800"; } 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"; } 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 is 0.33 * max-rtr-adv-interval; - otherwise it is max-rtr-adv-interval. "; } 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; default "false"; description "The boolean value to be placed in the 'Other configuration' flag field in the Router Advertisement."; } leaf link-mtu { Lhotka Expires August 23, 2012 [Page 44] Internet-Draft YANG Routing Configuration February 2012 type uint32; default "0"; description "The value to be placed in MTU options sent by the router. A value of zero indicates that no MTU options are sent."; } leaf reachable-time { type uint32 { range "0..3600000"; } units "milliseconds"; default "0"; description "The value to be placed in the Reachable Time field in the Router Advertisement messages sent by the router. The value zero means unspecified (by this router)."; } leaf retrans-timer { type uint32; units "milliseconds"; default "0"; 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. 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. "; reference "IANA: IP Parameters, http://www.iana.org/assignments/ip-parameters"; } leaf default-lifetime { type uint16 { range "0..9000"; } Lhotka Expires August 23, 2012 [Page 45] Internet-Draft YANG Routing Configuration February 2012 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 MaxRtrAdvInterval 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. The default value is dynamic and should be set to 3 * max-rtr-adv-interval. "; } container prefix-list { description "A list of prefixes to be placed in Prefix Information options in Router Advertisement messages sent from the interface. Default: 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. "; list prefix { key "seqno"; unique "prefix-spec"; description "Advertised prefix entry."; leaf seqno { type uint8; description "Sequential number of the entry."; } 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, in seconds. The designated value of all 1's (0xffffffff) represents infinity. Lhotka Expires August 23, 2012 [Page 46] Internet-Draft YANG Routing Configuration February 2012 Implementations may allow valid-lifetime to be specified in two ways: 1. a time that decrements in real time, that is, one that will result in a Lifetime of zero at the specified time in the future, 2. a fixed time that stays the same in consecutive advertisements. "; } 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."; } leaf preferred-lifetime { type uint32; units "seconds"; default "604800"; description "The value to be placed in the Preferred Lifetime in the Prefix Information option, in seconds. The designated value of all 1's (0xffffffff) represents infinity. Implementations MAY allow AdvPreferredLifetime to be specified in two ways: 1. a time that decrements in real time, that is, one that will result in a Lifetime of zero at a specified time in the future, 2. a fixed time that stays the same in consecutive advertisements. "; } leaf autonomous-flag { type boolean; default "true"; description "The value to be placed in the Autonomous Flag field in the Prefix Information option."; } } } Lhotka Expires August 23, 2012 [Page 47] Internet-Draft YANG Routing Configuration February 2012 } } augment "/rt:routing/rt:router/rt:routing-protocols/" + "rt:routing-protocol/rt:static-routes" { description "This augment defines the configuration of the 'static' pseudo-protocol with data specific for IPv6 unicast."; container ipv6 { description "Configuration of a 'static' pseudo-protocol instance consists of a list of routes."; list route { key "seqno"; ordered-by "user"; description "A user-ordered list of static routes."; leaf seqno { type uint16; description "Sequential number of the route."; } leaf description { type string; description "Textual description of the route."; } uses route-content; } } } augment "/rt:routing/rt:router/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; } } <CODE ENDS> Lhotka Expires August 23, 2012 [Page 48] Internet-Draft YANG Routing Configuration February 2012 9. IANA Considerations RFC Ed.: In this section, replace all occurrences of 'XXXX' with the actual RFC number (and remove this note). This document registers the following namespace URIs in the IETF XML registry [RFC3688]: ---------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-routing Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. ---------------------------------------------------------- ---------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. ---------------------------------------------------------- ---------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. ---------------------------------------------------------- ---------------------------------------------------------- URI: urn:ietf:params:xml:ns:yang:iana-afn-safi Registrant Contact: IANA. XML: N/A, the requested URI is an XML namespace. ---------------------------------------------------------- This document registers the following YANG modules in the YANG Module Names registry [RFC6020]: Lhotka Expires August 23, 2012 [Page 49] Internet-Draft YANG Routing Configuration February 2012 ------------------------------------------------------------------- name: ietf-routing namespace: urn:ietf:params:xml:ns:yang:ietf-routing prefix: rt reference: RFC XXXX ------------------------------------------------------------------- ------------------------------------------------------------------- name: ietf-ipv4-unicast-routing namespace: urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing prefix: v4ur reference: RFC XXXX ------------------------------------------------------------------- ------------------------------------------------------------------- name: ietf-ipv6-unicast-routing namespace: urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing prefix: v6ur reference: RFC XXXX ------------------------------------------------------------------- ------------------------------------------------------------------- name: iana-afn-safi namespace: urn:ietf:params:xml:ns:yang:iana-afn-safi prefix: ianaaf reference: RFC XXXX ------------------------------------------------------------------- Lhotka Expires August 23, 2012 [Page 50] Internet-Draft YANG Routing Configuration February 2012 10. Security Considerations The YANG modules defined in this document are designed to be accessed via the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the secure transport layer and the mandatory-to-implement secure transport is SSH [RFC6242]. A number of data nodes defined in the YANG modules are writable/ creatable/deletable (i.e., "config true" in YANG terms, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations to these data nodes, such as "edit-config", can have negative effects on the network if the operations are not properly protected. The vulnerable "config true" subtrees and data nodes are the following: /rt:routing/rt:router/rt:interfaces/rt:interface This list assigns a logical 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. 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. Lhotka Expires August 23, 2012 [Page 51] Internet-Draft YANG Routing Configuration February 2012 11. Acknowledgments The author wishes to thank Martin Bjorklund, Joel Halpern, Tom Petch and Juergen Schoenwaelder for their helpful comments and suggestions. Lhotka Expires August 23, 2012 [Page 52] Internet-Draft YANG Routing Configuration February 2012 12. References 12.1. Normative References [IANA-AFN] IANA, "Address Family Numbers.", January 2011. [IANA-SAFI] IANA, "Subsequent Address Family Identifiers (SAFI) Parameters.", March 2011. [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. [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for Network Configuration Protocol (NETCONF)", RFC 6020, 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-03 (work in progress), February 2012. [YANG-IP] Bjorklund, M., "A YANG Data Model for IP Configuration", draft-ietf-netmod-ip-cfg-02 (work in progress), February 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. Lhotka Expires August 23, 2012 [Page 53] Internet-Draft YANG Routing Configuration February 2012 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.1. <CODE BEGINS> file "example-rip@2012-02-20.yang" module example-rip { namespace "http://example.com/rip"; prefix "rip"; import ietf-routing { prefix "rt"; } identity rip { base rt:routing-protocol; description "Identity for the RIP routing protocol."; } typedef rip-metric { type uint8 { range "0..16"; } } grouping route-content { description "RIP-specific route content."; leaf metric { type rip-metric; } leaf tag { type uint16; default "0"; description "This leaf may be used to carry additional info, e.g. AS number."; } } Lhotka Expires August 23, 2012 [Page 54] Internet-Draft YANG Routing Configuration February 2012 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."; } description "RIP-specific route components."; uses route-content; } augment "/rt:get-route/rt:output/rt:route" { description "Add RIP-specific route content."; uses route-content; } augment "/rt:routing/rt:router/rt:interfaces/rt:interface" { when "../../rt:routing-protocols/rt:routing-protocol/rt:type = " + "'rip:rip'"; container rip { description "Per-interface RIP configuration."; leaf enabled { type boolean; default "true"; } leaf metric { type rip-metric; default "1"; } } } augment "/rt:routing/rt:router/rt:routing-protocols/" + "rt:routing-protocol" { when "rt:type = 'rip:rip'"; container rip { leaf update-interval { type uint8 { range "10..60"; } units "seconds"; default "30"; description Lhotka Expires August 23, 2012 [Page 55] Internet-Draft YANG Routing Configuration February 2012 "Time interval between periodic updates."; } } } } <CODE ENDS> Lhotka Expires August 23, 2012 [Page 56] Internet-Draft YANG Routing Configuration February 2012 Appendix B. Example: Reply to the NETCONF <get> Message This section contains a sample reply to the NETCONF <get> message, which could be sent by a server supporting (i.e., advertising them in the NETCONF <hello> message) the following YANG modules: o ietf-interfaces [YANG-IF], o ex-ethernet [YANG-IF], o ietf-ip [YANG-IP], o ietf-routing (Section 6), o ietf-ipv4-unicast-routing (Section 7), o ietf-ipv6-unicast-routing (Section 8). We assume a simple network setup as shown in Figure 3: router "A" 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 | | |2001:db8:0:1::1 eth0|192.0.2.1 +--------+--------+ | | | Router A | | | +--------+--------+ eth1|198.51.100.1 |2001:db8:0:2::1 | Figure 3: Example network configuration Router "A" then could send the following XML document as its reply to the NETCONF <get> message: Lhotka Expires August 23, 2012 [Page 57] Internet-Draft YANG Routing Configuration February 2012 <?xml version="1.0"?> <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:v4ur="urn:ietf:params:xml:ns:yang:ietf-ipv4-unicast-routing" xmlns:v6ur="urn:ietf:params:xml:ns:yang:ietf-ipv6-unicast-routing" xmlns:if="urn:ietf:params:xml:ns:yang:ietf-interfaces" xmlns:eth="http://example.com/ethernet" xmlns:ip="urn:ietf:params:xml:ns:yang:ietf-ip" xmlns:rt="urn:ietf:params:xml:ns:yang:ietf-routing"> <data> <if:interfaces> <if:interface> <if:name>eth0</if:name> <if:type>ethernetCsmacd</if:type> <if:location>05:00.0</if:location> <ip:ipv4> <ip:address> <ip:ip>192.0.2.1</ip:ip> <ip:prefix-length>24</ip:prefix-length> </ip:address> </ip:ipv4> <ip:ipv6> <ip:address> <ip:ip>2001:0db8:0:1::1</ip:ip> <ip:prefix-length>64</ip:prefix-length> </ip:address> <ip:autoconf> <ip:create-global-addresses>false</ip:create-global-addresses> </ip:autoconf> </ip:ipv6> </if:interface> <if:interface> <if:name>eth1</if:name> <if:type>ethernetCsmacd</if:type> <if:location>05:00.1</if:location> <ip:ipv4> <ip:address> <ip:ip>198.51.100.1</ip:ip> <ip:prefix-length>24</ip:prefix-length> </ip:address> </ip:ipv4> <ip:ipv6> <ip:address> <ip:ip>2001:0db8:0:2::1</ip:ip> <ip:prefix-length>64</ip:prefix-length> </ip:address> <ip:autoconf> Lhotka Expires August 23, 2012 [Page 58] Internet-Draft YANG Routing Configuration February 2012 <ip:create-global-addresses>false</ip:create-global-addresses> </ip:autoconf> </ip:ipv6> </if:interface> </if:interfaces> <rt:routing> <rt:router> <rt:name>rtr0</rt:name> <rt:interfaces> <rt:interface> <rt:name>eth0</rt:name> </rt:interface> <rt:interface> <rt:name>eth1</rt:name> <v6ur:ipv6-router-advertisements> <v6ur:send-advertisements>true</v6ur:send-advertisements> <v6ur:prefix-list> <v6ur:prefix> <v6ur:seqno>1</v6ur:seqno> <v6ur:prefix-spec>2001:db8:0:2::/64</v6ur:prefix-spec> </v6ur:prefix> </v6ur:prefix-list> </v6ur:ipv6-router-advertisements> </rt:interface> </rt:interfaces> <rt:routing-protocols> <rt:routing-protocol> <rt:name>direct</rt:name> <rt:type>rt:direct</rt:type> </rt:routing-protocol> <rt:routing-protocol> <rt:name>st0</rt:name> <rt:description> Static routing is used for the internal network. </rt:description> <rt:type>rt:static</rt:type> <rt:static-routes> <v4ur:ipv4> <v4ur:route> <v4ur:seqno>1</v4ur:seqno> <v4ur:dest-prefix>0.0.0.0/0</v4ur:dest-prefix> <v4ur:next-hop>192.0.2.2</v4ur:next-hop> </v4ur:route> </v4ur:ipv4> <v6ur:ipv6> <v6ur:route> <v6ur:seqno>1</v6ur:seqno> <v6ur:dest-prefix>::/0</v6ur:dest-prefix> Lhotka Expires August 23, 2012 [Page 59] Internet-Draft YANG Routing Configuration February 2012 <v6ur:next-hop>2001:db8:0:1::2</v6ur:next-hop> </v6ur:route> </v6ur:ipv6> </rt:static-routes> <rt:connected-routing-tables> <rt:routing-table> <rt:name>ipv4-unicast-main</rt:name> </rt:routing-table> <rt:routing-table> <rt:name>ipv6-unicast-main</rt:name> </rt:routing-table> </rt:connected-routing-tables> </rt:routing-protocol> </rt:routing-protocols> <rt:routing-tables> <rt:routing-table> <rt:name>ipv4-unicast-fib</rt:name> <rt:routes> <rt:route> <v4ur:dest-prefix>192.0.2.1/24</v4ur:dest-prefix> <v4ur:outgoing-interface>eth0</v4ur:outgoing-interface> <rt:source-protocol>direct</rt:source-protocol> <rt:last-modified>2012-02-20T17:11:27+01:00</rt:last-modified> </rt:route> <rt:route> <v4ur:dest-prefix>198.51.100.0/24</v4ur:dest-prefix> <v4ur:outgoing-interface>eth1</v4ur:outgoing-interface> <rt:source-protocol>direct</rt:source-protocol> <rt:last-modified>2012-02-20T17:11:27+01:00</rt:last-modified> </rt:route> <rt:route> <v4ur:dest-prefix>0.0.0.0/0</v4ur:dest-prefix> <v4ur:next-hop>192.0.2.2</v4ur:next-hop> <rt:source-protocol>st0</rt:source-protocol> <rt:last-modified>2012-02-20T18:02:45+01:00</rt:last-modified> </rt:route> </rt:routes> </rt:routing-table> <rt:routing-table> <rt:name>ipv6-unicast-fib</rt:name> <rt:address-family>ipV6</rt:address-family> <rt:safi>nlri-unicast</rt:safi> <rt:routes> <rt:route> <v6ur:dest-prefix>2001:db8:0:1::/64</v6ur:dest-prefix> <v6ur:outgoing-interface>eth0</v6ur:outgoing-interface> <rt:source-protocol>direct</rt:source-protocol> <rt:last-modified>2012-02-20T17:11:27+01:00</rt:last-modified> Lhotka Expires August 23, 2012 [Page 60] Internet-Draft YANG Routing Configuration February 2012 </rt:route> <rt:route> <v6ur:dest-prefix>2001:db8:0:2::/64</v6ur:dest-prefix> <v6ur:outgoing-interface>eth1</v6ur:outgoing-interface> <rt:source-protocol>direct</rt:source-protocol> <rt:last-modified>2012-02-20T17:11:27+01:00</rt:last-modified> </rt:route> <rt:route> <v6ur:dest-prefix>::/0</v6ur:dest-prefix> <v6ur:next-hop>2001:db8:0:1::2</v6ur:next-hop> <rt:source-protocol>st0</rt:source-protocol> <rt:last-modified>2012-02-20T18:02:45+01:00</rt:last-modified> </rt:route> </rt:routes> </rt:routing-table> <rt:routing-table> <rt:name>ipv4-unicast-main</rt:name> <rt:recipient-routing-tables> <rt:recipient-name>ipv4-unicast-fib</rt:recipient-name> </rt:recipient-routing-tables> <rt:routes> <rt:route> <v4ur:dest-prefix>0.0.0.0/0</v4ur:dest-prefix> <rt:source-protocol>st0</rt:source-protocol> <v4ur:next-hop>192.0.2.2</v4ur:next-hop> <rt:last-modified>2012-02-20T18:02:45+01:00</rt:last-modified> </rt:route> </rt:routes> </rt:routing-table> <rt:routing-table> <rt:name>ipv6-unicast-main</rt:name> <rt:address-family>ipV6</rt:address-family> <rt:safi>nlri-unicast</rt:safi> <rt:recipient-routing-tables> <rt:recipient-name>ipv6-unicast-fib</rt:recipient-name> </rt:recipient-routing-tables> <rt:routes> <rt:route> <v6ur:dest-prefix>::/0</v6ur:dest-prefix> <v6ur:next-hop>2001:db8:0:1::2</v6ur:next-hop> <rt:source-protocol>st0</rt:source-protocol> <rt:last-modified>2012-02-20T18:02:45+01:00</rt:last-modified> </rt:route> </rt:routes> </rt:routing-table> </rt:routing-tables> </rt:router> </rt:routing> Lhotka Expires August 23, 2012 [Page 61] Internet-Draft YANG Routing Configuration February 2012 </data> </rpc-reply> Lhotka Expires August 23, 2012 [Page 62] Internet-Draft YANG Routing Configuration February 2012 Appendix C. Change Log RFC Editor: remove this section upon publication as an RFC. C.1. 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 Logical 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.2. 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. o RPC operation "delete-route" was removed. o Illegal XPath references from "get-route" to the datastore were fixed. o Section "Security Considerations" was written. Lhotka Expires August 23, 2012 [Page 63] Internet-Draft YANG Routing Configuration February 2012 Author's Address Ladislav Lhotka CZ.NIC Email: lhotka@nic.cz Lhotka Expires August 23, 2012 [Page 64]