draft-ietf-netmod-factory-default-00.txt   draft-ietf-netmod-factory-default-01.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 17, 2019 Ericsson Hungary Expires: November 18, 2019 Ericsson Hungary
Y. Niu Y. Niu
Huawei Huawei
May 16, 2019 May 17, 2019
Factory default Setting Factory Default Setting
draft-ietf-netmod-factory-default-00 draft-ietf-netmod-factory-default-01
Abstract Abstract
This document defines a method to reset a YANG 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
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 the running that contains the data that will be copied over to the running
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 17, 2019. This Internet-Draft will expire on November 18, 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 42 skipping to change at page 2, line 42
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 YANG 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. When resetting a datastore all previous configuration best option. When resetting a datastore all previous configuration
settings will be lost and replaced by the factory-default content. 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 the that contains the data that will be copied over to all read-write
<startup>,<candiate>,<running> datastore at reset. This datastore configuration datastores at reset. This datastore can also be used
can also be used in <get-data> or <copy-config> operations. in <get-data> or <copy-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 3, line 31 skipping to change at page 3, line 31
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
The following terms are defined in [RFC8342] and are not redefined The following terms are defined in [RFC8342] and are not redefined
here: here:
o server
o startup configuration datastore o startup configuration datastore
o candiate configuration datastore o candiate configuration datastore
o running configuration datastore o running configuration datastore
o intended configuration datastore o intended configuration datastore
o operational state datastore o operational state datastore
skipping to change at page 4, line 8 skipping to change at page 4, line 8
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
YANG server resets the content of <running>, <candidate> and server resets the content of all read-write configuration datastores
<startup> to its factory- default content. Read-only datastores (e.g.,<running> and <startup>) to its factory-default content. Read-
receive their content from other datastores (e.g. <intended> gets its only datastores receive their content from other datastores (e.g.
content from <running>). <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 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. YANG Instance Data [I-D.ietf-netmod-yang-instance-file-format]
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 to set the content of the read-write configuration
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
some security data/passwords to the default value, remove logs,
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- This document introduces a new datastore resource named 'Factory-
Default' that represents a preconfigured minimal initial 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
YANG server in an implementation dependent manner. The content server in an implementation dependent manner. The content can not
can not be changed by management operations via NETCONF, be changed by management operations via NETCONF, RESTCONF,the CLI
RESTCONF,the CLI etc. unless specialized, dedicated operations are etc. unless specialized, dedicated operations are provided. The
provided. The contents of the datastore can be read using contents of the datastore can be read using NETCONF, RESTCONF
NETCONF, RESTCONF <get-data> operation. The operation <factory- <get-data> operation. The operation <factory-reset> can be used
reset> can be used to copy the content of the datastore to a set to copy the factory default content to a set of another
of another datastores. For <copy-config> operation,it can be used datastores. For <copy-config> operation,it can be used to copy
to copy the content of the datastore to another datastore, however the factory default content to another datastore, however the
the content of the datastore is not propagated automatically to content of the datastore is not propagated automatically to any
any other datastores. 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
<CODE BEGINS> file "ietf-factory-default.yang" <CODE BEGINS> file "ietf-factory-default.yang"
module ietf-factory-default { module ietf-factory-default {
yang-version 1.1; yang-version 1.1;
namespace urn:ietf:params:xml:ns:yang:ietf-factory-default; namespace urn:ietf:params:xml:ns:yang:ietf-factory-default;
prefix fdef; prefix fd;
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>
skipping to change at page 5, line 46 skipping to change at page 6, line 4
<mailto:joelja@bogus.com> <mailto:joelja@bogus.com>
WG Chair: Kent Watsen WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net> <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 - an extension to the NETCONF <copy-config> operation to
allow it to operate on the factory-default datastore. allow it to operate on the factory-default datastore.
It provides functionality to reset a YANG 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 Copyright (c) 2018 IETF Trust and the persons identified as
authors of the code. All rights reserved. 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 to
the license terms contained in, the Simplified BSD License set the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
skipping to change at page 6, line 39 skipping to change at page 6, line 46
"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";
} }
rpc factory-reset { rpc factory-reset {
description "The YANG server resets the content of <running>, description "The server resets the content of all read-write
<candidate> and <startup> to its factory default content."; configuration datastores (e.g.,<running> and <startup>) to
// Do we need an extra parameter that may order a restart of its factory default content.";
// the YANG-server or the whole system?
} }
identity factory-default { identity factory-default {
if-feature factory-default-as-datastore;
base ds:datastore; base ds: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:copy-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 copy-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
skipping to change at page 7, line 35 skipping to change at page 7, line 41
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
This document registers one YANG module in the YANG Module Names This document registers one YANG module in the YANG Module Names
Registry [RFC6020]. The following registration has been made: Registry [RFC6020]. The following registration has been made:
name: ietf-factory-default name: ietf-factory-default
namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default
prefix: fdef 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.
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.
skipping to change at page 9, line 29 skipping to change at page 9, line 34
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
v00 - v01
o Change YANG server into server defined in NMDA architecture based
on discussion.
o Allow reset the content of all read-write configuraton datastores
to its factory-default content except <candidate>.
o Add clarification text on factory-reset protocol operation
behavior.
v03 - v00 v03 - v00
Change draft name from draft-wu to draft-ietf-netmod-factory- o Change draft name from draft-wu to draft-ietf-netmod-factory-
default-00 without content changes. default-00 without content changes.
v02 - v03 v02 - v03
o Change reset-datastore RPC into factory-reset RPC to allow reset o Change reset-datastore RPC into factory-reset RPC to allow reset
the whole device with factory default content. the whole device with factory default content.
o Remove target datastore parameter from factory-reset RPC. o Remove target datastore parameter from factory-reset RPC.
o Other editorial changes. o Other editorial changes.
v01 - v02 v01 - v02
o Add copy-config based on Rob's comment. o Add copy-config based on Rob's comment.
skipping to change at page 9, line 49 skipping to change at page 10, line 17
o Remove target datastore parameter from factory-reset RPC. o Remove target datastore parameter from factory-reset RPC.
o Other editorial changes. o Other editorial changes.
v01 - v02 v01 - v02
o Add copy-config based on Rob's comment. o Add copy-config based on Rob's comment.
o Reference Update. o Reference Update.
v3 - v00 - v01 v03 - v00 - v01
o Changed name from draft-wu-netconf-restconf-factory-restore to o Changed name from draft-wu-netconf-restconf-factory-restore to
draft-wu-netmod-factory-default draft-wu-netmod-factory-default
o Removed copy-config ; reset-datastore is enough o Removed copy-config ; reset-datastore is enough
v02 - v03 v02 - v03
o Restructured o Restructured
 End of changes. 28 change blocks. 
42 lines changed or deleted 59 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/