draft-ietf-netconf-nmda-restconf-05.txt   rfc8527.txt 
Network Working Group M. Bjorklund Internet Engineering Task Force (IETF) M. Bjorklund
Internet-Draft Tail-f Systems Request for Comments: 8527 Tail-f Systems
Updates: 8040 (if approved) J. Schoenwaelder Updates: 8040 J. Schoenwaelder
Intended status: Standards Track Jacobs University Category: Standards Track Jacobs University
Expires: April 12, 2019 P. Shafer ISSN: 2070-1721 P. Shafer
K. Watsen
Juniper Networks Juniper Networks
K. Watsen
Watsen Networks
R. Wilton R. Wilton
Cisco Systems Cisco Systems
October 9, 2018 March 2019
RESTCONF Extensions to Support the Network Management Datastore RESTCONF Extensions to Support the
Architecture Network Management Datastore Architecture
draft-ietf-netconf-nmda-restconf-05
Abstract Abstract
This document extends the RESTCONF protocol defined in RFC 8040 in This document extends the RESTCONF protocol defined in RFC 8040 in
order to support the Network Management Datastore Architecture order to support the Network Management Datastore Architecture (NMDA)
defined in RFC 8342. defined in RFC 8342.
This document updates RFC 8040 by introducing new datastore This document updates RFC 8040 by introducing new datastore
resources, adding a new query parameter, and requiring the usage of resources, adding a new query parameter, and requiring the usage of
I-D.ietf-netconf-rfc7895bis by RESTCONF servers implementing the the YANG library (described in RFC 8525) by RESTCONF servers
Network Management Datastore Architecture. implementing the NMDA.
RFC Ed.: Please replace "I-D.ietf-netconf-rfc7895bis" above with its
final RFC assignment and remove this note.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This is an Internet Standards Track document.
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 http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months This document is a product of the Internet Engineering Task Force
and may be updated, replaced, or obsoleted by other documents at any (IETF). It represents the consensus of the IETF community. It has
time. It is inappropriate to use Internet-Drafts as reference received public review and has been approved for publication by the
material or to cite them other than as "work in progress." Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 7841.
This Internet-Draft will expire on April 12, 2019. 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/rfc8527.
Copyright Notice Copyright Notice
Copyright (c) 2018 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
(http://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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction ....................................................3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology ................................................3
2. Datastore and YANG Library Requirements . . . . . . . . . . . 3 2. Datastore and YANG Library Requirements .........................3
3. RESTCONF Extensions . . . . . . . . . . . . . . . . . . . . . 3 3. RESTCONF Extensions .............................................4
3.1. New Datastore Resources . . . . . . . . . . . . . . . . . 3 3.1. New Datastore Resources ....................................4
3.2. Protocol Operations . . . . . . . . . . . . . . . . . . . 4 3.2. Protocol Operations ........................................5
3.2.1. With-defaults query parameter on the operational 3.2.1. The "with-defaults" Query Parameter on the
state datastore . . . . . . . . . . . . . . . . . . . 5 Operational State Datastore .........................5
3.2.2. New "with-origin" Query Parameter . . . . . . . . . . 5 3.2.2. New "with-origin" Query Parameter ...................6
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 4. IANA Considerations .............................................7
5. Security Considerations . . . . . . . . . . . . . . . . . . . 6 5. Security Considerations .........................................7
6. Normative References . . . . . . . . . . . . . . . . . . . . 7 6. Normative References ............................................7
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 Authors' Addresses .................................................9
1. Introduction 1. Introduction
This document extends the RESTCONF protocol defined in [RFC8040] in This document extends the RESTCONF protocol defined in [RFC8040] in
order to support the Network Management Datastore Architecture (NMDA) order to support the Network Management Datastore Architecture (NMDA)
defined in [RFC8342]. defined in [RFC8342].
This document updates [RFC8040] in order to enable RESTCONF clients This document updates [RFC8040] in order to enable RESTCONF clients
to discover which datastores are supported by the RESTCONF server, to discover which datastores are supported by the RESTCONF server,
determine which modules are supported in each datastore, and to determine which modules are supported in each datastore, and interact
interact with all the datastores supported by the NMDA. with all the datastores supported by the NMDA. Specifically, the
Specifically, the update introduces new datastore resources, adds a update introduces new datastore resources, adds a new query
new query parameter, and requires the usage of parameter, and requires the usage of the YANG library [RFC8525] by
[I-D.ietf-netconf-rfc7895bis] by RESTCONF servers implementing the RESTCONF servers implementing the NMDA.
NMDA.
The solution presented in this document is backwards compatible with The solution presented in this document is backwards compatible with
[RFC8040]. This is achieved by only adding new resources and leaving [RFC8040]. This is achieved by only adding new resources and leaving
the semantics of the existing resources unchanged. the semantics of the existing resources unchanged.
1.1. Terminology 1.1. Terminology
This document uses the terminology defined by the NMDA [RFC8342]. This document uses the terminology defined by the NMDA [RFC8342].
The keywords "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
14, [RFC2119] [RFC8174] when, and only when, they appear in all BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
2. Datastore and YANG Library Requirements 2. Datastore and YANG Library Requirements
RFC Ed.: Please update 201X-XX-XX below with correct date and remove
this note.
An NMDA-compliant RESTCONF server MUST support the operational state An NMDA-compliant RESTCONF server MUST support the operational state
datastore and it MUST implement at least revision 201X-XX-XX of the datastore and MUST implement at least revision 2019-01-04 of the
"ietf-yang-library" module defined in [I-D.ietf-netconf-rfc7895bis]. "ietf-yang-library" module defined in [RFC8525].
Such a server identifies that it supports the NMDA both by Such a server identifies that it supports the NMDA both by
implementing the {+restconf}/ds/ietf-datastores:operational resource, implementing the {+restconf}/ds/ietf-datastores:operational resource
and by implementing at least revision 201X-XX-XX of the and by implementing at least revision 2019-01-04 of the
"ietf-yang-library" module. "ietf-yang-library" module.
A RESTCONF client can test if a server supports the NMDA by using A RESTCONF client can test if a server supports the NMDA by using
either the HEAD or GET methods on {+restconf}/ds/ietf- either the HEAD or GET methods on {+restconf}/ds/ietf-
datastores:operational. datastores:operational.
A RESTCONF client can discover which datastores and YANG modules the A RESTCONF client can discover which datastores and YANG modules the
server supports by reading the YANG library information from the server supports by reading the YANG library information from the
operational state datastore. operational state datastore.
skipping to change at page 4, line 29 skipping to change at page 4, line 42
o The resource {+restconf}/ds/ietf-datastores:intended refers to the o The resource {+restconf}/ds/ietf-datastores:intended refers to the
intended configuration datastore. intended configuration datastore.
An NMDA-compliant server MUST implement {+restconf}/ds/ietf- An NMDA-compliant server MUST implement {+restconf}/ds/ietf-
datastores:operational. Other datastore resources MAY be datastores:operational. Other datastore resources MAY be
implemented. implemented.
YANG actions can only be invoked in {+restconf}/ds/ietf- YANG actions can only be invoked in {+restconf}/ds/ietf-
datastores:operational. datastores:operational.
If a server implements other datastores, such as the example As an example, if a server implements a datastore called
datastore "ds-ephemeral" in the module "example-ds-ephemeral", the "ds-ephemeral", defined in a module called "example-ds-ephemeral",
server would implement the resource {+restconf}/ds/example- ds- then the server would implement the resource {+restconf}/ds/example-
ephemeral:ds-ephemeral. ds-ephemeral:ds-ephemeral.
3.2. Protocol Operations 3.2. Protocol Operations
The protocol operations available for the new datastore resources The protocol operations available for the new datastore resources
(Section 3.1) are the same as the protocol operations defined in (see Section 3.1) are the same as the protocol operations defined in
[RFC8040] for the {+restconf}/data resource with the following [RFC8040] for the {+restconf}/data resource with the following
exceptions: exceptions:
o Dynamic configuration datastores are excluded, as each dynamic o Dynamic configuration datastores are excluded, as each dynamic
configuration datastore definition needs to be reviewed for what configuration datastore definition needs to be reviewed for what
protocol operations it supports. protocol operations it supports.
o Some datastores are read-only by nature (e.g., <intended>), and o Some datastores are read-only by nature (e.g., <intended>); hence,
hence any attempt to modify these datastores will fail. A server any attempt to modify these datastores will fail. A server MUST
MUST return a response with a "405 Method Not Allowed" status-line return a response with a "405 Method Not Allowed" status-line and
and error-tag value "operation-not-supported". an error-tag value of "operation-not-supported".
o The semantics of the "with-defaults" query parameter ([RFC8040], o The semantics of the "with-defaults" query parameter
Section 4.8.9) differs when interacting with the operational state (Section 4.8.9 of [RFC8040]) differ when interacting with the
datastore. The semantics are described below, in Section 3.2.1. operational state datastore. The semantics are described in
Section 3.2.1.
o [RFC8040], Section 3.5.4, paragraph 3 does not apply when o [RFC8040], Section 3.5.4, paragraph 3 does not apply when
interacting with any resource under {+restconf}/ds. interacting with any resource under {+restconf}/ds.
3.2.1. With-defaults query parameter on the operational state datastore 3.2.1. The "with-defaults" Query Parameter on the Operational State
Datastore
The "with-defaults" query parameter ([RFC8040], Section 4.8.9) is Support for the "with-defaults" query parameter (Section 4.8.9 of
OPTIONAL to support when interacting with {+restconf}/ds/ietf- [RFC8040]) is OPTIONAL when interacting with {+restconf}/ds/ietf-
datastores:operational. The associated capability to indicate a datastores:operational. The associated capability to indicate a
server's support is identified with the URI: server's support is identified with the URI:
urn:ietf:params:restconf:capability:with-operational-defaults:1.0 urn:ietf:params:restconf:capability:with-operational-defaults:1.0
For servers that support it, the behavior of the "with-defaults" For servers that support it, the behavior of the "with-defaults"
query parameter on the operational state datastore is defined as query parameter on the operational state datastore is defined as
follows: follows:
o If no "with-defaults" query parameter is specified, or if it is o If no "with-defaults" query parameter is specified, or if it is
set to "explicit", "report-all", or "report-all-tagged", then the set to "explicit", "report-all", or "report-all-tagged", then the
"in use" values, as defined in [RFC8342] section 5.3, are returned "in use" values, as defined in Section 5.3 of [RFC8342], are
from the operational state datastore, even if a node happens to returned from the operational state datastore, even if a node
have a default statement in the YANG module and this default value happens to have a default statement in the YANG module and this
is being used by the server. If the "with-defaults" parameter is default value is being used by the server. If the "with-defaults"
set to "report-all-tagged", any values that match the schema parameter is set to "report-all-tagged", any values that match the
default are tagged with additional metadata, as described in schema default are tagged with additional metadata, as described
[RFC8040], Section 4.8.9. in Section 4.8.9 of [RFC8040].
o If the "with-defaults" query parameter is set to "trim", all "in o If the "with-defaults" query parameter is set to "trim", all "in
use" values are returned, except that the output is filtered to use" values are returned, except that the output is filtered to
exclude any values that match the default defined in the YANG exclude any values that match the default defined in the YANG
schema. schema.
Servers are not required to support all values in the "with-defaults" Servers are not required to support all values in the "with-defaults"
query parameter on the operational state datastore. If a request is query parameter on the operational state datastore. If a request is
made using a value that is not supported, then the error handling made using a value that is not supported, then the error handling
behavior is as described in ([RFC8040], Section 4.8.9). behavior is as described in Section 4.8.9 of [RFC8040].
3.2.2. New "with-origin" Query Parameter 3.2.2. New "with-origin" Query Parameter
A new query parameter named "with-origin" is added to the GET A new query parameter named "with-origin" is added to the GET
operation. If present, it requests that the server includes "origin" operation. If present, it requests that the server includes "origin"
metadata annotations in its response, as detailed in the NMDA. This metadata annotations in its response, as detailed in the NMDA. This
parameter is only valid when querying {+restconf}/ds/ietf- parameter is only valid when querying {+restconf}/ds/ietf-
datastores:operational or any datastores with identities derived from datastores:operational or any datastores with identities derived from
the "operational" identity. Otherwise, if an invalid datastore is the "operational" identity. Otherwise, if an invalid datastore is
specified then the server MUST return a response with a "400 Bad specified, then the server MUST return a response with a "400 Bad
Request" status-line, using an error-tag value of "invalid-value". Request" status-line, using an error-tag value of "invalid-value".
"origin" metadata annotations are not included unless a client "origin" metadata annotations are not included unless a client
explicitly requests them. explicitly requests them.
Data in the operational state datatstore can come from multiple Data in the operational state datatstore can come from multiple
sources. The server should return the most accurate value for the sources. The server should return the "origin" metadata annotation
"origin" metadata annotation as possible, indicating the source of value that most accurately indicates the source of the operational
the operational value, as specified in Section 5.3.4 of [RFC8342]. value, as specified in Section 5.3.4 of [RFC8342].
When encoding the origin metadata annotation for a hierarchy of When encoding the "origin" metadata annotation for a hierarchy of
returned nodes, the annotation can be omitted for a child node when returned nodes, the annotation can be omitted for a child node when
the value matches that of the parent node, as described in the value matches that of the parent node, as described in the
"ietf-origin" YANG module [RFC8342]. "ietf-origin" YANG module [RFC8342].
The "with-origin" query parameter is OPTIONAL to support. It is Support for the "with-origin" query parameter is OPTIONAL. It is
identified with the URI: identified with the URI:
urn:ietf:params:restconf:capability:with-origin:1.0 urn:ietf:params:restconf:capability:with-origin:1.0
4. IANA Considerations 4. IANA Considerations
This document defines two capability identifier URNs in the "RESTCONF This document defines two capability identifier URNs in the "RESTCONF
Capability URNs" registry defined in [RFC8040]: Capability URNs" registry defined in [RFC8040]:
Index Index
skipping to change at page 7, line 7 skipping to change at page 7, line 36
[RFC8341], which provides the means to restrict access for particular [RFC8341], which provides the means to restrict access for particular
RESTCONF users to a preconfigured subset of all available RESTCONF RESTCONF users to a preconfigured subset of all available RESTCONF
protocol operations and content. protocol operations and content.
The security constraints for the base RESTCONF protocol (see The security constraints for the base RESTCONF protocol (see
Section 12 of [RFC8040]) apply to the new RESTCONF datastore Section 12 of [RFC8040]) apply to the new RESTCONF datastore
resources defined in this document. resources defined in this document.
6. Normative References 6. Normative References
[I-D.ietf-netconf-rfc7895bis]
Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
and R. Wilton, "YANG Library", draft-ietf-netconf-
rfc7895bis-06 (work in progress), April 2018.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, <https://www.rfc- DOI 10.17487/RFC2119, March 1997,
editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG",
RFC 7951, DOI 10.17487/RFC7951, August 2016, RFC 7951, DOI 10.17487/RFC7951, August 2016,
<https://www.rfc-editor.org/info/rfc7951>. <https://www.rfc-editor.org/info/rfc7951>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341, Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018, <https://www.rfc- DOI 10.17487/RFC8341, March 2018,
editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>. <https://www.rfc-editor.org/info/rfc8342>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>. <https://www.rfc-editor.org/info/rfc8446>.
[RFC8525] Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
and R. Wilton, "YANG Library", RFC 8525,
DOI 10.17487/RFC8525, March 2019,
<https://www.rfc-editor.org/info/rfc8525>.
Authors' Addresses Authors' Addresses
Martin Bjorklund Martin Bjorklund
Tail-f Systems Tail-f Systems
Email: mbj@tail-f.com Email: mbj@tail-f.com
Juergen Schoenwaelder Juergen Schoenwaelder
Jacobs University Jacobs University
Email: j.schoenwaelder@jacobs-university.de Email: j.schoenwaelder@jacobs-university.de
Phil Shafer Phil Shafer
Juniper Networks Juniper Networks
Email: phil@juniper.net Email: phil@juniper.net
skipping to change at page 8, line 15 skipping to change at page 9, line 23
Jacobs University Jacobs University
Email: j.schoenwaelder@jacobs-university.de Email: j.schoenwaelder@jacobs-university.de
Phil Shafer Phil Shafer
Juniper Networks Juniper Networks
Email: phil@juniper.net Email: phil@juniper.net
Kent Watsen Kent Watsen
Juniper Networks Watsen Networks
Email: kwatsen@juniper.net Email: kent+ietf@watsen.net
Robert Wilton Robert Wilton
Cisco Systems Cisco Systems
Email: rwilton@cisco.com Email: rwilton@cisco.com
 End of changes. 38 change blocks. 
100 lines changed or deleted 93 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/