idnits 2.17.1 draft-qu-mpls-mpls-msd-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 : ---------------------------------------------------------------------------- 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 (August 2, 2021) is 991 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: February 3, 2022 S. Litkowski 6 Cisco Systems 7 J. Tantsura 8 Juniper 9 August 2, 2021 11 A YANG Model for MPLS MSD 12 draft-qu-mpls-mpls-msd-yang-02 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 February 3, 2022. 37 Copyright Notice 39 Copyright (c) 2021 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 44 (https://trustee.ietf.org/license-info) in effect on the date of 45 publication of this document. Please review these documents 46 carefully, as they describe your rights and restrictions with respect 47 to this document. Code Components extracted from this document must 48 include Simplified BSD License text as described in Section 4.e of 49 the Trust Legal Provisions and are provided without warranty as 50 described in the Simplified BSD License. 52 Table of Contents 54 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2 55 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2 56 2. YANG Module for MPLS MSD . . . . . . . . . . . . . . . . . . 2 57 3. Security Considerations . . . . . . . . . . . . . . . . . . . 6 58 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 59 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 60 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 61 6.1. Normative References . . . . . . . . . . . . . . . . . . 7 62 6.2. Informative References . . . . . . . . . . . . . . . . . 9 63 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 65 1. Overview 67 YANG [RFC7950] is a data definition language used to define the 68 contents of a conceptual data store that allows networked devices to 69 be managed using NETCONF [RFC6241] or RESTCONF [RFC8040]. 71 This document defines a YANG data model augmenting the IETF MPLS YANG 72 model [RFC8960], which itself augments [RFC8349], to provide 73 operational state for various MSDs[RFC8662]. 75 The augmentation defined in this document requires support for the 76 MPLS base model[RFC8960] which defines basic MPLS configuration and 77 state. 79 The YANG module in this document conforms to the Network Management 80 Datastore Architecture (NMDA) [RFC8342]. 82 1.1. Requirements Language 84 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 85 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 86 "OPTIONAL" in this document are to be interpreted as described in BCP 87 14 [RFC2119] [RFC8174] when, and only when, they appear in all 88 capitals, as shown here. 90 2. YANG Module for MPLS MSD 92 This document defines a YANG module for MSD extensions 93 [RFC8476][RFC8491] to MPLS base model as defined in [RFC8960]. 95 module: ietf-mpls-msd 96 augment /rt:routing/mpls:mpls: 97 +--ro node-msd 98 +--ro node-msds* [] 99 +--ro msd-type? identityref 100 +--ro msd-value? uint8 101 augment /rt:routing/mpls:mpls/mpls:interfaces/mpls:interface: 102 +--ro link-msd 103 +--ro link-msds* [] 104 +--ro msd-type? identityref 105 +--ro msd-value? uint8 107 file "ietf-mpls-msd@2021-08-02.yang" 108 module ietf-mpls-msd { 109 yang-version 1.1; 110 namespace "urn:ietf:params:xml:ns:yang:ietf-mpls-msd"; 111 prefix mpls-msd; 113 import ietf-routing { 114 prefix rt; 115 reference 116 "RFC 8349: A YANG Data Model for Routing 117 Management (NMDA Version)"; 118 } 120 import ietf-mpls { 121 prefix mpls; 122 reference "RFC 8960: A YANG Data Model for MPLS Base"; 123 } 125 organization 126 "IETF MPLS - MPLS Working Group"; 127 contact 128 "WG Web: 129 WG List: 131 Author: Yingzhen Qu 132 133 Author: Acee Lindem 134 135 Author: Stephane Litkowski 136 137 Author: Jeff Tantsura 138 140 "; 141 description 142 "The YANG module augments the base MPLS model, and it is to 143 manage different types of Maximum SID Depth (MSD). 145 This YANG model conforms to the Network Management 146 Datastore Architecture (NMDA) as described in RFC 8342. 148 Copyright (c) 2021 IETF Trust and the persons identified as 149 authors of the code. All rights reserved. 151 Redistribution and use in source and binary forms, with or 152 without modification, is permitted pursuant to, and subject 153 to the license terms contained in, the Simplified BSD License 154 set forth in Section 4.c of the IETF Trust's Legal Provisions 155 Relating to IETF Documents 156 (https://trustee.ietf.org/license-info). 158 This version of this YANG module is part of RFC XXXX; 159 see the RFC itself for full legal notices. 161 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 162 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 163 'MAY', and 'OPTIONAL' in this document are to be interpreted as 164 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 165 they appear in all capitals, as shown here."; 167 reference "RFC XXXX: YANG Data Model for Segment Routing."; 169 revision 2021-08-02 { 170 description 171 "Initial Version"; 172 reference "RFC XXXX: YANG Data Model for Segment Routing."; 173 } 175 identity msd-base-type { 176 description 177 "Base identity for Maximum SID Depth (MSD) Type"; 178 } 180 identity msd-mpls { 181 base msd-base-type; 182 description 183 "Base MPLS Imposition MSD."; 184 reference 185 "RFC 8491: Singling Maximum SID Depth (MSD) using IS-IS."; 186 } 188 identity msd-erld { 189 base msd-base-type; 190 description 191 "msd-erld is defined to advertise the Entropy Readable 192 Label Depth (ERLD)."; 193 reference 194 "RFC 8662: Entropy Label for Source Packet Routing in 195 Networking (SPRING) Tunnels"; 196 } 198 augment "/rt:routing/mpls:mpls" { 199 description 200 "This module augments MPLS data model (RFC 8960) 201 with node MSD."; 202 container node-msd { 203 config false; 204 description 205 "Maximum SID Depth (MSD) operational state."; 206 list node-msds { 207 leaf msd-type { 208 type identityref { 209 base msd-base-type; 210 } 211 description 212 "MSD types"; 213 } 214 leaf msd-value { 215 type uint8; 216 description 217 "MSD value, in the range of 0-255."; 218 } 219 description 220 "Node MSD is the smallest link MSD supported by 221 the node."; 222 } 223 } 224 } 226 augment "/rt:routing/mpls:mpls/mpls:interfaces/mpls:interface" { 227 description 228 "This module augments MPLS data model (RFC 8960) 229 with link MSD."; 230 container link-msd { 231 config false; 232 description 233 "Maximum SID Depth (MSD) interface operational state."; 234 list link-msds { 235 leaf msd-type { 236 type identityref { 237 base msd-base-type; 238 } 239 description 240 "MSD type"; 241 } 242 leaf msd-value { 243 type uint8; 244 description 245 "MSD value, in the range of 0-255."; 246 } 247 description 248 "List of link MSDs"; 249 } 250 } 251 } 252 } 253 255 3. Security Considerations 257 The YANG modules specified in this document define a schema for data 258 that is designed to be accessed via network management protocols such 259 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 260 is the secure transport layer, and the mandatory-to-implement secure 261 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 262 is HTTPS, and the mandatory-to-implement secure transport is TLS 263 [RFC8446]. 265 The NETCONF Access Control Model (NACM) [RFC8341] provides the means 266 to restrict access for particular NETCONF or RESTCONF users to a pre- 267 configured subset of all available NETCONF or RESTCONF protocol 268 operations and content. 270 There are a number of data nodes defined in the modules that are 271 writable/creatable/deletable (i.e., config true, which is the 272 default). These data nodes may be considered sensitive or vulnerable 273 in some network environments. Write operations (e.g., edit-config) 274 to these data nodes without proper protection can have a negative 275 effect on network operations. 277 Some of the readable data nodes in the modules may be considered 278 sensitive or vulnerable in some network environments. It is thus 279 important to control read access (e.g., via get, get-config, or 280 notification) to these data nodes. These are the subtrees and data 281 nodes and their sensitivity/vulnerability: 283 /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 USA 404 EMail: yingzhen.qu@futurewei.com 406 Acee Lindem 407 Cisco Systems 408 301 Midenhall Way 409 Cary, NC 27513 411 EMail: acee@cisco.com 413 Stephane Litkowski 414 Cisco Systems 416 EMail: slitkows.ietf@gmail.com 418 Jeff Tantsura 419 Juniper 421 EMail: jefftant.ietf@gmail.com