idnits 2.17.1 draft-ietf-netmod-factory-default-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 -- The document date (May 17, 2019) is 1806 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 304, but not defined == Missing Reference: 'RFC6020' is mentioned on line 314, but not defined == Unused Reference: 'RFC7950' is defined on line 355, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-netconf-zerotouch' is defined on line 375, 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 18, 2019 Ericsson Hungary 6 Y. Niu 7 Huawei 8 May 17, 2019 10 Factory Default Setting 11 draft-ietf-netmod-factory-default-01 13 Abstract 15 This document defines a method to reset a 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 18, 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 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 all read-write 94 configuration datastores at reset. This datastore can also be used 95 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 server 120 o startup configuration datastore 122 o candiate configuration datastore 124 o running configuration datastore 126 o intended configuration datastore 128 o operational state datastore 130 The following terms are defined in this document as follows: 132 o factory-default datastore: A read-only datastore holding a 133 preconfigured minimal initial configuration that can be used to 134 initialize the configuration of a server. The content of the 135 datastore is usually static, but MAY depend on external factors 136 like available HW. 138 2. Factory-Reset RPC 140 A new "factory-reset" RPC is introduced. Upon receiveing the RPC the 141 server resets the content of all read-write configuration datastores 142 (e.g., and ) to its factory-default content. Read- 143 only datastores receive their content from other datastores (e.g. 144 gets its content from ). 146 Factory-default content SHALL be specified by one of the following 147 means in order of precedence 149 1. For the , and datastores as the 150 content of the datastore, if it exists 152 2. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format] 154 3. In some implementation specific manner 156 4. For dynamic datastores unless otherwise specified the factory- 157 default content is empty. 159 In addition to set the content of the read-write configuration 160 datastores, the "factory-reset" RPC might also be used to clean up 161 files, restart the node or some of the SW processes, or it might set 162 some security data/passwords to the default value, remove logs, 163 remove any temporary data (from datastore or elsewhere) etc. 165 3. Factory-Default Datastore 167 This document introduces a new datastore resource named 'Factory- 168 Default' that represents a preconfigured minimal initial 169 configuration that can be used to initialize the configuration of a 170 server. 172 o Name: "factory-default" 174 o YANG modules: all 176 o YANG nodes: all "config true" data nodes 178 o Management operations: The content of the datastore is set by the 179 server in an implementation dependent manner. The content can not 180 be changed by management operations via NETCONF, RESTCONF,the CLI 181 etc. unless specialized, dedicated operations are provided. The 182 contents of the datastore can be read using NETCONF, RESTCONF 183 operation. The operation can be used 184 to copy the factory default content to a set of another 185 datastores. For operation,it can be used to copy 186 the factory default content to another datastore, however the 187 content of the datastore is not propagated automatically to any 188 other datastores. 190 o Origin: This document does not define a new origin identity as it 191 does not interact with datastore. 193 o Protocols: RESTCONF, NETCONF and other management protocol. 195 o Defining YANG module: "ietf-factory-default" 197 The datastore content is usually defined by the device vendor. It is 198 usually static, but MAY change e.g., depending on external factors 199 like HW available or during device upgrade. 201 On devices that support non-volatile storage, the contents of 202 MUST persist across restarts. 204 4. YANG Module 206 file "ietf-factory-default.yang" 207 module ietf-factory-default { 208 yang-version 1.1; 209 namespace urn:ietf:params:xml:ns:yang:ietf-factory-default; 210 prefix fd; 212 import ietf-netconf { prefix nc ; } 213 import ietf-datastores { prefix ds; } 215 organization 216 "IETF NETMOD (Network Modeling) Working Group"; 217 contact 218 "WG Web: 219 WG List: 221 WG Chair: Lou Berger 222 223 WG Chair: Joel Jaeggli 224 225 WG Chair: Kent Watsen 226 228 Editor: Balazs Lengyel 229 230 Editor: Qin Wu 231 232 Editor: Ye Niu 233 "; 235 description 236 "This module defines the 237 - factory-reset RPC 238 - factory-default datastore 239 - an extension to the NETCONF operation to 240 allow it to operate on the factory-default datastore. 242 It provides functionality to reset a server to its 243 factory-default content. 245 Copyright (c) 2018 IETF Trust and the persons identified as 246 authors of the code. All rights reserved. 248 Redistribution and use in source and binary forms, with or 249 without modification, is permitted pursuant to, and subject to 250 the license terms contained in, the Simplified BSD License set 251 forth in Section 4.c of the IETF Trust's Legal Provisions 252 Relating to IETF Documents 253 (https://trustee.ietf.org/license-info). 255 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL 256 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 257 'OPTIONAL' in the module text are to be interpreted as described 258 in RFC 2119 (https://tools.ietf.org/html/rfc2119). 260 This version of this YANG module is part of RFC XXXX 261 (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for 262 full legal notices."; 264 revision 2019-05-03 { 265 description 266 "Initial revision."; 267 reference "RFC XXXX: Factory default Setting"; 268 } 270 feature factory-default-as-datastore { 271 description "Indicates that the factory default configuration is 272 also available as a separate datastore"; 273 } 275 rpc factory-reset { 276 description "The server resets the content of all read-write 277 configuration datastores (e.g., and ) to 278 its factory default content."; 279 } 281 identity factory-default { 282 base ds:datastore; 283 if-feature factory-default-as-datastore; 284 description "The read-only datastore contains the configuration that 285 will be copied into e.g., the running datastore by the 286 factory-reset operation if the target is the running 287 datastore."; 288 } 290 augment /nc:copy-config/nc:input/nc:source/nc:config-source { 291 if-feature factory-default-as-datastore; 292 description "Allows the copy-config operation to use the 293 factory-default datastore as a source"; 294 leaf factory-default { 295 type empty ; 296 description 297 "The factory-default datastore is the source."; } 298 } 299 } 300 302 5. IANA Considerations 304 This document registers one URI in the IETF XML Registry [RFC3688]. 305 The following registration has been made: 307 URI: urn:ietf:params:xml:ns:yang:ietf-factory-default 309 Registrant Contact: The IESG. 311 XML: N/A, the requested URI is an XML namespace. 313 This document registers one YANG module in the YANG Module Names 314 Registry [RFC6020]. The following registration has been made: 316 name: ietf-factory-default 318 namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default 320 prefix: fd 322 RFC: xxxx 324 6. Security Considerations 326 The RPC can overwrite important and security 327 sensitive information in one of the other datastores e.g. running, 328 therefore it is important to restrict access to this RPC using the 329 standard access control methods. [RFC8341] 330 The content of the factory-default datastore is usually not security 331 sensitive as it is the same on any device of a certain type. 333 7. Acknowledgements 335 Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe 336 Clark,Robert Wilton, Kent Watsen, Joel Jaeggli,Andy Berman,Susan 337 Hares to review this draft and provide important input to this 338 document. 340 8. Contributors 342 Rohit R Ranade 343 Huawei 344 Email: rohitrranade@huawei.com 346 9. References 348 9.1. Normative References 350 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 351 Requirement Levels", BCP 14, RFC 2119, 352 DOI 10.17487/RFC2119, March 1997, 353 . 355 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 356 RFC 7950, DOI 10.17487/RFC7950, August 2016, 357 . 359 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 360 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 361 May 2017, . 363 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 364 Access Control Model", STD 91, RFC 8341, 365 DOI 10.17487/RFC8341, March 2018, 366 . 368 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 369 and R. Wilton, "Network Management Datastore Architecture 370 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 371 . 373 9.2. Informative References 375 [I-D.ietf-netconf-zerotouch] 376 Watsen, K., Abrahamsson, M., and I. Farrer, "Secure Zero 377 Touch Provisioning (SZTP)", draft-ietf-netconf- 378 zerotouch-29 (work in progress), January 2019. 380 [I-D.ietf-netmod-yang-instance-file-format] 381 Lengyel, B. and B. Claise, "YANG Instance Data File 382 Format", draft-ietf-netmod-yang-instance-file-format-02 383 (work in progress), February 2019. 385 Appendix A. Open Issues 387 o Do we need an extra parameter that may order a restart of the 388 YANG-server or the whole system? 390 o Do we allow different datastore have different factory default 391 content? No 393 Appendix B. Difference between datastore and datastore 396 When the device first boots up, the content of the and 397 will be identical. The content of can be 398 subsequently changed by using as a target in a operation. The is a read-only datastore 400 and it is usually static as described in earlier sections. 402 Appendix C. Changes between revisions 404 v00 - v01 406 o Change YANG server into server defined in NMDA architecture based 407 on discussion. 409 o Allow reset the content of all read-write configuraton datastores 410 to its factory-default content except . 412 o Add clarification text on factory-reset protocol operation 413 behavior. 415 v03 - v00 417 o Change draft name from draft-wu to draft-ietf-netmod-factory- 418 default-00 without content changes. 420 v02 - v03 421 o Change reset-datastore RPC into factory-reset RPC to allow reset 422 the whole device with factory default content. 424 o Remove target datastore parameter from factory-reset RPC. 426 o Other editorial changes. 428 v01 - v02 430 o Add copy-config based on Rob's comment. 432 o Reference Update. 434 v03 - v00 - v01 436 o Changed name from draft-wu-netconf-restconf-factory-restore to 437 draft-wu-netmod-factory-default 439 o Removed copy-config ; reset-datastore is enough 441 v02 - v03 443 o Restructured 445 o Made new datastore optional 447 o Removed Netconf capability 449 o Listed Open issues 451 v01 - v02 453 o - 455 v00 - v01 457 o - 459 Authors' Addresses 461 Qin Wu 462 Huawei 463 101 Software Avenue, Yuhua District 464 Nanjing, Jiangsu 210012 465 China 467 Email: bill.wu@huawei.com 468 Balazs Lengyel 469 Ericsson Hungary 470 Magyar Tudosok korutja 11 471 1117 Budapest 472 Hungary 474 Phone: +36-70-330-7909 475 Email: balazs.lengyel@ericsson.com 477 Ye Niu 478 Huawei 480 Email: niuye@huawei.com