idnits 2.17.1 draft-rvelucha-bfd-offload-yang-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 2 instances of too long lines in the document, the longest one being 1 character in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document doesn't use any RFC 2119 keywords, yet has text resembling RFC 2119 boilerplate text. -- The document date (26 July 2021) is 1003 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC3688' is defined on line 234, but no explicit reference was found in the text == Unused Reference: 'RFC5880' is defined on line 238, but no explicit reference was found in the text == Unused Reference: 'RFC5881' is defined on line 242, but no explicit reference was found in the text == Unused Reference: 'RFC6020' is defined on line 247, but no explicit reference was found in the text == Unused Reference: 'RFC6241' is defined on line 252, but no explicit reference was found in the text == Unused Reference: 'RFC6242' is defined on line 257, but no explicit reference was found in the text Summary: 1 error (**), 0 flaws (~~), 8 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group V. Rajaguru, Ed. 3 Internet-Draft Cisco Systems 4 Intended status: Standards Track 26 July 2021 5 Expires: 27 January 2022 7 YANG Data Model for Bidirectional Forwarding Detection (BFD) Hardware 8 Offloaded Session 9 draft-rvelucha-bfd-offload-yang-00 11 Abstract 13 This document defines a extension YANG data model that can be used to 14 manage Hardware Offloaded Bidirectional Forwarding Detection (BFD). 16 This document specially talks about BFD sessions that are offloaded 17 to hardware. 19 The YANG modules in this document conform to the Network Management 20 Datastore Architecture (NMDA). 22 Status of This Memo 24 This Internet-Draft is submitted in full conformance with the 25 provisions of BCP 78 and BCP 79. 27 Internet-Drafts are working documents of the Internet Engineering 28 Task Force (IETF). Note that other groups may also distribute 29 working documents as Internet-Drafts. The list of current Internet- 30 Drafts is at https://datatracker.ietf.org/drafts/current/. 32 Internet-Drafts are draft documents valid for a maximum of six months 33 and may be updated, replaced, or obsoleted by other documents at any 34 time. It is inappropriate to use Internet-Drafts as reference 35 material or to cite them other than as "work in progress." 37 This Internet-Draft will expire on 27 January 2022. 39 Copyright Notice 41 Copyright (c) 2021 IETF Trust and the persons identified as the 42 document authors. All rights reserved. 44 This document is subject to BCP 78 and the IETF Trust's Legal 45 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 46 license-info) in effect on the date of publication of this document. 47 Please review these documents carefully, as they describe your rights 48 and restrictions with respect to this document. Code Components 49 extracted from this document must include Simplified BSD License text 50 as described in Section 4.e of the Trust Legal Provisions and are 51 provided without warranty as described in the Simplified BSD License. 53 Table of Contents 55 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 56 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 57 1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 2 58 2. Design of the Data Model . . . . . . . . . . . . . . . . . . 2 59 3. BFD IP single-hop-ext hierarchy . . . . . . . . . . . . . . . 3 60 4. BFD IP single-hop ext YANG Module . . . . . . . . . . . . . . 3 61 5. Security Considerations . . . . . . . . . . . . . . . . . . . 5 62 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 63 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 5 64 8. Normative References . . . . . . . . . . . . . . . . . . . . 5 65 Appendix A. Change log . . . . . . . . . . . . . . . . . . . . . 6 66 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 6 68 1. Introduction 70 This document defines an extension YANG data model to base model 71 [I-D.ietf-bfd-yang] that can be used to manage BFD sessions that are 72 offloaded to hardware. BFD is a network protocol which is used for 73 liveness detection of arbitrary paths between systems. 75 1.1. Requirements Language 77 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 78 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 79 document are to be interpreted as described in BCP 14 [RFC2119] 80 [RFC8174] when, and only when, they appear in all capitals, as shown 81 here. 83 1.2. Tree Diagrams 85 This document uses the graphical representation of data models 86 defined in [RFC8340]. 88 2. Design of the Data Model 90 This yang model which is extension to base BFD yang mode been 91 designed to manage BFD HW offloaded sessions. This new "bfd" 92 container is augmented by all the YANG modules for their respective 93 specific information: 95 1. ietf-bfd-ip-sh-ext.yang augments "/routing/control-plane- 96 protocols/control-plane-protocol/bfd/ip-sh/sessions/session" with 97 the "ip-sh-ext" container for BFD sessions over IP single-hop 98 extension. 100 3. BFD IP single-hop-ext hierarchy 102 An "ip-sh-ext" node is added under "bfd" node in control-plane- 103 protocol. The operational state data for each BFD IP single-hop 104 session is under this "ip-sh-ext" node. 106 module: ietf-bfd-ip-sh-ext 107 augment /rt:routing/rt:control-plane-protocols 108 /rt:control-plane-protocol/bfd:bfd/bfd-ip-sh:ip-sh 109 /bfd-ip-sh:sessions/bfd-ip-sh:session: 110 +--rw ip-sh-ext 111 +--ro session-running-ext 112 +--ro session-offloaded? boolean 114 4. BFD IP single-hop ext YANG Module 116 This YANG module imports "ietf-bfd-ip-sh" from RFCXXX and augments. 118 file "ietf-bfd-ip-sh-ext@2021-07-27.yang" 119 module ietf-bfd-ip-sh-ext { 121 yang-version 1.1; 123 namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh-ext"; 125 prefix "bfd-ip-sh-ext"; 127 // RFC Ed.: replace occurences of XXXX with actual RFC number and 128 // remove this note 130 import ietf-bfd { 131 prefix "bfd"; 132 reference "RFC XXXX: YANG Data Model for BFD"; 133 } 135 import ietf-routing { 136 prefix "rt"; 137 reference 138 "RFC 8349: A YANG Data Model for Routing Management 139 (NMDA version)"; 141 } 143 import ietf-bfd-ip-sh { 144 prefix "bfd-ip-sh"; 145 reference 146 "RFC XXXX: A YANG data model for BFD IP single-hop"; 147 } 149 organization "IETF BFD Working Group"; 150 contact 151 "WG Web: 152 WG List: 154 Editors: Rajaguru Veluchamy (rvelucha@cisco.com)"; 156 description 157 "This module contains the YANG definition for BFD IP single-hop 158 as per RFC 5881 with some extended info. 160 Copyright (c) 2018 IETF Trust and the persons 161 identified as authors of the code. All rights reserved. 163 Redistribution and use in source and binary forms, with or 164 without modification, is permitted pursuant to, and subject 165 to the license terms contained in, the Simplified BSD License 166 set forth in Section 4.c of the IETF Trust's Legal Provisions 167 Relating to IETF Documents 168 (http://trustee.ietf.org/license-info). 170 This version of this YANG module is part of RFC XXXX; see 171 the RFC itself for full legal notices."; 173 reference "RFC XXXX"; 175 revision 2021-07-26 { 176 description "Initial revision."; 177 reference "RFC XXXX: A YANG data model for BFD IP single-hop 178 extension"; 179 } 181 /* 182 * Augments 183 */ 184 augment "/rt:routing/rt:control-plane-protocols/" 185 + "rt:control-plane-protocol/bfd:bfd/bfd-ip-sh:ip-sh/" 186 + "bfd-ip-sh:sessions/bfd-ip-sh:session" { 187 description "BFD augmentation for IP single-hop-ext"; 188 container ip-sh-ext { 189 description "BFD IP single-hop top level container with 190 extension"; 192 container session-running-ext { 193 config "false"; 194 description "BFD IP single-hop extension details"; 195 leaf session-offloaded { 196 type boolean; 197 description "Indicates whether BFD session is running 198 in HW."; 199 } 200 } 201 } 202 } 203 } 204 206 5. Security Considerations 208 TBD. 210 6. IANA Considerations 212 None. 214 7. Acknowledgements 216 I would like to thank Vengada Prasad Govindan for his support and 217 guidance on this work. 219 8. Normative References 221 [I-D.ietf-bfd-yang] 222 Rahman, R., Zheng, L., Jethanandani, M., Pallagatti, S., 223 and G. Mirsky, "YANG Data Model for Bidirectional 224 Forwarding Detection (BFD)", Work in Progress, Internet- 225 Draft, draft-ietf-bfd-yang-17, 2 August 2018, 226 . 229 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 230 Requirement Levels", BCP 14, RFC 2119, 231 DOI 10.17487/RFC2119, March 1997, 232 . 234 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 235 DOI 10.17487/RFC3688, January 2004, 236 . 238 [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 239 (BFD)", RFC 5880, DOI 10.17487/RFC5880, June 2010, 240 . 242 [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 243 (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, 244 DOI 10.17487/RFC5881, June 2010, 245 . 247 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 248 the Network Configuration Protocol (NETCONF)", RFC 6020, 249 DOI 10.17487/RFC6020, October 2010, 250 . 252 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 253 and A. Bierman, Ed., "Network Configuration Protocol 254 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 255 . 257 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 258 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 259 . 261 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 262 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 263 May 2017, . 265 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 266 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 267 . 269 Appendix A. Change log 271 RFC Editor: Remove this section upon publication as an RFC. 273 Author's Address 275 Rajaguru Veluchamy (editor) 276 Cisco Systems 277 India 279 Email: rvelucha@cisco.com