idnits 2.17.1 draft-ietf-netmod-factory-default-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 -- The document date (May 16, 2019) is 1799 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) == Missing Reference: 'RFC3688' is mentioned on line 296, but not defined == Missing Reference: 'RFC6020' is mentioned on line 306, but not defined == Unused Reference: 'RFC7950' is defined on line 348, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-netconf-zerotouch' is defined on line 368, but no explicit reference was found in the text == Outdated reference: A later version (-21) exists of draft-ietf-netmod-yang-instance-file-format-02 Summary: 0 errors (**), 0 flaws (~~), 6 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETMOD Working Group Q. Wu 3 Internet-Draft Huawei 4 Intended status: Standards Track B. Lengyel 5 Expires: November 17, 2019 Ericsson Hungary 6 Y. Niu 7 Huawei 8 May 16, 2019 10 Factory default Setting 11 draft-ietf-netmod-factory-default-00 13 Abstract 15 This document defines a method to reset a YANG server to its factory- 16 default content. The reset operation may be used e.g. during initial 17 zero-touch configuration or when the existing configuration has major 18 errors, so re-starting the configuration process from scratch is the 19 best option. 21 A new factory-reset RPC is defined. Several methods of documenting 22 the factory-default content are specified. 24 Optionally a new "factory-default" read-only datastore is defined, 25 that contains the data that will be copied over to the running 26 datastore at reset. 28 Status of This Memo 30 This Internet-Draft is submitted in full conformance with the 31 provisions of BCP 78 and BCP 79. 33 Internet-Drafts are working documents of the Internet Engineering 34 Task Force (IETF). Note that other groups may also distribute 35 working documents as Internet-Drafts. The list of current Internet- 36 Drafts is at https://datatracker.ietf.org/drafts/current/. 38 Internet-Drafts are draft documents valid for a maximum of six months 39 and may be updated, replaced, or obsoleted by other documents at any 40 time. It is inappropriate to use Internet-Drafts as reference 41 material or to cite them other than as "work in progress." 43 This Internet-Draft will expire on November 17, 2019. 45 Copyright Notice 47 Copyright (c) 2019 IETF Trust and the persons identified as the 48 document authors. All rights reserved. 50 This document is subject to BCP 78 and the IETF Trust's Legal 51 Provisions Relating to IETF Documents 52 (https://trustee.ietf.org/license-info) in effect on the date of 53 publication of this document. Please review these documents 54 carefully, as they describe your rights and restrictions with respect 55 to this document. Code Components extracted from this document must 56 include Simplified BSD License text as described in Section 4.e of 57 the Trust Legal Provisions and are provided without warranty as 58 described in the Simplified BSD License. 60 Table of Contents 62 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 63 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 64 2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 4 65 3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4 66 4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5 67 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 68 6. Security Considerations . . . . . . . . . . . . . . . . . . . 7 69 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 70 8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8 71 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 72 9.1. Normative References . . . . . . . . . . . . . . . . . . 8 73 9.2. Informative References . . . . . . . . . . . . . . . . . 8 74 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9 75 Appendix B. Difference between datastore and datastore . . . . . . . . . . . . . . . . . 9 77 Appendix C. Changes between revisions . . . . . . . . . . . . . 9 78 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 80 1. Introduction 82 This document defines a method to reset a YANG server to its factory- 83 default content. The reset operation may be used e.g. during initial 84 zero-touch configuration or when the existing configuration has major 85 errors, so re-starting the configuration process from scratch is the 86 best option. When resetting a datastore all previous configuration 87 settings will be lost and replaced by the factory-default content. 89 A new factory-reset RPC is defined. Several methods of documenting 90 the factory-default content are specified. 92 Optionally a new "factory-default" read-only datastore is defined, 93 that contains the data that will be copied over to the 94 ,, datastore at reset. This datastore 95 can also be used in or operations. 97 NETCONF defines the operation that allows resetting the 98 datastore and the operation that copies 99 the content of the datastore into the 100 datastore. However it is not possible to reset the running 101 datastore, to reset the candidate datastore without changing the 102 running datastore or to reset any dynamic datastore. 104 A RESTCONF server MAY implement the above NETCONF operations, but 105 that would still not allow it to reset the running configuration. 107 1.1. Terminology 109 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 110 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 111 "OPTIONAL" in this document are to be interpreted as described in BCP 112 14 [RFC2119] [RFC8174] when, and only when, they appear in all 113 capitals, as shown here. 115 The following terms are defined in [RFC8342] and are not redefined 116 here: 118 o startup configuration datastore 120 o candiate configuration datastore 122 o running configuration datastore 124 o intended configuration datastore 126 o operational state datastore 128 The following terms are defined in this document as follows: 130 o factory-default datastore: A read-only datastore holding a 131 preconfigured minimal initial configuration that can be used to 132 initialize the configuration of a server. The content of the 133 datastore is usually static, but MAY depend on external factors 134 like available HW. 136 2. Factory-Reset RPC 138 A new "factory-reset" RPC is introduced. Upon receiveing the RPC the 139 YANG server resets the content of , and 140 to its factory- default content. Read-only datastores 141 receive their content from other datastores (e.g. gets its 142 content from ). 144 Factory-default content SHALL be specified by one of the following 145 means in order of precedence 147 1. For the , and datastores as the 148 content of the datastore, if it exists 150 2. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format] 152 3. In some implementation specific manner 154 4. For dynamic datastores unless otherwise specified the factory- 155 default content is empty. 157 3. Factory-Default Datastore 159 This document introduces a new datastore resource named 'Factory- 160 Default' that represents a preconfigured minimal initial 161 configuration that can be used to initialize the configuration of a 162 server. 164 o Name: "factory-default" 166 o YANG modules: all 168 o YANG nodes: all "config true" data nodes 170 o Management operations: The content of the datastore is set by the 171 YANG server in an implementation dependent manner. The content 172 can not be changed by management operations via NETCONF, 173 RESTCONF,the CLI etc. unless specialized, dedicated operations are 174 provided. The contents of the datastore can be read using 175 NETCONF, RESTCONF operation. The operation can be used to copy the content of the datastore to a set 177 of another datastores. For operation,it can be used 178 to copy the content of the datastore to another datastore, however 179 the content of the datastore is not propagated automatically to 180 any other datastores. 182 o Origin: This document does not define a new origin identity as it 183 does not interact with datastore. 185 o Protocols: RESTCONF, NETCONF and other management protocol. 187 o Defining YANG module: "ietf-factory-default" 189 The datastore content is usually defined by the device vendor. It is 190 usually static, but MAY change e.g. depending on external factors 191 like HW available or during device upgrade. 193 On devices that support non-volatile storage, the contents of 194 MUST persist across restarts 196 4. YANG Module 198 file "ietf-factory-default.yang" 199 module ietf-factory-default { 200 yang-version 1.1; 201 namespace urn:ietf:params:xml:ns:yang:ietf-factory-default; 202 prefix fdef; 204 import ietf-netconf { prefix nc ; } 205 import ietf-datastores { prefix ds; } 207 organization 208 "IETF NETMOD (Network Modeling) Working Group"; 209 contact 210 "WG Web: 211 WG List: 213 WG Chair: Lou Berger 214 215 WG Chair: Joel Jaeggli 216 217 WG Chair: Kent Watsen 218 220 Editor: Balazs Lengyel 221 222 Editor: Qin Wu 223 224 Editor: Ye Niu 225 "; 226 description 227 "This module defines the 228 - factory-reset RPC 229 - factory-default datastore 230 - an extension to the NETCONF operation to 231 allow it to operate on the factory-default datastore. 233 It provides functionality to reset a YANG server to its 234 factory-default content. 236 Copyright (c) 2018 IETF Trust and the persons identified as 237 authors of the code. All rights reserved. 239 Redistribution and use in source and binary forms, with or 240 without modification, is permitted pursuant to, and subject to 241 the license terms contained in, the Simplified BSD License set 242 forth in Section 4.c of the IETF Trust's Legal Provisions 243 Relating to IETF Documents 244 (https://trustee.ietf.org/license-info). 246 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 247 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 248 'OPTIONAL' in the module text are to be interpreted as described 249 in RFC 2119 (https://tools.ietf.org/html/rfc2119). 251 This version of this YANG module is part of RFC XXXX 252 (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for 253 full legal notices."; 255 revision 2019-05-03 { 256 description 257 "Initial revision."; 258 reference "RFC XXXX: Factory default Setting"; 259 } 261 feature factory-default-as-datastore { 262 description "Indicates that the factory default configuration is 263 also available as a separate datastore"; 264 } 266 rpc factory-reset { 267 description "The YANG server resets the content of , 268 and to its factory default content."; 269 // Do we need an extra parameter that may order a restart of 270 // the YANG-server or the whole system? 271 } 273 identity factory-default { 274 if-feature factory-default-as-datastore; 275 base ds:datastore; 276 description "The read-only datastore contains the configuration that 277 will be copied into e.g. the running datastore by the 278 factory-reset operation if the target is the running 279 datastore."; 280 } 282 augment /nc:copy-config/nc:input/nc:source/nc:config-source { 283 if-feature factory-default-as-datastore; 284 description " Allows the copy-config operation to use the 285 factory-default datastore as a source"; 286 leaf factory-default { 287 type empty ; 288 description 289 "The factory-default datastore is the source."; } 290 } 291 } 292 294 5. IANA Considerations 296 This document registers one URI in the IETF XML Registry [RFC3688]. 297 The following registration has been made: 299 URI: urn:ietf:params:xml:ns:yang:ietf-factory-default 301 Registrant Contact: The IESG. 303 XML: N/A, the requested URI is an XML namespace. 305 This document registers one YANG module in the YANG Module Names 306 Registry [RFC6020]. The following registration has been made: 308 name: ietf-factory-default 310 namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default 312 prefix: fdef 314 RFC: xxxx 316 6. Security Considerations 318 The RPC can overwrite important and security 319 sensitive information in one of the other datastores e.g. running, 320 therefore it is important to restrict access to this RPC using the 321 standard access control methods. [RFC8341] 323 The content of the factory-default datastore is usually not security 324 sensitive as it is the same on any device of a certain type. 326 7. Acknowledgements 328 Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe 329 Clark,Robert Wilton, Kent Watsen, Joel Jaeggli,Andy Berman,Susan 330 Hares to review this draft and provide important input to this 331 document. 333 8. Contributors 335 Rohit R Ranade 336 Huawei 337 Email: rohitrranade@huawei.com 339 9. References 341 9.1. Normative References 343 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 344 Requirement Levels", BCP 14, RFC 2119, 345 DOI 10.17487/RFC2119, March 1997, 346 . 348 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 349 RFC 7950, DOI 10.17487/RFC7950, August 2016, 350 . 352 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 353 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 354 May 2017, . 356 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 357 Access Control Model", STD 91, RFC 8341, 358 DOI 10.17487/RFC8341, March 2018, 359 . 361 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 362 and R. Wilton, "Network Management Datastore Architecture 363 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 364 . 366 9.2. Informative References 368 [I-D.ietf-netconf-zerotouch] 369 Watsen, K., Abrahamsson, M., and I. Farrer, "Secure Zero 370 Touch Provisioning (SZTP)", draft-ietf-netconf- 371 zerotouch-29 (work in progress), January 2019. 373 [I-D.ietf-netmod-yang-instance-file-format] 374 Lengyel, B. and B. Claise, "YANG Instance Data File 375 Format", draft-ietf-netmod-yang-instance-file-format-02 376 (work in progress), February 2019. 378 Appendix A. Open Issues 380 o Do we need an extra parameter that may order a restart of the 381 YANG-server or the whole system? 383 o Do we allow different datastore have different factory default 384 content? No 386 Appendix B. Difference between datastore and datastore 389 When the device first boots up, the content of the and 390 will be identical. The content of can be 391 subsequently changed by using as a target in a operation. The is a read-only datastore 393 and it is usually static as described in earlier sections. 395 Appendix C. Changes between revisions 397 v03 - v00 399 Change draft name from draft-wu to draft-ietf-netmod-factory- 400 default-00 without content changes. 402 v02 - v03 404 o Change reset-datastore RPC into factory-reset RPC to allow reset 405 the whole device with factory default content. 407 o Remove target datastore parameter from factory-reset RPC. 409 o Other editorial changes. 411 v01 - v02 413 o Add copy-config based on Rob's comment. 415 o Reference Update. 417 v3 - v00 - v01 419 o Changed name from draft-wu-netconf-restconf-factory-restore to 420 draft-wu-netmod-factory-default 422 o Removed copy-config ; reset-datastore is enough 424 v02 - v03 426 o Restructured 428 o Made new datastore optional 430 o Removed Netconf capability 432 o Listed Open issues 434 v01 - v02 436 o - 438 v00 - v01 440 o - 442 Authors' Addresses 444 Qin Wu 445 Huawei 446 101 Software Avenue, Yuhua District 447 Nanjing, Jiangsu 210012 448 China 450 Email: bill.wu@huawei.com 452 Balazs Lengyel 453 Ericsson Hungary 454 Magyar Tudosok korutja 11 455 1117 Budapest 456 Hungary 458 Phone: +36-70-330-7909 459 Email: balazs.lengyel@ericsson.com 461 Ye Niu 462 Huawei 464 Email: niuye@huawei.com