idnits 2.17.1 draft-rvelucha-bfd-offload-yang-02.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 6 instances of too long lines in the document, the longest one being 3 characters 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 (22 February 2022) is 794 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: 'RFC5880' is defined on line 422, but no explicit reference was found in the text == Unused Reference: 'RFC5881' is defined on line 426, but no explicit reference was found in the text Summary: 1 error (**), 0 flaws (~~), 4 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 22 February 2022 5 Expires: 26 August 2022 7 YANG Data Model for Bidirectional Forwarding Detection (BFD) Hardware 8 Offloaded Session 9 draft-rvelucha-bfd-offload-yang-02 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 26 August 2022. 39 Copyright Notice 41 Copyright (c) 2022 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 Revised BSD License text as 50 described in Section 4.e of the Trust Legal Provisions and are 51 provided without warranty as described in the Revised 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 . . . . . . . . . . . . . . . . . . 3 59 3. BFD IP single-hop-ext hierarchy . . . . . . . . . . . . . . . 3 60 4. BFD IP multi-hop-ext hierarchy . . . . . . . . . . . . . . . 3 61 5. BFD Over LAG-ext hierarchy . . . . . . . . . . . . . . . . . 4 62 6. BFD IP single-hop ext YANG Module . . . . . . . . . . . . . . 4 63 7. BFD IP multi-hop ext YANG Module . . . . . . . . . . . . . . 6 64 8. BFD Over LAG ext YANG Module . . . . . . . . . . . . . . . . 8 65 9. Security Considerations . . . . . . . . . . . . . . . . . . . 9 66 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 67 11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 9 68 12. Normative References . . . . . . . . . . . . . . . . . . . . 10 69 Appendix A. Change log . . . . . . . . . . . . . . . . . . . . . 10 70 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 10 72 1. Introduction 74 This document defines an extension YANG data model to base model 75 [RFC9127] that can be used to manage BFD sessions that are offloaded 76 to hardware. BFD is a network protocol which is used for liveness 77 detection of arbitrary paths between systems. 79 1.1. Requirements Language 81 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 82 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 83 document are to be interpreted as described in BCP 14 [RFC2119] 84 [RFC8174] when, and only when, they appear in all capitals, as shown 85 here. 87 1.2. Tree Diagrams 89 This document uses the graphical representation of data models 90 defined in [RFC8340]. 92 2. Design of the Data Model 94 This yang model which is extension to base BFD yang mode been 95 designed to manage BFD HW offloaded sessions. This new "bfd" 96 container is augmented by all the YANG modules for their respective 97 specific information: 99 1. ietf-bfd-ip-sh-ext.yang augments "/routing/control-plane- 100 protocols/control-plane-protocol/bfd/ip-sh/sessions/session" with 101 the "session-offloaded" leaf for BFD sessions over IP single-hop 102 extension. 104 2. ietf-bfd-ip-mh-ext.yang augments "/routing/control-plane- 105 protocols/control-plane-protocol/bfd/ip-mh/sessions-groups/ 106 session-group" with the "session-offloaded" leaf for BFD sessions 107 over IP multi-hop extension. 109 3. ietf-bfd-lag-ext.yang augments "/routing/control-plane-protocols/ 110 control-plane-protocol/bfd/bfd-lag/sessions/session" with the 111 "ession-offloaded" leaf for BFD sessions over LAG extension. 113 3. BFD IP single-hop-ext hierarchy 115 An "ip-sh-ext" node is added under "bfd" node in control-plane- 116 protocol. The operational state data for each BFD IP single-hop 117 session is under this "ip-sh-ext" node. 119 module: ietf-bfd-ip-sh-ext 120 augment /rt:routing/rt:control-plane-protocols 121 /rt:control-plane-protocol/bfd:bfd/bfd-ip-sh:ip-sh 122 /bfd-ip-sh:sessions/bfd-ip-sh:session: 123 +--rw ip-sh-ext 124 +--ro session-running-ext 125 +--ro session-offloaded? boolean 127 4. BFD IP multi-hop-ext hierarchy 129 An "ip-mh-ext" node is added under "bfd" node in control-plane- 130 protocol. The operational state data for each BFD IP multi-hop 131 session is under this "ip-mh-ext" node. 133 module: ietf-bfd-ip-mh-ext 134 augment /rt:routing/rt:control-plane-protocols 135 /rt:control-plane-protocol/bfd:bfd/bfd-ip-mh:ip-mh 136 /bfd-ip-mh:session-groups/bfd-ip-mh:session-group: 137 +rw session-offloaded? boolean 139 5. BFD Over LAG-ext hierarchy 141 An "lag-ext" node is added under "bfd" node in control-plane- 142 protocol. The operational state data for each BFD Over LAG session 143 is under this "lag-ext" node. 145 module: ietf-bfd-lag-ext 146 augment /rt:routing/rt:control-plane-protocols 147 /rt:control-plane-protocol/bfd:bfd/bfd-lag:lag 148 /bfd-lag:sessions/bfd-lag:session: 149 +rw session-offloaded? boolean 151 6. BFD IP single-hop ext YANG Module 153 This YANG module imports "ietf-bfd-ip-sh" from RFC9127 and augments. 155 file "ietf-bfd-ip-sh-ext@2022-02-22.yang" 156 module ietf-bfd-ip-sh-ext { 157 yang-version 1.1; 158 namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-ip-sh-ext"; 160 prefix "bfd-ip-sh-ext"; 162 import ietf-bfd { 163 prefix "bfd"; 164 reference 165 "RFC 9127: A YANG Data Model for Bidirectional Forwarding 166 Detection (BFD)"; 167 } 169 import ietf-routing { 170 prefix "rt"; 171 reference 172 "RFC 8349: A YANG Data Model for Routing Management 173 (NMDA version)"; 174 } 176 import ietf-bfd-ip-sh { 177 prefix "bfd-ip-sh"; 178 reference 179 "RFC 9127: A YANG Data Model for Bidirectional Forwarding 180 Detection (BFD)"; 181 } 183 organization "IETF BFD Working Group"; 184 contact 185 "WG Web: 186 WG List: 188 Editors: Rajaguru Veluchamy (rvelucha@cisco.com)"; 190 description 191 "This module contains the YANG definition for BFD IP single-hop 192 as per RFC 5881 with some extended info. 194 Copyright (c) 2018 IETF Trust and the persons 195 identified as authors of the code. All rights reserved. 197 Redistribution and use in source and binary forms, with or 198 without modification, is permitted pursuant to, and subject 199 to the license terms contained in, the Simplified BSD License 200 set forth in Section 4.c of the IETF Trust's Legal Provisions 201 Relating to IETF Documents 202 (http://trustee.ietf.org/license-info). 204 This version of this YANG module is part of RFC XXXX; see 205 the RFC itself for full legal notices."; 207 reference 208 "RFC 5881: Bidirectional Forwarding Detection (BFD) 209 for IPv4 and IPv6 (Single Hop) 210 RFC 9127: YANG Data Model for Bidirectional Forwarding 211 Detection (BFD)"; 213 revision 2022-02-18 { 214 description "Initial revision."; 215 reference 216 "RFC XXXX: A YANG data model for BFD IP single-hop extension"; 217 } 219 /* 220 * Augments 221 */ 222 augment "/rt:routing/rt:control-plane-protocols/" 223 + "rt:control-plane-protocol/bfd:bfd/bfd-ip-sh:ip-sh/" 224 + "bfd-ip-sh:sessions/bfd-ip-sh:session" { 226 description "BFD augmentation for IP single-hop-ext"; 227 leaf session-offloaded { 228 type boolean; 229 description 230 "Indicates whether BFD session is running in hardware"; 231 } 232 } 233 } 234 236 7. BFD IP multi-hop ext YANG Module 238 This YANG module imports "ietf-bfd-ip-mh" from RFC9127 and augments. 240 file "ietf-bfd-ip-mh-ext@2022-02-22.yang" 241 module ietf-bfd-ip-mh-ext { 242 yang-version 1.1; 243 namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-ip-mh-ext"; 244 prefix "bfd-ip-mh-ext"; 246 import ietf-bfd { 247 prefix "bfd"; 248 reference 249 "RFC 9127: A YANG Data Model for Bidirectional Forwarding 250 Detection (BFD)"; 251 } 253 import ietf-routing { 254 prefix "rt"; 255 reference 256 "RFC 8349: A YANG Data Model for Routing Management 257 (NMDA version)"; 258 } 260 import ietf-bfd-ip-mh { 261 prefix "bfd-ip-mh"; 262 reference 263 "RFC 9127: A YANG Data Model for Bidirectional Forwarding 264 Detection (BFD)"; 265 } 267 organization "IETF BFD Working Group"; 268 contact 269 "WG Web: 270 WG List: 272 Editors: Rajaguru Veluchamy (rvelucha@cisco.com)"; 274 description 275 "This module contains the YANG definition for BFD IP single-hop 276 as per RFC 5881 with some extended info. 278 Copyright (c) 2018 IETF Trust and the persons 279 identified as authors of the code. All rights reserved. 281 Redistribution and use in source and binary forms, with or 282 without modification, is permitted pursuant to, and subject 283 to the license terms contained in, the Simplified BSD License 284 set forth in Section 4.c of the IETF Trust's Legal Provisions 285 Relating to IETF Documents 286 (http://trustee.ietf.org/license-info). 288 This version of this YANG module is part of RFC XXXX; see 289 the RFC itself for full legal notices."; 291 reference 292 "RFC 5881: Bidirectional Forwarding Detection (BFD) 293 for IPv4 and IPv6 (Single Hop) 294 RFC 9127: YANG Data Model for Bidirectional Forwarding 295 Detection (BFD)"; 297 revision 2022-02-18 { 298 description "Initial revision."; 299 reference 300 "RFC XXXX: A YANG data model for BFD IP single-hop extension"; 301 } 303 /* 304 * Augments 305 */ 306 augment "/rt:routing/rt:control-plane-protocols/" 307 + "rt:control-plane-protocol/bfd:bfd/bfd-ip-mh:ip-mh/" 308 + "bfd-ip-mh:session-groups/bfd-ip-mh:session-group" { 309 description "BFD augmentation for IP multi-hop-ext"; 310 leaf session-offloaded { 311 type boolean; 312 description 313 "Indicates whether BFD session is running in hardware"; 314 } 315 } 316 } 317 319 8. BFD Over LAG ext YANG Module 321 This YANG module imports "ietf-bfd-lag" from RFC9127 and augments. 323 file "ietf-bfd-lag-ext@2022-02-22.yang" 324 module ietf-bfd-lag-ext { 325 yang-version 1.1; 326 namespace "urn:ietf:params:xml:ns:yang:ietf-bfd-lag-ext"; 327 prefix "bfd-lag-ext"; 329 import ietf-bfd { 330 prefix "bfd"; 331 reference 332 "RFC 9127: A YANG Data Model for Bidirectional Forwarding 333 Detection (BFD)"; 334 } 336 import ietf-routing { 337 prefix "rt"; 338 reference 339 "RFC 8349: A YANG Data Model for Routing Management 340 (NMDA version)"; 341 } 343 import ietf-bfd-lag { 344 prefix "bfd-lag"; 345 reference 346 "RFC 9127: A YANG Data Model for Bidirectional Forwarding 347 Detection (BFD)"; 348 } 350 organization "IETF BFD Working Group"; 351 contact 352 "WG Web: 353 WG List: 355 Editors: Rajaguru Veluchamy (rvelucha@cisco.com)"; 357 description 358 "This module contains the YANG definition for BFD IP single-hop 359 as per RFC 5881 with some extended info. 361 Copyright (c) 2018 IETF Trust and the persons 362 identified as authors of the code. All rights reserved. 364 Redistribution and use in source and binary forms, with or 365 without modification, is permitted pursuant to, and subject 366 to the license terms contained in, the Simplified BSD License 367 set forth in Section 4.c of the IETF Trust's Legal Provisions 368 Relating to IETF Documents 369 (http://trustee.ietf.org/license-info). 371 This version of this YANG module is part of RFC XXXX; see 372 the RFC itself for full legal notices."; 374 reference 375 "RFC 5881: Bidirectional Forwarding Detection (BFD) 376 for IPv4 and IPv6 (Single Hop) 377 RFC 9127: YANG Data Model for Bidirectional Forwarding 378 Detection (BFD)"; 380 revision 2022-02-18 { 381 description "Initial revision."; 382 reference 383 "RFC XXXX: A YANG data model for BFD IP single-hop extension"; 384 } 386 /* 387 * Augments 388 */ 389 augment "/rt:routing/rt:control-plane-protocols/" 390 + "rt:control-plane-protocol/bfd:bfd/bfd-lag:lag/" 391 + "bfd-lag:sessions/bfd-lag:session" { 392 description "BFD augmentation for LAG ext"; 393 leaf session-offloaded { 394 type boolean; 395 description 396 "Indicates whether BFD session is running in hardware"; 397 } 398 } 399 } 400 402 9. Security Considerations 404 TBD. 406 10. IANA Considerations 408 None. 410 11. Acknowledgements 412 I would like to thank Vengada Prasad Govindan for his support and 413 guidance on this work. 415 12. Normative References 417 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 418 Requirement Levels", BCP 14, RFC 2119, 419 DOI 10.17487/RFC2119, March 1997, 420 . 422 [RFC5880] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 423 (BFD)", RFC 5880, DOI 10.17487/RFC5880, June 2010, 424 . 426 [RFC5881] Katz, D. and D. Ward, "Bidirectional Forwarding Detection 427 (BFD) for IPv4 and IPv6 (Single Hop)", RFC 5881, 428 DOI 10.17487/RFC5881, June 2010, 429 . 431 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 432 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 433 May 2017, . 435 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 436 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 437 . 439 [RFC9127] Rahman, R., Ed., Zheng, L., Ed., Jethanandani, M., Ed., 440 Pallagatti, S., and G. Mirsky, "YANG Data Model for 441 Bidirectional Forwarding Detection (BFD)", RFC 9127, 442 DOI 10.17487/RFC9127, October 2021, 443 . 445 Appendix A. Change log 447 RFC Editor: Remove this section upon publication as an RFC. 449 Author's Address 451 Rajaguru Veluchamy (editor) 452 Cisco Systems 453 India 454 Email: rvelucha@cisco.com