| NETCONF Working Group | Q. Wu |
| Internet-Draft | Y. Niu |
| Intended status: Standards Track | Huawei |
| Expires: December 31, 2018 | June 29, 2018 |
Factory default Setting Capability for RESTCONF
draft-wu-netconf-restconf-factory-restore-01
This document defines capability based extension to RESTCONF protocol that allows RESTCONF client to configure newly deployed devices with just its preconfigured initial state (i.e., factory default settings) during zero touch bootstrapping process or restore the configuration to its preconfigured initial state or system restore point either during device rooting process or at the time of system fatal error or malfunction.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 31, 2018.
Copyright (c) 2018 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.
RESTCONF uses HTTP methods such as HTTP POST, PUT, PATCH, and DELETE to provide CRUD operations on a conceptual datastore containing YANG- defined data, which is compatible with a server that implements NETCONF datastores. As described in [RFC8040], the HTTP PUT method on the datastore resource can be used to replace the entire content of the Datasore, however it can not be used to return any datastore (e.g., <startup>) to factory default setting or previous system restore point,especially when the RESTCONF server is implemented in a device that does not have NETCONF support. One of reasons is RESTCONF doesn't support URL capability.
This document defines capability based extension to RESTCONF protocol that allows RESTCONF client to configure newly deployed devices with just its preconfigured initial state (i.e., factory default settings) during zero touch bootstrapping process or restore the configuration to its preconfigured initial state or system restore point either during device rooting process or at the time of system fatal error.
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:
A RESTCONF server implementing this document MUST be NMDA-compliant [I-D.ietf-netconf-nmda-restconf] and is implemented in a device that does not have a NETCONF server [RFC8040]. A RESTCONF server supports both the operational state Datastore and the intended configuration datastore.
{+restconf}/ds/ietf-restconf-restore:factory-default
This document introduces a new datastore resource named 'Factory default setting' that represents datastore with its preconfigured initial state. This datastore resource is available using the following resource path:
ietf-restconf-restore:factory-default path component is encoded as an "identity" according to the JSON encoding rules for identities, defined in Section 4 of [RFC7951]. Such an identity MUST be derived from the "datastore" identity defined in the "ietf-datastores" YANG module [RFC8342].
When the factory default configuration is made accessible to the RESTCONF client The Factory default datastore is essentially a read only datastore.
In order to support factory restore and system restore capability in RESTCONF, the YANG module "ietf-restconf-restore" defines three operations below. The factory-restore operation is is similar to NETCONF <delete-config> and defined to support Factory default Setting Capability in RESTCONF.
The <factor-restore> operation atomically returns any target datastore to factory default setting. The <factor-restore>operation replaces the entire contents of a writable Datastore with the contents of complete factory default setting, similar to the <delete-config> operation defined in [RFC6241], but with additional flexibility in specifying the source with URL capability or as a new factory default datastore resource. If the target datastore exists, it is overwritten. Otherwise, a new one is created, if allowed. If an <factory-restore> operation is invoked on a non-writable datastore, then an error is returned, as specified in"ietf-netconf-nmda".
The "source" parameter is a datastore identity that indicates the desired source of <factor-restore> operation.
The "target" parameter is a name of the configuration datastore to use as the destination of the <factory-restore> operation.
The <url> element can appear as the <source> or <target> parameter.
The "restart" parameter is used to indicate whether to use bootstrapping to return target datastore to factory default setting in the < factor-restore > operation. If bootstrapping is used, the "source" parameter MAY not be specified.
POST /restconf/operations/ietf-restconf-factory-default:factory-recovery HTTP/1.1
Host: example.com
Content-Type: application/yang-data+xml
<input xmlns="https://example.com/ns/ ietf-restconf-factory-default ">
<source>
<url>file://checkpoint.conf</url>
</source>
<target>ds:running</target>
<restart>false</restart>
</input>
The client(e.g.,NMS) might send the following POST request message to invoke the "factory-recovery" RPC operation:
HTTP/1.1 204 No Content
Date: Thu, 26 Jan 2017 20:56:30 GMT
Server: example-server
In this request, <restart> element should be set to false, <source> element MUST be specified. If URL Capability is supported, <url>element in the <source> element MUST be specified. The server will use HTTP GET method to retrieve content of <source> corresponding to factory default setting datastore and copy the entire content to <target>. In successful case, the server might respond as follows:
POST /restconf/operations/ietf-restconf-factory-default:factory-recovery HTTP/1.1
Host: example.com
Content-Type: application/yang-data+xml
<input xmlns="https://example.com/ns/ ietf-restconf-factory-default ">
<target>ds:running</target>
<restart>true</restart>
</input>
The client(e.g.,NMS) might send the following POST request message to invoke the "factory-recovery" RPC operation:
HTTP/1.1 204 No Content
Date: Thu, 26 Jan 2017 20:56:30 GMT
Server: example-server
In this request, <restart> element should be set to true, <source> element is not specified. The server will use zerotouch bootstrap service defined in [I-D.ietf-netconf-zerotouch] to get factory default setting configuration from source of bootstrapping data( e.g., a file or URL) and copy the entire content to <target>. In successful case, the server might respond as follows:
<CODE BEGINS> file "ietf-restconf-restore@2018-06-21.yang"
module ietf-restconf-restore {
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-restore";
prefix rct;
import ietf-inet-types {
prefix inet;
}
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: Qin Wu
<mailto:bill.wu@huawei.com>";
description
"This module defines operations that implement factory-default and
system restore capability in the RESTCONF protocol.
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-06-21 {
description
"Initial revision.";
reference "RFC XXXX: Factory default Setting Capability for RESTCONF";
}
identity ephemeral {
base ds:dynamic;
description
"The ephemeral dynamic configuration datastore.";
}
identity factory {
base ds:datastore;
description
"The factory default configuration datastore.";
}
rpc factory-restore {
description
"The <factor-restore> operation atomically returns any target datastore
to factory default setting. The <factor-restore>operation replaces the
entire contents of a writable Datastore with the contents of complete
factory default setting, similar to the <delete-config> operation defined in
[RFC6241], but with additional flexibility in specifying the desired source
with URL capability or as new factory default datastore.
";
input {
container target {
description
"Particular configuration to return factory default setting to.";
choice config-target {
mandatory true;
description
"The configuration target of the factory default operation.";
leaf datastore {
type ds:datastore-ref;
mandatory true;
description
"Datastore which is the target of the factory-restore operation.
If the datastore is not supported by the server, then the
server MUST return an <rpc-error> element with an
<error-tag> value of 'invalid-value'.";
}
leaf url {
type inet:uri;
description
"The URL-based configuration is the config target.";
}
}
}
container source {
description
"Particular factory default configuration for factory restore
operation.";
choice config-source {
mandatory true;
description
"The configuration source for the factory default operation.";
leaf factory {
type ds:datastore-ref;
description
"The factory-default-setting configuration is the config source.";
}
leaf url {
type inet:uri;
description
"The URL-based configuration is the config source.";
}
}
}
leaf restart {
type boolean;
description
"indicate whether restart or zero touch bootstrapping
service is enabled.";
}
}
}
}
<CODE ENDS>
This document registers one URI in the IETF XML Registry [RFC3688]. The following registration has been made:
This document registers one YANG module in the YANG Module Names Registry [RFC6020]. The following registration has been made:
[RFC6241] provides security considerations for the base NETCONF message layer and the base operations of the NETCONF protocol. Security considerations for the NETCONF transports are provided in the transport documents.
In addition, it is important to recognize that <factor-restore> to the startup or running configurations is a sensitive provisioning operation, such global operations MUST disallow the changing of information that an individual does not have authorization to perform.
Thanks to Juergen Schoenwaelder, Ladislav Lhotka, Rohit R Ranade to review this draft and provide important input to this document.
| [I-D.ietf-netconf-zerotouch] | Watsen, K., Abrahamsson, M. and I. Farrer, "Zero Touch Provisioning for Networking Devices", Internet-Draft draft-ietf-netconf-zerotouch-22, June 2018. |
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
| [RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004. |
| [RFC5277] | Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008. |
| [RFC6020] | Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010. |
| [RFC6021] | Schoenwaelder, J., "Common YANG Data Types", RFC 6021, DOI 10.17487/RFC6021, October 2010. |
| [RFC6241] | Enns, R., Bjorklund, M., Schoenwaelder, J. and A. Bierman, "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011. |
| [RFC6242] | Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011. |
| [RFC6470] | Bierman, A., "Network Configuration Protocol (NETCONF) Base Notifications", RFC 6470, DOI 10.17487/RFC6470, February 2012. |
| [RFC8040] | Bierman, A., Bjorklund, M. and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017. |
| [RFC8174] | Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017. |
| [RFC8342] | Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K. and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018. |