]> Huawei

101 Software Avenue, Yuhua District Nanjing Jiangsu 210012 China bill.wu@huawei.com

Ericsson Hungary

Magyar Tudosok korutja 11 1117 Budapest Hungary +36-70-330-7909 balazs.lengyel@ericsson.com

Huawei

niuye@huawei.com

OPS Area NETMOD Working Group This document defines a method to reset a YANG datastore to it's factory-default content. The reset operation may be used e.g. during initial zero-touch configuration or when the existing configuration got major errors, so re-starting the configuration process from scratch is the best option. A new reset-datastore RPC is defined. Several methods of documenting the factory-default content are specified. Optionally a new "factory-default-running" read-only datastore is defined, that contains the data that will be copied over to the running datastore at reset.

This document defines a method to reset a YANG datastore to it's factory-default content. The reset operation may be used e.g. during initial zero-touch configuration or when the existing configuration got major errors, so re-starting the configuration process from scratch is the best option. When resetting a datastore all previous configuration settings will be lost and replaced by the factory-default content. A new reset-datastore RPC is defined. Several methods of documenting the factory-default content are specified. Optionally a new "factory-default-running" read-only datastore is defined, that contains the data that will be copied over to the running datastore at reset. This datastore can be used in <get-data> or <copy-config> operations. NETCONF defines the <delete> operation that allows resetting the <startup> datastore and the <discard-changes> operation that copies the content of the <running> datastore into the <candidate> datastore. However it is not possible to reset the running datastore, to reset the candidate datastore without changing the running datastore or to reset any dynamic datastore. A RESTCONF server MAY implement the above NETCONF operations, but that would still not allow it to reset the running configuration.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. The following terms are defined in [RFC8342] and are not redefined here: startup configuration datastore candiate configuration datastore running configuration datastore intended configuration datastore operational state datastore The following terms are defined in this document as follows: factory-default datastore: A read-only datastore holding a preconfigured minimal initial configuration that can be used to initialize the configuration of a server. The content of the datastore is usually static, but MAY depend on external factors like available HW.

A new "reset-datastore" RPC is introduced. It will have a target datastore as a parameter. Upon receiveing the RPC the YANG server resets the content of the target datastore to it's factory-default content. Only writable datastores can be specified as a target. Read-only datastores receive their content from other datastores (e.g. <intended> gets it's content from <running>). Factory-default content SHALL be specified by one of the following means in order of precedence For the <running>, <candidate> and <startup> datastores as the content of the <factory-default> datastore, if it exists YANG Instance Data In some implementation specific manner For dynamic datastores unless otherwise specified the factory-default content is empty.

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 server. Name: "factory-default" YANG modules: all YANG nodes: all "config true" data nodes Management operations: The content of the datastore is set by the YANG server in an implementation dependent manner. The content can not be changed by management operations via NETCONF, RESTCONF, the CLI etc. unless specialized, dedicated operations are provided. The contents of the datastore can be read using NETCONF, RESTCONF <get-data> operation. The operations <reset-datastore> or <copy-config> can be used to copy the content of the datastore to the another datastore. Protocols: RESTCONF, NETCONF and other management protocol. Defining YANG module: "ietf-factory-reset" The datastore content is usually defined by the device vendor. It is usually static, but MAY change e.g. depending on external factors like HW available or during device upgrade. On devices that support non-volatile storage, the contents of <factory > MUST persist across restarts

<CODE BEGINS> file "ietf-factory-default.yang" module ietf-factory-default { yang-version 1.1; namespace urn:ietf:params:xml:ns:yang:ietf-factory-default; prefix fdef; import ietf-netconf { prefix nc ; } import ietf-datastores { prefix ds; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: <https://tools.ietf.org/wg/netconf/> WG List: <mailto:netconf@ietf.org> WG Chair: Kent Watsen <mailto:kwatsen@juniper.net> WG Chair: Mahesh Jethanandani <mailto:mjethanandani@gmail.com> Editor: Balazs Lengyel <mailto:balazs.lengyel@ericsson.com> Editor: Qin Wu <mailto:bill.wu@huawei.com>"; description "This module defines the - reset-datastore RPC - 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 YANG datastore to it's factory-default content. Copyright (c) 2018 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://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 (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for full legal notices."; revision 2018-10-09 { description "Initial revision."; reference "RFC XXXX: Factory default Setting Capability for RESTCONF"; } feature factory-default-as-datastore { description "Indicates that the factory default configuration is also available as a separate datastore"; } rpc reset-datastore { description "The target datastore is reset to it's factory default content. "; input { leaf-list target-datasore { type identityref { base "ds:datastore" ; } min-elements 1; description "The datastore(s) of which's content will be replaced by the factory-default configuration."; } // Do we need an extra parameter that may order a restart of // the YANG-server or the whole system? } } identity factory-default { if-feature factory-default-as-datastore; base ds:datastore; description "The read-only datastore contains the configuration that will be copied into e.g. the running datastore by the reset-datastore operation if the target is the running datastore."; } augment /nc:copy-config/nc:input/nc:source/nc:config-source { if-feature factory-default-as-datastore; description " Allows the copy-config operation to use the factory-default-running-datastore as a source"; leaf factory-default { type empty ; description "The factory-default datastore is the source."; } } } <CODE ENDS>

This document registers one URI in the IETF XML Registry [RFC3688]. The following registration has been made: URI: urn:ietf:params:xml:ns:yang:ietf-factory-default Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. This document registers one YANG module in the YANG Module Names Registry [RFC6020]. The following registration has been made: name: ietf-factory-default namespace: urn:ietf:params:xml:ns:yang:ietf-factory-default prefix: fdef RFC: xxxx

The <reset-datastore> RPC can overwrite important and security sensitive information in one of the other datastores e.g. running, therefore it is important to restrict access to this RPC using the standard access control methods. The content of the factory-default datastore is usually not security sensitive as it is the same on any device of a certain type.

Thanks to Juergen Schoenwaelder, Ladislav Lhotka to review this draft and provide important input to this document.

Rohit R Ranade Huawei Email: rohitrranade@huawei.com

Do we need a restart after <reset-datastore> ? What kind of restart, just the YANG-Server or the full system? Do we need the concept of reboot? How is that different from a restart? Does it result in some sort of reset-datastore?

When the device first boots up, the content of the <startup> and <factory-default> will be identical. The content of <startup> can be subsequently changed by using <startup> as a target in a <copy-config> operation. The <factory-default> is a read-only datastore and it is usually static as described in earlier sections.

v02 - v03 Restructured Made new datastore optional Removed Netconf capability Listed Open issues v01 - v02 - v00 - v01 -