A YANG Data Model for Factory Default Settings
RFC 8808

Document Type RFC - Proposed Standard (August 2020; No errata)
Authors Qin Wu  , Balázs Lengyel  , Ye Niu 
Last updated 2020-08-31
Replaces draft-wu-netmod-factory-default
Stream IETF
Formats plain text html xml pdf htmlized bibtex
Yang Validation 0 errors, 0 warnings.
Reviews
Additional Resources
- Yang catalog entry for ietf-factory-default@2019-11-27.yang
- Yang impact analysis for draft-ietf-netmod-factory-default
- Mailing list discussion
Stream WG state Submitted to IESG for Publication
Document shepherd Kent Watsen
Shepherd write-up Show (last changed 2020-02-17)
IESG IESG state RFC 8808 (Proposed Standard)
Consensus Boilerplate Yes
Telechat date
Responsible AD Robert Wilton
Send notices to Kent Watsen <kent+ietf@watsen.net>
IANA IANA review state Version Changed - Review Needed
IANA action state RFC-Ed-Ack
IANA expert review state Expert Reviews OK


Internet Engineering Task Force (IETF)                             Q. Wu
Request for Comments: 8808                                        Huawei
Category: Standards Track                                     B. Lengyel
ISSN: 2070-1721                                         Ericsson Hungary
                                                                  Y. Niu
                                                                  Huawei
                                                             August 2020

             A YANG Data Model for Factory Default Settings

Abstract

   This document defines a YANG data model with the "factory-reset" RPC
   to allow clients to reset a server back to its factory default
   condition.  It also defines an optional "factory-default" datastore
   to allow clients to read the factory default configuration for the
   device.

   The YANG data model in this document conforms to the Network
   Management Datastore Architecture (NMDA) defined in RFC 8342.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 7841.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   https://www.rfc-editor.org/info/rfc8808.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction
     1.1.  Terminology
   2.  "Factory-Reset" RPC
   3.  "Factory-Default" Datastore
   4.  YANG Module
   5.  IANA Considerations
   6.  Security Considerations
   7.  References
     7.1.  Normative References
     7.2.  Informative References
   Acknowledgements
   Contributors
   Authors' Addresses

1.  Introduction

   This document defines a YANG data model and associated mechanism to
   reset a server to its factory default contents.  This mechanism may
   be used, for example, when the existing configuration has major
   errors and so restarting the configuration process from scratch is
   the best option.

   A "factory-reset" remote procedure call (RPC) is defined within the
   YANG data model.  When resetting a device, all previous configuration
   settings will be lost and replaced by the factory default contents.

   In addition, an optional "factory-default" read-only datastore is
   defined within the YANG data model.  This datastore contains the data
   to replace the contents of implemented read-write conventional
   configuration datastores at reset and can also be used in the
   <get-data> operation.

   The YANG data model in this document conforms to the Network
   Management Datastore Architecture defined in [RFC8342].

1.1.  Terminology

   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 [RFC7950] and are
   not redefined here:

   *  server

   *  startup configuration datastore

   *  candidate configuration datastore

   *  running configuration datastore

   *  intended configuration datastore

   *  operational state datastore

   *  conventional configuration datastore

   *  datastore schema

   *  RPC operation

   This document defines the following term:

   "factory-default" datastore:  A read-only configuration datastore
      holding a preset initial configuration that is used to initialize
      the configuration of a server.  This datastore is referred to as
      "<factory-default>".

2.  "Factory-Reset" RPC

   This document introduces a new "factory-reset" RPC.  Upon receiving
   the RPC:

   *  All supported conventional read-write configuration datastores
      (i.e., <running>, <startup>, and <candidate>) are reset to the
      contents of <factory-default>.

   *  Read-only datastores receive their contents from other datastores
      (e.g., <intended> gets its contents from <running>).
Show full document text