idnits 2.17.1 draft-qu-mpls-mpls-msd-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 : ---------------------------------------------------------------------------- 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 (February 4, 2021) is 1176 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) ** Obsolete normative reference: RFC 5246 (Obsoleted by RFC 8446) ** Obsolete normative reference: RFC 6536 (Obsoleted by RFC 8341) Summary: 2 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: August 8, 2021 S. Litkowski 6 Cisco Systems 7 J. Tantsura 8 Juniper 9 February 4, 2021 11 A YANG Model for MPLS MSD 12 draft-qu-mpls-mpls-msd-yang-00 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 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 August 8, 2021. 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 . . . . . . . . . . . . . . . . . . . . . . . . . 7 61 6.1. Normative References . . . . . . . . . . . . . . . . . . 7 62 6.2. Informative References . . . . . . . . . . . . . . . . . 9 63 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 9 65 1. Overview 67 YANG [RFC6020] [RFC7950] is a data definition language used to define 68 the contents of a conceptual data store that allows networked devices 69 to be managed using NETCONF [RFC6241]. YANG is proving relevant 70 beyond its initial confines, as bindings to other interfaces (e.g., 71 ReST) 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-02-04.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 "RFC 8349: A YANG Data Model for Routing 119 Management (NMDA Version)"; 120 } 122 import ietf-interfaces { 123 prefix if; 124 reference "RFC 8343: A YANG Data Model for Interface 125 Management (NMDA Version)"; 126 } 128 import ietf-mpls { 129 prefix mpls; 130 reference "RFC 8960: A YANG Data Model for MPLS Base"; 131 } 133 organization 134 "IETF MPLS - MPLS Working Group"; 135 contact 136 "WG Web: 137 WG List: 139 Author: Yingzhen Qu 140 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-02-04 { 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"; 187 } 188 identity base-mpls-msd { 189 base msd-base-type; 190 description 191 "Base MPLS Imposition MSD."; 192 reference 193 "RFC 8491: Singling MSD using IS-IS."; 194 } 196 identity erld-msd { 197 base msd-base-type; 198 description 199 "ERLD-MSD is defined to advertise the ERLD."; 200 reference 201 "RFC 8662: Entropy Label for Source Packet Routing in 202 Networking (SPRING) Tunnels"; 203 } 205 grouping max-sid-depth { 206 description 207 "Maximum SID Depth (MSD) grouping."; 208 list node-msds { 209 key "msd-type"; 210 leaf msd-type { 211 type identityref { 212 base msd-base-type; 213 } 214 description 215 "MSD-Types"; 216 } 217 leaf msd-value { 218 type uint8; 219 description 220 "MSD value, in the range of 0-255."; 221 } 222 description 223 "Node MSD is the smallest link MSD supported by 224 the node."; 225 } 226 list link-msds { 227 key "interface"; 228 leaf interface { 229 type if:interface-ref; 230 description 231 "Reference to device interface."; 232 } 233 list link-msd { 234 key "msd-type"; 235 leaf msd-type { 236 type identityref { 237 base msd-base-type; 238 } 239 description 240 "MSD-Types"; 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 description 251 "MSD supported by an individual interface."; 252 } 253 } 255 augment "/rt:routing/mpls:mpls" { 256 description 257 "This module augments MPLS data model (RFC 8960) 258 with MSD."; 259 container msd { 260 config false; 261 description 262 "Maximum SID Depth (MSD) operational state."; 263 uses max-sid-depth; 264 } 265 } 266 } 267 269 3. Security Considerations 271 The YANG modules specified in this document define a schema for data 272 that is designed to be accessed via network management protocols such 273 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 274 is the secure transport layer, and the mandatory-to-implement secure 275 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 276 is HTTPS, and the mandatory-to-implement secure transport is TLS 277 [RFC5246]. 279 The NETCONF access control model [RFC6536] provides the means to 280 restrict access for particular NETCONF or RESTCONF users to a pre- 281 configured subset of all available NETCONF or RESTCONF protocol 282 operations and content. 284 There are a number of data nodes defined in the modules that are 285 writable/creatable/deletable (i.e., config true, which is the 286 default). These data nodes may be considered sensitive or vulnerable 287 in some network environments. Write operations (e.g., edit-config) 288 to these data nodes without proper protection can have a negative 289 effect on network operations. 291 Some of the readable data nodes in the modules may be considered 292 sensitive or vulnerable in some network environments. It is thus 293 important to control read access (e.g., via get, get-config, or 294 notification) to these data nodes. The exposure of the Link State 295 Database (LSDB) will expose the detailed topology of the network. 296 This may be undesirable since both due to the fact that exposure may 297 facilitate other attacks. Additionally, network operators may 298 consider their topologies to be sensitive confidential data. 300 4. IANA Considerations 302 This document registers URIs in the IETF XML registry [RFC3688]. 303 Following the format in [RFC3688], the following registrations is 304 requested to be made: 306 URI: urn:ietf:params:xml:ns:yang:ietf-mpls-msd 307 Registrant Contact: The IESG. 308 XML: N/A, the requested URI is an XML namespace. 310 This document registers the YANG modules in the YANG Module Names 311 registry [RFC6020]. 313 name: ietf-mpls-msd 314 namespace: urn:ietf:params:xml:ns:yang:ietf-mpls-msd 315 prefix: mpls-msd 316 reference: RFC XXXX 318 5. Acknowledgements 320 This document was produced using Marshall Rose's xml2rfc tool. 322 The YANG model was developed using the suite of YANG tools written 323 and maintained by numerous authors. 325 6. References 327 6.1. Normative References 329 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 330 Requirement Levels", BCP 14, RFC 2119, 331 DOI 10.17487/RFC2119, March 1997, 332 . 334 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 335 DOI 10.17487/RFC3688, January 2004, 336 . 338 [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security 339 (TLS) Protocol Version 1.2", RFC 5246, 340 DOI 10.17487/RFC5246, August 2008, 341 . 343 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 344 the Network Configuration Protocol (NETCONF)", RFC 6020, 345 DOI 10.17487/RFC6020, October 2010, 346 . 348 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 349 and A. Bierman, Ed., "Network Configuration Protocol 350 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 351 . 353 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 354 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 355 . 357 [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration 358 Protocol (NETCONF) Access Control Model", RFC 6536, 359 DOI 10.17487/RFC6536, March 2012, 360 . 362 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 363 RFC 7950, DOI 10.17487/RFC7950, August 2016, 364 . 366 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 367 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 368 . 370 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 371 and R. Wilton, "Network Management Datastore Architecture 372 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 373 . 375 [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for 376 Routing Management (NMDA Version)", RFC 8349, 377 DOI 10.17487/RFC8349, March 2018, 378 . 380 [RFC8476] Tantsura, J., Chunduri, U., Aldrin, S., and P. Psenak, 381 "Signaling Maximum SID Depth (MSD) Using OSPF", RFC 8476, 382 DOI 10.17487/RFC8476, December 2018, 383 . 385 [RFC8491] Tantsura, J., Chunduri, U., Aldrin, S., and L. Ginsberg, 386 "Signaling Maximum SID Depth (MSD) Using IS-IS", RFC 8491, 387 DOI 10.17487/RFC8491, November 2018, 388 . 390 [RFC8960] Saad, T., Raza, K., Gandhi, R., Liu, X., and V. Beeram, "A 391 YANG Data Model for MPLS Base", RFC 8960, 392 DOI 10.17487/RFC8960, December 2020, 393 . 395 6.2. Informative References 397 [RFC8662] Kini, S., Kompella, K., Sivabalan, S., Litkowski, S., 398 Shakir, R., and J. Tantsura, "Entropy Label for Source 399 Packet Routing in Networking (SPRING) Tunnels", RFC 8662, 400 DOI 10.17487/RFC8662, December 2019, 401 . 403 Authors' Addresses 405 Yingzhen Qu 406 Futurewei 407 2330 Central Expressway 408 Santa Clara, CA 95050 409 USA 411 EMail: yingzhen.qu@futurewei.com 413 Acee Lindem 414 Cisco Systems 415 301 Midenhall Way 416 Cary, NC 27513 418 EMail: acee@cisco.com 419 Stephane Litkowski 420 Cisco Systems 422 EMail: slitkows.ietf@gmail.com 424 Jeff Tantsura 425 Juniper 427 EMail: jefftant.ietf@gmail.com