Internet Engineering Task Force (IETF) D. YeungInternet-Draft Arrcus Intended status:Request for Comments: 9129 Arrcus, Inc. Category: Standards Track Y. QuExpires: April 19, 2020ISSN: 2070-1721 Futurewei J. Zhang Juniper Networks I. Chen The MITRE Corporation A. Lindem Cisco Systems October17, 20192022 YANG Data Model for the OSPF Protocoldraft-ietf-ospf-yang-29Abstract This document defines a YANG data model that can be used to configure and manage OSPF. The model is based on YANG 1.1 as defined in RFC 7950 and conforms to the Network Management Datastore Architecture (NMDA) as described in RFC 8342. Status of This Memo ThisInternet-Draftissubmitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documentsan Internet Standards Track document. This document is a product of the Internet Engineering Task Force (IETF).Note that other groups may also distribute working documents as Internet-Drafts. The listIt represents the consensus ofcurrent Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents validthe IETF community. It has received public review and has been approved fora maximumpublication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841. Information about the current status ofsix monthsthis document, any errata, and how to provide feedback on it may beupdated, replaced, or obsoleted by other documentsobtained atany 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 April 19, 2020.https://www.rfc-editor.org/info/rfc9129. Copyright Notice Copyright (c)20192022 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 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 includeSimplifiedRevised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in theSimplifiedRevised BSD License. Table of Contents 1.Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2Introduction 1.1. Requirements Language. . . . . . . . . . . . . . . . . . 31.2. Tree Diagrams. . . . . . . . . . . . . . . . . . . . . . 32. Design of Data Model. . . . . . . . . . . . . . . . . . . . 32.1. OSPF Operational State. . . . . . . . . . . . . . . . . 32.2. Overview. . . . . . . . . . . . . . . . . . . . . . . . 42.3. OSPFv2 and OSPFv3. . . . . . . . . . . . . . . . . . . . 52.4. Optional Features. . . . . . . . . . . . . . . . . . . . 52.5. OSPF RouterConfiguration/OperationalConfiguration / Operational State. . . . . . . 72.6. OSPF AreaConfiguration/OperationalConfiguration / Operational State. . . . . . . . 102.7. OSPF InterfaceConfiguration/OperationalConfiguration / Operational State. . . . . 162.8. OSPF Notifications. . . . . . . . . . . . . . . . . . . 192.9. OSPF RPC Operations. . . . . . . . . . . . . . . . . . . 233. OSPF YANG Module. . . . . . . . . . . . . . . . . . . . . . 234. Security Considerations. . . . . . . . . . . . . . . . . . . 1205. IANA Considerations. . . . . . . . . . . . . . . . . . . . . 1236.Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 123 7.References. . . . . . . . . . . . . . . . . . . . . . . . . 124 7.1.6.1. Normative References. . . . . . . . . . . . . . . . . . 124 7.2.6.2. Informative References. . . . . . . . . . . . . . . . . 129 Appendix A. Contributors' Addresses . . . . . . . . . . . . . . 131Acknowledgments Contributors Authors' Addresses. . . . . . . . . . . . . . . . . . . . . . . 1311.OverviewIntroduction YANG[RFC6020][RFC7950][RFC7950] is a data definition language used to define the contents of a conceptualdata storedatastore that allows networked devices to be managed usingNETCONFthe Network Configuration Protocol (NETCONF) [RFC6241], RESTCONF [RFC8040], and otherNetwork Managementnetwork management protocols. Furthermore, YANG data models can be used as the basis for implementation of other interfaces, such asCLICommand-Line Interfaces (CLIs) and programmatic APIs. This document defines a YANG data model that can be used to configure and manageOSPF and itOSPF. It is an augmentation to the core routing datamodel. It fully conforms to the Network Management Datastore Architecture (NMDA) [RFC8342]. A core routing data modelmodel, which is defined in[RFC8349],[RFC8349] anditprovides the basis for the development of data models for routing protocols. This document fully conforms to the Network Management Datastore Architecture (NMDA) [RFC8342]. The interface data model is defined in [RFC8343] and is used for referencing interfaces from the routing protocol. Thekey-chaindata model for key chains [RFC8177] is used for OSPF authenticationis defined in [RFC8177]and provides both a reference to configuredkey-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. Theseincludesinclude demandcircuitcircuits [RFC1793],traffic engineeringTraffic Engineering (TE) [RFC3630], multiple addressfamilyfamilies [RFC5838], graceful restart [RFC3623] [RFC5187],NSSAthe Not-So-Stubby Area (NSSA) option [RFC3101], and OSPFv2 or OSPFv3 as aPE-CE Protocol [RFC4577],Provider Edge to Customer Edge (PE-CE) protocol [RFC4577] [RFC6565]. Thesenon-corenon- 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", "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. 1.2. Tree Diagrams This document uses the graphical representation of data modelsdefined inper [RFC8340]. 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 various aspects, including in terms of how the protocol instance is tied to the routing domain and how multiple protocol instances arebe instantiated among others.instantiated. The goal of this document is to define a data model that provides acommonuser interface that is common totheboth OSPFv2 andOSPFv3 protocols.OSPFv3. 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 OSPFconfigurationconfiguration, consistent with the Network Management Datastore Architecture [RFC8342]. Consequently, only therouting"routing" container in theietf-routing"ietf-routing" model [RFC8349] isaugmented. The routing-stateaugmented; 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"/routing/control-plane-protocols/ control-plane-protocol" path defined in theietf-routing"ietf-routing" module. Theietf-ospf"ietf-ospf" model defines a single instance of OSPFwhichthat may be instantiated as an OSPFv2 or OSPFv3 instance. Multiple instances are instantiated as multiple control-planeprotocolsprotocol instances. module: ietf-ospf augment /rt:routing/rt:control-plane-protocols/ rt:control-plane-protocol: +--rw ospf . . +--rwaf? identityrefaddress-family? iana-rt-types:address-family . . +--rw areas | +--rw area* [area-id] | +--rw area-id area-id-type | . | . | +--rw virtual-links | | +--rw virtual-link* [transit-area-id router-id] | | . | | . | +--rw sham-links {pe-ce-protocol}? | | +--rw sham-link* [local-id remote-id] | | . | | . | +--rw interfaces | +--rw interface* [name] | . | . +--rw topologies {multi-topology}? +--rw topology* [name] . . Theospf"ospf" container includes one OSPF protocol instance. The instance includes OSPFrouter levelrouter-level configuration and operational state. Each OSPF instance maps to acontrol-plane-protcolcontrol-plane protocol instance as defined in [RFC8349]. Thearea"areas" andarea/interface"area/interfaces" containers define the OSPF configuration and operational state for OSPF areas andinterfacesinterfaces, respectively. Thetopologies"topologies" container defines the OSPF configuration and operational state for OSPF topologies when themulti-topology"multi-topology" feature is supported. 2.3. OSPFv2 and OSPFv3 The data model defined herein supports both OSPFv2 and OSPFv3. The "version" field'version'is used to indicate the OSPF version and is mandatory. Based on the configured version, the data model varies to accommodate the differences between OSPFv2 and OSPFv3. 2.4. Optional Features Optional featuresarego beyond the basic OSPFconfiguration and itconfiguration. It is the responsibility of each vendor to decide whether to support a given feature on a particular device. This model defines the following optional features:1.multi-topology: Support for Multi-TopologyRouting (MTR)(MT) routing [RFC4915].2.multi-area-adj: Support for OSPF multi-areaadjacencyadjacencies [RFC5185].3.explicit-router-id: Support for the specification of an explicit per-instanceRouter-ID specification. 4.Router ID. demand-circuit: Support for OSPF demand circuits [RFC1793].5.mtu-ignore: Support for the disabling of OSPF Database Description packet MTU mismatch checking as specified insectionSection 10.6 of [RFC2328].6.lls: Support for OSPFlink-local signalingLink-Local Signaling (LLS) [RFC5613].7.prefix-suppression: Support for OSPF prefix advertisement suppression [RFC6860].8.ttl-security: Support for OSPF Time to Live (TTL) securitycheck supportchecking [RFC5082].9.nsr: Support for OSPF Non-Stop Routing (NSR). The OSPF NSR feature allows a router with redundant control-plane capability (e.g., dualRoute-ProcessorRoute Processor (RP) cards) to maintain its state and adjacencies during planned and unplanned control-plane processing restarts. It differs fromgraceful-restartgraceful restart orNon- StopNon-Stop Forwarding (NSF) in that no protocol signaling or assistance from adjacent OSPF neighbors is required to recover control-plane state.10.graceful-restart: SupportGracefulfor graceful OSPFRestart [RFC3623],restart [RFC3623] [RFC5187].11.auto-cost: Support for OSPF interface costcalculationcalculations according to reference bandwidth [RFC2328].12.max-ecmp: Support for configuration of the maximum number of Equal- Cost Multi-Path (ECMP) paths.13.max-lsa: Support for configuration of the maximum number ofLSAsLink State Advertisements (LSAs) the OSPF instance will accept [RFC1765].14.te-rid: Support for configuration of the Traffic Engineering (TE)Router-ID,Router ID, i.e., the Router Address TLV as described in Section 2.4.1 of [RFC3630] or the Router IPv6 Address TLV as described in Section 3 of [RFC5329].15.ldp-igp-sync: Support for LDP IGP synchronization [RFC5443].16.ospfv2-authentication-trailer: Support for the OSPFv2Authenticationauthentication traileras specified in[RFC5709]or[RFC7474].17.ospfv3-authentication-ipsec: Support for IPsec for OSPFv3 authentication [RFC4552].18.ospfv3-authentication-trailer: Support for the OSPFv3Authenticationauthentication traileras specified in[RFC7166].19.fast-reroute: Support for IP Fast Reroute (IP-FRR) [RFC5714].20.node-flag: Supportnode-flagfor node flags for OSPFprefixes.prefixes [RFC7684].21.node-tag: Support for nodeadmin tagadministrative tags for OSPF instances [RFC7777].22.lfa: Support for Loop-Free Alternates (LFAs) [RFC5286].23.remote-lfa: Support for RemoteLoop-Free Alternates (R-LFA)LFAs (R-LFAs) [RFC7490].24.stub-router: SupportRFC 6987for OSPFStub Router advertisementstub router advertisements [RFC6987].25.pe-ce-protocol: Support for OSPF as a PE-CE protocol[RFC4577],[RFC4577] [RFC6565].26.ietf-spf-delay: Support for the IETFSPFShortest Path First (SPF) delay algorithm [RFC8405].27.bfd: SupportBFD detection offor Bidirectional Forwarding Detection (BFD) to detect OSPF neighbor reachability[RFC5880], [RFC5881], and [I-D.ietf-bfd-yang]. 28.[RFC5880] [RFC5881]. hybrid-interface: Support for OSPFHybrid Broadcasthybrid broadcast andPoint-to- Point Interfacespoint-to- multipoint interfaces [RFC6845]. It is expected that vendors will support additional features through vendor-specific augmentations. 2.5. OSPF RouterConfiguration/OperationalConfiguration / Operational State Theospf"ospf" container is the top-level container in this data model. It represents an OSPF protocol instance and contains therouter levelrouter-level configuration and operational state. The operational state includestheinstance statistics, IETF SPF delay statistics,AS-Scopedthe AS-Scope Link StateDatabase,Database (LSDB), the local RIB, the SPFLog,log, and the LSA log. ("AS" stands for "Autonomous System".) module: ietf-ospf augment /rt:routing/rt:control-plane-protocols/ rt:control-plane-protocol: +--rw ospf . . +--rwafaddress-family? iana-rt-types:address-family +--rwenable?enabled? boolean +--rw explicit-router-id? rt-types:router-id | {explicit-router-id}? +--rw preference | +--rw (scope)? | +--:(single-value) | | +--rw all? uint8 | +--:(multi-values) | +--rw (granularity)? | | +--:(detail) | | | +--rw intra-area? uint8 | | | +--rw inter-area? uint8 | | +--:(coarse) | | +--rw internal? uint8 | +--rw external? uint8 +--rw nsr {nsr}? | +--rwenable?enabled? boolean +--rw graceful-restart {graceful-restart}? | +--rwenable?enabled? boolean | +--rwhelper-enable?helper-enabled? boolean | +--rw restart-interval? uint16 | +--rw helper-strict-lsa-checking? boolean +--rw auto-cost {auto-cost}? | +--rwenable?enabled? boolean | +--rw reference-bandwidth? uint32 +--rw spf-control | +--rw paths? uint16 {max-ecmp}? | +--rw ietf-spf-delay {ietf-spf-delay}? | +--rw initial-delay?uint16uint32 | +--rw short-delay?uint16uint32 | +--rw long-delay?uint16uint32 | +--rw hold-down?uint16uint32 | +--rw time-to-learn?uint16uint32 | +--ro current-state? enumeration | +--ro remaining-time-to-learn?uint16| rt-types:timer-value-milliseconds | +--ro remaining-hold-down?uint16| rt-types:timer-value-milliseconds | +--ro last-event-received? yang:timestamp | +--ro next-spf-time? yang:timestamp | +--ro last-spf-time? yang:timestamp +--rw database-control | +--rw max-lsa? uint32 {max-lsa}? +--rw stub-router {stub-router}? | +--rw (trigger)? | +--:(always) | +--rw always! +--rw mpls | +--rw te-rid {te-rid}? | | +--rw ipv4-router-id? inet:ipv4-address | | +--rw ipv6-router-id? inet:ipv6-address | +--rw ldp | +--rw igp-sync? boolean {ldp-igp-sync}? +--rw fast-reroute {fast-reroute}? | +--rw lfa {lfa}?+--ro protected-routes+--rw node-tags {node-tag}? | +--rw node-tag* [tag] | +--rw tag uint32 +--roaf-stats* [af prefix alternate]router-id? rt-types:router-id +--ro local-rib | +--roaf iana-rt-types:address-familyroute* [prefix] | +--ro prefixstringinet:ip-prefix | +--roalternate stringnext-hops |+--ro alternate-type? enumeration| +--robest? booleannext-hop* [] | | +--ronon-best-reason? stringoutgoing-interface? if:interface-ref | | +--roprotection-available? bitsnext-hop inet:ip-address | +--roalternate-metric1?metric? uint32 | +--roalternate-metric2? uint32route-type? route-type | +--roalternate-metric3?route-tag? uint32 +--rounprotected-routesstatistics | +--roaf-stats* [af prefix]discontinuity-time yang:date-and-time | +--roaf iana-rt-types:address-familyoriginate-new-lsa-count? yang:counter32 | +--roprefix string +--ro protection-statistics* [frr-protection-method]rx-new-lsas-count? yang:counter32 | +--rofrr-protection-method stringas-scope-lsa-count? yang:gauge32 | +--roaf-stats* [af]as-scope-lsa-chksum-sum? uint32 | +--roaf iana-rt-types:address-familydatabase | | +--rototal-routes? uint32as-scope-lsa-type* | | +--rounprotected-routes? uint32lsa-type? uint16 | | +--roprotected-routes? uint32lsa-count? yang:gauge32 | | +--rolinkprotected-routes?lsa-cksum-sum? uint32 | +--ronodeprotected-routes? uint32 +--rw node-tags {node-tag}?protected-routes {fast-reroute}? |+--rw node-tag* [tag]|+--rw tag uint32+--rorouter-id? +--ro local-ribaddress-family-stats* | | [address-family prefix alternate] | | +--roroute* [prefix]address-family | | iana-rt-types:address-family | | +--ro prefix inet:ip-prefix | | +--ronext-hopsalternate inet:ip-address | | +--ronext-hop* [next-hop]alternate-type? enumeration | | +--rooutgoing-interface? if:interface-refbest? boolean | | +--ronext-hop inet:ip-addressnon-best-reason? string | | +--rometric?protection-available? bits | | +--ro alternate-metric-1? uint32 | | +--roroute-type? route-typealternate-metric-2? uint32 | | +--roroute-tag?alternate-metric-3? uint32 | +--rostatisticsunprotected-routes {fast-reroute}? | | +--rodiscontinuity-time yang:date-and-timeaddress-family-stats* [address-family prefix] | | +--rooriginate-new-lsa-count? yang:counter32address-family iana-rt-types:address-family | | +--rorx-new-lsas-count? yang:counter32prefix inet:ip-prefix | +--roas-scope-lsa-count? yang:gauge32protection-statistics* [frr-protection-method] | +--roas-scope-lsa-chksum-sum? uint32frr-protection-method string | +--rodatabaseaddress-family-stats* [address-family] | +--roas-scope-lsa-type*address-family | iana-rt-types:address-family | +--rolsa-type? uint16total-routes? uint32 | +--rolsa-count? yang:gauge32unprotected-routes? uint32 | +--rolsa-cksum-sum? int32protected-routes? uint32 | +--ro linkprotected-routes? uint32 | +--ro nodeprotected-routes? uint32 +--ro database | +--ro as-scope-lsa-type* [lsa-type] | +--ro as-scope-lsas | +--ro as-scope-lsa* [lsa-id adv-router] | +--ro lsa-id union | +--ro adv-router inet:ipv4-address | +--ro decoded-completed? boolean | +--ro raw-data? yang:hex-string | +--ro (version)? | +--:(ospfv2) | | +--ro ospfv2 . . . . | +--:(ospfv3) | +--ro ospfv3 . . +--ro spf-log | +--ro event* [id] | +--ro id uint32 | +--ro spf-type? enumeration | +--ro schedule-timestamp? yang:timestamp | +--ro start-timestamp? yang:timestamp | +--ro end-timestamp? yang:timestamp | +--ro trigger-lsa* | +--ro area-id? area-id-type | +--rolink-id? union | +--rotype? uint16 | +--ro lsa-id?yang:dotted-quadunion | +--ro adv-router?yang:dotted-quadrt-types:router-id | +--ro seq-num? uint32 +--ro lsa-log | +--ro event* [id] | +--ro id uint32 | +--ro lsa | | +--ro area-id? area-id-type | | +--rolink-id? union | | +--rotype? uint16 | | +--ro lsa-id?yang:dotted-quadunion | | +--ro adv-router?yang:dotted-quadrt-types:router-id | | +--ro seq-num? uint32 | +--ro received-timestamp? yang:timestamp | +--ro reason? identityref . . 2.6. OSPF AreaConfiguration/OperationalConfiguration / Operational State Thearea"area" container contains OSPF area configuration and the list of interface containers representing all the OSPF interfaces in the area. The area operational state includesthearea statistics and theArea Link State Database (LSDB).area LSDB. module: ietf-ospf augment /rt:routing/rt:control-plane-protocols/ rt:control-plane-protocol: +--rw ospf . . +--rw areas | +--rw area* [area-id] | +--rw area-id area-id-type | +--rw area-type? identityref | +--rw summary? boolean | +--rw default-cost?uint32ospf-metric | +--rw ranges | | +--rw range* [prefix] | | +--rw prefix inet:ip-prefix | | +--rw advertise? boolean | | +--rw cost?uint24ospf-metric | +--rw topologies {ospf:multi-topology}? | | +--rw topology* [name] | | +--rw name -> ../../../../../../../../ | | ../../../rt:ribs/rib/name | | +--rw summary? boolean | | +--rw default-cost? ospf-metric | | +--rw ranges | | +--rw range* [prefix] | | +--rw prefix inet:ip-prefix | | +--rw advertise? boolean | | +--rw cost? ospf-metric | +--ro statistics | | +--ro discontinuity-time yang:date-and-time | | +--ro spf-runs-count? yang:counter32 | | +--ro abr-count? yang:gauge32 | | +--ro asbr-count? yang:gauge32 | | +--ro ar-nssa-translator-event-count? | | yang:counter32 | | +--ro area-scope-lsa-count? yang:gauge32 | | +--ro area-scope-lsa-cksum-sum?int32uint32 | | +--ro database | | +--ro area-scope-lsa-type* | | +--ro lsa-type? uint16 | | +--ro lsa-count? yang:gauge32 | | +--ro lsa-cksum-sum?int32uint32 | +--ro database | | +--ro area-scope-lsa-type* [lsa-type] | | +--ro lsa-type uint16 | | +--ro area-scope-lsas | | +--ro area-scope-lsa* [lsa-id adv-router] | | +--ro lsa-id union . . . . . . | | +--ro (version)? | | +--:(ospfv2) | | | +--ro ospfv2 | | | +--ro header . . . . . . . . | | | +--ro body | | | +--ro router . . . . . . . . | | | +--ro network . . . . . . . . | | | +--ro summary . . . . . . . . | | | +--ro external . . . . . . . . | | | +--ro opaque . . . . . . . . | | +--:(ospfv3) | | +--ro ospfv3 | | +--ro header . . . . . . | | +--ro body | | +--ro router . . . . . . | | +--ro network . . . . . . | | +--ro inter-area-prefix . . . . . . | | +--ro inter-area-router . . . . . . | | +--ro as-external . . . . . . | | +--ro nssa . . . . . . | | +--ro link . . . . . . | | +--ro intra-area-prefix . . . . . . | | +--ro router-information . . . . . . | +--rw virtual-links | | +--rw virtual-link* [transit-area-id router-id] | | +--rw transit-area-id -> ../../../../ | | area/area-id | | +--rw router-id rt-types:router-id | | +--rw hello-interval? uint16 | | +--rw dead-interval? uint32 | | +--rw retransmit-interval? uint16 | | +--rw transmit-delay? uint16 | | +--rw lls? boolean {lls}? | | +--rw ttl-security {ttl-security}? | | | +--rwenable?enabled? boolean | | | +--rw hops? uint8 | | +--rwenable?enabled? boolean | | +--rw authentication | | | +--rw (auth-type-selection)? | | | +--:(ospfv2-auth) | | | | +--rw ospfv2-auth-trailer-rfc? | | | | | ospfv2-auth-trailer-rfc-version | | | | | {ospfv2-authentication-trailer}? | | | | +--rw (ospfv2-auth-specification)? | | | | +--:(auth-key-chain) {key-chain}? | | | | | +--rw ospfv2-key-chain? | | | | | key-chain:key-chain-ref | | | | +--:(auth-key-explicit) | | | | +--rw ospfv2-key-id? uint32 | | | | +--rw ospfv2-key? string | | | | +--rw ospfv2-crypto-algorithm? | | | | identityref | | | +--:(ospfv3-auth-ipsec) | | | | {ospfv3-authentication-ipsec}? | | | | +--rw sa? string | | | +--:(ospfv3-auth-trailer) | | | | {ospfv3-authentication-trailer}? | | | +--rw (ospfv3-auth-specification)? | | | +--:(auth-key-chain) {key-chain}? | | | | +--rw ospfv3-key-chain? | | | | key-chain:key-chain-ref | | | +--:(auth-key-explicit) | | | +--rw ospfv3-sa-id? uint16 | | | +--rw ospfv3-key? string | | | +--rw ospfv3-crypto-algorithm? | | | identityref | | +--ro cost?uint16ospf-link-metric | | +--ro state? if-state-type | | +--ro hello-timer? rt-types: | | | rtimer-value-seconds16 | | +--ro wait-timer? rt-types: | | | rtimer-value-seconds16 | | +--ro dr-router-id? rt-types:router-id | | +--ro dr-ip-addr? inet:ip-address | | +--ro bdr-router-id? rt-types:router-id | | +--ro bdr-ip-addr? inet:ip-address | | +--ro statistics | | | +--ro discontinuity-time yang:date-and-time | | | +--ro if-event-count? yang:counter32 | | | +--ro link-scope-lsa-count? yang:gauge32 | | | +--ro link-scope-lsa-cksum-sum? | | | uint32 | | | +--ro database | | | +--ro link-scope-lsa-type* | | | +--ro lsa-type? uint16 | | | +--ro lsa-count? yang:gauge32 | | | +--ro lsa-cksum-sum? int32 | | +--ro neighbors | | | +--ro neighbor* [neighbor-router-id] | | | +--ro neighbor-router-id | | | rt-types:router-id | | | +--ro address? inet:ip-address | | | +--ro dr-router-id? rt-types:router-id | | | +--ro dr-ip-addr? inet:ip-address | | | +--ro bdr-router-id? rt-types:router-id | | | +--ro bdr-ip-addr? inet:ip-address | | | +--ro state? nbr-state-type | | | +--ro dead-timer? rt-types: | | | | rtimer-value-seconds16 | | | +--ro statistics | | | +--ro discontinuity-time | | | yang:date-and-time | | | +--ro nbr-event-count? | | | yang:counter32 | | | +--ro nbr-retrans-qlen? | | | yang:gauge32 | | +--ro database | | +--ro link-scope-lsa-type* [lsa-type] | | +--ro lsa-type uint16 | | +--ro link-scope-lsas . . . . | +--rw sham-links {pe-ce-protocol}? | | +--rw sham-link* [local-id remote-id] | | +--rw local-id inet:ip-address | | +--rw remote-id inet:ip-address | | +--rw hello-interval? uint16 | | +--rw dead-interval? uint32 | | +--rw retransmit-interval? uint16 | | +--rw transmit-delay? uint16 | | +--rw lls? boolean {lls}? | | +--rw ttl-security {ttl-security}? | | | +--rwenable?enabled? boolean | | | +--rw hops? uint8 | | +--rwenable?enabled? boolean | | +--rw authentication | | | +--rw (auth-type-selection)? | | | +--:(ospfv2-auth) | | | | +--rw ospfv2-auth-trailer-rfc? | | | | | ospfv2-auth-trailer-rfc-version | | | | | {ospfv2-authentication-trailer}? | | | | +--rw (ospfv2-auth-specification)? | | | | +--:(auth-key-chain) {key-chain}? | | | | | +--rw ospfv2-key-chain? | | | | | key-chain:key-chain-ref | | | | +--:(auth-key-explicit) | | | | +--rw ospfv2-key-id? uint32 | | | | +--rw ospfv2-key? string | | | | +--rw ospfv2-crypto-algorithm? | | | | identityref | | | +--:(ospfv3-auth-ipsec) | | | | {ospfv3-authentication-ipsec}? | | | | +--rw sa? string | | | +--:(ospfv3-auth-trailer) | | | | {ospfv3-authentication-trailer}? | | | +--rw (ospfv3-auth-specification)? | | | +--:(auth-key-chain) {key-chain}? | | | | +--rw ospfv3-key-chain? | | | | key-chain:key-chain-ref | | | +--:(auth-key-explicit) | | | +--rw ospfv3-sa-id? uint16 | | | +--rw ospfv3-key? string | | | +--rw ospfv3-crypto-algorithm? | | | identityref | | +--rw cost?uint16ospf-link-metric | | +--rw mtu-ignore? boolean | | {mtu-ignore}? | | +--rw prefix-suppression? boolean | | {prefix-suppression}? | | +--ro state? if-state-type | | +--ro hello-timer? rt-types: | | | rtimer-value-seconds16 | | +--ro wait-timer? rt-types: | | | rtimer-value-seconds16 | | +--ro dr-router-id? rt-types:router-id | | +--ro dr-ip-addr? inet:ip-address | | +--ro bdr-router-id? rt-types:router-id | | +--ro bdr-ip-addr? inet:ip-address | | +--ro statistics | | | +--ro discontinuity-time yang:date-and-time | | | +--ro if-event-count? yang:counter32 | | | +--ro link-scope-lsa-count? yang:gauge32 | | | +--ro link-scope-lsa-cksum-sum? | | | uint32 | | | +--ro database | | | +--ro link-scope-lsa-type* | | | +--ro lsa-type? uint16 | | | +--ro lsa-count? yang:gauge32 | | | +--ro lsa-cksum-sum?int32uint32 | | +--ro neighbors | | | +--ro neighbor* [neighbor-router-id] | | | +--ro neighbor-router-id | | | rt-types:router-id | | | +--ro address? inet:ip-address | | | +--ro dr-router-id? rt-types:router-id | | | +--ro dr-ip-addr? inet:ip-address | | | +--ro bdr-router-id? rt-types:router-id | | | +--ro bdr-ip-addr? inet:ip-address | | | +--ro state? nbr-state-type | | | +--ro cost?uint32ospf-link-metric | | | +--ro dead-timer? rt-types: | | | | rtimer-value-seconds16 | | | +--ro statistics | | | +--ro discontinuity-time? | | | yang:date-and-time | | | +--ro nbr-event-count? | | | yang:counter32 | | | +--ro nbr-retrans-qlen? | | | yang:gauge32 | | +--ro database | | +--ro link-scope-lsa-type* [lsa-type] | | +--ro lsa-type uint16 | | +--ro link-scope-lsas . . . . 2.7. OSPF InterfaceConfiguration/OperationalConfiguration / Operational State Theinterface"interface" container contains OSPF interface configuration and operational state. The interface operational state includes the interface statistics, the list of neighbors, andLink-Local Link State Database (LSDB).the link-local LSDB. module: ietf-ospf augment /rt:routing/rt:control-plane-protocols/ rt:control-plane-protocol: +--rw ospf . . +--rw areas | +--rw area* [area-id] | . | . | +--rw interfaces | +--rw interface* [name] | +--rw name if:interface-ref | +--rw interface-type? enumeration | +--rw passive? boolean | +--rw demand-circuit? boolean | {demand-circuit}? | +--rw priority? uint8 | +--rw multi-areas {multi-area-adj}? | | +--rw multi-area* [multi-area-id] | | +--rw multi-area-id area-id-type | | +--rw cost?uint16ospf-link-metric | +--rw static-neighbors | | +--rw neighbor* [identifier] | | +--rw identifier inet:ip-address | | +--rw cost?uint16ospf-link-metric | | +--rw poll-interval? uint16 | | +--rw priority? uint8 | +--rw node-flag? boolean | {node-flag}? | +--rw bfd {bfd}? | | +--rwenable?enabled? boolean | | +--rw local-multiplier? multiplier | | | {client-base-cfg-parms}? | | +--rw (interval-config-type)? | | | {client-base-cfg-parms}? | | +--:(tx-rx-intervals) | | | +--rw desired-min-tx-interval? uint32 | | | +--rw required-min-rx-interval? uint32 | | +--:(single-interval) | | | {single-minimum-interval}? | | +--rw min-interval? uint32 | +--rw fast-reroute {fast-reroute}? | | +--rw lfa {lfa}? | | +--rwcandidate-enable?candidate-enabled? boolean | | +--rwenable?enabled? boolean | | +--rw remote-lfa {remote-lfa}? | | +--rwenable?enabled? boolean | +--rw hello-interval? uint16 | +--rw dead-interval? uint32 | +--rw retransmit-interval? uint16 | +--rw transmit-delay? uint16 | +--rw lls? boolean {lls}? | +--rw ttl-security {ttl-security}? | | +--rwenable?enabled? boolean | | +--rw hops? uint8 | +--rwenable?enabled? boolean | +--rw authentication | | +--rw (auth-type-selection)? | | +--:(ospfv2-auth) | | | +--rw ospfv2-auth-trailer-rfc? | | | | ospfv2-auth-trailer-rfc-version | | | | {ospfv2-authentication-trailer}? | | | +--rw (ospfv2-auth-specification)? | | | +--:(auth-key-chain) {key-chain}? | | | | +--rw ospfv2-key-chain? | | | | key-chain:key-chain-ref | | | +--:(auth-key-explicit) | | | +--rw ospfv2-key-id? uint32 | | | +--rw ospfv2-key? string | | | +--rw ospfv2-crypto-algorithm? | | | identityref | | +--:(ospfv3-auth-ipsec) | | | {ospfv3-authentication-ipsec}? | | | +--rw sa? string | | +--:(ospfv3-auth-trailer) | | | {ospfv3-authentication-trailer}? | | +--rw (ospfv3-auth-specification)? | | +--:(auth-key-chain) {key-chain}? | | | +--rw ospfv3-key-chain? | | | key-chain:key-chain-ref | | +--:(auth-key-explicit) | | +--rw ospfv3-sa-id? uint16 | | +--rw ospfv3-key? string | | +--rw ospfv3-crypto-algorithm? | | identityref | +--rw cost?uint16ospf-link-metric | +--rw mtu-ignore? boolean | | {mtu-ignore}? | +--rw prefix-suppression? boolean | | {prefix-suppression}? | +--ro state? if-state-type | +--ro hello-timer? rt-types: | | rtimer-value-seconds16 | +--ro wait-timer? rt-types: | | rtimer-value-seconds16 | +--ro dr-router-id? rt-types:router-id | +--ro dr-ip-addr? inet:ip-address | +--ro bdr-router-id? rt-types:router-id | +--ro bdr-ip-addr? inet:ip-address | +--ro statistics | | +--ro discontinuity-time? yang:date-and-time | | +--ro if-event-count? yang:counter32 | | +--ro link-scope-lsa-count? yang:gauge32 | | +--ro link-scope-lsa-cksum-sum? | | uint32 | | +--ro database | | +--ro link-scope-lsa-type* | | +--ro lsa-type? uint16 | | +--ro lsa-count? yang:gauge32 | | +--ro lsa-cksum-sum? int32 | +--ro neighbors | | +--ro neighbor* [neighbor-router-id] | | +--ro neighbor-router-id | | rt-types:router-id | | +--ro address? inet:ip-address | | +--ro dr-router-id? rt-types:router-id | | +--ro dr-ip-addr? inet:ip-address | | +--ro bdr-router-id? rt-types:router-id | | +--ro bdr-ip-addr? inet:ip-address | | +--ro state? nbr-state-type | | +--ro dead-timer? rt-types: | | | rtimer-value-seconds16 | | +--ro statistics | | +--ro discontinuity-time? | | yang:date-and-time | | +--ro nbr-event-count? | | yang:counter32 | | +--ro nbr-retrans-qlen? | | yang:gauge32 | +--ro database | . +--ro link-scope-lsa-type* [lsa-type] | . +--ro lsa-type uint16 | . +--ro link-scope-lsas . . . . | +--rw topologies {ospf:multi-topology}? | | +--rw topology* [name] | | +--rw name -> ../../../../../../../../ | | ../../../rt:ribs/rib/name | | +--rw cost?uint32ospf-link-metric | +--rw instance-id? uint8 . . 2.8. OSPF Notifications This YANG data model defines a list of notifications that inform YANG clients of important events detected during protocol operation. The defined notifications cover the common set of traps from the OSPFv2 MIB [RFC4750] and OSPFv3 MIB [RFC5643]. notifications: +---n if-state-change | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocol | + [rt:name=current()/../routing-protocol-name]/control-plane-protocol[rt:name=current()/../ | +ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro (if-link-type-selection)? | | +--:(interface) | | | +--ro interface | | | +--ro interface? if:interface-ref | | +--:(virtual-link) | | | +--ro virtual-link | | | +--ro transit-area-id? area-id-type | | | +--ro neighbor-router-id? rt-types:router-id | | +--:(sham-link) | | +--ro sham-link | | +--ro area-id? area-id-type | | +--ro local-ip-addr? inet:ip-address | | +--ro remote-ip-addr? inet:ip-address | +--ro state? if-state-type +---n if-config-error | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocolcontrol-plane-protocol[rt:name=current()/../ | +[rt:name=current()/../routing-protocol-name]/ | + ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro (if-link-type-selection)? | | +--:(interface) | | | +--ro interface | | | +--ro interface? if:interface-ref | | +--:(virtual-link) | | | +--ro virtual-link | | | +--ro transit-area-id? area-id-type | | | +--ro neighbor-router-id? rt-types:router-id | | +--:(sham-link) | | +--ro sham-link | | +--ro area-id? area-id-type | | +--ro local-ip-addr? inet:ip-address | | +--ro remote-ip-addr? inet:ip-address | +--ro packet-source? yang:dotted-quad | +--ro packet-type? packet-type | +--ro error? enumeration +---n nbr-state-change | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocol | + [rt:name=current()/../routing-protocol-name]/control-plane-protocol[rt:name=current()/../ | +ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro (if-link-type-selection)? | | +--:(interface) | | | +--ro interface | | | +--ro interface? if:interface-ref | | +--:(virtual-link) | | | +--ro virtual-link | | | +--ro transit-area-id? area-id-type | | | +--ro neighbor-router-id? rt-types:router-id | | +--:(sham-link) | | +--ro sham-link | | +--ro area-id? area-id-type | | +--ro local-ip-addr? inet:ip-address | | +--ro remote-ip-addr? inet:ip-address | +--ro neighbor-router-id? rt-types:router-id | +--ro neighbor-ip-addr? yang:dotted-quad | +--ro state? nbr-state-type +---n nbr-restart-helper-status-change | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocolcontrol-plane-protocol[rt:name=current()/../ | +[rt:name=current()/../routing-protocol-name]/ | + ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro (if-link-type-selection)? | | +--:(interface) | | | +--ro interface | | | +--ro interface? if:interface-ref | | +--:(virtual-link) | | | +--ro virtual-link | | | +--ro transit-area-id? area-id-type | | | +--ro neighbor-router-id? rt-types:router-id | | +--:(sham-link) | | +--ro sham-link | | +--ro area-id? area-id-type | | +--ro local-ip-addr? inet:ip-address | | +--ro remote-ip-addr? inet:ip-address | +--ro neighbor-router-id? rt-types:router-id | +--ro neighbor-ip-addr? yang:dotted-quad | +--ro status? restart-helper-status-type | +--ro age?uint32rt-types:timer-value-seconds16 | +--ro exit-reason? restart-exit-reason-type +---n if-rx-bad-packet | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocolcontrol-plane-protocol[rt:name=current()/../ | +[rt:name=current()/../routing-protocol-name]/ | + ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro (if-link-type-selection)? | | +--:(interface) | | | +--ro interface | | | +--ro interface? if:interface-ref | | +--:(virtual-link) | | | +--ro virtual-link | | | +--ro transit-area-id? area-id-type | | | +--ro neighbor-router-id? rt-types:router-id | | +--:(sham-link) | | +--ro sham-link | | +--ro area-id? area-id-type | | +--ro local-ip-addr? inet:ip-address | | +--ro remote-ip-addr? inet:ip-address | +--ro packet-source? yang:dotted-quad | +--ro packet-type? packet-type +---n lsdb-approaching-overflow | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocol | + [rt:name=current()/../routing-protocol-name]/control-plane-protocol[rt:name=current()/../ | +ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro ext-lsdb-limit? uint32 +---n lsdb-overflow | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocolcontrol-plane-protocol[rt:name=current()/../ | +[rt:name=current()/../routing-protocol-name]/ | + ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro ext-lsdb-limit? uint32 +---n nssa-translator-status-change | +--ro routing-protocol-name? | + -> /rt:routing/control-plane-protocols/ | + control-plane-protocol/name | +--roaf?address-family? | + -> /rt:routing/control-plane-protocols/ | +control-plane-protocol | + [rt:name=current()/../routing-protocol-name]/control-plane-protocol[rt:name=current()/../ | +ospf:ospf/afrouting-protocol-name]/ospf/address-family | +--ro area-id? area-id-type | +--ro status? nssa-translator-state-type +---n restart-status-change +--ro routing-protocol-name? + -> /rt:routing/control-plane-protocols/ + control-plane-protocol/name +--roaf?address-family? + -> /rt:routing/control-plane-protocols/ +control-plane-protocol + [rt:name=current()/../routing-protocol-name]/control-plane-protocol[rt:name=current()/../ +ospf:ospf/afrouting-protocol-name]/ospf/address-family +--ro status? restart-status-type +--ro restart-interval? uint16 +--ro exit-reason? restart-exit-reason-type 2.9. OSPF RPC Operations The "ietf-ospf" module defines two RPC operations:oclear-database:resetResets thecontentcontents of a particular OSPFLink State Database. oLSDB, forces neighbor adjacencies to the 'DOWN' state, and reoriginates self-originated LSAs. clear-neighbor:ResetResets a particular OSPF neighbor or group of neighbors associated with an OSPF interface. rpcs: +---x clear-neighbor | +---w input | +---w routing-protocol-name | + -> /rt:routing/control-plane-protocols/ | + 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 The following RFCsand drafts are not referenced in the document text butare referenced in theietf-ospf.yang"ietf-ospf" YANG module: [RFC0905], [RFC1765], [RFC1793], [RFC2328], [RFC3101], [RFC3623], [RFC3630], [RFC4552], [RFC4576], [RFC4577], [RFC4915], [RFC4973], [RFC5082], [RFC5185], [RFC5187], [RFC5250], [RFC5286], [RFC5309], [RFC5329], [RFC5340], [RFC5443], [RFC5613], [RFC5642], [RFC5709], [RFC5714], [RFC5838], [RFC5880], [RFC5881], [RFC6565], [RFC6845], [RFC6860], [RFC6987], [RFC6991], [RFC7166], [RFC7474], [RFC7490], [RFC7684], [RFC7770], [RFC7777], [RFC7884], [RFC8177], [RFC8294], [RFC8343], [RFC8349], [RFC8405], [RFC8476], and[RFC8476].[RFC9314]. <CODE BEGINS> file"ietf-ospf@2019-10-17.yang""ietf-ospf@2022-09-26.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";inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-yang-types { prefix"yang";yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-interfaces { prefix"if";if; reference "RFC 8343: A YANG Data Model for InterfaceManagement (NMDA Version)";Management"; } import ietf-routing-types { prefix"rt-types";rt-types; reference "RFC 8294: Common YANG Data Types for the Routing Area"; } import iana-routing-types { prefix"iana-rt-types";iana-rt-types; reference "RFC 8294: Common YANG Data Types for the Routing Area"; } import ietf-routing { prefix"rt";rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-key-chain { prefix"key-chain";key-chain; reference "RFC 8177: YANG Data Model for Key Chains"; } import ietf-bfd-types { prefix"bfd-types";bfd-types; reference "RFCYYYY:9314: YANG Data Model for Bidirectional Forwarding Detection(BFD). Please replace YYYY with published RFC number for draft-ietf-bfd-yang.";(BFD)"; } organization "IETFLSR -Link State Routing (lsr) Working Group"; contact "WG Web:<https://datatracker.ietf.org/group/lsr/><https://datatracker.ietf.org/wg/lsr/> WG List: <mailto:lsr@ietf.org> Editor: Derek Yeung <mailto:derek@arrcus.com> Author: Acee Lindem <mailto:acee@cisco.com> Author: Yingzhen Qu <mailto:yingzhen.qu@futurewei.com> Author:Salih K A <mailto:salih@juniper.net>Jeffrey Zhang <mailto:zzhang@juniper.net> Author: Ing-Wher Chen <mailto:ingwherchen@mitre.org>"; 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 andpolicies,policies -- for example, route maps or route policies. This YANG data model conforms to the Network Management Datastore Architecture (NMDA) as described in RFC8242.8342. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here. Copyright (c)20182022 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, theSimplifiedRevised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFCXXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here. This version of this YANG module is part of RFC XXXX;9129; see the RFC itself for full legal notices."; revision2019-10-172022-09-26 { description "Initial revision."; reference "RFCXXXX: A9129: YANG Data Model forOSPF.";the OSPF Protocol"; } feature multi-topology { description "SupportMultiple-Topology Routing (MTR).";for Multi-Topology (MT) routing."; reference "RFC 4915: Multi-TopologyRouting";(MT) Routing in OSPF"; } feature multi-area-adj { description"OSPF"Support for OSPF multi-areaadjacency supportadjacencies as described in RFC 5185."; reference "RFC 5185: OSPF Multi-Area Adjacency"; } feature explicit-router-id { description"Set Router-ID"Sets the Router ID per instance explicitly."; } feature demand-circuit { description"OSPF"Support for OSPF demandcircuit supportcircuits as defined in RFC 1793."; reference "RFC 1793: Extending OSPF to Support Demand Circuits"; } feature mtu-ignore { description "Disable OSPF Database Description packet MTU mismatch checking as specified in theOSPFOSPFv2 protocolspecification.";specification (RFC 2328). This mismatch checking also applies to OSPFv3 (RFC 5340)."; reference "RFC 2328: OSPF Version 2,section 10.6";Section 10.6 RFC 5340: OSPF for IPv6"; } feature lls { description "OSPF link-local signaling (LLS) as defined in RFC 5613."; reference "RFC 5613: OSPF Link-Local Signaling"; } feature prefix-suppression { description "OSPF prefix suppression support as described in RFC 6860."; reference "RFC 6860:HideHiding Transit-Only Networks in OSPF"; } feature ttl-security { description"OSPF"Support for OSPF Time to Live (TTL) securitycheck support.";checking."; reference "RFC 5082: The Generalized TTL Security Mechanism (GTSM)"; } feature nsr { description "Non-Stop-Routing (NSR) support. The OSPF NSR feature allows a router with redundant control-plane capability (e.g., dualRoute-ProcessorRoute Processor (RP) cards) to maintain its state and adjacencies during planned and unplanned OSPF instance restarts. It differs fromgraceful-restartgraceful restart or Non-Stop Forwarding (NSF) in that no protocol signaling or assistance from adjacent OSPF neighbors is required to recover control-plane state."; } feature graceful-restart { description "Graceful OSPFRestartrestart as defined inRFCRFCs 3623 andRFC5187."; reference "RFC 3623: Graceful OSPF Restart RFC 5187: OSPFv3 Graceful Restart"; } feature auto-cost { description"Calculate"Calculates the OSPF interface cost according to reference bandwidth."; reference "RFC 2328: OSPF Version 2"; } feature max-ecmp { description"Setting"Sets the maximum number of ECMP paths."; } feature max-lsa { description"Setting"Sets the maximum number ofLSAsLink State Advertisements (LSAs) the OSPF instance will accept."; reference "RFC 1765: OSPF DatabaseOverload";Overflow"; } feature te-rid { description "Support for configuration of the Traffic Engineering (TE)Router-ID,Router ID, i.e., the Router Address TLV as described in Section 2.4.1 ofRFC3630RFC 3630 or the Router IPv6 Address TLV as described in Section 3 ofRFC5329.";RFC 5329."; reference "RFC 3630: Traffic Engineering (TE) Extensions to OSPF Version22, Section 2.4.1 RFC 5329: Traffic Engineering(TE)Extensions to OSPF Version 3, Section 3"; } feature ldp-igp-sync { description "LDP IGP synchronization."; reference "RFC 5443: LDP IGP Synchronization"; } feature ospfv2-authentication-trailer { description "SupportOSPFv2 authentication trailerfor the OSPFv2authentication.";authentication trailer."; reference "RFC 5709:Supporting Authentication Trailer forOSPFv2 HMAC-SHA Cryptographic Authentication RFC 7474: Security Extension for OSPFv2 When Using Manual Key Management"; } feature ospfv3-authentication-ipsec { description "Support for IPsec for OSPFv3 authentication."; reference "RFC 4552: Authentication/Confidentiality for OSPFv3"; } feature ospfv3-authentication-trailer { description "SupportOSPFv3 authentication trailerfor the OSPFv3authentication.";authentication trailer."; reference "RFC 7166: Supporting Authentication Trailer for OSPFv3"; } feature fast-reroute { description "Support for IP Fast Reroute (IP-FRR)."; reference "RFC 5714: IP Fast Reroute Framework"; } feature key-chain { description "Support ofkeychainkey chains for authentication."; reference"RFC8177:"RFC 8177: YANG Data Model for Key Chains"; } feature node-flag { description "Support fornode-flagnode flags for OSPF prefixes."; reference "RFC 7684: OSPFv2 Prefix/Link Attribute Advertisement"; } feature node-tag { description "Support for nodeadmin tagadministrative tags for OSPF routing instances."; reference "RFC 7777: Advertising Node Administrative Tags in OSPF"; } feature lfa { description "Support for Loop-Free Alternates (LFAs)."; reference "RFC 5286: Basic Specification for IP Fast Reroute: Loop-Free Alternates"; } feature remote-lfa { description "Support for RemoteLoop-Free Alternates (R-LFA).";LFAs (R-LFAs)."; reference "RFC 7490: Remote Loop-Free Alternate (LFA) Fast Reroute (FRR)"; } feature stub-router { description "Support forRFC 6987OSPFStub Router Advertisement.";stub router advertisement as defined in RFC 6987."; reference "RFC 6987: OSPF Stub Router Advertisement"; } feature pe-ce-protocol { description "Support for OSPF as aPE-CE protocol";Provider Edge to Customer Edge (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 for the IETFSPFShortest Path First (SPF) delay algorithm."; reference "RFC 8405:SPF Back-off algorithmShortest Path First (SPF) Back-Off Delay Algorithm forlink stateLink-State IGPs"; } feature bfd { description "Support for BFDdetection ofto detect OSPF neighbor reachability."; reference "RFC 5880: Bidirectional Forwarding Detection (BFD) RFC 5881: Bidirectional Forwarding Detection (BFD) for IPv4 and IPv6 (Single Hop)"; } feature hybrid-interface { description "Support for the OSPFHybridhybrid interface type."; reference "RFC 6845: OSPF Hybrid Broadcast and Point-to-Multipoint Interface Type"; } identity ospf { base"rt:routing-protocol";rt:routing-protocol; description "Any OSPF protocolversion";version."; } identity ospfv2 { base"ospf";ospf; description "OSPFv2protocol";protocol."; } identity ospfv3 { base"ospf";ospf; description "OSPFv3protocol";protocol."; } identity area-type { description "Base identity for an OSPF area type."; } identity normal-area { base area-type; description "OSPF normal area."; } identity stub-nssa-area { base area-type; description "OSPF stub area orNSSA area.";Not-So-Stubby Area (NSSA)."; } identity stub-area { base stub-nssa-area; description "OSPF stub area."; } identity nssa-area { base stub-nssa-area; description "OSPFNot-So-Stubby Area (NSSA).";NSSA."; reference "RFC 3101: The OSPF Not-So-Stubby Area (NSSA) Option"; } identity ospf-lsa-type { description "Base identity for OSPFv2 and OSPFv3 Link State Advertisement (LSA)types";types."; } identity ospfv2-lsa-type { base ospf-lsa-type; description "OSPFv2 LSAtypes";types."; } identity ospfv2-router-lsa { base ospfv2-lsa-type; description "OSPFv2Router LSARouter-LSA - Type1";1."; } identity ospfv2-network-lsa { base ospfv2-lsa-type; description "OSPFv2Network LSANetwork-LSA - Type2";2."; } identity ospfv2-summary-lsa-type { base ospfv2-lsa-type; description "OSPFv2Summarysummary LSAtypes";types."; } identity ospfv2-network-summary-lsa { base ospfv2-summary-lsa-type; description "OSPFv2 NetworkSummarysummary LSA - Type3";3."; } identity ospfv2-asbr-summary-lsa { base ospfv2-summary-lsa-type; description "OSPFv2ASAutonomous System Boundary Router (ASBR)Summarysummary LSA - Type4";4."; } identity ospfv2-external-lsa-type { base ospfv2-lsa-type; description "OSPFv2External LSA types";External-LSA types."; } identity ospfv2-as-external-lsa { base ospfv2-external-lsa-type; description "OSPFv2AS External LSAAS-External-LSA - Type5";5."; } identity ospfv2-nssa-lsa { base ospfv2-external-lsa-type; description "OSPFv2Not-So-Stubby-Area (NSSA) LSANSSA-LSA - Type7";7."; } identity ospfv2-opaque-lsa-type { base ospfv2-lsa-type; description "OSPFv2 Opaque-LSA types."; reference "RFC 5250: The OSPF Opaque LSAtypes";Option"; } identity ospfv2-link-scope-opaque-lsa { base ospfv2-opaque-lsa-type; description "OSPFv2Link-Scoped Opaque LSALink-Scope Opaque-LSA - Type9";9."; } identity ospfv2-area-scope-opaque-lsa { base ospfv2-opaque-lsa-type; description "OSPFv2Area-Scoped Opaque LSAArea-Scope Opaque-LSA - Type10";10."; } identity ospfv2-as-scope-opaque-lsa { base ospfv2-opaque-lsa-type; description "OSPFv2AS-Scoped Opaque LSAAS-Scope Opaque-LSA - Type11";11."; } identity ospfv2-unknown-lsa-type { base ospfv2-lsa-type; description "OSPFv2Unknownunknown LSAtype";type."; } identity ospfv3-lsa-type { base ospf-lsa-type; description "OSPFv3 LSA types."; reference "RFC 5340: OSPF for IPv6"; } identity ospfv3-router-lsa { base ospfv3-lsa-type; description "OSPFv3Router LSARouter-LSA - Type0x2001";0x2001."; } identity ospfv3-network-lsa { base ospfv3-lsa-type; description "OSPFv3Network LSANetwork-LSA - Type0x2002";0x2002."; } identity ospfv3-summary-lsa-type { base ospfv3-lsa-type; description "OSPFv3Summarysummary LSAtypes";types."; } identity ospfv3-inter-area-prefix-lsa { base ospfv3-summary-lsa-type; description "OSPFv3Inter-area Prefix LSAInter-Area-Prefix-LSA - Type0x2003";0x2003."; } identity ospfv3-inter-area-router-lsa { base ospfv3-summary-lsa-type; description "OSPFv3Inter-area Router LSAInter-Area-Router-LSA - Type0x2004";0x2004."; } identity ospfv3-external-lsa-type { base ospfv3-lsa-type; description "OSPFv3External LSA types";External-LSA types."; } identity ospfv3-as-external-lsa { base ospfv3-external-lsa-type; description "OSPFv3AS-External LSAAS-External-LSA - Type0x4005";0x4005."; } identity ospfv3-nssa-lsa { base ospfv3-external-lsa-type; description "OSPFv3Not-So-Stubby-Area (NSSA) LSANSSA-LSA - Type0x2007";0x2007."; } identity ospfv3-link-lsa { base ospfv3-lsa-type; description "OSPFv3Link LSALink-LSA - Type0x0008";0x0008."; } identity ospfv3-intra-area-prefix-lsa { base ospfv3-lsa-type; description "OSPFv3Intra-area Prefix LSAIntra-Area-Prefix-LSA - Type0x2009";0x2009."; } identity ospfv3-router-information-lsa { base ospfv3-lsa-type; description "OSPFv3Router Information LSARouter-Information-LSA - Types 0x800C, 0xA00C, and0xC00C";0xC00C."; } identity ospfv3-unknown-lsa-type { base ospfv3-lsa-type; description "OSPFv3Unknownunknown LSAtype";type."; } identity lsa-log-reason { description "Base identity for an LSA log reason."; } identity lsa-refresh { base lsa-log-reason; description "Identity used whenthean LSA is logged as a result of receiving a refresh LSA."; } identity lsa-content-change { base lsa-log-reason; description "Identity used whenthean LSA is logged as a result of a change in thecontentcontents of the LSA."; } identity lsa-purge { base lsa-log-reason; description "Identity used whenthean LSA is logged as a result of being purged."; } identity informational-capability { description "Base identity for router informational capabilities."; } identity graceful-restart { base informational-capability; description "When set, the router is capable of restarting gracefully."; reference "RFC 3623: Graceful OSPF Restart RFC 5187: OSPFv3 Graceful Restart"; } identity graceful-restart-helper { base informational-capability; description "When set, the router is capable of acting as a graceful restart helper."; reference "RFC 3623: Graceful OSPF Restart RFC 5187: OSPFv3 Graceful Restart"; } identity stub-router { base informational-capability; description "When set, the router is capable of acting as an OSPFStub Router.";stub router."; reference "RFC 6987: OSPF Stub Router Advertisement"; } identity traffic-engineering { base informational-capability; description "When set, the router is capable of OSPFtraffic engineering.";TE."; reference "RFC 3630: Traffic Engineering (TE) Extensions to OSPF Version 2 RFC 5329: Traffic Engineering(TE)Extensions to OSPF Version 3"; } identity p2p-over-lan { base informational-capability; description "When set, the router is capable of OSPFPoint-to-Pointpoint-to-point over a LAN."; reference "RFC 5309: Point-to-Point Operation over LAN in Link State Routing Protocols"; } identity experimental-te { base informational-capability; description "When set, the router is capable of OSPF experimentaltraffic engineering.";TE."; reference "RFC 4973:OSPF-xTE OSPFOSPF-xTE: Experimental Extension to OSPF for Traffic Engineering"; } identity router-lsa-bit { description "Base identity for Router-LSA bits."; } identity vlink-end-bit { base router-lsa-bit; description"V bit, when"V-bit. When set, the router is an endpoint of one or more virtual links."; } identity asbr-bit { base router-lsa-bit; description"E bit, when"E-bit. When set, the router is anASAutonomous System Boundary Router (ASBR)."; } identity abr-bit { base router-lsa-bit; description"B bit, when"B-bit. When set, the router is an Area Border Router (ABR)."; } identity nssa-bit { base router-lsa-bit; description"Nt bit, when"Nt-bit. When set, the router is an NSSA border router that is unconditionally translatingNSSA LSAsNSSA-LSAs intoAS-external LSAs.";AS-External-LSAs."; } identity ospfv3-lsa-option { description "Base identity for OSPF LSAoptions flags.";Options."; } identity af-bit { base ospfv3-lsa-option; description"AF bit, when"AF-bit. When set, the router supports OSPFv3 Address Families (AFs) as described in RFC 5838."; reference "RFC 5838: Support of Address Families inRFC5838.";OSPFv3"; } identity dc-bit { base ospfv3-lsa-option; description"DC bit, when"DC-bit. When set, the router supports demand circuits."; } identity r-bit { base ospfv3-lsa-option; description"R bit, when"R-bit. When set, the originator is an active router."; } identity n-bit { base ospfv3-lsa-option; description"N bit, when"N-bit. When set, the router is attached to anNSSA";NSSA."; } identity e-bit { base ospfv3-lsa-option; description"E bit, this"E-bit. This bit describes the wayAS-external LSAsAS-External-LSAs areflooded";flooded."; } identity v6-bit { base ospfv3-lsa-option; description"V6 bit, if"V6-bit. If clear, the router/link should be excluded from IPv6 routingcalculation";calculations."; } identity ospfv3-prefix-option { description "Base identity for OSPFv3Prefix Options.";prefix options."; } identity nu-bit { base ospfv3-prefix-option; description"NU Bit, when"NU-bit. When set, the prefix should be excluded from IPv6 unicast calculations."; } identity la-bit { base ospfv3-prefix-option; description"LA bit, when"LA-bit. When set, the prefix is actually an IPv6 interface address of theAdvertising Router.";advertising router."; } identity p-bit { base ospfv3-prefix-option; description"P bit, when"P-bit. When set, the NSSAareaprefix should be translated to anAS External LSAAS-External-LSA and advertised by the translating NSSABorder Router.";border router."; } identity dn-bit { base ospfv3-prefix-option; description"DN bit, when"DN-bit. When set, theinter-area-prefix LSAInter-Area-Prefix-LSA orAS-external LSAAS-External-LSA prefix has been advertised as an L3VPN prefix."; } identity ospfv2-lsa-option { description "Base identity for OSPFv2 LSAoption flags.";Options."; } identity mt-bit { base ospfv2-lsa-option; description"MT bit,"MT-bit. When set, the router supports multi-topology as described in RFC 4915."; reference "RFC 4915: Multi-Topology (MT) Routing in OSPF"; } identity v2-dc-bit { base ospfv2-lsa-option; description"DC bit,"DC-bit. When set, the router supports demand circuits."; } identity v2-p-bit { base ospfv2-lsa-option; description"P bit, wnly"P-bit. Only used in type-7LSA.LSAs. When set, an NSSA border router should translate the type-7 LSA to a type-5 LSA."; } identitymc-flagmc-bit { base ospfv2-lsa-option; description"MC Bit, when"MC-bit. When set, the router supportsMOSPF.";Multicast Extensions to OSPF (MOSPF)."; } identityv2-e-flagv2-e-bit { base ospfv2-lsa-option; description"E Bit, this"E-bit. This bit describes the wayAS-external LSAsAS-External-LSAs are flooded."; } identity o-bit { base ospfv2-lsa-option; description"O bit, when"O-bit. When set, the router isopaque-capableopaque capable as described in RFC 5250."; reference "RFC 5250: The OSPF Opaque LSA Option"; } identity v2-dn-bit { base ospfv2-lsa-option; description"DN bit, when"DN-bit. When a type 3,5type 5, or type 7 LSA is sent from a PE to a CE, theDN bitDN-bit must be set. See RFC 4576."; reference "RFC 4576: Using a Link State Advertisement (LSA) Options Bit to Prevent Looping in BGP/MPLS IP Virtual Private Networks (VPNs)"; } identity ospfv2-extended-prefix-flag { description "Base identity forextended prefixthe Extended Prefix TLV flag."; } identity a-flag { base ospfv2-extended-prefix-flag; description "Attachflag, when setflag. When set, it indicates that the prefix correspondsandto a routewhatthat is directly connected to the advertisingrouter..";router."; } identity node-flag { base ospfv2-extended-prefix-flag; description "Nodeflag, whenflag. When set, it indicates that the prefix is used to represent the advertising node, e.g., a loopback address."; } typedef ospf-metric { type uint32 { range "0 .. 16777215"; } description "OSPFMetric -metric. 24-bit unsigned integer."; } typedef ospf-link-metric { type uint16 { range "0 .. 65535"; } description "OSPFLink Metric -link metric. 16-bit unsigned integer."; } typedef opaque-id { type uint32 { range "0 .. 16777215"; } description"Opaque ID -"Opaque-LSA ID. 24-bit unsigned integer."; } typedef area-id-type { type yang:dotted-quad; description "Area ID type."; } typedef route-type { type enumeration { enum intra-area { description "OSPF intra-area route."; } enum inter-area { description "OSPF inter-area route."; } enum external-1 { description "OSPF type 1 external route."; } enum external-2 { description "OSPF type 2 external route."; } enum nssa-1 { description "OSPF type 1 NSSA route."; } enum nssa-2 { description "OSPF type 2 NSSA route."; } } description "OSPF route type."; } typedef if-state-type { type enumeration { enum down { value"1";1; description "Interfacedownis in the 'Down' state."; } enum loopback { value"2";2; description "Interfaceloopbackis in the 'Loopback' state."; } enum waiting { value"3";3; description "Interfacewaitingis in the 'Waiting' state."; } enum point-to-point { value"4";4; description "Interfacepoint-to-pointis in the 'Point-to-point' state."; } enum dr { value"5";5; description "InterfaceDesignated Router (DR)is in the 'DR' (Designated Router) state."; } enum bdr { value"6";6; description "InterfaceBackupis in the 'Backup' (Backup Designated Router(BDR)(BDR)) state."; } enum dr-other { value"7";7; description "InterfaceOther Designated Routeris in the 'DR Other' state."; } } description "OSPF interface state type."; reference "RFC 2328: OSPF Version 2"; } typedef router-link-type { type enumeration { enum point-to-point-link { value"1";1; description"Point-to-Point"Point-to-point link toRouter";another router."; } enum transit-network-link { value"2";2; description "Link to a transitnetworknetwork, identified byDesignated-Router (DR)";the DR."; } enum stub-network-link { value"3";3; description "Link to a stubnetworknetwork, identified bysubnet";the subnet."; } enum virtual-link { value"4";4; description "Virtual link across a transitarea";area."; } } description "OSPFRouter Link Type.";router link type."; } typedef nbr-state-type { type enumeration { enum down { value"1";1; description "Neighbordownis in the 'Down' state."; } enum attempt { value"2";2; description "Neighborattemptis in the 'Attempt' state."; } enum init { value"3";3; description "Neighborinitis in the 'Init' state."; } enum 2-way { value"4";4; description "Neighbor2-Wayis in the '2-Way' state."; } enum exstart { value"5";5; description "Neighborexchange startis in the 'ExStart' (exchange start) state."; } enum exchange { value"6";6; description "Neighborexchangeis in the 'Exchange' state."; } enum loading { value"7";7; description "Neighborloadingis in the 'Loading' state."; } enum full { value"8";8; description "Neighborfullis in the 'Full' state."; } } description "OSPF neighbor state type."; reference "RFC 2328: OSPF Version 2"; } typedef restart-helper-status-type { type enumeration { enum not-helping { value"1";1; description "Restart helper statusnot helping.";of 'not-helping'."; } enum helping { value"2";2; description "Restart helper statushelping.";of 'helping'."; } } description "Restart helper status type."; } typedef restart-exit-reason-type { type enumeration { enum none { value"1";1; description "Restart not attempted."; } enum in-progress { value"2";2; description "Restart in progress."; } enum completed { value"3";3; description "Restart successfully completed."; } enum timed-out { value"4";4; description "Restart timed out."; } enum topology-changed { value"5";5; description "Restart aborted due to a topology change."; } } description "Describes the outcome of the lastattempt at agracefulrestart, either by itselfrestart attempt. The local router is being restarted or acting as a helper."; } typedef packet-type { type enumeration { enum hello { value"1";1; description "OSPF Hello packet."; } enum database-description { value"2";2; description "OSPF Database Description packet."; } enum link-state-request { value"3";3; description "OSPF Link State Request packet."; } enum link-state-update { value"4";4; description "OSPF Link State Update packet."; } enum link-state-ack { value"5";5; description "OSPF Link StateAcknowledgementAcknowledgment packet."; } } description "OSPF packet type."; } typedef nssa-translator-state-type { type enumeration { enum enabled { value"1";1; description"NSSA translator enabled state.";"NSSATranslatorState is 'enabled'."; } enum elected { value"2";2; description"NSSA translator elected state.";"NSSATranslatorState is 'elected'."; } enum disabled { value"3";3; description"NSSA translator disabled state.";"NSSATranslatorState is 'disabled'."; } } description "OSPF NSSA translator state type."; reference "RFC 3101: The OSPF Not-So-Stubby Area (NSSA) Option"; } typedef restart-status-type { type enumeration { enum not-restarting { value"1";1; description"Router"The router is not restarting."; } enum planned-restart { value"2";2; description"Router"The router is going through a planned restart."; } enum unplanned-restart { value"3";3; description"Router"The router is going through an unplanned restart."; } } description "OSPF graceful restart status type."; } typedef fletcher-checksum16-type { type string { pattern '(0x)?[0-9a-fA-F]{4}'; } description "Fletcher 16-bit checksum in hex-string format 0xXXXX."; reference "RFC 905: ISO Transport ProtocolspecificationSpecification ISO DP 8073"; } typedef ospfv2-auth-trailer-rfc-version { type enumeration { enum rfc5709 { description "Support for the OSPFAuthentication Trailerauthentication trailer as described in RFC5709";5709."; reference "RFC 5709: OSPFv2 HMAC-SHA Cryptographic Authentication"; } enum rfc7474 { description "Support for the OSPFAuthentication Trailerauthentication trailer as described in RFC7474";7474."; reference "RFC 7474: Security Extension for OSPFv2 When Using Manual KeyManagement Authentication";Management"; } } description "OSPFv2Authentication Trailer Support";authentication trailer support."; } grouping tlv { description "Type-Length-Value(TLV)";(TLV)."; leaf type { type uint16; description "TLV type."; } leaf length { type uint16; description "TLV length (octets)."; } leaf value { type yang:hex-string; description "TLV value."; } } grouping unknown-tlvs { description"Unknown TLVs grouping - Used"Grouping used for unknown TLVs or unknown sub-TLVs."; container unknown-tlvs { description "All unknown TLVs."; list unknown-tlv { description "Unknown TLV."; uses tlv; } } } grouping node-tag-tlv { description "OSPF Node Admin Tag TLV grouping."; list node-tag { leaf tag { type uint32; description"Node admin tag value.";"Value of the node administrative tag."; } description "List of tags."; } } grouping router-capabilities-tlv { description"OSPF Router Capabilities"Grouping for OSPF router capabilities TLVgrouping.";types."; reference "RFC 7770: Extensions to OSPF for Advertising Optional Router Capabilities"; container router-informational-capabilities { leaf-list informational-capabilities { type identityref { base informational-capability; } description"Informational capability list."List of informational capabilities. This list willcontainscontain the identities for the informational capabilities supported by the router."; } description "OSPF Router Informational FlagDefinitions.";definitions."; } list informational-capabilities-flags { leaf informational-flag { type uint32; description "Individual informational capability flag."; } description "List of informational capability flags. This will return all the 32-bit informationalflagsflags, irrespective of whether or not they are known to the device."; } list functional-capabilities { leaf functional-flag { type uint32; description "Individual functional capability flag."; } description "List of functional capability flags. This will return all the 32-bit functionalflagsflags, irrespective of whether or not they are known to the device."; } } grouping dynamic-hostname-tlv { description "Dynamic HostnameTLV";TLV."; reference "RFC 5642: DynamicHostnamesHostname Exchange Mechanism for OSPF"; leaf hostname { type string { length "1..255"; } description "DynamicHostname";hostname."; } } grouping sbfd-discriminator-tlv { description"Seamless BFD"S-BFD DiscriminatorTLV";TLV."; reference "RFC 7884:S-BFD Discriminators in OSPF";OSPF Extensions to Advertise Seamless Bidirectional Forwarding Detection (S-BFD) Target Discriminators"; list sbfd-discriminators { leaf sbfd-discriminator { type uint32; description "Individual S-BFD Discriminator."; } description "List of S-BFDDiscriminators";Discriminators."; } } grouping maximum-sid-depth-tlv { description"Maximum"Node MSD TLV (TLV for Maximum SIDDepth (MSD) TLV";Depth)."; reference "RFC 8476: Signaling MaximumSegmentSID Depth (MSD)usingUsing OSPF"; list msd-type { leaf msd-type { type uint8; description "MaximumSegmentSID Depth (MSD)type";type."; } leaf msd-value { type uint8; description"Maximum Segment Depth (MSD)"MSD value for thetype";type."; } description "List ofMaximum Segment Depth (MSD) tuples";MSD tuples."; } } grouping ospf-router-lsa-bits { container router-bits { leaf-list rtr-lsa-bits { type identityref { base router-lsa-bit; } description"Router LSA bits list."List of Router-LSA bits. This list will contain identities for thebits whichbits; these identities are set in the Router-LSA bits."; } description"Router LSA Bits.";"Router-LSA bits."; } description"Router LSA Bits -"Router-LSA bits. Currently commonforto both OSPFv2 and OSPFv3 butitmay diverge with future augmentations."; } grouping ospfv2-router-link { description "OSPFv2 router link."; leaf link-id { type union { type inet:ipv4-address; type yang:dotted-quad; } description "Router-LSA LinkID";ID."; } leaf link-data { type union { type inet:ipv4-address; type uint32; } description "Router-LSALinklink data."; } leaf type { type router-link-type; description "Router-LSALinklink type."; } } grouping ospfv2-lsa-body { description "OSPFv2 LSA body."; container router { when "derived-from-or-self(../../header/type, " + "'ospfv2-router-lsa')" { description "Only applies to Router-LSAs."; } description"Router LSA.";"Router-LSA."; uses ospf-router-lsa-bits; leaf num-of-links { type uint16; description "Number of links inRouter LSA.";the Router-LSA."; } container links { description "All routerLinks.";links."; list link { description"Router LSA"Router-LSA link."; uses ospfv2-router-link; container topologies { description "All topologies for the link."; list topology { description"Topology specific"Topology-specific information."; leaf mt-id { type uint8; description "The MT-ID for the topology enabled on the link."; } leaf metric { type uint16; description "Metric for the topology."; } } } } } } container network { when "derived-from-or-self(../../header/type, " + "'ospfv2-network-lsa')" { description "Only applies toNetwork LSAs.";Network-LSAs."; } description"Network LSA.";"Network-LSA."; leaf network-mask { type yang:dotted-quad; description "The IP address mask for the network."; } container attached-routers { description "All attached routers."; leaf-list attached-router { type inet:ipv4-address; description "List of the routers attached to the network."; } } } container summary { when "derived-from(../../header/type, " + "'ospfv2-summary-lsa-type')" { description "Only applies toSummarysummary LSAs."; } description "Summary LSA."; leaf network-mask { type inet:ipv4-address; description "The IP address mask for thenetwork";network."; } container topologies { description "All topologies for the summary LSA."; list topology { description"Topology specific"Topology-specific information."; leaf mt-id { type uint8; description "The MT-ID for the topology enabled for the summary."; } leaf metric { type ospf-metric; description "Metric for the topology."; } } } } container external { when "derived-from(../../header/type, " + "'ospfv2-external-lsa-type')" { description "Only applies toAS-external LSAsAS-External-LSAs andNSSA LSAs.";NSSA-LSAs."; } description"External LSA.";"External-LSA."; leaf network-mask { type inet:ipv4-address; description "The IP address mask for thenetwork";network."; } container topologies { description "All topologies for theexternal.";External-LSA."; list topology { description"Topology specific"Topology-specific information."; leaf mt-id { type uint8; description "The MT-ID for the topology enabled for the external or NSSA prefix."; } leaf flags { type bits { bit E { description "When set, the metric specified is a Type 2 external metric."; } } description"Flags.";"Topology flags."; } leaf metric { type ospf-metric; description "Metric for the topology."; } leaf forwarding-address { type inet:ipv4-address; description"Forwarding"IPv4 Forwarding address."; } leaf external-route-tag { type uint32; description "Route tag for the topology."; } } } } container opaque { when "derived-from(../../header/type, " + "'ospfv2-opaque-lsa-type')" { description "Only applies toOpaque LSAs.";Opaque-LSAs."; } description"Opaque LSA.";"Opaque-LSA."; container ri-opaque { description "OSPFRouter Information (RI) opaque LSA.";Router-Information-Opaque-LSA."; reference "RFC 7770: Extensions to OSPF for Advertising Optional Router Capabilities"; container router-capabilities-tlv { description "Informational and functional routercapabilities";capabilities."; uses router-capabilities-tlv; } container node-tag-tlvs { description "Allnode tagNode Admin Tag TLVs."; list node-tag-tlv { description "NodetagAdmin Tag TLV."; uses node-tag-tlv; } } container dynamic-hostname-tlv { description "OSPF DynamicHostname";Hostname TLV."; uses dynamic-hostname-tlv; } container sbfd-discriminator-tlv { description "OSPF S-BFDDiscriminators";Discriminator TLV."; uses sbfd-discriminator-tlv; } container maximum-sid-depth-tlv { description "OSPFMaximum SID Depth (MSD) values";Node MSD TLV."; uses maximum-sid-depth-tlv; } uses unknown-tlvs; } container te-opaque { description "OSPFv2Traffic Engineering (TE) opaque LSA.";TE Opaque-LSA."; reference "RFC 3630: Traffic Engineering (TE) Extensions toOSPFv2";OSPF Version 2"; container router-address-tlv { description "Router address TLV."; leaf router-address { type inet:ipv4-address; description "Router address."; } } container link-tlv { description "Describes a singlelink, and itlink. It is constructedoffrom a set ofSub-TLVs.";sub-TLVs."; leaf link-type { type router-link-type; mandatory true; description "Link type."; } leaf link-id { type union { type inet:ipv4-address; type yang:dotted-quad; } mandatory true; description "Link ID."; } container local-if-ipv4-addrs { description "All local interface IPv4 addresses."; leaf-list local-if-ipv4-addr { type inet:ipv4-address; description "List of local interface IPv4 addresses."; } } container remote-if-ipv4-addrs { description "All remote interface IPv4 addresses."; leaf-list remote-if-ipv4-addr { type inet:ipv4-address; description "List of remote interface IPv4 addresses."; } } leaf te-metric { type uint32; description "TE metric."; } leaf max-bandwidth { type rt-types:bandwidth-ieee-float32; description "Maximum bandwidth."; } leaf max-reservable-bandwidth { type rt-types:bandwidth-ieee-float32; description "Maximum reservable bandwidth."; } container unreserved-bandwidths { description "All unreserved bandwidths."; list unreserved-bandwidth { leaf priority { type uint8 { range "0 .. 7"; } description "Priority from 0 to 7."; } leaf unreserved-bandwidth { type rt-types:bandwidth-ieee-float32; description "Unreserved bandwidth."; } description "List of unreserved bandwidths for different priorities."; } } leaf admin-group { type uint32; description "Administrativegroup/ResourceGroup / Resource Class/Color."; } uses unknown-tlvs; } } container extended-prefix-opaque { description "Allextended prefixExtended Prefix TLVs in the LSA."; list extended-prefix-tlv { description "ExtendedprefixPrefix TLV."; leaf route-type { type enumeration { enum unspecified { value"0";0; description "Unspecified."; } enum intra-area { value"1";1; description "OSPF intra-area route."; } enum inter-area { value"3";3; description "OSPF inter-area route."; } enum external { value"5";5; description "OSPFExternalexternal route."; } enum nssa { value"7";7; description "OSPF NSSA external route."; } } description "Route type."; } container flags { leaf-list extended-prefix-flags { type identityref { base ospfv2-extended-prefix-flag; } description"Extended prefix"List of Extended Prefix TLVflags list.flags. This list will contain identities for the prefixflags thatflags; these identities are set in the extended prefix flags."; } description "PrefixFlags.";flags."; } leaf prefix { type inet:ip-prefix; description "Address prefix."; } uses unknown-tlvs; } } container extended-link-opaque { description "Allextended linkExtended Link TLVs in the LSA."; reference "RFC 7684: OSPFv2 Prefix/Link Attribute Advertisement"; container extended-link-tlv { description "ExtendedlinkLink TLV."; uses ospfv2-router-link; container maximum-sid-depth-tlv { description "OSPFMaximum SID Depth (MSD) values";Node MSD TLV."; uses maximum-sid-depth-tlv; } uses unknown-tlvs; } } } } grouping ospfv3-lsa-options { description "OSPFv3 LSAoptions";Options."; container lsa-options { leaf-list lsa-options { type identityref { base ospfv3-lsa-option; } description"OSPFv3"List of OSPFv3 LSAOption flags list.Options. This list will contain the identities for the OSPFv3 LSAoptionsOptions that are set for the LSA."; } description "OSPFv3 LSAoptions.";Options."; } } grouping ospfv3-lsa-prefix { description "OSPFv3 LSA prefix."; leaf prefix { type inet:ip-prefix; description "LSAPrefix.";prefix."; } container prefix-options { leaf-list prefix-options { type identityref { base ospfv3-prefix-option; } description"OSPFv3"List of OSPFv3 prefixoption flag list.Options. This list will contain the identities for the OSPFv3 options that are set for the OSPFv3 prefix."; } description "Prefix options."; } } grouping ospfv3-lsa-external { description"AS-External and NSSA LSA.";"AS-External-LSA or NSSA-LSA."; leaf metric { type ospf-metric; description"Metric";"AS-External-LSA or NSSA-LSA Metric."; } leaf flags { type bits { bit E { description "When set, the metric specified is a Type 2 external metric."; } bit F { description "When set, aForwarding Addressforwarding address is included in the LSA."; } bit T { description "When set, anExternal Route Tagexternal route tag is included in the LSA."; } } description"Flags.";"AS-External-LSA or NSSA-LSA flags."; } leaf referenced-ls-type { type identityref { base ospfv3-lsa-type; } description "Referenced Link Statetype.";(LS) Type."; reference "RFC 5340: OSPF for IPv6"; } leaf unknown-referenced-ls-type { type uint16; description "Value for an unknown ReferencedLink State type.";LS Type."; } uses ospfv3-lsa-prefix; leaf forwarding-address { type inet:ipv6-address; description"Forwarding"IPv6 Forwarding address."; } leaf external-route-tag { type uint32; description "Route tag."; } leaf referenced-link-state-id { type uint32; description "Referenced Link State ID."; reference "RFC 5340: OSPF for IPv6"; } } grouping ospfv3-lsa-body { description "OSPFv3 LSA body."; container router { when "derived-from-or-self(../../header/type, " + "'ospfv3-router-lsa')" { description "Only applies toRouter LSAs.";Router-LSAs."; } description"Router LSA.";"Router-LSA."; uses ospf-router-lsa-bits; uses ospfv3-lsa-options; container links { description "All routerlink.";links."; list link { description"Router LSA"Router-LSA link."; leaf interface-id { type uint32; description "Interface ID for the link."; } leaf neighbor-interface-id { type uint32; description "Neighbor's Interface ID for the link."; } leaf neighbor-router-id { type rt-types:router-id; description "Neighbor's Router ID for the link."; } leaf type { type router-link-type; description "Link type: 1 - Point-to-Point Link 2 - Transit Network Link 3 -Stub Network LinkReserved for OSPFv3 Links 4 - VirtualLink";Link."; } leaf metric { type uint16; description "LinkMetric.";metric."; } } } } container network { when "derived-from-or-self(../../header/type, " + "'ospfv3-network-lsa')" { description "Only applies toNetwork LSAs.";Network-LSAs."; } description"Network LSA.";"Network-LSA."; uses ospfv3-lsa-options; container attached-routers { description "All attached routers."; leaf-list attached-router { type rt-types:router-id; description "List of the routers attached to the network."; } } } container inter-area-prefix { when "derived-from-or-self(../../header/type, " + "'ospfv3-inter-area-prefix-lsa')" { description "Only applies toInter-Area-Prefix LSAs.";Inter-Area-Prefix-LSAs."; } leaf metric { type ospf-metric; description "Inter-Area PrefixMetric";metric."; } uses ospfv3-lsa-prefix; description"Prefix LSA.";"Prefix-LSA."; } container inter-area-router { when "derived-from-or-self(../../header/type, " + "'ospfv3-inter-area-router-lsa')" { description "Only applies toInter-Area-Router LSAs.";Inter-Area-Router-LSAs."; } uses ospfv3-lsa-options; leaf metric { type ospf-metric; description"AS"Autonomous System Boundary Router (ASBR)Metric.";metric."; } leaf destination-router-id { type rt-types:router-id; description "The Router ID of the ASBR described by the LSA."; } description"Inter-Area-Router LSA.";"Inter-Area-Router-LSA."; } container as-external { when "derived-from-or-self(../../header/type, " + "'ospfv3-as-external-lsa')" { description "Only applies toAS-external LSAs.";AS-External-LSAs."; } uses ospfv3-lsa-external; description"AS-External LSA.";"AS-External-LSA."; } container nssa { when "derived-from-or-self(../../header/type, " + "'ospfv3-nssa-lsa')" { description "Only applies toNSSA LSAs.";NSSA-LSAs."; } uses ospfv3-lsa-external; description"NSSA LSA.";"NSSA-LSA."; } container link { when "derived-from-or-self(../../header/type, " + "'ospfv3-link-lsa')" { description "Only applies toLink LSAs.";Link-LSAs."; } leaf rtr-priority { type uint8; description "Router priority for DR election. A router with a higher priority will be preferred in theelection and aelection. A value of 0 indicates that the router is not eligible to becomeDesignated Routerthe DR orBackup Designated Router (BDR).";BDR."; } uses ospfv3-lsa-options; leaf link-local-interface-address { type inet:ipv6-address; description "The originating router's link-local interface address for the link."; } leaf num-of-prefixes { type uint32; description "Number of prefixes."; } container prefixes { description "All prefixes for the link."; list prefix { description "List of prefixes associated with the link."; uses ospfv3-lsa-prefix; } } description"Link LSA.";"Link-LSA."; } container intra-area-prefix { when "derived-from-or-self(../../header/type, " + "'ospfv3-intra-area-prefix-lsa')" { description "Only applies toIntra-Area-Prefix LSAs.";Intra-Area-Prefix-LSAs."; } description"Intra-Area-Prefix LSA.";"Intra-Area-Prefix-LSA."; leaf referenced-ls-type { type identityref { base ospfv3-lsa-type; } description "ReferencedLink State type.";LS Type."; } leaf unknown-referenced-ls-type { type uint16; description "Value for an unknown ReferencedLink State type.";LS Type."; } leaf referenced-link-state-id { type uint32; description "Referenced Link State ID."; } leaf referenced-adv-router { type rt-types:router-id; description "Referenced Advertising Router."; reference "RFC 5340: OSPF for IPv6"; } leaf num-of-prefixes { type uint16; description "Number of prefixes."; } container prefixes { description "All prefixes in this LSA."; list prefix { description "List of prefixes in this LSA."; uses ospfv3-lsa-prefix; leaf metric { typeospf-metric;uint16; description "PrefixMetric.";metric."; } } } } container router-information { when "derived-from-or-self(../../header/type, " + "'ospfv3-router-information-lsa')" { description "Only applies to Router-Information-LSAs (RFC 7770)."; reference "RFC 7770: Extensions to OSPF for Advertising Optional RouterInformation LSAs (RFC7770).";Capabilities"; } container router-capabilities-tlv { description "Informational and functional routercapabilities";capabilities."; uses router-capabilities-tlv; } container node-tag-tlvs { description "Allnode tag tlvs.";Node Admin Tag TLVs."; list node-tag-tlv { description "Nodetag tlv.";Admin Tag TLV."; uses node-tag-tlv; } } container dynamic-hostname-tlv { description "OSPF DynamicHostname";Hostname TLV."; uses dynamic-hostname-tlv; } container sbfd-discriminator-tlv { description "OSPF S-BFDDiscriminators";Discriminator TLV."; uses sbfd-discriminator-tlv; } description"Router Information LSA.";"Router-Information-LSA."; reference "RFC 7770: Extensions to OSPF for Advertising Optional Router Capabilities"; } } grouping lsa-header { description "Common LSA for OSPFv2 andOSPFv3";OSPFv3."; leaf age { type uint16; mandatory true; description "LSA age."; } leaf type { type identityref { base ospf-lsa-type; } mandatory true; description "LSAtype";type."; } leaf adv-router { type rt-types:router-id; 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 "LSAlengthlength, including the header."; } } grouping ospfv2-lsa { description "OSPFv2LSA -LSA. LSAs are uniquely identified by the <LSA Type,Link-StateLink State ID, Advertising Router>tupletuple, with the sequence number differentiating the LSA instances."; container header { must "(derived-from(type, " + "'ospfv2-opaque-lsa-type') and " + "opaque-id and opaque-type) or " + "(not(derived-from(type, " + "'ospfv2-opaque-lsa-type')) " + "and not(opaque-id) and not(opaque-type))" { description"Opaque type"The opaque-type andIDthe opaque-id only apply toOpaque LSAs.";Opaque-LSAs."; } description "Decoded OSPFv2 LSA header data."; container lsa-options { leaf-list lsa-options { type identityref { base ospfv2-lsa-option; } description"LSA option flags list."List of LSA Options. This list will contain the identities for theidentities for theOSPFv2 LSAoptionsOptions that are set."; } description "LSAoptions.";Options."; } leaf lsa-id { type yang:dotted-quad; mandatory true; description"Link-State"Link State ID."; } leaf opaque-type { type uint8; description"Opaque"Opaque-LSA type."; } leaf opaque-id { type opaque-id; description"Opaque"Opaque-LSA ID."; } uses lsa-header; } container body { description "Decoded OSPFv2 LSA body data."; uses ospfv2-lsa-body; } } grouping ospfv3-lsa { description "Decoded OSPFv3 LSA."; container header { description "Decoded OSPFv3 LSA header data."; leaf lsa-id { type uint32; mandatory true; description "OSPFv3 LSA ID."; } uses lsa-header; } container body { description "Decoded OSPF LSA body data."; uses ospfv3-lsa-body; } } grouping lsa-common { description "Common fields for OSPF LSA representation."; leaf decode-completed { type boolean; description "The OSPF LSA body was successfullydecoded other thandecoded, except for unknown TLVs. UnknownLSAsLSA types and OSPFv2 unknownopaque LSAOpaque-LSA types are not decoded. Additionally, malformed LSAs are generally not accepted and will not be in the Link StateDatabase.";Database (LSDB)."; } leaf raw-data { type yang:hex-string; description "The hexadecimal representation of the complete LSAin network byte order hexadecimalas received ororiginated.";originated, in network byte order."; } } grouping lsa { description "OSPF LSA."; uses lsa-common; choice version { description "OSPFv2 or OSPFv3 LSA body."; container ospfv2 { description "OSPFv2LSA";LSA."; uses ospfv2-lsa; } container ospfv3 { description "OSPFv3LSA";LSA."; uses ospfv3-lsa; } } } grouping lsa-key { description "OSPF LSAkey - thekey. The database key for each LSA of a given type in theLink State DataBase (LSDB).";LSDB."; leaf lsa-id { type union { type yang:dotted-quad; type uint32; } description"Link-State"Link State ID."; } leaf adv-router { type rt-types:router-id; description "Advertising router."; } } grouping instance-stat { description "Per-instancestatistics";statistics."; leaf discontinuity-time { type yang:date-and-time; description "The timeonof the most recent occasion at which any one or more of this OSPF instance's counters suffered a discontinuity. If no such discontinuities have occurred since the OSPF instance was lastre-initialized,reinitialized, then this node contains the time the OSPF instance wasre-initializedreinitialized, which normally occurs when it was created."; } leaf originate-new-lsa-count { type yang:counter32; description "The number of new LSAs originated. Discontinuities in the value of this counter can occur when the OSPF instance isre-initialized.";reinitialized."; } leaf rx-new-lsas-count { type yang:counter32; description "The number of new LSAs received. Discontinuities in the value of this counter can occur when the OSPF instance isre-initialized.";reinitialized."; } leaf as-scope-lsa-count { type yang:gauge32; description "The number ofAS-scopeAS-Scope LSAs."; } leaf as-scope-lsa-chksum-sum { type uint32; description "Themodule 2**32modulo 2^32 sum of the LSA checksums forAS-scopeAS-Scope LSAs. The value should be treated as unsigned when comparing two sums of checksums. While differing checksums indicate a different combination of LSAs, equivalent checksums don't guarantee that the LSAs are thesamesame, given that multiple combinations of LSAs can result in the same checksum."; } container database { description "Container forper AS-scopeper-AS-Scope LSA statistics."; list as-scope-lsa-type { description "List ofAS-scopeAS-Scope LSAstatistics";statistics."; leaf lsa-type { type uint16; description "AS-Scope LSA type."; } leaf lsa-count { type yang:gauge32; description "The number of LSAs ofthethis LSA type."; } leaf lsa-cksum-sum { type uint32; description "Themodule 2**32modulo 2^32 sum of the LSA checksums fortheLSAs of this type. The value should be treated as unsigned when comparing two sums of checksums. While differing checksums indicate a different combination of LSAs, equivalent checksums don't guarantee that the LSAs are thesamesame, given that multiple combinations of LSAs can result in the same checksum."; } } } uses instance-fast-reroute-state; } grouping area-stat { description "Per-area statistics."; leaf discontinuity-time { type yang:date-and-time; description "The timeonof the most recent occasion at which any one or more of this OSPF area's counters suffered a discontinuity. If no such discontinuities have occurred since the OSPF area was lastre-initialized,reinitialized, then this node contains the time the OSPF area wasre-initializedreinitialized, which normally occurs when it was created."; } leaf spf-runs-count { type yang:counter32; description "The number of times the intra-area SPF has run. Discontinuities in the value of this counter can occur when the OSPF area isre-initialized.";reinitialized."; } 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 Boundary Routers(ASBRs).";(ASBRs) reachable within this area."; } leaf ar-nssa-translator-event-count { type yang:counter32; description "The number of NSSA translator-state changes. Discontinuities in the value of this counter can occur when the OSPF area isre-initialized.";reinitialized."; } leaf area-scope-lsa-count { type yang:gauge32; description "The number of area-scope LSAs in the area."; } leaf area-scope-lsa-cksum-sum { type uint32; description "Themodule 2**32modulo 2^32 sum of the LSA checksums for area-scope LSAs. The value should be treated as unsigned when comparing two sums of checksums. While differing checksums indicate a different combination of LSAs, equivalent checksums don't guarantee that the LSAs are thesamesame, given that multiple combinations of LSAs can result in the same checksum."; } container database { description "Container for area-scope LSA type statistics."; list area-scope-lsa-type { description "List of area-scope LSAstatistics";statistics."; leaf lsa-type { type uint16; description "Area-scope LSA type."; } leaf lsa-count { type yang:gauge32; description "The number of LSAs ofthethis LSA type."; } leaf lsa-cksum-sum { type uint32; description "Themodule 2**32modulo 2^32 sum of the LSA checksums fortheLSAs of this type. The value should be treated as unsigned when comparing two sums of checksums. While differing checksums indicate a different combination of LSAs, equivalent checksums don't guarantee that the LSAs are thesamesame, given that multiple combinations of LSAs can result in the same checksum."; } } } } grouping interface-stat { description "Per-interfacestatistics";statistics."; leaf discontinuity-time { type yang:date-and-time; description "The timeonof the most recent occasion at which any one or more of this OSPF interface's counters suffered a discontinuity. If no such discontinuities have occurred since the OSPF interface was lastre-initialized,reinitialized, then this node contains the time the OSPF interface wasre-initializedreinitialized, which normally occurs when it was created."; } leaf if-event-count { type yang:counter32; description "The number of times this interface has changed its state or an error has occurred. Discontinuities in the value of this counter can occur when the OSPF interface isre-initialized.";reinitialized."; } leaf link-scope-lsa-count { type yang:gauge32; description "The number of link-scope LSAs."; } leaf link-scope-lsa-cksum-sum { type uint32; description "Themodule 2**32modulo 2^32 sum of the LSA checksums for link-scope LSAs. The value should be treated as unsigned when comparing two sums of checksums. While differing checksums indicate a different combination of LSAs, equivalent checksums don't guarantee that the LSAs are thesamesame, given that multiple combinations of LSAs can result in the same checksum."; } container database { description "Container for link-scope LSA type statistics."; list link-scope-lsa-type { description "List of link-scope LSAstatistics";statistics."; leaf lsa-type { type uint16; description"Link scope"Link-scope LSA type."; } leaf lsa-count { type yang:gauge32; description "The number of LSAs ofthethis LSA type."; } leaf lsa-cksum-sum { type uint32; description "Themodule 2**32modulo 2^32 sum of the LSA checksums fortheLSAs of this type. The value should be treated as unsigned when comparing two sums of checksums. While differing checksums indicate a different combination of LSAs, equivalent checksums don't guarantee that the LSAs are thesamesame, given that multiple combinations of LSAs can result in the same checksum."; } } } } grouping neighbor-stat { description "Per-neighbor statistics."; leaf discontinuity-time { type yang:date-and-time; description "The timeonof the most recent occasion at which any one or more of this OSPF neighbor's counters suffered a discontinuity. If no such discontinuities have occurred since the OSPF neighbor was lastre-initialized,reinitialized, then this node contains the time the OSPF neighbor wasre-initializedreinitialized, which normally occurs when the neighbor is dynamically discoveredandcreated.";and created."; } leaf nbr-event-count { type yang:counter32; description "The number of times this neighbor has changed state or an error has occurred. Discontinuities in the value of this counter can occur when the OSPF neighbor isre-initialized.";reinitialized."; } leaf nbr-retrans-qlen { type yang:gauge32; description "The current length of the retransmission queue."; } } grouping instance-fast-reroute-config { description "This group defines the global configuration of IP FastReRoute (FRR).";Reroute (IP-FRR)."; container fast-reroute { if-featurefast-reroute;"fast-reroute"; description "This container may be augmented with global parameters for IP-FRR."; container lfa { if-featurelfa;"lfa"; description "This container may be augmented with global parameters for Loop-FreeAlternatives (LFA).Alternates (LFAs). Container creation has no effect on LFA activation."; } } } grouping instance-fast-reroute-state { description "IP-FRR state datagrouping";grouping."; container protected-routes { if-featurefast-reroute;"fast-reroute"; config false; description "Instance protectionstatistics";statistics."; list address-family-stats { key "address-family prefix alternate"; description"Per Address Family"Per-Address-Family (AF) protected prefixinformation";information."; leaf address-family { type iana-rt-types:address-family; description"Address-family";"Address family."; } leaf prefix { type inet:ip-prefix; description "Protected prefix."; } leaf alternate { type inet:ip-address; description "Alternate next hop for the prefix."; } leaf alternate-type { type enumeration { enum equal-cost { description"ECMP"ECMP-based alternate."; } enum lfa { description"LFA"LFA-based alternate."; } enum remote-lfa { description"Remote LFA"Remote-LFA-based alternate."; } enum tunnel { description"Tunnel based"Tunnel-based alternate (like RSVP-TE or GRE)."; } enum ti-lfa { description"TI-LFA alternate.";"An alternate based on Topology-Independent Loop-Free Alternate (TI-LFA)."; } enum mrt { description"MRT alternate.";"An alternate based on Maximally Redundant Trees (MRTs)."; } enum other { description "Unknown alternate type."; } } description "Type of alternate."; } leaf best { type boolean; description "Indicates that this alternate is preferred."; } leaf non-best-reason { type string { length "1..255"; } description "Information field used to describe why the alternate is notbest.";the best choice."; } leaf protection-available { type bits { bit node-protect { position 0; description "Node protection available."; } bit link-protect { position 1; description "Link protection available."; } bit srlg-protect { position 2; description"SRLG"Shared Risk Link Group (SRLG) protection available."; } bit downstream-protect { position 3; description "Downstream protection available."; } bit other { position 4; description "Other protection available."; } } description "Protection provided by the alternate."; } leafalternate-metric1alternate-metric-1 { type uint32; description "Metric from the Point of Local Repair (PLR) to the destination through the alternate path."; } leafalternate-metric2alternate-metric-2 { type uint32; description "Metric from the PLR to the alternatenode";node."; } leafalternate-metric3alternate-metric-3 { type uint32; description "Metric from the alternate node to thedestination";destination."; } } } container unprotected-routes { if-featurefast-reroute;"fast-reroute"; config false; description "List of prefixes that are notprotected";protected."; list address-family-stats { key "address-family prefix"; description"Per Address Family (AF)"Per-AF unprotected prefix statistics."; leaf address-family { type iana-rt-types:address-family; description"Address-family";"Address family."; } leaf prefix { type inet:ip-prefix; description "Unprotected prefix."; } } } list protection-statistics { keyfrr-protection-method;"frr-protection-method"; config false; description "List of protection methodstatistics";statistics."; leaf frr-protection-method { type string; description "Protection method used."; } list address-family-stats { keyaddress-family;"address-family"; description"Per Address Family"Per-AF protection statistics."; leaf address-family { type iana-rt-types:address-family; description"Address-family";"Address family."; } leaf total-routes { type uint32; description "Total prefixes."; } leaf unprotected-routes { type uint32; description "Total prefixes that are not protected."; } leaf protected-routes { type uint32; description "Total prefixes that are protected."; } leaf linkprotected-routes { type uint32; description "Total prefixes that are link protected."; } leaf nodeprotected-routes { type uint32; description "Total prefixes that are node protected."; } } } } grouping interface-fast-reroute-config { description "This group defines interface configuration of IP-FRR."; container fast-reroute { if-featurefast-reroute;"fast-reroute"; container lfa { if-featurelfa;"lfa"; leafcandidate-enablecandidate-enabled { type boolean; defaulttrue;"true"; description"Enable"Enables the interface to be used as a backup."; } leafenableenabled { type boolean; defaultfalse;"false"; description "ActivatesLFA -an LFA. Per-prefix LFA computation is assumed."; } container remote-lfa { if-featureremote-lfa;"remote-lfa"; leafenableenabled { type boolean; defaultfalse;"false"; description "Activates a Remote LFA (R-LFA)."; } description"Remote LFA"R-LFA configuration."; } description "LFA configuration."; } description "InterfaceIP Fast-rerouteIP-FRR configuration."; } } grouping interface-physical-link-config { description "Interface cost configuration that only applies to physical interfaces (non-virtual) and sham links."; leaf cost { type ospf-link-metric; description"Interface"Interface's cost."; } leaf mtu-ignore { if-featuremtu-ignore;"mtu-ignore"; type boolean; description"Enable/Disable"Enables/disables bypassing the MTU mismatch check in Database Description packets as specified in Section 10.6 of RFC2328, section 10.6.";2328."; reference "RFC 2328: OSPF Version 2, Section 10.6"; } leaf prefix-suppression { if-featureprefix-suppression;"prefix-suppression"; type boolean; description"Suppress"Suppresses advertisement of the prefixes associated with the interface."; } } grouping interface-common-config { description "Common configuration for all types of interfaces, including virtual links and sham links."; leaf hello-interval { type uint16; unitsseconds;"seconds"; description "Interval betweenhelloHello packets (seconds). It must be the same for all routers on the same network. Different networks, implementations, and deployments will use differenthello-intervals.Hello intervals. A sample value for a LAN network would be 10 seconds."; reference "RFC 2328: OSPF Version 2, Appendix C.3"; } leaf dead-interval { type uint16; unitsseconds;"seconds"; must"../dead-interval'../dead-interval >../hello-interval"../hello-interval' { error-message "The dead interval must be " + "larger than thehelloHello interval"; description "The value must be greater thanthe'hello-interval'."; } description "Interval after which a neighbor is declared down (seconds) ifhelloHello packets are not received. It is typically 3 or 4 times thehello-interval.'hello-interval' period. A typical value for LAN networks is 40 seconds."; reference "RFC 2328: OSPF Version 2, Appendix C.3"; } leaf retransmit-interval { type uint16 { range "1..3600"; } unitsseconds;"seconds"; description "Interval between retransmitting unacknowledged Link State Advertisements (LSAs) (seconds). This should be well over the round-trip transmit delay for any two routers on the network. A sample value would be 5 seconds."; reference "RFC 2328: OSPF Version 2, Appendix C.3"; } leaf transmit-delay { type uint16; unitsseconds;"seconds"; description "Estimated time needed to transmit Link State Update (LSU) packets on the interface (seconds). LSAs have their age incremented by this amount when advertised on the interface. A sample value would be 1 second."; reference "RFC 2328: OSPF Version 2, Appendix C.3"; } leaf lls { if-featurells;"lls"; type boolean; description"Enable/Disable"Enables/disables link-local signaling (LLS) support."; } container ttl-security { if-featurettl-security;"ttl-security"; description "Time to Live (TTL) securitycheck.";checking."; leafenableenabled { type boolean; description"Enable/Disable"Enables/disables TTL securitycheck.";checking."; } leaf hops { type uint8 { range "1..254"; } default1;"1"; description "Maximum number of hops that an OSPF packet may have traversed before reception."; } } leafenableenabled { type boolean; defaulttrue;"true"; description"Enable/disable"Enables/disables the OSPF protocol on the interface."; } container authentication { description "Authentication configuration."; choice auth-type-selection { description "Options for OSPFv2/OSPFv3 authentication configuration."; case ospfv2-auth { when "derived-from-or-self(../../../../../../rt:type, " + "'ospfv2')" { description "Applied to OSPFv2 only."; } leaf ospfv2-auth-trailer-rfc { if-featureospfv2-authentication-trailer;"ospfv2-authentication-trailer"; type ospfv2-auth-trailer-rfc-version; description "Version ofOSFPv2OSPFv2 authentication trailersupport - RFCsupport. See RFCs 5709orand 7474."; reference "RFC 5709: OSPFv2 HMAC-SHA Cryptographic Authentication RFC7474";7474: Security Extension for OSPFv2 When Using Manual Key Management"; } choice ospfv2-auth-specification { description "Key chain or explicit key parameterspecification";specification."; case auth-key-chain { if-featurekey-chain;"key-chain"; leaf ospfv2-key-chain { type key-chain:key-chain-ref; description"key-chain name.";"Name of the key chain."; } } case auth-key-explicit { leaf ospfv2-key-id { type uint32; description "KeyIdentifier";identifier."; } leaf ospfv2-key { type string; description "OSPFv2 authentication key. The length of the key may be dependent on the cryptographic algorithm."; } leaf ospfv2-crypto-algorithm { type identityref { base key-chain:crypto-algorithm; } description "Cryptographic algorithm associated with the key."; } } } } case ospfv3-auth-ipsec { when "derived-from-or-self(../../../../../../rt:type, " + "'ospfv3')" { description "Applied to OSPFv3 only."; } if-featureospfv3-authentication-ipsec;"ospfv3-authentication-ipsec"; leaf sa { type string; description"Security"Name of the Security Association(SA) name.";(SA)."; } } case ospfv3-auth-trailer { when "derived-from-or-self(../../../../../../rt:type, " + "'ospfv3')" { description "Applied to OSPFv3 only."; } if-featureospfv3-authentication-trailer;"ospfv3-authentication-trailer"; choice ospfv3-auth-specification { description "Key chain or explicit key parameterspecification";specification."; case auth-key-chain { if-featurekey-chain;"key-chain"; leaf ospfv3-key-chain { type key-chain:key-chain-ref; description"key-chain name.";"Name of the key chain."; } } case auth-key-explicit { leaf ospfv3-sa-id { type uint16; description "Security Association (SA)Identifier";Identifier."; } leaf ospfv3-key { type string; description "OSPFv3 authentication key. The length of the key may be dependent on the cryptographic algorithm."; } leaf ospfv3-crypto-algorithm { type identityref { base key-chain:crypto-algorithm; } description "Cryptographic algorithm associated with the key."; } } } } } } } grouping interface-config { description "Configuration forreal interfaces.";normal OSPF interfaces (not virtual or sham interfaces)."; leaf interface-type { type enumeration { enum"broadcast"broadcast { description"Specify"Specifies an OSPF broadcast multi-access network."; } enum"non-broadcast"non-broadcast { description"Specify"Specifies an OSPF Non-Broadcast Multi-Access (NBMA) network."; } enum"point-to-multipoint"point-to-multipoint { description"Specify"Specifies an OSPF point-to-multipoint network."; } enum"point-to-point"point-to-point { description"Specify"Specifies an OSPF point-to-point network."; } enum"hybrid"hybrid { if-featurehybrid-interface;"hybrid-interface"; description"Specify"Specifies an OSPF hybridbroadcast/P2MPbroadcast / point-to-multipoint network."; } } description "Interface type."; } leaf passive { type boolean; description"Enable/Disable passive interface -"Enables/disables a passive interface. A passive interface's prefix will beadvertisedadvertised, but no neighbor adjacencies will be formed on the interface."; } leaf demand-circuit { if-featuredemand-circuit;"demand-circuit"; type boolean; description"Enable/Disable"Enables/disables a demand circuit."; } leaf priority { type uint8; description"Configure"Configures OSPF router priority.OnIn a multi-accessnetworknetwork, this value is for Designated Router (DR) election. The priority is ignored on other interface types. A router with a higher priority will be preferred in theelection and aelection. A value of 0 indicates that the router is not eligible to becomeDesignated Routerthe DR or BackupDesignated RouterDR (BDR)."; } container multi-areas { if-featuremulti-area-adj;"multi-area-adj"; description "Container for multi-areaconfig.";configuration."; list multi-area { keymulti-area-id;"multi-area-id"; description"Configure"Configures an OSPF multi-area adjacency."; leaf multi-area-id { type area-id-type; description "Multi-area adjacency area ID."; } leaf cost { type ospf-link-metric; description "Interface cost for a multi-area adjacency."; } } } container static-neighbors { description "Statically configured neighbors."; list neighbor { key "identifier"; description"Specify"Specifies a static OSPF neighbor."; leaf identifier { type inet:ip-address; description"Neighbor"Neighbor's Router ID, IPv4 address, or IPv6 address."; } leaf cost { type ospf-link-metric; description"Neighbor"Interface cost. Different implementations have different defaultcostscosts, with some defaulting to a cost inversely proportional to the interface speed. Others will default to11, equating the cost to a hopcount." ;count."; } leaf poll-interval { type uint16; unitsseconds;"seconds"; description"Neighbor"Neighbor's poll interval (seconds) for sending OSPFhelloHello packets to discover the neighbor on NBMA networks. This interval dictates the granularity for discovery of new neighbors. A sample would be 120 seconds (2 minutes) for a legacy Packet Data Network (PDN) X.25 network."; reference "RFC 2328: OSPF Version 2, Appendix C.5"; } leaf priority { type uint8; description"Neighbor"Neighbor's priority for DR election. A router with a higher priority will be preferred in theelection and aelection. A value of 0 indicates that the router is not eligible to becomeDesignated Routerthe DR orBackup Designated Router (BDR).";BDR."; } } } leaf node-flag { if-featurenode-flag;"node-flag"; type boolean; defaultfalse;"false"; description"Set"Sets the prefix as identifying the advertising router."; reference "RFC 7684: OSPFv2 Prefix/Link Attribute Advertisement"; } container bfd { if-featurebfd;"bfd"; description "BFDClient Configuration.";interface configuration."; uses bfd-types:client-cfg-parms; reference "RFCYYYY:5880: Bidirectional Forwarding Detection (BFD) RFC 5881: Bidirectional Forwarding Detection (BFD) for IPv4 and IPv6 (Single Hop) RFC 9314: YANG Data Model for Bidirectional Forwarding Detection(BFD). Please replace YYYY with published RFC number for draft-ietf-bfd-yang.";(BFD)"; } uses interface-fast-reroute-config; uses interface-common-config; uses interface-physical-link-config; } grouping neighbor-state { description "OSPF neighbor operational state."; leaf address { type inet:ip-address; config false; description"Neighbor"Neighbor's address."; } leaf dr-router-id { type rt-types:router-id; config false; description "Neighbor'sDesignated Router (DR)DR Router ID."; } leaf dr-ip-addr { type inet:ip-address; config false; description "Neighbor'sDesignated Router (DR)DR IP address."; } leaf bdr-router-id { type rt-types:router-id; config false; description "Neighbor'sBackup Designated Router (BDR)BDR Router ID."; } leaf bdr-ip-addr { type inet:ip-address; config false; description "Neighbor'sBackup Designated Router (BDR)BDR IPAddress.";address."; } leaf state { type nbr-state-type; config false; description "OSPF neighbor state."; } leaf cost { type ospf-link-metric; config false; description "Cost to reach the neighbor forPoint-to-Multipointpoint-to-multipoint and Hybridnetworks";networks."; } leaf dead-timer { type rt-types:timer-value-seconds16; config false; description "This timer tracks the remaining time before the neighbor is declared dead."; } container statistics { config false; description "Per-neighborstatistics";statistics."; uses neighbor-stat; } } grouping interface-common-state { description "OSPF interface common operational state."; reference"RFC2328 Section 9:"RFC 2328: OSPFVersion2 - The Interface Data Structure";Version 2, Section 9"; leaf state { type if-state-type; config false; description "Interface state."; } leaf hello-timer { type rt-types:timer-value-seconds16; config false; description "This timer tracks the remaining time before the nexthelloHello packet is sent on the interface."; } leaf wait-timer { type rt-types:timer-value-seconds16; config false; description "This timer tracks the remaining time before the interface exits theWaiting'Waiting' state."; } leaf dr-router-id { type rt-types:router-id; config false; description"Designated Router (DR)"DR Router ID."; } leaf dr-ip-addr { type inet:ip-address; config false; description"Designated Router (DR)"DR IP address."; } leaf bdr-router-id { type rt-types:router-id; config false; description"Backup Designated Router (BDR)"BDR Router ID."; } leaf bdr-ip-addr { type inet:ip-address; config false; description"Backup Designated Router (BDR)"BDR IPAddress.";address."; } container statistics { config false; description "Per-interfacestatistics";statistics."; uses interface-stat; } container neighbors { config false; description "All neighbors for the interface."; list neighbor { key "neighbor-router-id"; description "List of interface OSPF neighbors."; leaf neighbor-router-id { type rt-types:router-id; description"Neighbor"Neighbor's Router ID."; } uses neighbor-state; } } container database { config false; description "Link-scopeLink State Database.";LSDB."; list link-scope-lsa-type { key "lsa-type"; description "List of OSPF link-scope LSAs."; leaf lsa-type { type uint16; description "OSPF link-scope LSA type."; } container link-scope-lsas { description "All link-scope LSAs of this LSA type."; list link-scope-lsa { key "lsa-id adv-router"; description "List of OSPF link-scopeLSAs";LSAs."; uses lsa-key; uses lsa { refine "version/ospfv2/ospfv2" { must "derived-from-or-self( " + "../../../../../../../../../../" + "rt:type, 'ospfv2')" { description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../../../../../" + "rt:type, 'ospfv3')" { description "OSPFv3 LSA."; } } } } } } } } grouping interface-state { description "OSPF interface operational state."; reference"RFC2328 Section 9:"RFC 2328: OSPFVersion2 - The Interface Data Structure";Version 2, Section 9"; uses interface-common-state; } grouping virtual-link-config { description "OSPF virtual link configuration state."; uses interface-common-config; } grouping virtual-link-state { description "OSPF virtual link operational state."; leaf cost { type ospf-link-metric; config false; description "Virtual linkinterfaceinterface's cost."; } uses interface-common-state; } grouping sham-link-config { 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."; uses interface-common-state; } grouping address-family-area-config { description "OSPFaddress-family specificaddress-family-specific areaconfigconfiguration state."; container ranges { description "Container for summaryranges";ranges."; list range { key "prefix"; description"Summarize"Summarizes routes matchingaddress/mask -the address/mask. Applicable to Area Border Routers (ABRs) only."; leaf prefix { type inet:ip-prefix; description "IPv4 or IPv6prefix";prefix."; } leaf advertise { type boolean; description "Advertise or hide."; } leaf cost { type ospf-metric; description "Advertised cost of a summary route."; } } } } grouping area-common-config { description "OSPF area common configuration state."; leaf summary { when "derived-from(../area-type,'stub-nssa-area')" { description "Summary advertisement into thestub/NSSA area.";stub area or NSSA."; } type boolean; description"Enable/Disable"Enables/disables summary advertisement into the stub area orNSSA area.";NSSA."; } leaf default-cost { when "derived-from(../area-type,'stub-nssa-area')" { description "Cost for the LSA default route advertised into the stub area orNSSA area.";NSSA."; } type ospf-metric; description"Set"Sets the summary default route cost for a stub area orNSSA area.";NSSA."; } } grouping area-config { description "OSPF area configuration state."; leaf area-type { type identityref { base area-type; } defaultnormal-area;"normal-area"; description "Area type."; } uses area-common-config; uses address-family-area-config; } grouping area-state { description "OSPF area operational state."; container statistics { config false; description "Per-areastatistics";statistics."; uses area-stat; } container database { config false; description "Area-scopeLink State Database.";LSDB."; list area-scope-lsa-type { key "lsa-type"; description "List of OSPF area-scope LSAs."; leaf lsa-type { type uint16; description "OSPF area-scope LSA type."; } container area-scope-lsas { description "All area-scopeLSAs of an area-scope LSA type.";LSAs."; list area-scope-lsa { key "lsa-id adv-router"; description "List of OSPF area-scopeLSAs";LSAs."; uses lsa-key; uses lsa { refine "version/ospfv2/ospfv2" { must "derived-from-or-self( " + "../../../../../../../../" + "rt:type, 'ospfv2')" { description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../../../" + "rt:type, 'ospfv3')" { description "OSPFv3 LSA."; } } } } } } } } grouping local-rib { description"Local-rib -"Local RIB. RIB forRoutesroutes computed by the local OSPF routing instance."; container local-rib { config false; description"Local-rib.";"Local RIB."; list route { key "prefix"; description"Routes";"OSPF instance's Local Routes."; leaf prefix { type inet:ip-prefix; description "Destination prefix."; } container next-hops { description "Next hops for the route."; list next-hop {key "next-hop";description "List of next hops for theroute";route."; leaf outgoing-interface { type if:interface-ref; description "Name of the outgoing interface."; } leaf next-hop { type inet:ip-address; description"Next hop address.";"Address of the next hop."; } } } leaf metric { type uint32; description "Metric for this route."; } leaf route-type { type route-type; description "Route type for this route."; } leaf route-tag { type uint32; description "Route tag for this route."; } } } } grouping ietf-spf-delay { leaf initial-delay { type uint32; unitsmilliseconds;"milliseconds"; default "50"; description "Delay used while inQUIETthe 'QUIET' state (milliseconds)."; } leaf short-delay { type uint32; unitsmilliseconds;"milliseconds"; default "200"; description "Delay used while inSHORT_WAITthe 'SHORT_WAIT' state (milliseconds)."; } leaf long-delay { type uint32; unitsmilliseconds;"milliseconds"; default "5000"; description "Delay used while inLONG_WAITthe 'LONG_WAIT' state (milliseconds)."; } leaf hold-down { type uint32; unitsmilliseconds;"milliseconds"; default "10000"; description"Timer used to consider an IGP stability"This timer value defines the period without any changes for the IGP to be considered stable (milliseconds)."; } leaf time-to-learn { type uint32; unitsmilliseconds;"milliseconds"; default "500"; description "Duration used to learn all the IGP events related to a singlecomponent failurenetwork event (milliseconds)."; } leaf current-state { type enumeration { enum"quiet"quiet { description"QUIET state";"'QUIET' state."; } enum"short-wait"short-wait { description"SHORT_WAIT state";"'SHORT_WAIT' state."; } enum"long-wait"long-wait { description"LONG_WAIT state";"'LONG_WAIT' state."; } } config false; description "Current SPF back-off algorithm state."; } leaf remaining-time-to-learn { type rt-types:timer-value-milliseconds; config false; description "Remaining time until the time-to-learn timer fires."; } leaf remaining-hold-down { type rt-types:timer-value-milliseconds; config false; description "Remaining time until the hold-down timer fires."; } leaf last-event-received { type yang:timestamp; config false; description "Time of the last SPF triggering event."; } leaf next-spf-time { type yang:timestamp; config false; description "Time when the next SPF has been scheduled."; } leaf last-spf-time { type yang:timestamp; config false; description "Time of the last SPF computation."; } description "Grouping for IETF SPF delay configuration andstate";state."; reference "RFC 8405: Shortest Path First (SPF) Back-Off Delay Algorithm for Link-State IGPs"; } grouping node-tag-config { description "OSPF node tagconfigconfiguration state."; container node-tags { if-featurenode-tag;"node-tag"; list node-tag { keytag;"tag"; leaf tag { type uint32; description "Node tag value."; } description "List of node tags."; } description "Container for nodeadminadministrative tags."; } } grouping instance-config { description "OSPF instanceconfigconfiguration state."; leafenableenabled { type boolean; defaulttrue;"true"; description"Enable/Disable"Enables/disables the protocol."; } leaf explicit-router-id { if-featureexplicit-router-id;"explicit-router-id"; type rt-types:router-id; description "Defined in RFC 2328. A 32-bit number that uniquely identifies the router."; reference "RFC 2328: OSPF Version 2"; } container preference { description "Route preference configuration. In many implementations, preference is referred to as administrative distance."; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; choice scope { description "Options for expressing preference as single or multiple values."; case single-value { leaf all { type uint8; description "Preference for intra-area, inter-area, and external routes."; } } case multi-values { choice granularity { description "Options for expressing preference for intra-area and inter-area routes."; case detail { leaf intra-area { type uint8; description "Preference for intra-area routes."; } leaf inter-area { type uint8; description "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 AS external and NSSA routes."; } } } } container nsr { if-featurensr;"nsr"; description "Non-Stop Routing (NSR)configconfiguration state."; leafenableenabled { type boolean; description"Enable/Disable"Enables/disables NSR."; } } container graceful-restart { if-featuregraceful-restart;"graceful-restart"; description "Graceful restartconfigconfiguration state."; reference "RFC 3623:OSPFGraceful OSPF Restart RFC 5187: OSPFv3 Graceful Restart"; leafenableenabled { type boolean; description"Enable/Disable"Enables/disables graceful restart as defined in RFC 3623 for OSPFv2 and RFC 5187 for OSPFv3."; } leafhelper-enablehelper-enabled { type boolean; description"Enable"Enables graceful restart helper support for restarting routers(RFC 3623(Section 3 of RFC 3623)."; reference "RFC 3623: Graceful OSPF Restart, Section3).";3"; } leaf restart-interval { type uint16 { range "1..1800"; } unitsseconds;"seconds"; default "120"; description "Interval during which to attempt graceful restart prior to failing(RFC 3623 Section B.1) (seconds)";(seconds) (Appendix B.1 of RFC 3623)."; reference "RFC 3623: Graceful OSPF Restart, Appendix B.1"; } leaf helper-strict-lsa-checking { type boolean; description"Terminate"Terminates graceful restart when an LSA topology change is detected(RFC 3623 Section B.2).";(Appendix B.2 of RFC 3623)."; reference "RFC 3623: Graceful OSPF Restart, Appendix B.2"; } } container auto-cost { if-featureauto-cost;"auto-cost"; description "InterfaceAuto-costauto-cost configuration state."; leafenableenabled { type boolean; description"Enable/Disable"Enables/disables interface auto-cost."; } leaf reference-bandwidth { when"../enable"../enabled = 'true'" { description "Only whenauto costauto-cost isenabled";enabled."; } type uint32 { range "1..4294967"; } unitsMbits;"Mbits"; description"Configure"Configures reference bandwidth used to automatically determine interface cost (Mbits). The cost is the reference bandwidth divided by the interfacespeedspeed, with 1 being the minimum cost."; } } container spf-control { leaf paths { if-featuremax-ecmp;"max-ecmp"; type uint16 { range "1..65535"; } description "Maximum number of Equal-Cost Multi-Path (ECMP) paths."; } container ietf-spf-delay { if-featureietf-spf-delay;"ietf-spf-delay"; uses ietf-spf-delay; description "IETF SPF delay algorithm configuration."; } description "SPF calculation control."; } container database-control { leaf max-lsa { if-featuremax-lsa;"max-lsa"; type uint32 { range "1..4294967294"; } description "Maximum number ofLSAsOSPF LSAs the router will accept."; } description "Database maintenance control."; } container stub-router { if-featurestub-router;"stub-router"; description"Set"Sets the maximum metricconfiguration";configuration."; choice trigger { description "Specific triggerswhichthat will enable stub router state."; container always { presence "Enables unconditional stub router support"; description "Unconditional stub router state(advertise(advertises transit links withMaxLinkMetric";'MaxLinkMetric')."; reference "RFC 6987: OSPF Stub Router Advertisement"; } } } container mpls { description "OSPF MPLSconfigconfiguration state."; container te-rid { if-featurete-rid;"te-rid"; description "Stable OSPF Router IPAddressaddress used forTraffic Engineering (TE)";TE."; leaf ipv4-router-id { type inet:ipv4-address; description "Explicitlyconfigure theconfigures a TE IPv4 Router ID."; } leaf ipv6-router-id { type inet:ipv6-address; description "Explicitlyconfigure theconfigures a TE IPv6 Router ID."; } } container ldp { description "OSPF MPLS LDPconfigconfiguration state."; leaf igp-sync { if-featureldp-igp-sync;"ldp-igp-sync"; type boolean; description"Enable"Enables LDP IGP synchronization."; } } } uses instance-fast-reroute-config; uses node-tag-config; } grouping instance-state { description "OSPF instance operational state."; leaf router-id { type rt-types:router-id; config false; description "Defined in RFC 2328. A 32-bit number that uniquely identifies the router."; reference "RFC 2328: OSPF Version 2"; } uses local-rib; container statistics { config false; description "Per-instancestatistics";statistics."; uses instance-stat; } container database { config false; description"AS-scope Link State Database.";"AS-Scope LSDB."; list as-scope-lsa-type { key "lsa-type"; description "List of OSPFAS-scopeAS-Scope LSAs."; leaf lsa-type { type uint16; description "OSPFAS scopeAS-Scope LSA type."; } container as-scope-lsas { description "AllAS-scope of LSAAS-Scope LSAs of this LSA type."; list as-scope-lsa { key "lsa-id adv-router"; description "List of OSPFAS-scope LSAs";AS-Scope LSAs."; uses lsa-key; uses lsa { refine "version/ospfv2/ospfv2" { must "derived-from-or-self( " + "../../../../../../" + "rt:type, 'ospfv2')" { description "OSPFv2 LSA."; } } refine "version/ospfv3/ospfv3" { must "derived-from-or-self( " + "../../../../../../" + "rt:type, 'ospfv3')" { description "OSPFv3 LSA."; } } } } } } } uses spf-log; uses lsa-log; } grouping multi-topology-area-common-config { description "OSPF multi-topology area common configuration state."; leaf summary { when "derived-from(../../../area-type, 'stub-nssa-area')" { description "Summary advertisement into thestub/NSSA area.";stub area or NSSA."; } type boolean; description"Enable/Disable"Enables/disables a summary advertisement into the topology in the stub area orNSSA area.";NSSA."; } leaf default-cost { when "derived-from(../../../area-type, 'stub-nssa-area')" { description "Cost for the LSA default route advertised into the topologyintoin the stub area orNSSA area.";NSSA."; } type ospf-metric; description"Set"Sets the summary default route cost for a stub area orNSSA area.";NSSA."; } } grouping multi-topology-area-config { description "OSPF multi-topology area configuration state."; uses multi-topology-area-common-config; uses address-family-area-config; } grouping multi-topology-state { description "OSPF multi-topology operational state."; uses local-rib; } grouping multi-topology-interface-config { description "OSPF multi-topology configuration state."; leaf cost { type ospf-link-metric; description "Interface cost for this topology."; } } grouping ospfv3-interface-config { description "OSPFv3interface specificinterface-specific configuration state."; leaf instance-id { typeuint8 { range "0 .. 31"; }uint8; default "0"; description "OSPFv3 instance ID."; } } grouping ospfv3-interface-state { description "OSPFv3interface specificinterface-specific operational state."; leaf interface-id { typeuint16;uint32; config false; description "OSPFv3 interface ID."; } } grouping lsa-identifiers { description "The parameters that uniquely identify an LSA."; leaf area-id { type area-id-type; description "AreaID";ID."; } leaf type { type uint16; description "LSA type."; } leaf lsa-id { type union { type inet:ipv4-address; type yang:dotted-quad; } description"Link-State"Link State ID."; } leaf adv-router { type rt-types:router-id; description "LSA advertising router."; } leaf seq-num { type uint32; description "LSA sequence number."; } } grouping spf-log { description "Grouping for the SPF log."; container spf-log { config false; description "This container lists the SPFlog.";log entries."; list event { keyid;"id"; description "List of SPF log entries represented as a wrapping buffer in chronologicalorderorder, with the oldest entry returned first."; leaf id { type uint32; description "Eventidentifier - Purelyidentifier. A purely internal value."; } leaf spf-type { type enumeration { enum full { description"SPF"The SPF computation was for aFullfull SPF."; } enum intra { description"SPF"The SPF computation was only for intra-area routes."; } enum inter { description"SPF"The SPF computation was only for inter-area summary routes."; } enum external { description"SPF"The SPF computation was only for AS external and NSSA routes."; } } description "The SPF computation type for the SPF log entry."; } leaf schedule-timestamp { type yang:timestamp; description "This is the timestamp when the computation was scheduled."; } leaf start-timestamp { type yang:timestamp; description "This is the timestamp when the computation was started."; } leaf end-timestamp { type yang:timestamp; description "This is 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 the LSA log."; container lsa-log { config false; description "This container lists the LSAlog.log entries. Local LSA modifications are also included in the list."; list event { keyid;"id"; description "List of LSA log entries represented as a wrapping buffer in chronologicalorderorder, with the oldestentriesentry returned first."; leaf id { type uint32; description "Eventidentifier -identifier. A purely internal value."; } container lsa { description "This container describes thelogged LSA.";LSA that was logged."; uses lsa-identifiers; } leaf received-timestamp { type yang:timestamp; description "This is the timestamp when the LSA was received. In the case of a local LSA update, the timestamp refers to the LSA origination time."; } leaf reason { type identityref { base lsa-log-reason; } description"This reason"Reason for the LSA log entry."; } } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol" { when "derived-from(rt:type, 'ospf')" { description "This augmentation is only valid for a routing protocol instance of OSPF (type 'ospfv2' or 'ospfv3')."; } description "OSPF protocolietf-routing'ietf-routing' modulecontrol-plane-protocol'control-plane-protocol' augmentation."; container ospf { description "OSPF protocolInstance";instance."; leaf address-family { when "derived-from-or-self(../../rt:type, 'ospfv3')" { description "Only applicable to OSPFv3."; } type iana-rt-types:address-family; description"Address-family"Address family of the instance."; } uses instance-config; uses instance-state; container areas { description "All OSPF areas."; list area { key "area-id"; description "List of OSPFareas";areas."; leaf area-id { type area-id-type; description "AreaID";ID."; } uses area-config; uses area-state; container virtual-links { when "derived-from-or-self(../area-type, 'normal-area') " + "and ../area-id = '0.0.0.0'" { description "Virtual links must be in a backbone area."; } description "All virtual links."; list virtual-link { key "transit-area-id router-id"; description "OSPF virtuallink";link."; leaf transit-area-id { type leafref { path "../../../../area/area-id"; } must "derived-from-or-self(" +"../../../../area[area-id=current()]/area-type, ""../../../../area[area-id=current()]" +"'normal-area')"/area-type, 'normal-area') and " +"../../../../area[area-id=current()]/area-id != ""../../../../area[area-id=current()]" +"'0.0.0.0'""/area-id != '0.0.0.0'" { error-message"Virtual"The virtual link transit area must " +"be non-zero.";"not be the backbone area."; description"Virtual-link"The virtual link transit area must not benon-zero area.";the backbone area (0.0.0.0)."; } description "Virtual link transit area ID."; } leaf router-id { type rt-types:router-id; description "VirtualLinklink remote endpoint Router ID."; } uses virtual-link-config; uses virtual-link-state; } } container sham-links { if-featurepe-ce-protocol;"pe-ce-protocol"; description "All sham links."; list sham-link { key "local-id remote-id"; description "OSPF shamlink";link."; leaf local-id { type inet:ip-address; description "Address of the local shamLinklink endpoint."; } leaf remote-id { type inet:ip-address; description "Address of the remote shamLinklink endpoint."; } uses sham-link-config; uses sham-link-state; } } container interfaces { description "All OSPF interfaces."; list interface { key "name"; description "List of OSPF interfaces."; leaf name { type if:interface-ref; description "Interface name reference."; } uses interface-config; uses interface-state; } } } } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/ospf" { when "derived-from(../rt:type, 'ospf')" { description "This augmentation is only valid for OSPF (type 'ospfv2' or 'ospfv3')."; } if-featuremulti-topology;"multi-topology"; description "OSPF multi-topology instance configuration state augmentation."; container topologies { description "All topologies."; list topology { key "name"; description "OSPFtopology -topology. The OSPF topologyaddress-familyaddress family must coincide with therouting-instance address-family.";routing instance's address family."; leaf name { type leafref { path "../../../../../../rt:ribs/rt:rib/rt:name"; } description "RIB name corresponding to the OSPF topology."; } uses multi-topology-state; } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/ospf/" + "areas/area" { when "derived-from-or-self(../../../rt:type, " + "'ospfv2')" { description "This augmentation is only valid for OSPFv2."; } if-featuremulti-topology;"multi-topology"; description "OSPF multi-topology area configuration state augmentation."; container topologies { description "All topologies for the area."; list topology { key "name"; description "OSPF area topology."; leaf name { type leafref { path "../../../../../../../../" + "rt:ribs/rt:rib/rt:name"; } description "Single topology enabled for this area."; } uses multi-topology-area-config; } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/ospf/" + "areas/area/interfaces/interface" { when "derived-from-or-self(../../../../../rt:type, " + "'ospfv2')" { description "This augmentation is only valid for OSPFv2."; } if-featuremulti-topology;"multi-topology"; description "OSPF multi-topology interface configuration state augmentation."; container topologies { 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 "Single topology enabled on this interface."; } uses multi-topology-interface-config; } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/ospf/" + "areas/area/interfaces/interface" { when "derived-from-or-self(../../../../../rt:type, " + "'ospfv3')" { description "This augmentation is only valid for OSPFv3."; } description "OSPFv3interface specificinterface-specific configuration state augmentation."; uses ospfv3-interface-config; uses ospfv3-interface-state; } grouping route-content { description "This grouping defines OSPF-specific route attributes."; leaf metric { type uint32; description "OSPF route metric."; } leaf tag { type uint32; default "0"; description "OSPF route tag."; } leaf route-type { type route-type; description "OSPF routetype";type."; } } augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" { when "derived-from(rt:source-protocol, 'ospf')" { description "This augmentation is only valid for routes whose source protocol is OSPF."; } description "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 forOSPF internalan OSPF-internal reason, thenerror-tag'error-tag' anderror-app-tag'error-app-tag' should be set toa meaningful value.";values indicating the error."; input { leaf routing-protocol-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory"true";true; description "OSPF protocol instance for which information for neighborsareis to be cleared. If the referenced OSPF instance doesn't exist, then this operation SHALL fail witherror-tagan 'error-tag' setting of 'data-missing' anderror-app-tagan 'error-app-tag' setting of 'routing-protocol-instance-not-found'."; } leaf interface { type if:interface-ref; description "Name of the OSPF interface for which neighbors are to be cleared. If the referenced OSPF interface doesn't exist, then this operation SHALL fail witherror-tagan 'error-tag' setting of 'data-missing' anderror-app-tagan 'error-app-tag' setting of 'ospf-interface-not-found'."; } } } rpc clear-database { description "This RPC request clears a particular OSPF Link State Database. Additionally, all neighbor adjacencies will be forced to the DOWN state and self-originated LSAs will be reoriginated. If the operation fails forOSPF internalan OSPF-internal reason, thenerror-tag'error-tag' anderror-app-tag'error-app-tag' should be set toa meaningful value.";values indicating the error."; input { leaf routing-protocol-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory"true";true; description "OSPF protocol instance whoseLink State DatabaseLSDB is to be cleared. If the referenced OSPF instance doesn't exist, then this operation SHALL fail witherror-tagan 'error-tag' setting of 'data-missing' anderror-app-tagan 'error-app-tag' setting of 'routing-protocol-instance-not-found'."; } } } /* * Notifications */ grouping notification-instance-hdr { description "This grouping describes commoninstance specificinstance-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')"; description"OSPF"Name of the OSPF routing protocolinstance name.";instance."; } leaf address-family { type leafref { path "/rt:routing/" + "rt:control-plane-protocols/rt:control-plane-protocol" + "[rt:name=current()/../routing-protocol-name]/" + "ospf/address-family"; } description "Address family of the OSPF instance."; } } grouping notification-interface { description "This grouping provides interface information fortheOSPFinterface specific notification.";interface-specific notifications."; choice if-link-type-selection { description "Options for linktype.";types."; container interface { description "Normal interface."; leaf interface { type if:interface-ref; description "Interface."; } } container virtual-link { description"virtual-link.";"Virtual link."; leaf transit-area-id { type area-id-type; description "Area ID."; } leaf neighbor-router-id { type rt-types:router-id; description"Neighbor"Neighbor's Router ID."; } } container sham-link { description"sham"Sham link."; leaf area-id { type area-id-type; description "Area ID."; } leaf local-ip-addr { type inet:ip-address; description "Shamlinklink's local address."; } leaf remote-ip-addr { type inet:ip-address; description "Shamlinklink's remote address."; } } } } grouping notification-neighbor { description "This grouping provides the neighbor information forneighbor specificneighbor-specific notifications."; leaf neighbor-router-id { type rt-types:router-id; description"Neighbor"Neighbor's Router ID."; } leaf neighbor-ip-addr { type inet:ip-address; description"Neighbor"Neighbor's address."; } } notification if-state-change { uses notification-instance-hdr; uses notification-interface; leaf state { type if-state-type; description "Interface state."; } description "This notification is sent when an interface state change is detected."; } notification if-config-error { uses notification-instance-hdr; uses notification-interface; leaf packet-source { type inet:ip-address; description "Source address."; } leaf packet-type { type packet-type; description "OSPF packet type."; } leaf error { type enumeration { enum"bad-version"bad-version { description "Bad version."; } enum"area-mismatch"area-mismatch { description "Area mismatch."; } enum"unknown-nbma-nbr"unknown-nbma-nbr { description "Unknown NBMA neighbor."; } enum"unknown-virtual-nbr"unknown-virtual-nbr { description "Unknown virtual link neighbor."; } enum"auth-type-mismatch"auth-type-mismatch { description"Auth"Authentication type mismatch."; } enum"auth-failure"auth-failure { description"Auth"Authentication failure."; } enum"net-mask-mismatch"net-mask-mismatch { description "Network mask mismatch."; } enum"hello-interval-mismatch"hello-interval-mismatch { description "Hello interval mismatch."; } enum"dead-interval-mismatch"dead-interval-mismatch { description "Dead interval mismatch."; } enum"option-mismatch"option-mismatch { description "Option mismatch."; } enum"mtu-mismatch"mtu-mismatch { description "MTU mismatch."; } enum"duplicate-router-id"duplicate-router-id { description "Duplicate Router ID."; } enum"no-error"no-error { description "No error."; } } description "Errorcode.";codes."; } description "This notification is sent when a packet is received indicating an interfaceconfigconfiguration erroris detected.";on the sending OSPF router."; } 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 a 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 rt-types:timer-value-seconds16; description "Remaining time in the current OSPF graceful 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 helper status change is detected."; } notification if-rx-bad-packet { uses notification-instance-hdr; uses notification-interface; leaf packet-source { type inet:ip-address; description "Source address."; } leaf packet-type { type packet-type; description "OSPF packet type."; } description "This notification is sent when an OSPF packet that cannot be parsed is received on an OSPF interface."; } notification lsdb-approaching-overflow { uses notification-instance-hdr; leaf ext-lsdb-limit { type uint32; description "The maximum number of non-defaultAS-external LSAsAS-External-LSA entries that can be stored in theLink State Database.";LSDB."; } description "This notification is sent when the number of LSAs in the router'sLink State DatabaseLSDB has exceeded ninety percent of theAS-externalAS-External-LSA limit(ext-lsdb-limit).";('ext-lsdb-limit')."; } notification lsdb-overflow { uses notification-instance-hdr; leaf ext-lsdb-limit { type uint32; description "The maximum number of non-defaultAS-external LSAsAS-External-LSA entries that can be stored in theLink State Database.";LSDB."; } description "This notification is sent when the number of LSAs in the router'sLink State DatabaseLSDB has exceeded theAS-externalAS-External-LSA limit(ext-lsdb-limit).";('ext-lsdb-limit')."; } notification nssa-translator-status-change { uses notification-instance-hdr; leaf area-id { type area-id-type; description "Area ID."; } leaf status { type nssa-translator-state-type; description "NSSA translator status."; } description "This notification is sent when there is a change in the router's role in translating OSPFNSSA LSAsNSSA-LSAs to OSPFAS-External LSAs.";AS-External-LSAs."; } notification restart-status-change { uses notification-instance-hdr; leaf status { type restart-status-type; description "Restart status."; } leaf restart-interval { type uint16 { range1..1800;"1..1800"; } unitsseconds;"seconds"; default "120"; description "Restart interval."; } leaf exit-reason { type restart-exit-reason-type; description "Restart exit reason."; } description "This notification is sent when the graceful restart state for the router has changed."; } } <CODE ENDS> 4. Security Considerations The YANGmodulesmodule specified in this documentdefinedefines 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 [RFC8446]. TheNETCONFNetwork Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to apre- configuredpreconfigured subset of all available NETCONF or RESTCONF protocol operations and content. There are a number of data nodes defined inietf-ospf.yangthis 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. These are the subtrees and data nodes and their sensitivity/vulnerability: /ospf /ospf/areas/ /ospf/areas/area[area-id] /ospf/virtual-links/ /ospf/virtual-links/virtual-link[transit-area-id router-id] /ospf/areas/area[area-id]/interfaces /ospf/areas/area[area-id]/interfaces/interface[name] /ospf/area/area[area-id]/sham-links /ospf/area/area[area-id]/sham-links/sham-link[local-id remote-id] Writable datanodenodes represent the configuration of each instance, area, virtual link,sham-link,sham link, andinterface. Theseinterface, and they correspond to thefollowingschemanodes: /ospf /ospf/areas/ /ospf/areas/area[area-id] /ospf/virtual-links/ /ospf/virtual-links/virtual-link[transit-area-id router-id] /ospf/areas/area[area-id]/interfaces /ospf/areas/area[area-id]/interfaces/interface[name] /ospf/area/area[area-id]/sham-links /ospf/area/area[area-id]/sham-links/sham-link[local-id remote-id]nodes listed above. For OSPF, the ability to modify OSPF configuration will allow the entire OSPF domain to becompromisedcompromised, including peering with unauthorized routers to misroute traffic or mount a massive Denial- of-Service (DoS) attack. For example, adding OSPF on any unprotected interface could allow an OSPF adjacency to be formed with an unauthorized and malicious neighbor. Once an adjacency is formed, traffic could be hijacked. As a simpler example, aDenial-of-ServiceDoS attack could be mounted by changing the cost of an OSPF interface to be asymmetric such that a hard routing loop ensues. In general, unauthorized modification of most OSPF features will posetheretheir own set of securityrisks and the "Security Considerations"risks. The Security Considerations sections in the respective reference RFCs should be consulted. Some of the readable data nodes inthe ietf-ospf.yangthis 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 exposureThese are the subtrees and data nodes and their sensitivity/vulnerability: /ospf/database /ospf/areas/area[area-id]/database /ospf/virtual-links/virtual-link[transit-area-id router- id]/database /ospf/areas/area[area-id]/interfaces/interface[name]/database /ospf/area/area[area-id]/sham-links/sham-link[local-id remote- id]/database Exposure of the Link State Database (LSDB) will in turn expose the detailed topology of the network. There is a separateLink State DatabaseLSDB for each instance, area, virtual link,sham-link,sham link, and interface. These correspond to thefollowingschemanodes: /ospf/database /ospf/areas/area[area-id]/database /ospf/virtual-links/virtual-link[transit-area-id router- id]/database /ospf/areas/area[area-id]/interfaces/interface[name]/database /ospf/area/area[area-id]/sham-links/sham-link[local-id remote- id]/databasenodes listed above. Exposure of theLink State DatabaseLSDB includes information beyond the scope of the OSPFrouter and thisrouter. This may beundesirableundesirable, since exposure may facilitate other attacks. Additionally, in the case of an area LSDB, the complete IP network topology and, if deployed, thetraffic engineeringTE topology of the OSPF area can bereconstucted.reconstructed. Network operators may consider their topologies to be sensitive confidential data. For OSPF authentication, configuration is supported via the specification ofkey-chainskey chains [RFC8177] or the direct specification of a key and an authentication algorithm. Hence, authentication configuration using the"auth-table-trailer""auth-key-chain" case in the"authentication""ospfv2-auth- specification" or "ospfv3-auth-specification" container inherits the security considerations of [RFC8177]. This includestheconsiderations with respect to the local storage and handling of authentication keys. Additionally, local specification of OSPF authentication keys and the associated authentication algorithm is supported for legacy implementations that do not supportkey-chains [RFC8177]key chains [RFC8177]. It is RECOMMENDED that implementations migrate tokey-chains due thekey chains because of (1) seamless support of key and algorithm rollover,as well as, the hexadecimal key(2) specificationaffordingof a hexadecimal key, which affords more key entropy, and (3) encryption of keys using the Advanced Encryption Standard (AES) Key Wrap with PaddingAlgorithmalgorithm [RFC5649]. Some of the RPC operations in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. These are the operations and their sensitivity/vulnerability: * The OSPF YANG module supports the "clear-neighbor" and"clear-database""clear- database" RPCs. If access to either of these RPCs is compromised,they can result intemporary network outages can be employed to mount DoSattacks.attacks as a result. The actual authentication key data (whether locally specified or part of akey-chain)key chain) is sensitive and needs to be kept secret from unauthorized parties; compromise of the key data would allow an attacker to forge OSPF traffic that would be accepted as authentic, potentially compromising theentiretyentire OSPF domain. 5. IANA Considerations This document registers a URI in theIETF"IETF XMLregistryRegistry" [RFC3688]. Following the format in [RFC3688], the following registrationis requested to behas been made: URI: urn:ietf:params:xml:ns:yang:ietf-ospf Registrant Contact: The IESG. XML:N/A,N/A; the requested URI is an XML namespace. This document registers a YANG module in theYANG"YANG ModuleNamesNames" registry [RFC6020].name:Name: ietf-ospfnamespace:Namespace: urn:ietf:params:xml:ns:yang:ietf-ospfprefix:Prefix: ospfreference:Reference: RFCXXXX9129 6.Acknowledgements The authors wish to thank Yi Yang, Alexander Clemm, Gaurav Gupta, Ladislav Lhotka, Stephane Litkowski, Greg Hankins, Manish Gupta, Michael Darwish, and Alan Davey for their thorough reviews and helpful comments. Thanks to Tom Petch for last call review and improvement of the document organization. Thanks to Alvaro Retana for AD comments. Thanks to Benjamin Kaduk, Suresh Krishnan, and Roman Dannyliw for IESG review comments. This document was produced using Marshall Rose's xml2rfc tool. Author affiliation with The MITRE Corporation is provided for identification purposes only, and is not intended to convey or imply MITRE's concurrence with, or support for, the positions, opinions or viewpoints expressed. MITRE has approved this document for Public Release, Distribution Unlimited, with Public Release Case Number 18-3194. 7.References7.1.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-17 (work in progress), August 2018.[RFC1765] Moy, J., "OSPF Database Overflow", RFC 1765, DOI 10.17487/RFC1765, March 1995, <https://www.rfc-editor.org/info/rfc1765>. [RFC1793] Moy, J., "Extending OSPF to Support Demand Circuits", RFC 1793, DOI 10.17487/RFC1793, April 1995, <https://www.rfc-editor.org/info/rfc1793>. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <https://www.rfc-editor.org/info/rfc2119>. [RFC2328] Moy, J., "OSPF Version 2", STD 54, RFC 2328, DOI 10.17487/RFC2328, April 1998, <https://www.rfc-editor.org/info/rfc2328>. [RFC3101] Murphy, P., "The OSPF Not-So-Stubby Area (NSSA) Option", RFC 3101, DOI 10.17487/RFC3101, January 2003, <https://www.rfc-editor.org/info/rfc3101>. [RFC3623] Moy, J., Pillay-Esnault, P., and A. Lindem, "Graceful OSPF Restart", RFC 3623, DOI 10.17487/RFC3623, November 2003, <https://www.rfc-editor.org/info/rfc3623>. [RFC3630] Katz, D., Kompella, K., and D. Yeung, "Traffic Engineering (TE) Extensions to OSPF Version 2", RFC 3630, DOI 10.17487/RFC3630, September 2003, <https://www.rfc-editor.org/info/rfc3630>. [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, <https://www.rfc-editor.org/info/rfc3688>. [RFC4552] Gupta, M. and N. Melam, "Authentication/Confidentiality for OSPFv3", RFC 4552, DOI 10.17487/RFC4552, June 2006, <https://www.rfc-editor.org/info/rfc4552>. [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, <https://www.rfc-editor.org/info/rfc4576>. [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, <https://www.rfc-editor.org/info/rfc4577>. [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, <https://www.rfc-editor.org/info/rfc4915>. [RFC4973] Srisuresh, P. and P. Joseph, "OSPF-xTE: Experimental Extension to OSPF for Traffic Engineering", RFC 4973, DOI 10.17487/RFC4973, July 2007, <https://www.rfc-editor.org/info/rfc4973>. [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, <https://www.rfc-editor.org/info/rfc5082>. [RFC5185] Mirtorabi, S., Psenak, P., Lindem, A., Ed., and A. Oswal, "OSPF Multi-Area Adjacency", RFC 5185, DOI 10.17487/RFC5185, May 2008, <https://www.rfc-editor.org/info/rfc5185>. [RFC5187] Pillay-Esnault, P. and A. Lindem, "OSPFv3 Graceful Restart", RFC 5187, DOI 10.17487/RFC5187, June 2008, <https://www.rfc-editor.org/info/rfc5187>. [RFC5250] Berger, L., Bryskin, I., Zinin, A., and R. Coltun, "The OSPF Opaque LSA Option", RFC 5250, DOI 10.17487/RFC5250, July 2008, <https://www.rfc-editor.org/info/rfc5250>. [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, <https://www.rfc-editor.org/info/rfc5286>. [RFC5309] Shen, N., Ed. and A. Zinin, Ed., "Point-to-Point Operation over LAN in Link State Routing Protocols", RFC 5309, DOI 10.17487/RFC5309, October 2008, <https://www.rfc-editor.org/info/rfc5309>. [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, <https://www.rfc-editor.org/info/rfc5329>. [RFC5340] Coltun, R., Ferguson, D., Moy, J., and A. Lindem, "OSPF for IPv6", RFC 5340, DOI 10.17487/RFC5340, July 2008, <https://www.rfc-editor.org/info/rfc5340>. [RFC5613] Zinin, A., Roy, A., Nguyen, L., Friedman, B., and D. Yeung, "OSPF Link-Local Signaling", RFC 5613, DOI 10.17487/RFC5613, August 2009, <https://www.rfc-editor.org/info/rfc5613>. [RFC5642] Venkata, S., Harwani, S., Pignataro, C., and D. McPherson, "Dynamic Hostname Exchange Mechanism for OSPF", RFC 5642, DOI 10.17487/RFC5642, August 2009, <https://www.rfc-editor.org/info/rfc5642>. [RFC5709] Bhatia, M., Manral, V., Fanto, M., White, R., Barnes, M., Li, T., and R. Atkinson, "OSPFv2 HMAC-SHA Cryptographic Authentication", RFC 5709, DOI 10.17487/RFC5709, October 2009, <https://www.rfc-editor.org/info/rfc5709>. [RFC5714] Shand, M. and S. Bryant, "IP Fast Reroute Framework", RFC 5714, DOI 10.17487/RFC5714, January 2010, <https://www.rfc-editor.org/info/rfc5714>. [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, <https://www.rfc-editor.org/info/rfc5838>. [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, <https://www.rfc-editor.org/info/rfc6020>. [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, <https://www.rfc-editor.org/info/rfc6241>. [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, <https://www.rfc-editor.org/info/rfc6242>. [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, <https://www.rfc-editor.org/info/rfc6565>. [RFC6845] Sheth, N., Wang, L., and J. Zhang, "OSPF Hybrid Broadcast and Point-to-Multipoint Interface Type", RFC 6845, DOI 10.17487/RFC6845, January 2013, <https://www.rfc-editor.org/info/rfc6845>. [RFC6860] Yang, Y., Retana, A., and A. Roy, "Hiding Transit-Only Networks in OSPF", RFC 6860, DOI 10.17487/RFC6860, January 2013, <https://www.rfc-editor.org/info/rfc6860>. [RFC6987] Retana, A., Nguyen, L., Zinin, A., White, R., and D. McPherson, "OSPF Stub Router Advertisement", RFC 6987, DOI 10.17487/RFC6987, September 2013, <https://www.rfc-editor.org/info/rfc6987>. [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-editor.org/info/rfc6991>. [RFC7166] Bhatia, M., Manral, V., and A. Lindem, "Supporting Authentication Trailer for OSPFv3", RFC 7166, DOI 10.17487/RFC7166, March 2014, <https://www.rfc-editor.org/info/rfc7166>. [RFC7474] Bhatia, M., Hartman, S., Zhang, D., and A. Lindem, Ed., "Security Extension for OSPFv2 When Using Manual Key Management", RFC 7474, DOI 10.17487/RFC7474, April 2015, <https://www.rfc-editor.org/info/rfc7474>. [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, <https://www.rfc-editor.org/info/rfc7490>. [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, <https://www.rfc-editor.org/info/rfc7684>. [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, <https://www.rfc-editor.org/info/rfc7770>. [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, <https://www.rfc-editor.org/info/rfc7777>. [RFC7884] Pignataro, C., Bhatia, M., Aldrin, S., and T. Ranganath, "OSPF Extensions to Advertise Seamless Bidirectional Forwarding Detection (S-BFD) Target Discriminators", RFC 7884, DOI 10.17487/RFC7884, July 2016, <https://www.rfc-editor.org/info/rfc7884>. [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, <https://www.rfc-editor.org/info/rfc7950>. [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, <https://www.rfc-editor.org/info/rfc8040>. [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <https://www.rfc-editor.org/info/rfc8174>. [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, <https://www.rfc-editor.org/info/rfc8177>. [RFC8294] Liu, X., Qu, Y., Lindem, A., Hopps, C., and L. Berger, "Common YANG Data Types for the Routing Area", RFC 8294, DOI 10.17487/RFC8294, December 2017, <https://www.rfc-editor.org/info/rfc8294>. [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, <https://www.rfc-editor.org/info/rfc8340>. [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, <https://www.rfc-editor.org/info/rfc8341>. [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, <https://www.rfc-editor.org/info/rfc8342>. [RFC8343] Bjorklund, M., "A YANG Data Model for Interface Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, <https://www.rfc-editor.org/info/rfc8343>. [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, <https://www.rfc-editor.org/info/rfc8349>. [RFC8405] Decraene, B., Litkowski, S., Gredler, H., Lindem, A., Francois, P., and C. Bowers, "Shortest Path First (SPF) Back-Off Delay Algorithm for Link-State IGPs", RFC 8405, DOI 10.17487/RFC8405, June 2018, <https://www.rfc-editor.org/info/rfc8405>. [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, <https://www.rfc-editor.org/info/rfc8446>. [RFC8476] Tantsura, J., Chunduri, U., Aldrin, S., and P. Psenak, "Signaling Maximum SID Depth (MSD) Using OSPF", RFC 8476, DOI 10.17487/RFC8476, December 2018, <https://www.rfc-editor.org/info/rfc8476>.7.2.[RFC9314] Jethanandani, M., Ed., Rahman, R., Ed., Zheng, L., Ed., Pallagatti, S., and G. Mirsky, "YANG Data Model for Bidirectional Forwarding Detection (BFD)", RFC 9314, DOI 10.17487/RFC9314, September 2022, <https://www.rfc-editor.org/info/rfc9314>. 6.2. Informative References [RFC0905] International Organization for Standardization, "ISO Transport Protocol specification ISO DP 8073", RFC 905, DOI 10.17487/RFC0905, April 1984, <https://www.rfc-editor.org/info/rfc905>. [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, <https://www.rfc-editor.org/info/rfc4750>. [RFC5443] Jork, M., Atlas, A., and L. Fang, "LDP IGP Synchronization", RFC 5443, DOI 10.17487/RFC5443, March 2009, <https://www.rfc-editor.org/info/rfc5443>. [RFC5643] Joyal, D., Ed. and V. Manral, Ed., "Management Information Base for OSPFv3", RFC 5643, DOI 10.17487/RFC5643, August 2009, <https://www.rfc-editor.org/info/rfc5643>. [RFC5649] Housley, R. and M. Dworkin, "Advanced Encryption Standard (AES) Key Wrap with Padding Algorithm", RFC 5649, DOI 10.17487/RFC5649, September 2009, <https://www.rfc-editor.org/info/rfc5649>. [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection (BFD)", RFC 5880, DOI 10.17487/RFC5880, June 2010, <https://www.rfc-editor.org/info/rfc5880>. [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, DOI 10.17487/RFC5881, June 2010, <https://www.rfc-editor.org/info/rfc5881>.Appendix A. Contributors' AddressesAcknowledgments The authors wish to thank Yi Yang, Alexander Clemm, Gaurav Gupta, Ladislav Lhotka, Stephane Litkowski, Greg Hankins, Manish Gupta, Michael Darwish, Alan Davey, and Renato Westphal for their thorough reviews and helpful comments. Thanks to Tom Petch for Last Call review and improvements to the organization of the document. Thanks to Alvaro Retana for AD comments. Thanks to Benjamin Kaduk, Suresh Krishnan, and Roman Danyliw for IESG review comments. Author affiliation with The MITRE Corporation is provided for identification purposes only and is not intended to convey or imply MITRE's concurrence with, or support for, the positions, opinions, or viewpoints expressed. MITRE has approved this document for Public Release, Distribution Unlimited, with Public Release Case Number 18-3194. Contributors Dean Bogdanovic Volta Networks, Inc.EMail:Email: dean@voltanet.io Kiran Koushik Agrahara Sreenivasa Verizon 500 W Dove Rd Southlake, TX 76092USA EMail:United States of America Email: kk@employees.org Authors' Addresses Derek YeungArrcus EMail:Arrcus, Inc. 2077 Gateway Place, Suite 400 San Jose, CA 95110 United States of America Email: derek@arrcus.com Yingzhen Qu Futurewei 2330 Central Expressway Santa Clara, CA 95050USA EMail:United States of America Email: yingzhen.qu@futurewei.com Jeffrey Zhang Juniper Networks 10 Technology Park Drive Westford, MA 01886USA EMail:United States of America Email: zzhang@juniper.net Ing-Wher Chen The MITRE CorporationEMail:Email: ingwherchen@mitre.org Acee Lindem Cisco Systems 301 Midenhall Way Cary, NC 27513EMail:United States of America Email: acee@cisco.com