--- 1/draft-ietf-ospf-yang-10.txt 2018-04-03 13:13:13.604578051 -0700 +++ 2/draft-ietf-ospf-yang-11.txt 2018-04-03 13:13:13.780582290 -0700 @@ -1,56 +1,56 @@ Internet D. Yeung Internet-Draft Arrcus Intended status: Standards Track Y. Qu -Expires: September 4, 2018 Huawei +Expires: October 5, 2018 Huawei J. Zhang Juniper Networks I. Chen Jabil A. Lindem Cisco Systems - March 3, 2018 + April 3, 2018 Yang Data Model for OSPF Protocol - draft-ietf-ospf-yang-10 + draft-ietf-ospf-yang-11 Abstract This document defines a YANG data model that can be used to configure and manage OSPF. Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. 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 https://datatracker.ietf.org/drafts/current/. + Drafts is at http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months 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 September 4, 2018. + This Internet-Draft will expire on October 5, 2018. Copyright Notice Copyright (c) 2018 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 - (https://trustee.ietf.org/license-info) in effect on the date of + (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2 @@ -61,82 +61,82 @@ 2.3. OSPFv2 and OSPFv3 . . . . . . . . . . . . . . . . . . . . 5 2.4. Optional Features . . . . . . . . . . . . . . . . . . . . 5 2.5. OSPF Router Configuration/Operational State . . . . . . . 5 2.6. OSPF Area Configuration/Operational State . . . . . . . . 8 2.7. OSPF Interface Configuration/Operational State . . . . . 13 2.8. OSPF notification . . . . . . . . . . . . . . . . . . . . 15 2.9. OSPF RPC Operations . . . . . . . . . . . . . . . . . . . 19 3. OSPF Yang Module . . . . . . . . . . . . . . . . . . . . . . 19 4. Security Considerations . . . . . . . . . . . . . . . . . . . 100 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 101 - 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 102 - 6.1. Normative References . . . . . . . . . . . . . . . . . . 102 - 6.2. Informative References . . . . . . . . . . . . . . . . . 104 - Appendix A. Contributors' Addreses . . . . . . . . . . . . . . . 105 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 105 + 6. Normative References . . . . . . . . . . . . . . . . . . . . 101 + Appendix A. Contributors' Addreses . . . . . . . . . . . . . . . 107 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 107 1. Overview YANG [RFC6020] is a data definition language used to define the contents of a conceptual data store that allows networked devices to be managed using NETCONF [RFC6241]. YANG is proving relevant beyond its initial confines, as bindings to other interfaces (e.g., ReST) and encodings other than XML (e.g., JSON) are being defined. Furthermore, YANG data models can be used as the basis for implementation of other interfaces, such as CLI and programmatic APIs. This document defines a YANG data model that can be used to configure and manage OSPF and it is an augmentation to the core routing data - model. A core routing data model is defined in [RFC8022], and it + model. A core routing data model is defined in [RFC8349], and it provides the basis for the development of data models for routing - protocols. The interface data model is defined in [RFC7223] and is + protocols. The interface data model is defined in [RFC8343] and is used for referencing interfaces from the routing protocol. The key- chain data model used for OSPF authentication is defined in [RFC8177] and provides both a reference to configured key-chains and an enumeration of cryptographic algorithms. Both OSPFv2 [RFC2328] and OSPFv3 [RFC5340] are supported. In addition to the core OSPF protocol, features described in other OSPF RFCs are also supported. These includes demand circuit [RFC1793], traffic engineering [RFC3630], multiple address family [RFC5838], graceful restart [RFC3623] [RFC5187], NSSA [RFC3101], and OSPF(v3) as a PE-CE Protocol [RFC4577], [RFC6565]. These non-core features are optional in the OSPF data model. 1.1. Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", - "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this - document are to be interpreted as described in [RFC2119]. + "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and + "OPTIONAL" in this document are to be interpreted as described in BCP + 14 [RFC2119] [RFC8174] when, and only when, they appear in all + capitals, as shown here. 2. Design of Data Model Although the basis of OSPF configuration elements like routers, areas, and interfaces remains the same, the detailed configuration model varies among router vendors. Differences are observed in terms of how the protocol engine is tied to the routing domain, how multiple protocol engines are be instantiated among others. The goal of this document is to define a data model that provides a common user interface to the OSPFv2 and OSPFv3 protocols. There is very little information that is designated as "mandatory", providing freedom for vendors to adapt this data model to their respective product implementations. 2.1. OSPF Operational State The OSPF operational state is included in the same tree as OSPF configuration consistent with Network Management Datastore - Architecture [I-D.ietf-netmod-revised-datastores]. Consequently, - only the routing container in the ietf-routing model [RFC8022] is - augmented. The routing-state container is not augmented. + Architecture [RFC8342]. Consequently, only the routing container in + the ietf-routing model [RFC8349] is augmented. The routing-state + container is not augmented. 2.2. Overview The OSPF YANG module defined in this document has all the common building blocks for the OSPF protocol. The OSPF YANG module augments the /routing/control-plane-protocols/ control-plane-protocol path defined in the ietf-routing module. module: ietf-ospf @@ -896,24 +896,34 @@ | + control-plane-protocol/name | +---w interface? if:interface-ref +---x clear-database +---w input +---w routing-protocol-name -> /rt:routing/control-plane-protocols/ control-plane-protocol/name 3. OSPF Yang Module - file "ietf-ospf@2018-03-03.yang" + The following RFCs and drafts are not referenced in the document text + but are referenced in the ietf-ospf.yang module: [RFC0905], + [RFC1765], [RFC4552], [RFC4576], [RFC4915], [RFC5082], [RFC5185], + [RFC5250], [RFC5286], [RFC5329], [RFC5443], [RFC5613], [RFC5714], + + [RFC5880], [RFC5881], [RFC6021], [RFC6860], [RFC6987], [RFC7490], + [RFC7684], [RFC7770], [RFC7777], [RFC8291], [RFC8343], [RFC8349], + [I-D.ietf-bfd-yang], and [I-D.ietf-rtgwg-backoff-algo]. + + file "ietf-ospf@2018-04-03.yang" module ietf-ospf { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-ospf"; + prefix ospf; import ietf-inet-types { prefix "inet"; reference "RFC 6021 - Common YANG Data Types"; } import ietf-yang-types { prefix "yang"; reference "RFC 6021 - Common YANG Data Types"; @@ -914,45 +924,46 @@ reference "RFC 6021 - Common YANG Data Types"; } import ietf-yang-types { prefix "yang"; reference "RFC 6021 - Common YANG Data Types"; } import ietf-interfaces { prefix "if"; - reference "RFC XXXX - A YANG Data Model for Interface + reference "RFC 8343 - A YANG Data Model for Interface Management (NDMA Version)"; } import ietf-routing-types { prefix "rt-types"; reference "RFC 8291 - Common YANG Data Types for the Routing Area"; } import iana-routing-types { prefix "iana-rt-types"; reference "RFC 8291 - Common YANG Data Types for the Routing Area"; } import ietf-routing { prefix "rt"; - reference "RFC XXXX - A YANG Data Model for Routing + reference "RFC 8349 - A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-key-chain { prefix "key-chain"; reference "RFC 8177 - YANG Data Model for Key Chains"; + } import ietf-bfd-types { prefix "bfd-types"; reference "RFC XXXX - YANG Data Model for Bidirectional Forwarding Detection (BFD)"; } organization "IETF OSPF - OSPF Working Group"; @@ -978,38 +989,36 @@ description "This YANG module defines the generic configuration and operational state for the OSPF protocol common to all vendor implementations. It is intended that the module will be extended by vendors to define vendor-specific OSPF configuration parameters and policies, for example route maps or route policies. This YANG model conforms to the Network Management - Datastore Architecture (NDMA) as described in RFC XXXX. + Datastore Architecture (NDMA) as described in RFC 8242. - Copyright (c) 2017 IETF Trust and the persons identified as + Copyright (c) 2018 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."; - reference "RFC XXXX"; - - revision 2018-03-03 { + revision 2018-04-03 { description "Initial revision."; reference "RFC XXXX: A YANG Data Model for OSPF."; } feature multi-topology { description "Support Multiple-Topolgy Routing (MTR)."; reference "RFC 4915 - Multi-Topology Routing"; @@ -1044,28 +1053,28 @@ } feature prefix-suppression { description "OSPF prefix suppression support as in RFC 6860."; reference "RFC 6860 - Hide Transit-Only Networks in OSPF"; } feature ttl-security { description - "OSPF TTL security check."; + "OSPF Time to Live (TTL) security check support."; reference "RFC 5082 - The Generalized TTL Security Mechanism (GTSM)"; } feature nsr { description - "Non-Stop-Routing (NSR)."; + "Non-Stop-Routing (NSR) support."; } feature graceful-restart { description "Graceful OSPF Restart as defined in RFC 3623 and RFC 5187."; reference "RFC 3630 - Graceful OSPF Restart RFC 5187 - OSPFv3 Graceful Restart"; } @@ -1081,25 +1090,24 @@ reference "RFC 2328 - OSPF Version 2"; } feature max-ecmp { description "Setting maximum number of ECMP paths."; } feature max-lsa { description - "Setting maximum number of LSAs the OSPF instance + "Setting the maximum number of LSAs the OSPF instance will accept."; reference "RFC 1765 - OSPF Database Overload"; } - feature te-rid { description "TE Router-ID."; reference "RFC 3630 - Traffic Engineering (TE) Extensions to OSPF Version 2 RFC 5329 - Traffic Engineering (TE) Extensions to OSPF Version 3"; } feature ldp-igp-sync { @@ -1110,92 +1118,90 @@ feature ospfv3-authentication-ipsec { description "Use IPsec for OSPFv3 authentication."; reference "RFC 4552 - Authentication/Confidentiality for OSPFv3"; } feature fast-reroute { description - "Support of IP Fast Reroute (IP-FRR)."; + "Support for IP Fast Reroute (IP-FRR)."; reference "RFC 5714 - IP Fast Rereoute Framework"; } feature node-flag { description - "Support of node flag."; + "Support for node-flag for OSPF prefixes."; reference "RFC 7684 - OSPFv2 Prefix/Link Advertisement"; } feature node-tag { description - "Support of node tag."; + "Support for node admin tag for OSPF routing instances."; reference "RFC 7777 - Advertising Node Administrative Tags in OSPF"; } feature lfa { description - "Support of Loop Free Alternates (LFAs)."; + "Support for Loop-Free Alternates (LFAs)."; reference "RFC 5286 - Basic Specification for IP Fast Reroute: Loop-Free Alternates"; } - feature remote-lfa { description - "Support of Remote Loop Free Alternates (R-LFA)."; + "Support for Remote Loop-Free Alternates (R-LFA)."; reference "RFC 7490 - Remote Loop-Free Alternate (LFA) Fast Reroute (FRR)"; } + feature stub-router { description - "Support of RFC 6987 OSPF Stub Router Advertisement."; + "Support for RFC 6987 OSPF Stub Router Advertisement."; reference "RFC 6987 - OSPF Stub Router Advertisement"; } feature pe-ce-protocol { description - "Support PE-CE protocol"; + "Support for OSPF as a PE-CE protocol"; reference "RFC 4577 - OSPF as the Provider/Customer Edge Protocol for BGP/MPLS IP Virtual Private Networks (VPNs) RFC 6565 - OSPFv3 as a Provider Edge to Customer Edge (PE-CE) Routing Protocol"; } feature ietf-spf-delay { description - "Support of IETF SPF delay algorithm."; + "Support for IETF SPF delay algorithm."; reference "RFC XXXX - SPF Back-off algorithm for link state IGPs"; } feature bfd { description - "Support of BFD."; - reference "RFC 5880 - Bidirectional Forwarding Detection - (BFD) + "Support for BFD detection of OSPF neighbor reachability."; + reference "RFC 5880 - Bidirectional Forwarding Detection (BFD) RFC 5881 - Bidirectional Forwarding Detection (BFD) for IPv4 and IPv6 (Single Hop)"; } identity ospf-protocol { base "rt:routing-protocol"; - description "Any version the OSPF protocol"; + description "Any OSPF protocol version"; } identity ospfv2 { base "ospf-protocol"; description "OSPFv2 protocol"; } - identity ospfv3 { base "ospf-protocol"; description "OSPFv3 protocol"; } identity operation-mode { description "OSPF operation mode."; } @@ -1192,27 +1198,20 @@ identity ospfv3 { base "ospf-protocol"; description "OSPFv3 protocol"; } identity operation-mode { description "OSPF operation mode."; } - identity ships-in-the-night { - base operation-mode; - description - "Ships-in-the-night operation mode in which - each OSPF instance carries only one address family"; - } - identity area-type { description "Base identity for OSPF area type."; } identity normal-area { base area-type; description "OSPF normal area."; } identity stub-nssa-area { @@ -1220,28 +1219,29 @@ description "OSPF stub or NSSA area."; } identity stub-area { base stub-nssa-area; description "OSPF stub area."; } identity nssa-area { base stub-nssa-area; - description "OSPF NSSA area."; + description "OSPF Not-So-Stubby Area (NSSA)."; reference "RFC 3101 - The OSPF Not-So-Stubby Area (NSSA) Option"; } identity ospf-lsa-type { description - "Base identity for OSPFv3 and OSPFv3 LSA types"; + "Base identity for OSPFv3 and OSPFv3 + Link State Advertisement (LSA) types"; } identity ospfv2-lsa-type { base ospf-lsa-type; description "OSPFv2 LSA types"; } identity ospfv2-router-lsa { base ospfv2-lsa-type; description @@ -1704,21 +1704,21 @@ } } } grouping node-tag-tlv { description "OSPF Node Admin Tag TLV grouping."; list node-tag { leaf tag { type uint32; description - "Node tag value."; + "Node admin tag value."; } description "List of tags."; } } grouping ospfv2-router-link { description "OSPFv2 router link."; leaf link-id { type union { @@ -1739,21 +1739,21 @@ description "Router-LSA Link type."; } } grouping ospfv2-lsa-body { description "OSPFv2 LSA body."; container router { when "derived-from-or-self(../../header/type, " + "'ospf:ospfv2-router-lsa')" { description - "Only applies to Router LSAs."; + "Only applies to Router-LSAs."; } description "Router LSA."; leaf flags { type bits { bit V { description "When set, the router is an endpoint of one or more virtual links."; } @@ -1771,21 +1771,21 @@ description "When set, the router is an NSSA border router that is unconditionally translating NSSA LSAs into AS-external LSAs."; } } description "Flags."; } leaf num-of-links { type uint16; - description "Number of links."; + description "Number of links in Router LSA."; } container links { description "All router Links."; list link { description "Router LSA link."; uses ospfv2-router-link; container topologies { description "All topologies for the link."; list topology { description @@ -1915,24 +1915,24 @@ description "Only applies to Opaque LSAs."; } description "Opaque LSA."; uses unknown-tlvs; container node-tag-tlvs { description - "All node tag tlvs."; + "All node tag TLVs."; list node-tag-tlv { description - "Node tag tlv."; + "Node tag TLV."; uses node-tag-tlv; } } container router-address-tlv { description "Router address TLV."; leaf router-address { type inet:ipv4-address; description @@ -2045,21 +2045,21 @@ type bits { bit A { description "Attach flag."; } bit N { description "Node flag."; } } - description "Flags."; + description "Prefix Flags."; } leaf prefix { type inet:ip-prefix; description "Address prefix."; } uses unknown-tlvs; } } @@ -2109,21 +2109,21 @@ description "OSPFv3 LSA options."; } } grouping ospfv3-lsa-prefix { description "OSPFv3 LSA prefix."; leaf prefix { type inet:ip-prefix; description - "Prefix."; + "LSA Prefix."; } leaf prefix-options { type bits { bit NU { description "When set, the prefix should be excluded from IPv6 unicast calculations."; } bit LA { description @@ -2240,46 +2240,49 @@ } uses ospfv3-lsa-options; container links { description "All router link."; list link { description "Router LSA link."; leaf interface-id { type uint32; - description "Interface ID."; + description "Interface ID for link."; } leaf neighbor-interface-id { type uint32; - description "Neighbor Interface ID."; + description "Neighbor's Interface ID for link."; } leaf neighbor-router-id { type rt-types:router-id; - description "Neighbor Router ID."; + description "Neighbor's Router ID for link."; } leaf type { type uint8; - description "Link type."; + description "Link type: 1 - Point-to-Point Link + 2 - Transit Network Link + 3 - Stub Network Link Link + 4 - Virtual Link"; } leaf metric { type uint16; - description "Metric."; + description "Link Metric."; } } } } container network { when "derived-from-or-self(../../header/type, " + "'ospfv3-network-lsa')" { description - "Only applies to Network LSA."; + "Only applies to Network LSAs."; } description "Network LSA."; uses ospfv3-lsa-options; container attached-routers { description "All attached routers."; leaf-list attached-router { type yang:dotted-quad; description @@ -2288,40 +2291,40 @@ } } container inter-area-prefix { when "derived-from-or-self(../../header/type, " + "'ospfv3-inter-area-prefix-lsa')" { description "Only applies to Inter-Area-Prefix LSAs."; } leaf metric { type uint24; - description "Metric"; + description "Inter-Area Prefix Metric"; } uses ospfv3-lsa-prefix; - description "Inter-Area-Prefix LSA."; + description "Prefix LSA."; } container inter-area-router { when "derived-from-or-self(../../header/type, " + "'ospfv3-inter-area-router-lsa')" { description "Only applies to Inter-Area-Router LSAs."; } uses ospfv3-lsa-options; leaf metric { type uint24; - description "Metric."; + description "AS Boundary Router (ASBR) Metric."; } leaf destination-router-id { type rt-types:router-id; description - "The Router ID of the router being described by the LSA."; + "The Router ID of the ASBR described by the LSA."; } description "Inter-Area-Router LSA."; } container as-external { when "derived-from-or-self(../../header/type, " + "'ospfv3-as-external-lsa')" { description "Only applies to AS-external LSAs."; } @@ -2370,21 +2373,21 @@ "List of prefixes associated with the link."; uses ospfv3-lsa-prefix; } } description "Link LSA."; } container intra-area-prefix { when "derived-from-or-self(../../header/type, " + "'ospfv3-intra-area-prefix-lsa')" { description - "Only applies to Intra-Area-Prefix LSA."; + "Only applies to Intra-Area-Prefix LSAs."; } description "Intra-Area-Prefix LSA."; leaf referenced-ls-type { type uint16; description "Referenced Link State type."; } leaf referenced-link-state-id { type uint32; description @@ -2421,64 +2425,68 @@ container node-tag-tlvs { description "All node tag tlvs."; list node-tag-tlv { description "Node tag tlv."; uses node-tag-tlv; } } description "Router Information LSA."; + reference "RFC 7770 -Extensions for Advertising Router + Capabilities"; } } grouping lsa-header { description "Common LSA for OSPFv2 and OSPFv3"; leaf age { type uint16; mandatory true; description "LSA age."; } leaf type { type identityref { base ospf-lsa-type; } mandatory true; - description "LSA type."; - + description "LSA type"; } leaf adv-router { type yang:dotted-quad; mandatory true; description "LSA advertising router."; } leaf seq-num { type uint32; mandatory true; description "LSA sequence number."; } leaf checksum { type fletcher-checksum16-type; mandatory true; description "LSA checksum."; } leaf length { type uint16; mandatory true; - description "LSA length."; + description "LSA length including the header."; } } grouping ospfv2-lsa { description - "OSPFv2 LSA."; + "OSPFv2 LSA - LSAs are uniquely identified by + the + tuple with the sequence number differentiating + LSA instances."; container header { must "(derived-from-or-self(type, " + "'ospfv2-opaque-lsa-type') and " + "opaque-id and opaque-type) or " + "(not(derived-from-or-self(type, " + "'ospfv2-opaque-lsa-type')) " + "and not(opaque-id) and not(opaque-type))" { description "Opaque type and ID only apply to Opaque LSAs."; } @@ -2521,28 +2528,27 @@ "When a type 3, 5 or 7 LSA is sent from a PE to a CE, the DN bit must be set. See RFC 4576."; } } mandatory true; description "LSA options."; } leaf lsa-id { type yang:dotted-quad; mandatory true; - description "LSA ID."; + description "Link-State ID."; } leaf opaque-type { type uint8; description "Opaque type."; } - leaf opaque-id { type uint24; description "Opaque ID."; } uses lsa-header; } container body { description "Decoded OSPFv2 LSA body data."; @@ -2605,56 +2610,55 @@ grouping lsa-key { description "OSPF LSA key."; leaf lsa-id { type union { type yang:dotted-quad; type uint32; } description - "LSA ID."; + "Link-State ID."; } leaf adv-router { type inet:ipv4-address; description "Advertising router."; } } grouping instance-stat { description "Per-instance statistics"; leaf originate-new-lsa-count { type yang:counter32; description "The number of new LSAs originated."; } leaf rx-new-lsas-count { type yang:counter32; description "The number of LSAs received."; } leaf as-scope-lsa-count { type yang:gauge32; - description "The number of AS Scope LSAs."; + description "The number of AS-scope LSAs."; } leaf as-scope-lsa-chksum-sum { type uint32; description - "The sum of the LSA checksums for AS Scope LSAs."; - + "The sum of the LSA checksums for AS-scope LSAs."; } container database { description "Container for per AS-scope LSA statistics."; list as-scope-lsa-type { description "List of AS-scope LSA statistics"; leaf lsa-type { type uint16; - description "AS-scope LSA type."; + description "AS-Scope LSA type."; } leaf lsa-count { type yang:gauge32; description "The number of LSAs of the LSA type."; } leaf lsa-cksum-sum { type int32; description "The sum of the LSA checksums of the LSA type."; } @@ -2671,43 +2675,43 @@ } leaf abr-count { type yang:gauge32; description "The total number of Area Border Routers (ABRs) reachable within this area."; } leaf asbr-count { type yang:gauge32; description - "The total number of AS Border Routers (ASBRs)."; + "The total number of AS Boundary Routers (ASBRs)."; } leaf ar-nssa-translator-event-count { type yang:counter32; description "The number of NSSA translator-state changes."; } leaf area-scope-lsa-count { type yang:gauge32; description - "The number of area scope LSAs in the area."; + "The number of area-scope LSAs in the area."; } leaf area-scope-lsa-cksum-sum { type int32; - description "The sum of the area scope LSAs checksums."; + description "The sum of the area-scope LSAs checksums."; } container database { - description "Container for area scope LSA type statistics."; + description "Container for area-scope LSA type statistics."; list area-scope-lsa-type { - description "List of area scope LSA statistics"; + description "List of area-scope LSA statistics"; leaf lsa-type { type uint16; - description "Area scope LSA type."; + description "Area-scope LSA type."; } leaf lsa-count { type yang:gauge32; description "The number of LSAs of the LSA type."; } leaf lsa-cksum-sum { type int32; description "The sum of the LSA checksums of the LSA type."; } @@ -2718,30 +2722,31 @@ grouping interface-stat { description "Per-interface statistics"; leaf if-event-count { type yang:counter32; description "The number of times this interface has changed its state or an error has occurred."; } leaf link-scope-lsa-count { type yang:gauge32; - description "The number of link scope LSAs."; + description "The number of link-scope LSAs."; } leaf link-scope-lsa-cksum-sum { type uint32; - description "The sum of link scope LSA checksums."; + description "The sum of link-scope LSA checksums."; + } container database { - description "Container for link scope LSA type statistics."; + description "Container for link-scope LSA type statistics."; list link-scope-lsa-type { - description "List of link scope LSA statistics"; + description "List of link-scope LSA statistics"; leaf lsa-type { type uint16; description "Link scope LSA type."; } leaf lsa-count { type yang:gauge32; description "The number of LSAs of the LSA type."; } leaf lsa-cksum-sum { type int32; @@ -2762,35 +2767,37 @@ } leaf nbr-retrans-qlen { type yang:gauge32; description "The current length of the retransmission queue."; } } grouping instance-fast-reroute-config { description - "This group defines global configuration of IP-FRR."; + "This group defines global configuration of IP + Fast ReRoute (FRR)."; container fast-reroute { if-feature fast-reroute; description "This container may be augmented with global parameters for IP-FRR."; container lfa { if-feature lfa; description "This container may be augmented with - global parameters for LFA. Container creation - has no effect on LFA activation."; + global parameters for Loop-Free Alternatives (LFA). + Container creation has no effect on LFA activation."; } } } + grouping interface-fast-reroute-config { description "This group defines interface configuration of IP-FRR."; container fast-reroute { if-feature fast-reroute; container lfa { if-feature lfa; leaf candidate-enable { type boolean; default true; @@ -2812,21 +2819,21 @@ description "Activates Remote LFA (R-LFA)."; } description "Remote LFA configuration."; } description "LFA configuration."; } description - "IP Fast-reroute configuration."; + "Interface IP Fast-reroute configuration."; } } grouping interface-physical-link-config { description "Interface cost configuration that only applies to physical interfaces and sham links."; leaf cost { type uint16 { range "1..65535"; @@ -2865,27 +2872,29 @@ } leaf dead-interval { type uint32 { range "1..2147483647"; } units seconds; must "../dead-interval > ../hello-interval" { error-message "The dead interval must be " + "larger than the hello interval"; + description "The value MUST be greater than 'hello-internval'."; } description - "Interval after which a neighbor is - declared down (seconds)."; + "Interval after which a neighbor is declared down + (seconds) if hello packets are not received."; } + leaf retransmit-interval { type uint16 { range "1..3600"; } units seconds; description "Interval between retransmitting unacknowledged Link State Advertisements (LSAs) (seconds)."; } @@ -2889,70 +2898,70 @@ State Advertisements (LSAs) (seconds)."; } leaf transmit-delay { type uint16 { range "1..3600"; } units seconds; description "Estimated time needed to transmit Link State Update - packets on the interface (seconds)."; + (LSU) packets on the interface (seconds)."; } leaf lls { if-feature lls; type boolean; description "Enable/Disable link-local signaling (LLS) support."; } container ttl-security { if-feature ttl-security; - description "TTL security check."; + description "Time to Live (TTL) security check."; leaf enable { type boolean; description "Enable/Disable TTL security check."; } leaf hops { type uint8 { range "1..254"; } description "Maximum number of hops that an OSPF packet may have traversed before reception."; } } leaf enable { if-feature admin-control; type boolean; default true; description - "Enable/disable protocol on the interface."; + "Enable/disable OSPF protocol on the interface."; } container authentication { description "Authentication configuration."; choice auth-type-selection { description - "Options for expressing authentication setting."; + "Options for OSPFv3 authentication configuration."; case auth-ipsec { when "derived-from-or-self(../../../../../../rt:type, " + "'ospf:ospfv3')" { description "Applied to OSPFv3 only."; } if-feature ospfv3-authentication-ipsec; leaf sa { type string; description - "Security Association name."; + "Security Association (SA) name."; } } case auth-trailer-key-chain { leaf key-chain { type key-chain:key-chain-ref; description "key-chain name."; } } case auth-trailer-key { @@ -2960,28 +2969,30 @@ type string; description "Key string in ASCII format."; } leaf crypto-algorithm { type identityref { base key-chain:crypto-algorithm; } description "Cryptographic algorithm associated with key."; + + } } } } } - } // interface-common-config grouping interface-config { description "Configuration for real interfaces."; + leaf interface-type { type enumeration { enum "broadcast" { description "Specify OSPF broadcast multi-access network."; } enum "non-broadcast" { description "Specify OSPF Non-Broadcast Multi-Access (NBMA) network."; @@ -3044,93 +3054,99 @@ description "Statically configured neighbors."; list neighbor { key "identifier"; description "Specify a static OSPF neighbor."; leaf identifier { type inet:ip-address; description - "Neighbor router ID, IPv4 address, or IPv6 address."; + "Neighbor Router ID, IPv4 address, or IPv6 address."; } leaf cost { type uint16 { range "1..65535"; } description "Neighbor cost."; } leaf poll-interval { type uint16 { range "1..65535"; } units seconds; - description "Neighbor poll interval (seconds)."; + description + "Neighbor poll interval (seconds) for sending OSPF + hello packets to discover the neighbor on NBMA + networks."; } leaf priority { type uint8 { range "1..255"; } description "Neighbor priority for DR election."; } } } leaf node-flag { if-feature node-flag; type boolean; default false; description - "Set prefix as a node representative prefix."; + "Set prefix as identifying the advertising router."; + reference "RFC 7684 - OSPFv2 Prefix/Link Attribute + Advertisement"; } container bfd { if-feature bfd; description "BFD Client Configuration."; uses bfd-types:client-cfg-parms; reference "draft-ietf-bfd-yang-xx.txt: YANG Data Model for Bidirectional Forwarding Detection (BFD)"; } uses interface-fast-reroute-config; uses interface-common-config; uses interface-physical-link-config; - } // grouping interface-config + } grouping neighbor-state { description "OSPF neighbor operational state."; leaf address { type inet:ip-address; config false; description "Neighbor address."; } leaf dr-router-id { type rt-types:router-id; config false; - description "Neighbor's Designated Router (DR) router ID."; + description "Neighbor's Designated Router (DR) Router ID."; } leaf dr-ip-addr { type inet:ip-address; config false; description "Neighbor's Designated Router (DR) IP address."; } + leaf bdr-router-id { type rt-types:router-id; config false; description - "Neighbor's Backup Designated Router (BDR) router ID."; + "Neighbor's Backup Designated Router (BDR) Router ID."; } leaf bdr-ip-addr { type inet:ip-address; config false; description "Neighbor's Backup Designated Router (BDR) IP Address."; } leaf state { type nbr-state-type; @@ -3140,25 +3156,24 @@ } leaf dead-timer { type uint32; units "seconds"; config false; description "This timer tracks the remaining time before the neighbor is declared dead."; } container statistics { config false; - description "Per neighbor statistics"; + description "Per-neighbor statistics"; uses neighbor-stat; } } - grouping interface-common-state { description "OSPF interface common operational state."; reference "RFC2328 Section 9"; leaf state { type if-state-type; config false; description "Interface state."; } @@ -3161,99 +3176,101 @@ type if-state-type; config false; description "Interface state."; } leaf hello-timer { type uint32; units "seconds"; config false; description "This timer tracks the remaining time before - the next hello packet is sent."; + the next hello packet is sent on the + interface."; } leaf wait-timer { type uint32; units "seconds"; config false; description "This timer tracks the remaining time before the interface exits the Waiting state."; } leaf dr-router-id { type rt-types:router-id; config false; - description "Designated Router (DR) router ID."; + description "Designated Router (DR) Router ID."; } leaf dr-ip-addr { type inet:ip-address; config false; description "Designated Router (DR) IP address."; } leaf bdr-router-id { type rt-types:router-id; config false; - description "Backup Designated Router (BDR) router ID."; + description "Backup Designated Router (BDR) Router ID."; } leaf bdr-ip-addr { type inet:ip-address; config false; description "Backup Designated Router (BDR) IP Address."; } container statistics { config false; - description "Per interface statistics"; + description "Per-interface statistics"; uses interface-stat; } container neighbors { config false; description "All neighbors for the interface."; list neighbor { key "neighbor-router-id"; description - "List of OSPF neighbors."; + "List of interface OSPF neighbors."; leaf neighbor-router-id { type rt-types:router-id; description - "Neighbor router ID."; + "Neighbor Router ID."; } uses neighbor-state; - } // list of OSPF neighbors + } } container database { config false; - description "Link scope LSA database."; + description "Link-scope LSA database."; list link-scope-lsa-type { key "lsa-type"; description - "List OSPF link scope LSA databases."; + "List OSPF link-scope LSA databases."; leaf lsa-type { type uint16; - description "OSPF link scope LSA type."; + description "OSPF link-scope LSA type."; } container link-scope-lsas { description - "All link scope LSAs of this LSA type."; + "All link-scope LSAs of this LSA type."; list link-scope-lsa { key "lsa-id adv-router"; - description "List of OSPF link scope LSAs"; + description "List of OSPF link-scope LSAs"; uses lsa-key; uses lsa { refine "version/ospfv2/ospfv2" { must "derived-from-or-self( " + "../../../../../../../../../../" + "rt:type, 'ospf:ospfv2')" { + description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../../../../../" + "rt:type, 'ospf:ospfv3')" { description "OSPFv3 LSA."; } } @@ -3253,23 +3270,24 @@ refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../../../../../" + "rt:type, 'ospf:ospfv3')" { description "OSPFv3 LSA."; } } } } } - } // list link-scope-lsas } - } // interface-common-state + } + } + grouping interface-state { description "OSPF interface operational state."; reference "RFC2328 Section 9"; uses interface-common-state; } grouping virtual-link-config { description @@ -3297,36 +3315,35 @@ description "OSPF sham link configuration state."; uses interface-common-config; uses interface-physical-link-config; } grouping sham-link-state { description "OSPF sham link operational state."; - /* All container/leaf should be config false. */ uses interface-common-state; } grouping af-area-config { description "OSPF address-family specific area config state."; container ranges { description "Container for summary ranges"; list range { key "prefix"; description - "Summarize routes matching address/mask - (Area Border Routers (ABRs) only)"; + "Summarize routes matching address/mask - + Applicable to Area Border Routers (ABRs) only."; leaf prefix { type inet:ip-prefix; description "IPv4 or IPv6 prefix"; } leaf advertise { type boolean; description "Advertise or hide."; } @@ -3378,97 +3394,91 @@ leaf area-type { type identityref { base area-type; } default normal-area; description "Area type."; } uses area-common-config; - - uses af-area-config { - when "derived-from-or-self(../../operation-mode, " - + "'ospf:ships-in-the-night')" { - description - "Ships in the night configuration."; - } - } + uses af-area-config; } grouping area-state { description "OSPF area operational state."; container statistics { config false; - description "Per area statistics"; + description "Per-area statistics"; uses area-stat; } container database { config false; - description "Area scope LSA database."; + description "Area-scope LSA database."; list area-scope-lsa-type { key "lsa-type"; - description "List OSPF area scope LSA databases."; + description "List OSPF area-scope LSA databases."; leaf lsa-type { type uint16; - description "OSPF area scope LSA type."; + description "OSPF area-scope LSA type."; } container area-scope-lsas { description - "All area scope LSAs of an area scope + "All area-scope LSAs of an area-scope LSA type."; list area-scope-lsa { key "lsa-id adv-router"; - description "List of OSPF area scope LSAs"; + description "List of OSPF area-scope LSAs"; uses lsa-key; uses lsa { refine "version/ospfv2/ospfv2" { must "derived-from-or-self( " + "../../../../../../../../" + "rt:type, 'ospf:ospfv2')" { description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../../../" + "rt:type, 'ospf:ospfv3')" { description "OSPFv3 LSA."; } } } } } - } // list area-scope-lsas + } } } grouping local-rib { - description "Local-rib grouping."; + description "Local-rib - RIB for Routes computed by the local + OSPF routing instance."; container local-rib { config false; description "Local-rib."; list route { key "prefix"; description "Routes"; leaf prefix { type inet:ip-prefix; description "Destination prefix."; } container next-hops { - description "All next hops for the route."; + description "Next hops for the route."; list next-hop { key "next-hop"; - description "List of next hop for the route"; + description "List of next hops for the route"; leaf outgoing-interface { type if:interface-ref; description "Name of the outgoing interface."; } leaf next-hop { type inet:ip-address; description "Nexthop address."; } } @@ -3534,56 +3544,57 @@ } enum "short-wait" { description "SHORT_WAIT state"; } enum "long-wait" { description "LONG_WAIT state"; } } config false; description - "Current state of the algorithm."; + "Current SPF backoff algorithm state."; + } leaf remaining-time-to-learn { type uint16; units "seconds"; config false; description "Remaining time until time-to-learn timer fires."; } leaf remaining-hold-down { type uint16; units "seconds"; config false; description "Remaining time until hold-down timer fires."; } leaf last-event-received { type yang:timestamp; config false; description - "Time of last IGP event received"; + "Time of last SPF triggering event."; } leaf next-spf-time { type yang:timestamp; config false; description "Time when next SPF has been scheduled."; } leaf last-spf-time { type yang:timestamp; config false; description "Time of last SPF computation."; } description - "Grouping for IETF SPF delay operational states."; + "Grouping for IETF SPF backoff operational states."; } grouping node-tag-config { description "OSPF node tag config state."; container node-tags { if-feature node-tag; list node-tag { key tag; leaf tag { @@ -3583,26 +3594,27 @@ description "OSPF node tag config state."; container node-tags { if-feature node-tag; list node-tag { key tag; leaf tag { type uint32; description "Node tag value."; + } description "List of tags."; } description - "Container for node tags."; + "Container for node admin tags."; } } grouping instance-config { description "OSPF instance config state."; leaf explicit-router-id { if-feature explicit-router-id; type rt-types:router-id; @@ -3642,70 +3654,69 @@ "Preference for inter-area routes."; } } case coarse { leaf internal { type uint8; description "Preference for both intra-area and inter-area routes."; } - } } leaf external { type uint8; description - "Preference for external routes."; + "Preference for AS external routes."; } } } } container nsr { if-feature nsr; description "Non-Stop Routing (NSR) config state."; leaf enable { type boolean; description "Enable/Disable NSR."; } } container graceful-restart { if-feature graceful-restart; description "Graceful restart config state."; - reference "RFC3623 - OSPF Graceful Restart"; + reference "RFC 3623 - OSPF Graceful Restart + RFC 5178 - OSPFv3 Graceful Restart"; leaf enable { type boolean; description "Enable/Disable graceful restart as defined in RFC 3623 for OSPFv2 and RFC 5187 for OSPFv3."; } leaf helper-enable { type boolean; description "Enable graceful restart helper support for restarting routers (RFC 3623 Section 3)."; } leaf restart-interval { type uint16 { - range "1..1800"; // Range is defined in RFC 3623. + range "1..1800"; } units seconds; - default "120"; // Default is defined in RFC 3623. + default "120"; description "Interval to attempt graceful restart prior to failing (RFC 3623 Section B.1) (seconds)"; - } leaf helper-strict-lsa-checking { type boolean; description "Terminate graceful restart when an LSA topology change is detected (RFC 3623 Section B.2)."; } } leaf enable { @@ -3747,21 +3758,21 @@ type uint16 { range "1..32"; } description "Maximum number of Equal-Cost Multi-Path (ECMP) paths."; } container ietf-spf-delay { if-feature ietf-spf-delay; uses ietf-spf-delay-config; description - "IETF spf delay algorithm configuration."; + "IETF SPF delay algorithm configuration."; } description "SPF calculation control."; } container database-control { leaf max-lsa { if-feature max-lsa; type uint32 { range "1..4294967294"; } @@ -3793,26 +3804,26 @@ description "OSPF MPLS config state."; container te-rid { if-feature te-rid; description "Stable OSPF Router IP Address used for Traffic Engineering (TE)"; leaf ipv4-router-id { type inet:ipv4-address; description - "Explicitly configure the TE IPv4 router ID."; + "Explicitly configure the TE IPv4 Router ID."; } leaf ipv6-router-id { type inet:ipv6-address; description - "Explicitly configure the TE IPv6 router ID."; + "Explicitly configure the TE IPv6 Router ID."; } } container ldp { description "OSPF MPLS LDP config state."; leaf igp-sync { if-feature ldp-igp-sync; type boolean; description "Enable LDP IGP synchronization."; @@ -3832,47 +3843,47 @@ config false; description "Defined in RFC 2328. A 32-bit number that uniquely identifies the router."; } uses local-rib; container statistics { config false; - description "Per instance statistics"; + description "Per-instance statistics"; uses instance-stat; } + container ietf-spf-delay { if-feature ietf-spf-delay; config false; - uses ietf-spf-delay-config; uses ietf-spf-delay-state; description - "IETF SPF delay operational states."; + "IETF SPF delay state."; } container database { config false; - description "AS scope LSA database."; + description "AS-scope LSA database."; list as-scope-lsa-type { key "lsa-type"; - description "List OSPF AS scope LSA databases."; + description "List OSPF AS-scope LSA databases."; leaf lsa-type { type uint16; description "OSPF AS scope LSA type."; } container as-scope-lsas { - description "All AS scope of LSA of this LSA type."; + description "All AS-scope of LSA of this LSA type."; list as-scope-lsa { key "lsa-id adv-router"; - description "List of OSPF area scope LSAs"; + description "List of OSPF AS-scope LSAs"; uses lsa-key; uses lsa { refine "version/ospfv2/ospfv2" { must "derived-from-or-self( " + "../../../../../../" + "rt:type, 'ospf:ospfv2')" { description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { @@ -3872,49 +3883,41 @@ must "derived-from-or-self( " + "../../../../../../" + "rt:type, 'ospf:ospfv2')" { description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../" + "rt:type, 'ospf:ospfv3')" { + description "OSPFv3 LSA."; } } } } } - } // list as-scope-lsas + } } uses spf-log; uses lsa-log; } - grouping ospf-config { - description - "OSPF top configuration state."; - leaf operation-mode { - type identityref { - base operation-mode; - } - default ospf:ships-in-the-night; + grouping ospf-config { description - "OSPF operation mode."; - } + "OSPF top configuration state - currently empty."; } grouping ospf-state { - /* All leaf/container must be config false. */ description - "OSPF top operational state."; + "OSPF top operational state - currently empty."; } grouping multi-topology-area-common-config { description "OSPF multi-topology area common configuration state."; leaf summary { when "derived-from(" + "../../../../../areas/area[area-id=current()/../area-id]/" + "area-type, 'stub-nssa-area')" { description @@ -3940,43 +3943,34 @@ "Set the summary default route cost for a stub or NSSA area."; } } grouping multi-topology-area-config { description "OSPF multi-topology area configuration state."; uses multi-topology-area-common-config; - - uses af-area-config { - when "derived-from-or-self(../../../../operation-mode, " - + "'ospf:ships-in-the-night')" { - description - "Ships in the night configuration."; - } - } + uses af-area-config; } grouping multi-topology-area-state { - /* All leaf/container must be config false. */ description "OSPF multi-topology area operational state."; } grouping multi-topology-config { description "OSPF multi-topology configuration state."; } grouping multi-topology-state { - /* All leaf/container must be config false. */ description "OSPF multi-topology operational state."; uses local-rib; } grouping multi-topology-interface-config { description "OSPF multi-topology configuration state."; @@ -3979,22 +3973,22 @@ grouping multi-topology-interface-config { description "OSPF multi-topology configuration state."; leaf cost { type uint32; description "Interface cost for this topology."; } } + grouping multi-topology-interface-state { - /* All leaf/container must be config false. */ description "OSPF multi-topology operational state."; } grouping ospfv3-interface-config { description "OSPFv3 interface specific configuration state."; leaf instance-id { type uint8 { @@ -4018,35 +4012,28 @@ } grouping lsa-identifiers { description "The parameters that uniquely identify an LSA."; leaf area-id { type area-id-type; description "Area ID"; } - leaf link-id { - type union { - type inet:ipv4-address; - type yang:dotted-quad; - } - description "Link ID."; - } leaf type { type uint16; description "LSA type."; } leaf lsa-id { type yang:dotted-quad; - description "LSA ID."; + description "Link-State ID."; } leaf adv-router { type yang:dotted-quad; description "LSA advertising router."; } leaf seq-num { type uint32; description "LSA sequence number."; @@ -4056,132 +4043,128 @@ grouping spf-log { description "Grouping for SPF log."; container spf-log { config false; description "This container lists the SPF log."; list event { key id; description - "List of SPF logs. - It is used as a wrapping buffer."; + "List of SPF log entries represented + as a wrapping buffer."; leaf id { type uint32; description - "This leaf defines the event identifier. - This is a purely internal value."; + "Event identifier - Ppurely internal value."; } leaf spf-type { type enumeration { enum full { description - "Computation done is a Full SPF."; + "SPF computation was a Full SPF."; } enum intra { description - "Computation done is only for intra-area routes."; + "SPF computation was only for intra-area routes."; } enum inter { description - "Computation done is only for inter-area + "SPF computation was only for inter-area summary routes."; } enum external { description - "Computation done is only for AS external routes."; + "SPF computation was only for AS external routes."; } } description - "The SPF computation type."; + "The SPF computation type for the SPF log entry."; } leaf schedule-timestamp { type yang:timestamp; description - "This leaf describes the timestamp - when the computation was scheduled."; + "This is the timestamp when the computation was + scheduled."; } leaf start-timestamp { type yang:timestamp; description - "This leaf describes the timestamp - when the computation was started."; + "This is the timestamp when the computation was + started."; } leaf end-timestamp { type yang:timestamp; description - "This leaf describes the timestamp - when the computation was completed."; + "This the timestamp when the computation was + completed."; } list trigger-lsa { description "The list of LSAs that triggered the computation."; uses lsa-identifiers; } } } } grouping lsa-log { description - "Grouping for LSA log."; + "Grouping for the LSA log."; container lsa-log { config false; description "This conatiner lists the LSA log. Local LSA modifications are also included in the list."; - list event { key id; description - "List of LSA logs. - It is used as a wrapping buffer."; + "List of LSA log entries represented + as a wrapping buffer."; leaf id { type uint32; description - "This leaf defines the event identifier. - This is a purely internal value."; + "Event identifier - purely internal value."; } container lsa { description "This container describes the logged LSA."; uses lsa-identifiers; } leaf received-timestamp { type yang:timestamp; description - "This leaf describes the timestamp - when the LSA was received. In case of - local LSA update, the timestamp refers - to the local LSA update time."; + "This is the timestamp when the LSA was received. + In case of local LSA update, the timestamp refers + to the LSA origination time."; } leaf reason { type identityref { base lsa-log-reason; } description - "This leaf describes the reason - that resulted in this LSA log."; + "This reason for the LSA log entry."; } } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol" { when "derived-from(rt:type, 'ospf:ospf-protocol')" { description "This augmentation is only valid for a routing protocol instance of OSPF (type 'ospfv2' or 'ospfv3')."; } - description "OSPF augmentation."; + description "OSPF protocol ietf-routing module + control-plane-protocol augmentation."; container ospf { description "OSPF protocol Instance"; uses ospf-config; uses ospf-state; leaf af { type iana-rt-types:address-family; @@ -4232,25 +4215,26 @@ description "Virtual-link trasit area must be non-zero area."; } description "Virtual link tranist area ID."; } leaf router-id { type rt-types:router-id; description - "Virtual Link remote endpoint router ID."; + "Virtual Link remote endpoint Router ID."; } uses virtual-link-config; uses virtual-link-state; + } } container sham-links { if-feature pe-ce-protocol; description "All sham links."; list sham-link { key "local-id remote-id"; description "OSPF sham link"; leaf local-id { @@ -4249,74 +4233,76 @@ container sham-links { if-feature pe-ce-protocol; description "All sham links."; list sham-link { key "local-id remote-id"; description "OSPF sham link"; leaf local-id { type inet:ip-address; description - "Address of the local Sham Link endpoint."; + "Address of the local sham Link endpoint."; } leaf remote-id { type inet:ip-address; description - "Address of the remote Sham Link endpoint."; + "Address of the remote sham Link endpoint."; } uses sham-link-config; uses sham-link-state; } } container interfaces { description "All interfaces."; list interface { key "name"; description "List of OSPF interfaces."; leaf name { type if:interface-ref; description - "Interface name."; + "Interface name reference."; } uses interface-config; uses interface-state; - } // list of interfaces } - } // list of areas } - } // OSPF instance + } + } + } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/ospf:ospf" { when "derived-from(../rt:type, 'ospf:ospf-protocol')" { description "This augmentation is only valid for OSPF (type 'ospfv2' or 'ospfv3')."; } if-feature multi-topology; description "OSPF multi-topology instance configuration state augmentation."; container topologies { description "All topologies."; list topology { - // Topology must be in the same routing-instance - // and of same AF as the container. key "name"; - description "OSPF topology."; + description + "OSPF topology - The OSPF topology address-family + must coincide with the routing-instance + address-family."; leaf name { type leafref { path "../../../../../../rt:ribs/rt:rib/rt:name"; } - description "RIB"; + description "RIB name corresponding to the OSPF + topology."; } uses multi-topology-config; uses multi-topology-state; container areas { description "All areas in the topology."; list area { key "area-id"; description @@ -4350,21 +4336,21 @@ description "All topologies for the interface."; list topology { key "name"; description "OSPF interface topology."; leaf name { type leafref { path "../../../../../../../../../../" + "rt:ribs/rt:rib/rt:name"; } description - "One of the topologies enabled on this interface."; + "Single topology enabled on this interface."; } uses multi-topology-interface-config; uses multi-topology-interface-state; } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/ospf:ospf/" @@ -4409,92 +4395,88 @@ "OSPF-specific route attributes."; uses route-content; } /* * RPCs */ rpc clear-neighbor { description - "This RPC request clears a particular - set of OSPF neighbors. If the operation - fails for OSPF internal reason, then - error-tag and error-app-tag should be set - to a meaningful value."; + "This RPC request clears a particular set of OSPF neighbors. + If the operation fails for OSPF internal reason, then + error-tag and error-app-tag should be set to a meaningful + value."; input { leaf routing-protocol-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory "true"; description - "Name of the OSPF protocol instance which information - is being queried. + "OSPF protocol instance which information for neighbors + are to be cleared. - If the OSPF instance with name equal to the - value of this parameter doesn't exist, then this - operation SHALL fail with error-tag 'data-missing' + If the referenced OSPF instance doesn't exist, then + this operation SHALL fail with error-tag 'data-missing' and error-app-tag 'routing-protocol-instance-not-found'."; } leaf interface { type if:interface-ref; description - "Name of the OSPF interface. + "Name of the OSPF interface for which neighbors are to + be cleared. - If the OSPF interface with name equal to the - value of this parameter doesn't exist, then this - operation SHALL fail with error-tag 'data-missing' - and error-app-tag + If the referenced OSPF interface doesn't exist, then + this operation SHALL fail with error-tag + 'data-missing' and error-app-tag 'ospf-interface-not-found'."; } } } rpc clear-database { description - "This RPC request clears a particular - OSPF database. If the operation - fails for OSPF internal reason, then - error-tag and error-app-tag should be set - to a meaningful value."; + "This RPC request clears a particular OSPF link-state + database. If the operation fails for OSPF internal reason, + then error-tag and error-app-tag should be set to a + meaningful value."; input { leaf routing-protocol-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory "true"; description - "Name of the OSPF protocol instance whose - information is being queried. + "OSPF protocol instance whose link-state database is to + be cleared. - If the OSPF instance with name equal to the - value of this parameter doesn't exist, then this - operation SHALL fail with error-tag 'data-missing' + If the referenced OSPF instance doesn't exist, then + this operation SHALL fail with error-tag 'data-missing' and error-app-tag 'routing-protocol-instance-not-found'."; } } } /* * Notifications */ grouping notification-instance-hdr { description - "This group describes common instance specific - data for notifications."; + "This grouping describes common instance specific + data for OSPF notifications."; leaf routing-protocol-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } must "derived-from( " + "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol[rt:name=current()]/" + "rt:type, 'ospf:ospf-protocol')"; @@ -4509,22 +4491,22 @@ + "[rt:name=current()/../routing-protocol-name]/" + "ospf:ospf/af"; } description "Address family of the OSPF instance."; } } grouping notification-interface { description - "This grouping provides the interface information - for the notifications."; + "This grouping provides interface information + for the OSPF interface specific notification."; choice if-link-type-selection { description "Options for link type."; container interface { description "Normal interface."; leaf interface { type if:interface-ref; description "Interface."; } @@ -4527,48 +4509,49 @@ leaf interface { type if:interface-ref; description "Interface."; } } container virtual-link { description "virtual-link."; leaf transit-area-id { type area-id-type; description "Area ID."; + } leaf neighbor-router-id { type rt-types:router-id; description "Neighbor Router ID."; } } container sham-link { - description "sham-link."; + description "sham link."; leaf area-id { type area-id-type; description "Area ID."; } leaf local-ip-addr { type inet:ip-address; description "Sham link local address."; } leaf remote-ip-addr { type inet:ip-address; description "Sham link remote address."; } } } } grouping notification-neighbor { description "This grouping provides the neighbor information - for the notifications."; + for neighbor specific notifications."; leaf neighbor-router-id { type rt-types:router-id; description "Neighbor Router ID."; } leaf neighbor-ip-addr { type yang:dotted-quad; description "Neighbor address."; } @@ -4630,30 +4613,30 @@ enum "dead-interval-mismatch" { description "Dead interval mismatch."; } enum "option-mismatch" { description "Option mismatch."; } enum "mtu-mismatch" { description "MTU mismatch."; } enum "duplicate-router-id" { - description "Duplicate router ID."; + description "Duplicate Router ID."; } enum "no-error" { description "No error."; } } description "Error code."; } description - "This notification is sent when interface + "This notification is sent when an interface config error is detected."; } notification nbr-state-change { uses notification-instance-hdr; uses notification-interface; uses notification-neighbor; leaf state { type nbr-state-type; @@ -4652,41 +4635,42 @@ notification nbr-state-change { uses notification-instance-hdr; uses notification-interface; uses notification-neighbor; leaf state { type nbr-state-type; description "Neighbor state."; } + description - "This notification is sent when neighbor + "This notification is sent when aa neighbor state change is detected."; } notification nbr-restart-helper-status-change { uses notification-instance-hdr; uses notification-interface; uses notification-neighbor; leaf status { type restart-helper-status-type; description "Restart helper status."; } leaf age { type uint32; units seconds; description "Remaining time in current OSPF graceful restart - interval, if the router is acting as a restart + interval when the router is acting as a restart helper for the neighbor."; } leaf exit-reason { type restart-exit-reason-type; description "Restart helper exit reason."; } description "This notification is sent when a neighbor restart @@ -4717,37 +4702,37 @@ leaf ext-lsdb-limit { type uint32; description "The maximum number of non-default AS-external LSAs entries that can be stored in the link state database."; } description "This notification is sent when the number of LSAs in the router's link state database has exceeded - ninety percent of the ext-lsdb-limit."; + ninety percent of the AS-external limit (ext-lsdb-limit)."; } notification lsdb-overflow { uses notification-instance-hdr; leaf ext-lsdb-limit { type uint32; description "The maximum number of non-default AS-external LSAs entries that can be stored in the link state database."; } description "This notification is sent when the number of LSAs - in the router's link state database has exceeded - ext-lsdb-limit."; + in the router's link state database has exceeded the + AS-external limit (ext-lsdb-limit)."; } notification nssa-translator-status-change { uses notification-instance-hdr; leaf area-id { type area-id-type; description "Area ID."; } @@ -4790,51 +4774,53 @@ description "This notification is sent when the graceful restart state for the router has changed."; } } 4. Security Considerations - The YANG module defined in this document is designed to be accessed - via network management protocols such as NETCONF [RFC6241] or - RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport - layer, and the mandatory-to-implement secure transport is Secure - Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the - mandatory-to-implement secure transport is TLS [RFC5246]. + The YANG modules specified in this document define a schema for data + that is designed to be accessed via network management protocols such + as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer + is the secure transport layer, and the mandatory-to-implement secure + transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer + is HTTPS, and the mandatory-to-implement secure transport is TLS + [RFC5246]. The NETCONF access control model [RFC6536] provides the means to restrict access for particular NETCONF or RESTCONF users to a pre- configured subset of all available NETCONF or RESTCONF protocol operations and content. - There are a number of data nodes defined in this YANG module that are - writable/creatable/deletable (i.e., config true, which is the - default). These data nodes may be considered sensitive or vulnerable - in some network environments. Write operations (e.g., edit-config) - to these data nodes without proper protection can have a negative - effect on network operations. For OSPF, the ability to modify OSPF - configuration will allow the entire OSPF domain to be compromised - including peering with unauthorized routers to misroute traffic or - mount a massive Denial-of-Service (DoS) attack. The security - considerations of OSPFv2 [RFC2328] and [RFC5340]. + There are a number of data nodes defined in ietf-ospf.yang module + that are writable/creatable/deletable (i.e., config true, which is + the default). These data nodes may be considered sensitive or + vulnerable in some network environments. Write operations (e.g., + edit-config) to these data nodes without proper protection can have a + negative effect on network operations. For OSPF, the ability to + modify OSPF configuration will allow the entire OSPF domain to be + compromised including peering with unauthorized routers to misroute + traffic or mount a massive Denial-of-Service (DoS) attack. The + security considerations of OSPFv2 [RFC2328] and [RFC5340] apply to + the ietf-ospf.yang module as well. - Some of the readable data nodes in this YANG module may be considered - sensitive or vulnerable in some network environments. It is thus - important to control read access (e.g., via get, get-config, or - notification) to these data nodes. The exposure of the Link State + Some of the readable data nodes in the ietf-ospf.yang module may be + considered sensitive or vulnerable in some network environments. It + is thus important to control read access (e.g., via get, get-config, + or notification) to these data nodes. The exposure of the Link State Database (LSDB) will expose the detailed topology of the network. This may be undesirable since both due to the fact that exposure may facilitate other attacks. Additionally, network operators may - consider their topologies to be propritary. + consider their topologies to be sensitive confidential data. For OSPF authentication, configuration is supported via the specification of key-chains [RFC8177] or the direct specification of key and authentication algorithm. Hence, authentification configuration using the "auth-table-trailer" case in the "authentication" container inherits the security considerations of [RFC8177]. This includes the considerations with respect to the local storage and handling of authentication keys. Some of the RPC operations in this YANG module may be considered @@ -4845,130 +4831,248 @@ temporary network outages be employed to mount DoS attacks. 5. Acknowledgements The authors wish to thank Yi Yang, Alexander Clemm, Gaurav Gupta, Ladislav Lhotka, Stephane Litkowski, Greg Hankins, Manish Gupta and Alan Davey for their thorough reviews and helpful comments. This document was produced using Marshall Rose's xml2rfc tool. -6. References +6. Normative References -6.1. Normative References + [I-D.ietf-bfd-yang] + Rahman, R., Zheng, L., Jethanandani, M., Networks, J., and + G. Mirsky, "YANG Data Model for Bidirectional Forwarding + Detection (BFD)", draft-ietf-bfd-yang-13 (work in + progress), March 2018. + + [I-D.ietf-rtgwg-backoff-algo] + Decraene, B., Litkowski, S., Gredler, H., Lindem, A., + Francois, P., and C. Bowers, "SPF Back-off Delay algorithm + for link state IGPs", draft-ietf-rtgwg-backoff-algo-10 + (work in progress), March 2018. + + [RFC0905] "ISO Transport Protocol specification ISO DP 8073", + RFC 905, DOI 10.17487/RFC0905, April 1984, + . + + [RFC1765] Moy, J., "OSPF Database Overflow", RFC 1765, + DOI 10.17487/RFC1765, March 1995, . [RFC1793] Moy, J., "Extending OSPF to Support Demand Circuits", RFC 1793, DOI 10.17487/RFC1793, April 1995, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, - DOI 10.17487/RFC2119, March 1997, - . + DOI 10.17487/RFC2119, March 1997, . [RFC2328] Moy, J., "OSPF Version 2", STD 54, RFC 2328, - DOI 10.17487/RFC2328, April 1998, - . + DOI 10.17487/RFC2328, April 1998, . [RFC3101] Murphy, P., "The OSPF Not-So-Stubby Area (NSSA) Option", RFC 3101, DOI 10.17487/RFC3101, January 2003, . [RFC3623] Moy, J., Pillay-Esnault, P., and A. Lindem, "Graceful OSPF Restart", RFC 3623, DOI 10.17487/RFC3623, November 2003, . [RFC3630] Katz, D., Kompella, K., and D. Yeung, "Traffic Engineering (TE) Extensions to OSPF Version 2", RFC 3630, - DOI 10.17487/RFC3630, September 2003, - . + DOI 10.17487/RFC3630, September 2003, . + + [RFC4552] Gupta, M. and N. Melam, "Authentication/Confidentiality + for OSPFv3", RFC 4552, DOI 10.17487/RFC4552, June 2006, + . + + [RFC4576] Rosen, E., Psenak, P., and P. Pillay-Esnault, "Using a + Link State Advertisement (LSA) Options Bit to Prevent + Looping in BGP/MPLS IP Virtual Private Networks (VPNs)", + RFC 4576, DOI 10.17487/RFC4576, June 2006, + . [RFC4577] Rosen, E., Psenak, P., and P. Pillay-Esnault, "OSPF as the Provider/Customer Edge Protocol for BGP/MPLS IP Virtual Private Networks (VPNs)", RFC 4577, DOI 10.17487/RFC4577, June 2006, . [RFC4750] Joyal, D., Ed., Galecki, P., Ed., Giacalone, S., Ed., Coltun, R., and F. Baker, "OSPF Version 2 Management Information Base", RFC 4750, DOI 10.17487/RFC4750, December 2006, . + [RFC4915] Psenak, P., Mirtorabi, S., Roy, A., Nguyen, L., and P. + Pillay-Esnault, "Multi-Topology (MT) Routing in OSPF", + RFC 4915, DOI 10.17487/RFC4915, June 2007, + . + + [RFC5082] Gill, V., Heasley, J., Meyer, D., Savola, P., Ed., and C. + Pignataro, "The Generalized TTL Security Mechanism + (GTSM)", RFC 5082, DOI 10.17487/RFC5082, October 2007, + . + + [RFC5185] Mirtorabi, S., Psenak, P., Lindem, A., Ed., and A. Oswal, + "OSPF Multi-Area Adjacency", RFC 5185, + DOI 10.17487/RFC5185, May 2008, . + [RFC5187] Pillay-Esnault, P. and A. Lindem, "OSPFv3 Graceful Restart", RFC 5187, DOI 10.17487/RFC5187, June 2008, . [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security (TLS) Protocol Version 1.2", RFC 5246, - DOI 10.17487/RFC5246, August 2008, - . + DOI 10.17487/RFC5246, August 2008, . + + [RFC5250] Berger, L., Bryskin, I., Zinin, A., and R. Coltun, "The + OSPF Opaque LSA Option", RFC 5250, DOI 10.17487/RFC5250, + July 2008, . + + [RFC5286] Atlas, A., Ed. and A. Zinin, Ed., "Basic Specification for + IP Fast Reroute: Loop-Free Alternates", RFC 5286, + DOI 10.17487/RFC5286, September 2008, . + + [RFC5329] Ishiguro, K., Manral, V., Davey, A., and A. Lindem, Ed., + "Traffic Engineering Extensions to OSPF Version 3", + RFC 5329, DOI 10.17487/RFC5329, September 2008, + . [RFC5340] Coltun, R., Ferguson, D., Moy, J., and A. Lindem, "OSPF for IPv6", RFC 5340, DOI 10.17487/RFC5340, July 2008, . + [RFC5443] Jork, M., Atlas, A., and L. Fang, "LDP IGP + Synchronization", RFC 5443, DOI 10.17487/RFC5443, March + 2009, . + + [RFC5613] Zinin, A., Roy, A., Nguyen, L., Friedman, B., and D. + Yeung, "OSPF Link-Local Signaling", RFC 5613, + DOI 10.17487/RFC5613, August 2009, . + [RFC5643] Joyal, D., Ed. and V. Manral, Ed., "Management Information Base for OSPFv3", RFC 5643, DOI 10.17487/RFC5643, August 2009, . + [RFC5714] Shand, M. and S. Bryant, "IP Fast Reroute Framework", + RFC 5714, DOI 10.17487/RFC5714, January 2010, + . + [RFC5838] Lindem, A., Ed., Mirtorabi, S., Roy, A., Barnes, M., and R. Aggarwal, "Support of Address Families in OSPFv3", RFC 5838, DOI 10.17487/RFC5838, April 2010, . + [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection + (BFD)", RFC 5880, DOI 10.17487/RFC5880, June 2010, + . + + [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection + (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, + DOI 10.17487/RFC5881, June 2010, . + [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, - DOI 10.17487/RFC6020, October 2010, - . + DOI 10.17487/RFC6020, October 2010, . + + [RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types", + RFC 6021, DOI 10.17487/RFC6021, October 2010, + . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, . [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration Protocol (NETCONF) Access Control Model", RFC 6536, - DOI 10.17487/RFC6536, March 2012, - . + DOI 10.17487/RFC6536, March 2012, . [RFC6565] Pillay-Esnault, P., Moyer, P., Doyle, J., Ertekin, E., and M. Lundberg, "OSPFv3 as a Provider Edge to Customer Edge (PE-CE) Routing Protocol", RFC 6565, DOI 10.17487/RFC6565, June 2012, . - [RFC7223] Bjorklund, M., "A YANG Data Model for Interface - Management", RFC 7223, DOI 10.17487/RFC7223, May 2014, - . + [RFC6860] Yang, Y., Retana, A., and A. Roy, "Hiding Transit-Only + Networks in OSPF", RFC 6860, DOI 10.17487/RFC6860, January + 2013, . - [RFC8022] Lhotka, L. and A. Lindem, "A YANG Data Model for Routing - Management", RFC 8022, DOI 10.17487/RFC8022, November - 2016, . + [RFC6987] Retana, A., Nguyen, L., Zinin, A., White, R., and D. + McPherson, "OSPF Stub Router Advertisement", RFC 6987, + DOI 10.17487/RFC6987, September 2013, . + + [RFC7490] Bryant, S., Filsfils, C., Previdi, S., Shand, M., and N. + So, "Remote Loop-Free Alternate (LFA) Fast Reroute (FRR)", + RFC 7490, DOI 10.17487/RFC7490, April 2015, + . + + [RFC7684] Psenak, P., Gredler, H., Shakir, R., Henderickx, W., + Tantsura, J., and A. Lindem, "OSPFv2 Prefix/Link Attribute + Advertisement", RFC 7684, DOI 10.17487/RFC7684, November + 2015, . + + [RFC7770] Lindem, A., Ed., Shen, N., Vasseur, JP., Aggarwal, R., and + S. Shaffer, "Extensions to OSPF for Advertising Optional + Router Capabilities", RFC 7770, DOI 10.17487/RFC7770, + February 2016, . + + [RFC7777] Hegde, S., Shakir, R., Smirnov, A., Li, Z., and B. + Decraene, "Advertising Node Administrative Tags in OSPF", + RFC 7777, DOI 10.17487/RFC7777, March 2016, + . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . + [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC + 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, + May 2017, . + [RFC8177] Lindem, A., Ed., Qu, Y., Yeung, D., Chen, I., and J. Zhang, "YANG Data Model for Key Chains", RFC 8177, - DOI 10.17487/RFC8177, June 2017, - . + DOI 10.17487/RFC8177, June 2017, . -6.2. Informative References + [RFC8291] Thomson, M., "Message Encryption for Web Push", RFC 8291, + DOI 10.17487/RFC8291, November 2017, . - [I-D.ietf-netmod-revised-datastores] - Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., - and R. Wilton, "Network Management Datastore - Architecture", draft-ietf-netmod-revised-datastores-02 - (work in progress), May 2017. + [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., + and R. Wilton, "Network Management Datastore Architecture + (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, + . + + [RFC8343] Bjorklund, M., "A YANG Data Model for Interface + Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, + . + + [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for + Routing Management (NMDA Version)", RFC 8349, + DOI 10.17487/RFC8349, March 2018, . Appendix A. Contributors' Addreses Dean Bogdanovic Volta Networks, Inc. EMail: dean@voltanet.io Kiran Koushik Agrahara Sreenivasa Cisco Systems