idnits 2.17.00 (12 Aug 2021) /tmp/idnits39452/draft-qu-mpls-mpls-msd-yang-01.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 == Line 105 has weird spacing: '...terface if:...' == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (August 1, 2021) is 293 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 (~~), 4 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 2, 2022 S. Litkowski 6 Cisco Systems 7 J. Tantsura 8 Juniper 9 August 1, 2021 11 A YANG Model for MPLS MSD 12 draft-qu-mpls-mpls-msd-yang-01 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 2, 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 . . . . . . . . . . . . . . . . . . 3 57 3. Security Considerations . . . . . . . . . . . . . . . . . . . 6 58 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 59 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 60 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 61 6.1. Normative References . . . . . . . . . . . . . . . . . . 8 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]. YANG is proving relevant beyond 70 its initial confines, as bindings to other interfaces (e.g., ReST) 71 and encodings other than XML (e.g., JSON) are being defined. 72 Furthermore, YANG data models can be used as the basis for 73 implementation of other interfaces, such as CLI and programmatic 74 APIs. 76 This document defines a YANG data module augmenting the IETF MPLS 77 YANG model [RFC8960], which itself augments [RFC8349], to provide 78 operational state for various MSDs[RFC8662]. 80 The augmentation defined in this document requires support for the 81 MPLS base model[RFC8960] which defines basic MPLS configuration and 82 state. 84 The YANG module in this document conforms to the Network Management 85 Datastore Architecture (NMDA) [RFC8342]. 87 1.1. Requirements Language 89 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 90 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 91 document are to be interpreted as described in [RFC2119]. 93 2. YANG Module for MPLS MSD 95 This document defines a YANG module for MSD extensions 96 [RFC8476][RFC8491] to MPLS base model as defined in [RFC8960]. 98 module: ietf-mpls-msd 99 augment /rt:routing/mpls:mpls: 100 +--ro msd 101 +--ro node-msds* [msd-type] 102 | +--ro msd-type identityref 103 | +--ro msd-value? uint8 104 +--ro link-msds* [interface] 105 +--ro interface if:interface-ref 106 +--ro link-msd* [msd-type] 107 +--ro msd-type identityref 108 +--ro msd-value? uint8 110 file "ietf-mpls-msd@2021-08-01.yang" 111 module ietf-mpls-msd { 112 yang-version 1.1; 113 namespace "urn:ietf:params:xml:ns:yang:ietf-mpls-msd"; 114 prefix mpls-msd; 116 import ietf-routing { 117 prefix rt; 118 reference 119 "RFC 8349: A YANG Data Model for Routing 120 Management (NMDA Version)"; 121 } 123 import ietf-interfaces { 124 prefix if; 125 reference 126 "RFC 8343: A YANG Data Model for Interface 127 Management (NMDA Version)"; 128 } 130 import ietf-mpls { 131 prefix mpls; 132 reference "RFC 8960: A YANG Data Model for MPLS Base"; 133 } 135 organization 136 "IETF MPLS - MPLS Working Group"; 137 contact 138 "WG Web: 139 WG List: 140 Author: Yingzhen Qu 141 142 Author: Acee Lindem 143 144 Author: Stephane Litkowski 145 146 Author: Jeff Tantsura 147 149 "; 150 description 151 "The YANG module augments the base MPLS model, and it is to 152 manage different types of MSDs. 154 This YANG model conforms to the Network Management 155 Datastore Architecture (NMDA) as described in RFC 8342. 157 Copyright (c) 2021 IETF Trust and the persons identified as 158 authors of the code. All rights reserved. 160 Redistribution and use in source and binary forms, with or 161 without modification, is permitted pursuant to, and subject 162 to the license terms contained in, the Simplified BSD License 163 set forth in Section 4.c of the IETF Trust's Legal Provisions 164 Relating to IETF Documents 165 (https://trustee.ietf.org/license-info). 167 This version of this YANG module is part of RFC XXXX; 168 see the RFC itself for full legal notices. 170 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 171 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 172 'MAY', and 'OPTIONAL' in this document are to be interpreted as 173 described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, 174 they appear in all capitals, as shown here."; 176 reference "RFC XXXX: YANG Data Model for Segment Routing."; 178 revision 2021-08-01 { 179 description 180 "Initial Version"; 181 reference "RFC XXXX: YANG Data Model for Segment Routing."; 182 } 184 identity msd-base-type { 185 description 186 "Base identity for MSD Type"; 188 } 190 identity base-mpls-msd { 191 base msd-base-type; 192 description 193 "Base MPLS Imposition MSD."; 194 reference 195 "RFC 8491: Singling MSD using IS-IS."; 196 } 198 identity erld-msd { 199 base msd-base-type; 200 description 201 "ERLD-MSD is defined to advertise the ERLD."; 202 reference 203 "RFC 8662: Entropy Label for Source Packet Routing in 204 Networking (SPRING) Tunnels"; 205 } 207 grouping max-sid-depth { 208 description 209 "Maximum SID Depth (MSD) grouping."; 210 list node-msds { 211 key "msd-type"; 212 leaf msd-type { 213 type identityref { 214 base msd-base-type; 215 } 216 description 217 "MSD types"; 218 } 219 leaf msd-value { 220 type uint8; 221 description 222 "MSD value, in the range of 0-255."; 223 } 224 description 225 "Node MSD is the smallest link MSD supported by 226 the node."; 227 } 228 list link-msds { 229 key "interface"; 230 leaf interface { 231 type if:interface-ref; 232 description 233 "Reference to device interface."; 234 } 235 list link-msd { 236 key "msd-type"; 237 leaf msd-type { 238 type identityref { 239 base msd-base-type; 240 } 241 description 242 "MSD type"; 243 } 244 leaf msd-value { 245 type uint8; 246 description 247 "MSD value, in the range of 0-255."; 248 } 249 description 250 "List of link MSDs"; 251 } 252 description 253 "MSD supported by an individual interface."; 254 } 255 } 257 augment "/rt:routing/mpls:mpls" { 258 description 259 "This module augments MPLS data model (RFC 8960) 260 with MSD."; 261 container msd { 262 config false; 263 description 264 "Maximum SID Depth (MSD) operational state."; 265 uses max-sid-depth; 266 } 267 } 268 } 269 271 3. Security Considerations 273 The YANG modules specified in this document define a schema for data 274 that is designed to be accessed via network management protocols such 275 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 276 is the secure transport layer, and the mandatory-to-implement secure 277 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 278 is HTTPS, and the mandatory-to-implement secure transport is TLS 279 [RFC8446]. 281 The NETCONF Access Control Model (NACM) [RFC8341] provides the means 282 to restrict access for particular NETCONF or RESTCONF users to a pre- 283 configured subset of all available NETCONF or RESTCONF protocol 284 operations and content. 286 There are a number of data nodes defined in the modules that are 287 writable/creatable/deletable (i.e., config true, which is the 288 default). These data nodes may be considered sensitive or vulnerable 289 in some network environments. Write operations (e.g., edit-config) 290 to these data nodes without proper protection can have a negative 291 effect on network operations. 293 Some of the readable data nodes in the modules may be considered 294 sensitive or vulnerable in some network environments. It is thus 295 important to control read access (e.g., via get, get-config, or 296 notification) to these data nodes. These are the subtrees and data 297 nodes and their sensitivity/vulnerability: 299 /rt:routing/mpls:mpls/msd/node-msds 301 /rt:routing/mpls:mpls/msd/link-msds 303 Exposure of the node's maximum SID depth may be useful in mounting 304 a Denial-of-Service (DoS) attach by sending packets to the node 305 that the router can't process. 307 4. IANA Considerations 309 This document registers URIs in the IETF XML registry [RFC3688]. 310 Following the format in [RFC3688], the following registrations is 311 requested to be made: 313 URI: urn:ietf:params:xml:ns:yang:ietf-mpls-msd 314 Registrant Contact: The IESG. 315 XML: N/A, the requested URI is an XML namespace. 317 This document registers the YANG modules in the YANG Module Names 318 registry [RFC6020]. 320 name: ietf-mpls-msd 321 namespace: urn:ietf:params:xml:ns:yang:ietf-mpls-msd 322 prefix: mpls-msd 323 reference: RFC XXXX 325 5. Acknowledgements 327 This document was produced using Marshall Rose's xml2rfc tool. 329 The YANG model was developed using the suite of YANG tools written 330 and maintained by numerous authors. 332 6. References 334 6.1. Normative References 336 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 337 Requirement Levels", BCP 14, RFC 2119, 338 DOI 10.17487/RFC2119, March 1997, 339 . 341 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 342 DOI 10.17487/RFC3688, January 2004, 343 . 345 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 346 the Network Configuration Protocol (NETCONF)", RFC 6020, 347 DOI 10.17487/RFC6020, October 2010, 348 . 350 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 351 and A. Bierman, Ed., "Network Configuration Protocol 352 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 353 . 355 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 356 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 357 . 359 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 360 RFC 7950, DOI 10.17487/RFC7950, August 2016, 361 . 363 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 364 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 365 . 367 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 368 Access Control Model", STD 91, RFC 8341, 369 DOI 10.17487/RFC8341, March 2018, 370 . 372 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 373 and R. Wilton, "Network Management Datastore Architecture 374 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 375 . 377 [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for 378 Routing Management (NMDA Version)", RFC 8349, 379 DOI 10.17487/RFC8349, March 2018, 380 . 382 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 383 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 384 . 386 [RFC8476] Tantsura, J., Chunduri, U., Aldrin, S., and P. Psenak, 387 "Signaling Maximum SID Depth (MSD) Using OSPF", RFC 8476, 388 DOI 10.17487/RFC8476, December 2018, 389 . 391 [RFC8491] Tantsura, J., Chunduri, U., Aldrin, S., and L. Ginsberg, 392 "Signaling Maximum SID Depth (MSD) Using IS-IS", RFC 8491, 393 DOI 10.17487/RFC8491, November 2018, 394 . 396 [RFC8960] Saad, T., Raza, K., Gandhi, R., Liu, X., and V. Beeram, "A 397 YANG Data Model for MPLS Base", RFC 8960, 398 DOI 10.17487/RFC8960, December 2020, 399 . 401 6.2. Informative References 403 [RFC8662] Kini, S., Kompella, K., Sivabalan, S., Litkowski, S., 404 Shakir, R., and J. Tantsura, "Entropy Label for Source 405 Packet Routing in Networking (SPRING) Tunnels", RFC 8662, 406 DOI 10.17487/RFC8662, December 2019, 407 . 409 Authors' Addresses 411 Yingzhen Qu 412 Futurewei 413 2330 Central Expressway 414 Santa Clara, CA 95050 415 USA 417 EMail: yingzhen.qu@futurewei.com 418 Acee Lindem 419 Cisco Systems 420 301 Midenhall Way 421 Cary, NC 27513 423 EMail: acee@cisco.com 425 Stephane Litkowski 426 Cisco Systems 428 EMail: slitkows.ietf@gmail.com 430 Jeff Tantsura 431 Juniper 433 EMail: jefftant.ietf@gmail.com