draft-ietf-netmod-factory-default-04.txt   draft-ietf-netmod-factory-default-05.txt 
NETMOD Working Group Q. Wu NETMOD Working Group Q. Wu
Internet-Draft Huawei Internet-Draft Huawei
Intended status: Standards Track B. Lengyel Intended status: Standards Track B. Lengyel
Expires: April 28, 2020 Ericsson Hungary Expires: May 2, 2020 Ericsson Hungary
Y. Niu Y. Niu
Huawei Huawei
October 26, 2019 October 30, 2019
Factory Default Setting Factory Default Setting
draft-ietf-netmod-factory-default-04 draft-ietf-netmod-factory-default-05
Abstract Abstract
This document defines a method to reset a server to its factory- This document defines a method to reset a server to its factory-
default content. The reset operation may be used e.g. during initial default content. The reset operation may be used e.g. during initial
zero-touch configuration or when the existing configuration has major zero-touch configuration or when the existing configuration has major
errors, so re-starting the configuration process from scratch is the errors, so re-starting the configuration process from scratch is the
best option. best option.
A new factory-reset RPC is defined. Several methods of documenting A new factory-reset RPC is defined. Several methods of documenting
skipping to change at page 1, line 44 skipping to change at page 1, line 44
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 28, 2020. This Internet-Draft will expire on May 2, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 34 skipping to change at page 2, line 34
2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 4 2. Factory-Reset RPC . . . . . . . . . . . . . . . . . . . . . . 4
3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4 3. Factory-Default Datastore . . . . . . . . . . . . . . . . . . 4
4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5 4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
6. Security Considerations . . . . . . . . . . . . . . . . . . . 7 6. Security Considerations . . . . . . . . . . . . . . . . . . . 7
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8
8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8 8. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 8
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8
9.1. Normative References . . . . . . . . . . . . . . . . . . 8 9.1. Normative References . . . . . . . . . . . . . . . . . . 8
9.2. Informative References . . . . . . . . . . . . . . . . . 9 9.2. Informative References . . . . . . . . . . . . . . . . . 9
Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9 Appendix A. Difference between <startup> datastore and <factory-
Appendix B. Difference between <startup> datastore and <factory-
default> datastore . . . . . . . . . . . . . . . . . 9 default> datastore . . . . . . . . . . . . . . . . . 9
Appendix C. Changes between revisions . . . . . . . . . . . . . 9 Appendix B. Changes between revisions . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 11
1. Introduction 1. Introduction
This document defines a method to reset a server to its factory- This document defines a method to reset a server to its factory-
default content. The reset operation may be used e.g. during initial default content. The reset operation may be used e.g. during initial
zero-touch configuration [RFC8572] or when the existing configuration zero-touch configuration [RFC8572] or when the existing configuration
has major errors, so re-starting the configuration process from has major errors, so re-starting the configuration process from
scratch is the best option. When resetting a datastore all previous scratch is the best option. When resetting a datastore all previous
configuration settings will be lost and replaced by the factory- configuration settings will be lost and replaced by the factory-
skipping to change at page 4, line 9 skipping to change at page 4, line 9
o factory-default datastore: A read-only datastore holding a o factory-default datastore: A read-only datastore holding a
preconfigured minimal initial configuration that can be used to preconfigured minimal initial configuration that can be used to
initialize the configuration of a server. The content of the initialize the configuration of a server. The content of the
datastore is usually static, but MAY depend on external factors datastore is usually static, but MAY depend on external factors
like available HW. like available HW.
2. Factory-Reset RPC 2. Factory-Reset RPC
A new "factory-reset" RPC is introduced. Upon receiveing the RPC the A new "factory-reset" RPC is introduced. Upon receiveing the RPC the
server resets the content of all read-write configuration datastores server resets the content of all read-write configuration datastores
(e.g.,<running> and <startup>) to its factory-default content. Read- (e.g.,<running> and <startup>) to their factory-default content.
only datastores receive their content from other datastores (e.g. Read-only datastores receive their content from other datastores
<intended> gets its content from <running>). (e.g. <intended> gets its content from <running>).
Factory-default content SHALL be specified by one of the following Factory-default content SHALL be specified by one of the following
means in order of precedence means in descending order of precedence
1. For the <running>,<candidate> and <startup> datastores as the 1. For the <running>,<candidate> and <startup> datastores as the
content of the <factory-default> datastore, if it exists content of the <factory-default> datastore, if it exists;
2. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format] 2. by vendors using YANG Instance Data
[I-D.ietf-netmod-yang-instance-file-format] file format in
vendor's website or other places where off-line document is kept;
3. In some implementation specific manner 3. In some implementation specific manner;
4. For dynamic datastores unless otherwise specified the factory- 4. For dynamic datastores unless otherwise specified the factory-
default content is empty. default content is empty.
In addition,the "factory-reset" RPC might also be used to trigger For the server supporting zero touch bootstrapping mechanisms, the
some other restoring and resetting tasks such as files cleanup, factory default configuration causes the bootstrapping process to
restarting the node or some of the SW processes, or setting some execute,e.g.,the server might reset configuration to device's factory
security data/passwords to the default value, removing logs, removing default configuration,for the version of operating system software it
any temporary data (from datastore or elsewhere) etc. When and why is running. In addition,the "factory-reset" RPC might also be used
these tasks are triggered is not the scope of this document. to trigger some other restoring and resetting tasks such as files
cleanup, restarting the node or some of the software processes,
setting some security data/passwords to the default value, removing
logs, or removing any temporary data (from datastore or elsewhere),
etc. When and why these tasks are triggered is not the scope of this
document.
3. Factory-Default Datastore 3. Factory-Default Datastore
Following guidelines for defining Datastores in the appendix A of Following guidelines for defining Datastores in the appendix A of
[RFC8342], this document introduces a new datastore resource named [RFC8342], this document introduces a new datastore resource named
'Factory-Default' that represents a preconfigured minimal initial 'Factory-Default' that represents a preconfigured minimal initial
configuration that can be used to initialize the configuration of a configuration that can be used to initialize the configuration of a
server. server.
o Name: "factory-default" o Name: "factory-default"
skipping to change at page 6, line 41 skipping to change at page 6, line 48
} }
feature factory-default-as-datastore { feature factory-default-as-datastore {
description "Indicates that the factory default configuration is description "Indicates that the factory default configuration is
also available as a separate datastore"; also available as a separate datastore";
} }
rpc factory-reset { rpc factory-reset {
description "The server resets the content of all read-write description "The server resets the content of all read-write
configuration datastores (e.g.,<running> and <startup>) to configuration datastores (e.g.,<running> and <startup>) to
its factory default content."; their factory default content.";
} }
identity factory-default { identity factory-default {
base ds:datastore; base ds:datastore;
if-feature factory-default-as-datastore; if-feature factory-default-as-datastore;
description "The read-only datastore contains the configuration that description "The read-only datastore contains the configuration that
will be copied into e.g., the running datastore by the will be copied into e.g., the running datastore by the
factory-reset operation if the target is the running factory-reset operation if the target is the running
datastore."; datastore.";
} }
skipping to change at page 9, line 17 skipping to change at page 9, line 22
[I-D.ietf-netmod-yang-instance-file-format] [I-D.ietf-netmod-yang-instance-file-format]
Lengyel, B. and B. Claise, "YANG Instance Data File Lengyel, B. and B. Claise, "YANG Instance Data File
Format", draft-ietf-netmod-yang-instance-file-format-04 Format", draft-ietf-netmod-yang-instance-file-format-04
(work in progress), August 2019. (work in progress), August 2019.
[RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero [RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero
Touch Provisioning (SZTP)", RFC 8572, Touch Provisioning (SZTP)", RFC 8572,
DOI 10.17487/RFC8572, April 2019, DOI 10.17487/RFC8572, April 2019,
<https://www.rfc-editor.org/info/rfc8572>. <https://www.rfc-editor.org/info/rfc8572>.
Appendix A. Open Issues Appendix A. Difference between <startup> datastore and <factory-
o Do we need an extra parameter that may order a restart of the
YANG-server or the whole system?
o Do we allow different datastore have different factory default
content? No
Appendix B. Difference between <startup> datastore and <factory-
default> datastore default> datastore
When the device first boots up, the content of the <startup> and When the device first boots up, the content of the <startup> and
<factory-default> will be identical. The content of <startup> can be <factory-default> will be identical. The content of <startup> can be
subsequently changed by using <startup> as a target in a <copy- subsequently changed by using <startup> as a target in a <copy-
config> operation. The <factory-default> is a read-only datastore config> operation. The <factory-default> is a read-only datastore
and it is usually static as described in earlier sections. and it is usually static as described in earlier sections.
Appendix C. Changes between revisions Appendix B. Changes between revisions
v03 - 04 v03 - 04
o Additional text to clarify factory-reset RPC usage. o Additional text to clarify factory-reset RPC usage.
v02 - 03 v02 - 03
o Update security consideration section. o Update security consideration section.
v01 - v02 v01 - v02
skipping to change at page 11, line 4 skipping to change at page 10, line 49
v02 - v03 v02 - v03
o Restructured o Restructured
o Made new datastore optional o Made new datastore optional
o Removed Netconf capability o Removed Netconf capability
o Listed Open issues o Listed Open issues
v01 - v02
v01 - v02
o - o -
v00 - v01 v00 - v01
o - o -
Authors' Addresses Authors' Addresses
Qin Wu Qin Wu
Huawei Huawei
 End of changes. 17 change blocks. 
32 lines changed or deleted 30 lines changed or added

This html diff was produced by rfcdiff 1.47. The latest version is available from http://tools.ietf.org/tools/rfcdiff/