idnits 2.17.1 draft-qu-mpls-mpls-msd-yang-03.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 : ---------------------------------------------------------------------------- No issues found here. 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 seems to have RFC 2119 boilerplate text. -- The document date (2 February 2022) is 813 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) No issues found here. Summary: 0 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Y. Qu 3 Internet-Draft Futurewei 4 Intended status: Standards Track A. Lindem 5 Expires: 6 August 2022 S. Litkowski 6 Cisco Systems 7 J. Tantsura 8 Juniper 9 2 February 2022 11 A YANG Model for MPLS MSD 12 draft-qu-mpls-mpls-msd-yang-03 14 Abstract 16 This document defines a YANG data module augmenting the IETF MPLS 17 YANG model to provide support for MPLS Maximum SID Depths (MSDs) as 18 defined in RFC 8476 and RFC 8491. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at https://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on 6 August 2022. 37 Copyright Notice 39 Copyright (c) 2022 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 44 license-info) in effect on the date of publication of this document. 45 Please review these documents carefully, as they describe your rights 46 and restrictions with respect to this document. Code Components 47 extracted from this document must include Revised BSD License text as 48 described in Section 4.e of the Trust Legal Provisions and are 49 provided without warranty as described in the Revised BSD License. 51 Table of Contents 53 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2 54 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 55 2. YANG Module for MPLS MSD . . . . . . . . . . . . . . . . . . 3 56 3. Security Considerations . . . . . . . . . . . . . . . . . . . 6 57 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 58 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 59 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 60 6.1. Normative References . . . . . . . . . . . . . . . . . . 7 61 6.2. Informative References . . . . . . . . . . . . . . . . . 9 62 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 64 1. Overview 66 YANG [RFC7950] is a data definition language used to define the 67 contents of a conceptual data store that allows networked devices to 68 be managed using NETCONF [RFC6241] or RESTCONF [RFC8040]. 70 This document defines a YANG data model augmenting the IETF MPLS YANG 71 model [RFC8960], which itself augments [RFC8349], to provide 72 operational state for various MSDs[RFC8662]. 74 The augmentation defined in this document requires support for the 75 MPLS base model[RFC8960] which defines basic MPLS configuration and 76 state. 78 The YANG module in this document conforms to the Network Management 79 Datastore Architecture (NMDA) [RFC8342]. 81 1.1. Requirements Language 83 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 84 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 85 "OPTIONAL" in this document are to be interpreted as described in BCP 86 14 [RFC2119] [RFC8174] when, and only when, they appear in all 87 capitals, as shown here. 89 2. YANG Module for MPLS MSD 91 This document defines a YANG module for MSD extensions 92 [RFC8476][RFC8491] to MPLS base model as defined in [RFC8960]. 94 module: ietf-mpls-msd 95 augment /rt:routing/mpls:mpls: 96 +--ro node-msd 97 +--ro node-msds* [] 98 +--ro msd-type? identityref 99 +--ro msd-value? uint8 100 augment /rt:routing/mpls:mpls/mpls:interfaces/mpls:interface: 101 +--ro link-msd 102 +--ro link-msds* [] 103 +--ro msd-type? identityref 104 +--ro msd-value? uint8 106 file "ietf-mpls-msd@2021-08-02.yang" 107 module ietf-mpls-msd { 108 yang-version 1.1; 109 namespace "urn:ietf:params:xml:ns:yang:ietf-mpls-msd"; 110 prefix mpls-msd; 112 import ietf-routing { 113 prefix rt; 114 reference 115 "RFC 8349: A YANG Data Model for Routing 116 Management (NMDA Version)"; 117 } 119 import ietf-mpls { 120 prefix mpls; 121 reference "RFC 8960: A YANG Data Model for MPLS Base"; 122 } 124 organization 125 "IETF MPLS - MPLS Working Group"; 126 contact 127 "WG Web: 128 WG List: 130 Author: Yingzhen Qu 131 132 Author: Acee Lindem 133 134 Author: Stephane Litkowski 135 136 Author: Jeff Tantsura 137 139 "; 140 description 141 "The YANG module augments the base MPLS model, and it is to 142 manage different types of Maximum SID Depth (MSD). 144 This YANG model conforms to the Network Management 145 Datastore Architecture (NMDA) as described in RFC 8342. 147 Copyright (c) 2021 IETF Trust and the persons identified as 148 authors of the code. All rights reserved. 150 Redistribution and use in source and binary forms, with or 151 without modification, is permitted pursuant to, and subject 152 to the license terms contained in, the Simplified BSD License 153 set forth in Section 4.c of the IETF Trust's Legal Provisions 154 Relating to IETF Documents 155 (https://trustee.ietf.org/license-info). 157 This version of this YANG module is part of RFC XXXX; 158 see the RFC itself for full legal notices. 160 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 161 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 162 'MAY', and 'OPTIONAL' in this document are to be interpreted as 163 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 164 they appear in all capitals, as shown here."; 166 reference "RFC XXXX: YANG Data Model for Segment Routing."; 168 revision 2021-08-02 { 169 description 170 "Initial Version"; 171 reference "RFC XXXX: YANG Data Model for Segment Routing."; 172 } 174 identity msd-base-type { 175 description 176 "Base identity for Maximum SID Depth (MSD) Type"; 177 } 179 identity msd-mpls { 180 base msd-base-type; 181 description 182 "Base MPLS Imposition MSD."; 183 reference 184 "RFC 8491: Singling Maximum SID Depth (MSD) using IS-IS."; 185 } 187 identity msd-erld { 188 base msd-base-type; 189 description 190 "msd-erld is defined to advertise the Entropy Readable 191 Label Depth (ERLD)."; 192 reference 193 "RFC 8662: Entropy Label for Source Packet Routing in 194 Networking (SPRING) Tunnels"; 195 } 197 augment "/rt:routing/mpls:mpls" { 198 description 199 "This module augments MPLS data model (RFC 8960) 200 with node MSD."; 201 container node-msd { 202 config false; 203 description 204 "Maximum SID Depth (MSD) operational state."; 205 list node-msds { 206 leaf msd-type { 207 type identityref { 208 base msd-base-type; 209 } 210 description 211 "MSD types"; 212 } 213 leaf msd-value { 214 type uint8; 215 description 216 "MSD value, in the range of 0-255."; 217 } 218 description 219 "Node MSD is the smallest link MSD supported by 220 the node."; 221 } 222 } 223 } 225 augment "/rt:routing/mpls:mpls/mpls:interfaces/mpls:interface" { 226 description 227 "This module augments MPLS data model (RFC 8960) 228 with link MSD."; 229 container link-msd { 230 config false; 231 description 232 "Maximum SID Depth (MSD) interface operational state."; 233 list link-msds { 234 leaf msd-type { 235 type identityref { 236 base msd-base-type; 237 } 238 description 239 "MSD type"; 240 } 241 leaf msd-value { 242 type uint8; 243 description 244 "MSD value, in the range of 0-255."; 245 } 246 description 247 "List of link MSDs"; 248 } 249 } 250 } 251 } 252 254 3. Security Considerations 256 The YANG modules specified in this document define a schema for data 257 that is designed to be accessed via network management protocols such 258 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 259 is the secure transport layer, and the mandatory-to-implement secure 260 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 261 is HTTPS, and the mandatory-to-implement secure transport is TLS 262 [RFC8446]. 264 The NETCONF Access Control Model (NACM) [RFC8341] provides the means 265 to restrict access for particular NETCONF or RESTCONF users to a pre- 266 configured subset of all available NETCONF or RESTCONF protocol 267 operations and content. 269 There are a number of data nodes defined in the modules that are 270 writable/creatable/deletable (i.e., config true, which is the 271 default). These data nodes may be considered sensitive or vulnerable 272 in some network environments. Write operations (e.g., edit-config) 273 to these data nodes without proper protection can have a negative 274 effect on network operations. 276 Some of the readable data nodes in the modules may be considered 277 sensitive or vulnerable in some network environments. It is thus 278 important to control read access (e.g., via get, get-config, or 279 notification) to these data nodes. These are the subtrees and data 280 nodes and their sensitivity/vulnerability: 282 /rt:routing/mpls:mpls/msd/node-msds 284 /rt:routing/mpls:mpls/msd/link-msds 286 Exposure of the node's maximum SID depth may be useful in mounting 287 a Denial-of-Service (DoS) attach by sending packets to the node 288 that the router can't process. 290 4. IANA Considerations 292 This document registers URIs in the IETF XML registry [RFC3688]. 293 Following the format in [RFC3688], the following registrations is 294 requested to be made: 296 URI: urn:ietf:params:xml:ns:yang:ietf-mpls-msd 297 Registrant Contact: The IESG. 298 XML: N/A, the requested URI is an XML namespace. 300 This document registers the YANG modules in the YANG Module Names 301 registry [RFC6020]. 303 name: ietf-mpls-msd 304 namespace: urn:ietf:params:xml:ns:yang:ietf-mpls-msd 305 prefix: mpls-msd 306 reference: RFC XXXX 308 5. Acknowledgements 310 This document was produced using Marshall Rose's xml2rfc tool. 312 The YANG model was developed using the suite of YANG tools written 313 and maintained by numerous authors. 315 6. References 317 6.1. Normative References 319 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 320 Requirement Levels", BCP 14, RFC 2119, 321 DOI 10.17487/RFC2119, March 1997, 322 . 324 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 325 DOI 10.17487/RFC3688, January 2004, 326 . 328 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 329 the Network Configuration Protocol (NETCONF)", RFC 6020, 330 DOI 10.17487/RFC6020, October 2010, 331 . 333 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 334 and A. Bierman, Ed., "Network Configuration Protocol 335 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 336 . 338 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 339 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 340 . 342 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 343 RFC 7950, DOI 10.17487/RFC7950, August 2016, 344 . 346 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 347 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 348 . 350 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 351 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 352 May 2017, . 354 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 355 Access Control Model", STD 91, RFC 8341, 356 DOI 10.17487/RFC8341, March 2018, 357 . 359 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 360 and R. Wilton, "Network Management Datastore Architecture 361 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 362 . 364 [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for 365 Routing Management (NMDA Version)", RFC 8349, 366 DOI 10.17487/RFC8349, March 2018, 367 . 369 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 370 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 371 . 373 [RFC8476] Tantsura, J., Chunduri, U., Aldrin, S., and P. Psenak, 374 "Signaling Maximum SID Depth (MSD) Using OSPF", RFC 8476, 375 DOI 10.17487/RFC8476, December 2018, 376 . 378 [RFC8491] Tantsura, J., Chunduri, U., Aldrin, S., and L. Ginsberg, 379 "Signaling Maximum SID Depth (MSD) Using IS-IS", RFC 8491, 380 DOI 10.17487/RFC8491, November 2018, 381 . 383 [RFC8960] Saad, T., Raza, K., Gandhi, R., Liu, X., and V. Beeram, "A 384 YANG Data Model for MPLS Base", RFC 8960, 385 DOI 10.17487/RFC8960, December 2020, 386 . 388 6.2. Informative References 390 [RFC8662] Kini, S., Kompella, K., Sivabalan, S., Litkowski, S., 391 Shakir, R., and J. Tantsura, "Entropy Label for Source 392 Packet Routing in Networking (SPRING) Tunnels", RFC 8662, 393 DOI 10.17487/RFC8662, December 2019, 394 . 396 Authors' Addresses 398 Yingzhen Qu 399 Futurewei 400 2330 Central Expressway 401 Santa Clara, CA 95050 402 United States of America 404 Email: yingzhen.qu@futurewei.com 406 Acee Lindem 407 Cisco Systems 408 301 Midenhall Way 409 Cary, NC 27513 410 Email: acee@cisco.com 412 Stephane Litkowski 413 Cisco Systems 415 Email: slitkows.ietf@gmail.com 417 Jeff Tantsura 418 Juniper 420 Email: jefftant.ietf@gmail.com