draft-ietf-netmod-factory-default-01.txt   draft-ietf-netmod-factory-default-02.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: November 18, 2019 Ericsson Hungary Expires: December 31, 2019 Ericsson Hungary
Y. Niu Y. Niu
Huawei Huawei
May 17, 2019 June 29, 2019
Factory Default Setting Factory Default Setting
draft-ietf-netmod-factory-default-01 draft-ietf-netmod-factory-default-02
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 November 18, 2019. This Internet-Draft will expire on December 31, 2019.
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 29 skipping to change at page 2, line 29
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
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 . . . . . . . . . . . . . . . . . . . . . . 7
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 . . . . . . . . . . . . . . . . . 8 9.2. Informative References . . . . . . . . . . . . . . . . . 8
Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 9
Appendix B. 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 C. Changes between revisions . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10
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 or when the existing configuration has major zero-touch configuration [RFC8572] or when the existing configuration
errors, so re-starting the configuration process from scratch is the has major errors, so re-starting the configuration process from
best option. When resetting a datastore all previous configuration scratch is the best option. When resetting a datastore all previous
settings will be lost and replaced by the factory-default content. configuration settings will be lost and replaced by the factory-
default content.
A new factory-reset RPC is defined. Several methods of documenting A new factory-reset RPC is defined. Several methods of documenting
the factory-default content are specified. the factory-default content are specified.
Optionally a new "factory-default" read-only datastore is defined, Optionally a new "factory-default" read-only datastore is defined,
that contains the data that will be copied over to all read-write that contains the data that will be copied over to all read-write
configuration datastores at reset. This datastore can also be used configuration datastores at reset. This datastore can also be used
in <get-data> or <copy-config> operations. in <get-data> or <get-config> operations.
NETCONF defines the <delete> operation that allows resetting the NETCONF defines the <delete> operation that allows resetting the
<startup> datastore and the <discard-changes> operation that copies <startup> datastore and the <discard-changes> operation that copies
the content of the <running> datastore into the <candidate> the content of the <running> datastore into the <candidate>
datastore. However it is not possible to reset the running datastore. However it is not possible to reset the running
datastore, to reset the candidate datastore without changing the datastore, to reset the candidate datastore without changing the
running datastore or to reset any dynamic datastore. running datastore or to reset any dynamic datastore.
A RESTCONF server MAY implement the above NETCONF operations, but A RESTCONF server MAY implement the above NETCONF operations, but
that would still not allow it to reset the running configuration. that would still not allow it to reset the running configuration.
skipping to change at page 4, line 34 skipping to change at page 4, line 34
default content is empty. default content is empty.
In addition to set the content of the read-write configuration In addition to set the content of the read-write configuration
datastores, the "factory-reset" RPC might also be used to clean up datastores, the "factory-reset" RPC might also be used to clean up
files, restart the node or some of the SW processes, or it might set files, restart the node or some of the SW processes, or it might set
some security data/passwords to the default value, remove logs, some security data/passwords to the default value, remove logs,
remove any temporary data (from datastore or elsewhere) etc. remove any temporary data (from datastore or elsewhere) etc.
3. Factory-Default Datastore 3. Factory-Default Datastore
This document introduces a new datastore resource named 'Factory- Following guidelines for defining Datastores in the appendix A of
Default' that represents a preconfigured minimal initial [RFC8342], this document introduces a new datastore resource named
'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"
o YANG modules: all o YANG modules: all
o YANG nodes: all "config true" data nodes o YANG nodes: all "config true" data nodes
o Management operations: The content of the datastore is set by the o Management operations: The content of the datastore is set by the
server in an implementation dependent manner. The content can not server in an implementation dependent manner. The content can not
be changed by management operations via NETCONF, RESTCONF,the CLI be changed by management operations via NETCONF, RESTCONF,the CLI
etc. unless specialized, dedicated operations are provided. The etc. unless specialized, dedicated operations are provided. The
contents of the datastore can be read using NETCONF, RESTCONF contents of the datastore can be read using NETCONF, RESTCONF
<get-data> operation. The operation <factory-reset> can be used <get-data> and <get-config> operations. The operation <factory-
to copy the factory default content to a set of another reset> can be used to copy the factory default content to a set of
datastores. For <copy-config> operation,it can be used to copy read-write configuration datastores and then the content of these
the factory default content to another datastore, however the datastores is propagated automatically to any other read only
content of the datastore is not propagated automatically to any datastores, e.g., <intended> and <operational>.
other datastores.
o Origin: This document does not define a new origin identity as it o Origin: This document does not define a new origin identity as it
does not interact with <operational> datastore. does not interact with <operational> datastore.
o Protocols: RESTCONF, NETCONF and other management protocol. o Protocols: RESTCONF, NETCONF and other management protocol.
o Defining YANG module: "ietf-factory-default" o Defining YANG module: "ietf-factory-default".
The datastore content is usually defined by the device vendor. It is The datastore content is usually defined by the device vendor. It is
usually static, but MAY change e.g., depending on external factors usually static, but MAY change e.g., depending on external factors
like HW available or during device upgrade. like HW available or during device upgrade.
On devices that support non-volatile storage, the contents of On devices that support non-volatile storage, the contents of
<factory > MUST persist across restarts. <factory > MUST persist across restarts.
4. YANG Module 4. YANG Module
skipping to change at page 5, line 39 skipping to change at page 5, line 39
import ietf-netconf { prefix nc ; } import ietf-netconf { prefix nc ; }
import ietf-datastores { prefix ds; } import ietf-datastores { prefix ds; }
organization organization
"IETF NETMOD (Network Modeling) Working Group"; "IETF NETMOD (Network Modeling) Working Group";
contact contact
"WG Web: <https://tools.ietf.org/wg/netconf/> "WG Web: <https://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
WG Chair: Lou Berger
<mailto:lberger@labn.net>
WG Chair: Joel Jaeggli
<mailto:joelja@bogus.com>
WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net>
Editor: Balazs Lengyel Editor: Balazs Lengyel
<mailto:balazs.lengyel@ericsson.com> <mailto:balazs.lengyel@ericsson.com>
Editor: Qin Wu Editor: Qin Wu
<mailto:bill.wu@huawei.com> <mailto:bill.wu@huawei.com>
Editor: Ye Niu Editor: Ye Niu
<mailto:niuye@huawei.com>"; <mailto:niuye@huawei.com>";
description description
"This module defines the "This module defines the
- factory-reset RPC - factory-reset RPC
- factory-default datastore - factory-default datastore
- an extension to the NETCONF <copy-config> operation to
allow it to operate on the factory-default datastore.
It provides functionality to reset a server to its It provides functionality to reset a server to its
factory-default content. factory-default content.
Copyright (c) 2018 IETF Trust and the persons identified as The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
authors of the code. All rights reserved. NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.
Copyright (c) 2019 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to without modification, is permitted pursuant to, and subject
the license terms contained in, the Simplified BSD License set to the license terms contained in, the Simplified BSD License
forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(https://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
'OPTIONAL' in the module text are to be interpreted as described
in RFC 2119 (https://tools.ietf.org/html/rfc2119).
This version of this YANG module is part of RFC XXXX This version of this YANG module is part of RFC XXXX;
(https://tools.ietf.org/html/rfcXXXX); see the RFC itself for see the RFC itself for full legal notices.";
full legal notices.";
revision 2019-05-03 { revision 2019-05-03 {
description description
"Initial revision."; "Initial revision.";
reference "RFC XXXX: Factory default Setting"; reference "RFC XXXX: Factory default Setting";
} }
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";
skipping to change at page 7, line 10 skipping to change at page 6, line 49
} }
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.";
} }
augment /nc:get-config/nc:input/nc:source/nc:config-source {
augment /nc:copy-config/nc:input/nc:source/nc:config-source {
if-feature factory-default-as-datastore; if-feature factory-default-as-datastore;
description "Allows the copy-config operation to use the description "Allows the get-config operation to use the
factory-default datastore as a source"; factory-default datastore as a source";
leaf factory-default { leaf factory-default {
type empty ; type empty ;
description description
"The factory-default datastore is the source."; } "The factory-default datastore is the source."; }
}
} }
<CODE ENDS> <CODE ENDS>
5. IANA Considerations 5. IANA Considerations
This document registers one URI in the IETF XML Registry [RFC3688]. This document registers one URI in the IETF XML Registry [RFC3688].
The following registration has been made: The following registration has been made:
URI: urn:ietf:params:xml:ns:yang:ietf-factory-default URI: urn:ietf:params:xml:ns:yang:ietf-factory-default
skipping to change at page 8, line 4 skipping to change at page 7, line 40
prefix: fd prefix: fd
RFC: xxxx RFC: xxxx
6. Security Considerations 6. Security Considerations
The <factory-reset> RPC can overwrite important and security The <factory-reset> RPC can overwrite important and security
sensitive information in one of the other datastores e.g. running, sensitive information in one of the other datastores e.g. running,
therefore it is important to restrict access to this RPC using the therefore it is important to restrict access to this RPC using the
standard access control methods. [RFC8341] standard access control methods. [RFC8341]
The content of the factory-default datastore is usually not security The content of the factory-default datastore is usually not security
sensitive as it is the same on any device of a certain type. sensitive as it is the same on any device of a certain type. In case
there is any sensitive content in the factory-default datastore, it
should be protected in a secure way,e.g.,sign or encrypt the
sensitive information.
7. Acknowledgements 7. Acknowledgements
Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Alex Campbell,Joe
Clark,Robert Wilton, Kent Watsen, Joel Jaeggli,Andy Berman,Susan Clark,Robert Wilton, Kent Watsen, Joel Jaeggli,Andy Berman,Susan
Hares to review this draft and provide important input to this Hares to review this draft and provide important input to this
document. document.
8. Contributors 8. Contributors
skipping to change at page 9, line 5 skipping to change at page 8, line 40
DOI 10.17487/RFC8341, March 2018, DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>. <https://www.rfc-editor.org/info/rfc8342>.
9.2. Informative References 9.2. Informative References
[I-D.ietf-netconf-zerotouch]
Watsen, K., Abrahamsson, M., and I. Farrer, "Secure Zero
Touch Provisioning (SZTP)", draft-ietf-netconf-
zerotouch-29 (work in progress), January 2019.
[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-02 Format", draft-ietf-netmod-yang-instance-file-format-02
(work in progress), February 2019. (work in progress), February 2019.
[RFC8572] Watsen, K., Farrer, I., and M. Abrahamsson, "Secure Zero
Touch Provisioning (SZTP)", RFC 8572,
DOI 10.17487/RFC8572, April 2019,
<https://www.rfc-editor.org/info/rfc8572>.
Appendix A. Open Issues Appendix A. Open Issues
o Do we need an extra parameter that may order a restart of the o Do we need an extra parameter that may order a restart of the
YANG-server or the whole system? YANG-server or the whole system?
o Do we allow different datastore have different factory default o Do we allow different datastore have different factory default
content? No content? No
Appendix B. Difference between <startup> datastore and <factory- 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 C. Changes between revisions
v01 - v02
o Address security issue in the security consideration section.
o Remove an extension to the NETCONF <copy-config> operation which
allows it to operate on the factory-default datastore.
o Add an extension to the NETCONF <get-config.operation which allows
it to operate on the factory-default datastore.
v00 - v01 v00 - v01
o Change YANG server into server defined in NMDA architecture based o Change YANG server into server defined in NMDA architecture based
on discussion. on discussion.
o Allow reset the content of all read-write configuraton datastores o Allow reset the content of all read-write configuraton datastores
to its factory-default content except <candidate>. to its factory-default content except <candidate>.
o Add clarification text on factory-reset protocol operation o Add clarification text on factory-reset protocol operation
behavior. behavior.
 End of changes. 26 change blocks. 
53 lines changed or deleted 57 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/