draft-ietf-netconf-nmda-restconf-02.txt   draft-ietf-netconf-nmda-restconf-03.txt 
Network Working Group M. Bjorklund Network Working Group M. Bjorklund
Internet-Draft Tail-f Systems Internet-Draft Tail-f Systems
Updates: 8040 (if approved) J. Schoenwaelder Updates: 8040 (if approved) J. Schoenwaelder
Intended status: Standards Track Jacobs University Intended status: Standards Track Jacobs University
Expires: July 21, 2018 P. Shafer Expires: September 2, 2018 P. Shafer
K. Watsen K. Watsen
Juniper Networks Juniper Networks
R. Wilton R. Wilton
Cisco Systems Cisco Systems
January 17, 2018 March 1, 2018
RESTCONF Extensions to Support the Network Management Datastore RESTCONF Extensions to Support the Network Management Datastore
Architecture Architecture
draft-ietf-netconf-nmda-restconf-02 draft-ietf-netconf-nmda-restconf-03
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
defined in I-D.ietf-netmod-revised-datastores. defined in I-D.ietf-netmod-revised-datastores.
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 I-D.ietf-netconf-rfc7895bis by RESTCONF servers implementing the
skipping to change at page 1, line 47 skipping to change at page 1, line 47
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 21, 2018. This Internet-Draft will expire on September 2, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 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 (http://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
skipping to change at page 2, line 28 skipping to change at page 2, line 28
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
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 . . . . . . . . . . . . . . . . . . . . . 3
3.1. New Datastore Resources . . . . . . . . . . . . . . . . . 3 3.1. New Datastore Resources . . . . . . . . . . . . . . . . . 3
3.2. Protocol Operations . . . . . . . . . . . . . . . . . . . 4 3.2. Protocol Operations . . . . . . . . . . . . . . . . . . . 4
3.2.1. New "with-origin" Query Parameter . . . . . . . . . . 5 3.2.1. With-defaults query parameter on the operational
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 state datastore . . . . . . . . . . . . . . . . . . . 5
5. Security Considerations . . . . . . . . . . . . . . . . . . . 5 3.2.2. New "with-origin" Query Parameter . . . . . . . . . . 5
6. Normative References . . . . . . . . . . . . . . . . . . . . 6 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
5. Security Considerations . . . . . . . . . . . . . . . . . . . 6
6. Normative References . . . . . . . . . . . . . . . . . . . . 7
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7
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 [I-D.ietf-netmod-revised-datastores]. defined in [I-D.ietf-netmod-revised-datastores].
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, as to discover which datastores are supported by the RESTCONF server, as
skipping to change at page 4, line 41 skipping to change at page 4, line 45
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>), and
hence any attempt to modify these datastores will fail. A server hence any attempt to modify these datastores will fail. A server
MUST return a response with a "405 Method Not Allowed" status- MUST return a response with a "405 Method Not Allowed" status-
line, and error-tag value "operation-not-supported". line, and error-tag value "operation-not-supported".
o The "with-defaults" query parameter ([RFC8040], Section 4.8.9) o The semantics of the "with-defaults" query parameter ([RFC8040],
does not apply when interacting with {+restconf}/ds/ietf- Section 4.8.9) differs when interacting with the operational state
datastores:operational. This means that all "in use" values, as datastore. The semantics are described below, in Section 3.2.1.
defined in [I-D.ietf-netmod-revised-datastores] section 5.3, are
returned for the operational state datastore, even if a node
happens to have a default statement in the YANG module, and this
default value is being used by the server. If the "with-defaults"
query parameter is present in a request to this resource, the
server MUST return a response with a "400 Bad Request" status-
line. The error-tag value "invalid-value" is used in this case.
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. New "with-origin" Query Parameter 3.2.1. With-defaults query parameter on the operational state datastore
The "with-defaults" query parameter ([RFC8040], Section 4.8.9) is
optional to support when interacting with {+restconf}/ds/ietf-
datastores:operational. The associated capability to indicate a
server's support is identified with the URI:
urn:ietf:params:restconf:capability:with-operational-defaults:1.0
For servers that support it, the behavior of the "with-defaults"
query parameter on the operational state datastore is defined as
follows:
o If no "with-defaults" query parameter is specified, or if it is
set to "explicit", "report-all", or "report-all-tagged", then the
"in use" values, as defined in
[I-D.ietf-netmod-revised-datastores] section 5.3, are returned
from the operational state datastore, even if a node happens to
have a default statement in the YANG module, and this default
value is being used by the server. If the "with-defaults"
parameter is set to "report-all-tagged", any values that match the
schema default are tagged with additional metadata, as described
in [RFC8040], Section 4.8.9.
o If the "with-defaults" query parameter is set to "trim", all "in
use" values are returned, except that the output is filtered to
exclude any values that match the default defined in the YANG
schema.
Servers are not required to support all values in the "with-defaults"
query parameter on the operational state datastore. If a request is
made using a value that is not supported, then the error handling
behavior is as described in ([RFC8040], Section 4.8.9).
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
skipping to change at page 5, line 39 skipping to change at page 6, line 23
the value matches that of the parent node, as described in the value matches that of the parent node, as described in
"ietf-origin" YANG module [I-D.ietf-netmod-revised-datastores]. "ietf-origin" YANG module [I-D.ietf-netmod-revised-datastores].
The "with-origin" query parameter is optional to support. It is The "with-origin" query parameter is optional to support. 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 one capability in the "RESTCONF Capability This document defines two capability identifier URNs in the "RESTCONF
URNs" registry defined in [RFC8040]: Capability URNs" registry defined in [RFC8040]:
Index Capability Identifier Index
------------------------------------------------------------------ Capability Identifier
---------------------
:with-origin urn:ietf:params:restconf:capability:with-origin:1.0 :with-origin
urn:ietf:params:restconf:capability:with-origin:1.0
:with-operational-defaults
urn:ietf:params:restconf:capability:with-operational-defaults:1.0
5. Security Considerations 5. Security Considerations
This documents extends the RESTCONF protocol by introducing new This documents extends the RESTCONF protocol by introducing new
datastore resources. The lowest RESTCONF layer is HTTPS, and the datastore resources. The lowest RESTCONF layer is HTTPS, and the
mandatory-to-implement secure transport is TLS [RFC5246]. The mandatory-to-implement secure transport is TLS [RFC5246]. The
RESTCONF protocol uses the network configuration access control model RESTCONF protocol uses the network configuration access control model
[I-D.ietf-netconf-rfc6536bis], which provides the means to restrict [I-D.ietf-netconf-rfc6536bis], which provides the means to restrict
access for particular RESTCONF users to a preconfigured subset of all access for particular RESTCONF users to a preconfigured subset of all
available RESTCONF protocol operations and content. available RESTCONF 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 resources Section 12 of [RFC8040] apply to the new RESTCONF datastore resources
defined in this document. defined in this document.
6. Normative References 6. Normative References
skipping to change at page 6, line 21 skipping to change at page 7, line 13
defined in this document. defined in this document.
6. Normative References 6. Normative References
[I-D.ietf-netconf-rfc6536bis] [I-D.ietf-netconf-rfc6536bis]
Bierman, A. and M. Bjorklund, "Network Configuration Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Module", draft-ietf-netconf-rfc6536bis-09 Access Control Module", draft-ietf-netconf-rfc6536bis-09
(work in progress), December 2017. (work in progress), December 2017.
[I-D.ietf-netconf-rfc7895bis] [I-D.ietf-netconf-rfc7895bis]
Bierman, A., Bjorklund, M., and K. Watsen, "YANG Library", Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
draft-ietf-netconf-rfc7895bis-02 (work in progress), and R. Wilton, "YANG Library", draft-ietf-netconf-
October 2017. rfc7895bis-05 (work in progress), February 2018.
[I-D.ietf-netmod-revised-datastores] [I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-10 Architecture", draft-ietf-netmod-revised-datastores-10
(work in progress), January 2018. (work in progress), January 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, DOI 10.17487/ Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
RFC2119, March 1997, <https://www.rfc-editor.org/info/ RFC2119, March 1997, <https://www.rfc-editor.org/info/
 End of changes. 12 change blocks. 
28 lines changed or deleted 61 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/