NETCONF Working Group M. Bjorklund
Internet-Draft Tail-f Systems
Updates: 8040 (if approved) J. Schoenwaelder
Intended status: Standards Track Jacobs University
Expires: January 4, 2018 P. Shafer
K. Watsen
Juniper Networks
R. Wilton
Cisco Systems
July 3, 2017

RESTCONF Update to Support the NMDA


This document updates RESTCONF [RFC8040] in order to support the Network Management Datastore Architecture (NMDA) defined in [I-D.ietf-netmod-revised-datastores].

Editorial Note (To be removed by RFC Editor)

This draft contains many placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed. No other RFC Editor instructions are specified elsewhere in this document.

Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements:

Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement:

The following two Appendix sections are to be removed prior to publication:

Status of This Memo

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

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 January 4, 2018.

Copyright Notice

Copyright (c) 2017 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 ( 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

This document updates RESTCONF [RFC8040] in order to support the Network Management Datastore Architecture (NMDA) defined in [I-D.ietf-netmod-revised-datastores].

The solution presented in this document is backwards compatible with [RFC8040]. This is achieved by it only adding new top-level resources, and thereby leaving the semantics of all existing resources alone.

2. Requirements Language

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.

3. Summary of Updates to RFC 8040

This document updates [RFC8040] in the following ways:

4. Conformance

A RESTCONF server identifies that it supports NMDA both by supporting the <operational> datastore, as well as by supporting at least revision YANG_LIBRARY_REVISION of the "ietf-yang-library" module, as specified in [I-D.nmdsdt-netconf-rfc7895bis].

RESTCONF clients MAY test if a server supports NMDA using the HEAD method on the <operational> datastore resource, described later in this document.

RESTCONF clients MAY also test if a server supports the NMDA using either the HEAD or GET methods on 'ietf-yang-library:yang-library' resource, under either {+restconf}/data or <operational>, though only the latter resource SHOULD be used so that the client doesn't need to have any ongoing need to use the {+restconf}/data resource.

RESTCONF clients MAY also test if a server supports the NMDA by checking the revision number for the "ietf-yang-library" module listed under 'ietf-yang-library:modules-state', under either {+restconf}/data or <operational>. This approach might be preferred by some existing clients, but new clients should avoid using the deprecated 'modules-state' resource.

5. The {+restconf}/ds/<datastore> Resource


Knowing which datastores a server supports, from querying the ietf-yang-library module, a RESTCONF client interacts with specific datastores using the resource path template:


Where <datastore> is encoded as an 'identity'. For instance:

6. Protocol Operations

All existing protocol operations defined in [RFC8040] for the {+restconf}/data resource are available for all of the new datastore resources with the following exceptions:

7. Security Considerations


8. IANA Considerations


9. Normative References

[I-D.ietf-netmod-revised-datastores] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K. and R. Wilton, "Network Management Datastore Architecture", Internet-Draft draft-ietf-netmod-revised-datastores-03, July 2017.
[I-D.nmdsdt-netconf-rfc7895bis] Bierman, A., Bjorklund, M. and K. Watsen, "YANG Module Library", Internet-Draft draft-nmdsdt-netconf-rfc7895bis-00, May 2017.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997.
[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.

Authors' Addresses

Martin Bjorklund Tail-f Systems EMail:
Juergen Schoenwaelder Jacobs University EMail:
Phil Shafer Juniper Networks EMail:
Kent Watsen Juniper Networks EMail:
Rob Wilton Cisco Systems EMail: