--- 1/draft-ietf-netconf-nmda-restconf-02.txt 2018-03-01 01:13:08.914567348 -0800 +++ 2/draft-ietf-netconf-nmda-restconf-03.txt 2018-03-01 01:13:08.934567819 -0800 @@ -1,25 +1,25 @@ Network Working Group M. Bjorklund Internet-Draft Tail-f Systems Updates: 8040 (if approved) J. Schoenwaelder Intended status: Standards Track Jacobs University -Expires: July 21, 2018 P. Shafer +Expires: September 2, 2018 P. Shafer K. Watsen Juniper Networks R. Wilton Cisco Systems - January 17, 2018 + March 1, 2018 RESTCONF Extensions to Support the Network Management Datastore Architecture - draft-ietf-netconf-nmda-restconf-02 + draft-ietf-netconf-nmda-restconf-03 Abstract This document extends the RESTCONF protocol defined in RFC 8040 in order to support the Network Management Datastore Architecture defined in I-D.ietf-netmod-revised-datastores. This document updates RFC 8040 by introducing new datastore resources, adding a new query parameter, and requiring the usage of I-D.ietf-netconf-rfc7895bis by RESTCONF servers implementing the @@ -36,21 +36,21 @@ 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 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 July 21, 2018. + This Internet-Draft will expire on September 2, 2018. Copyright Notice 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 (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -61,24 +61,26 @@ described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 2. Datastore and YANG Library Requirements . . . . . . . . . . . 3 3. RESTCONF Extensions . . . . . . . . . . . . . . . . . . . . . 3 3.1. New Datastore Resources . . . . . . . . . . . . . . . . . 3 3.2. Protocol Operations . . . . . . . . . . . . . . . . . . . 4 - 3.2.1. New "with-origin" Query Parameter . . . . . . . . . . 5 - 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5 - 5. Security Considerations . . . . . . . . . . . . . . . . . . . 5 - 6. Normative References . . . . . . . . . . . . . . . . . . . . 6 + 3.2.1. With-defaults query parameter on the operational + state datastore . . . . . . . . . . . . . . . . . . . 5 + 3.2.2. New "with-origin" Query Parameter . . . . . . . . . . 5 + 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6 + 5. Security Considerations . . . . . . . . . . . . . . . . . . . 6 + 6. Normative References . . . . . . . . . . . . . . . . . . . . 7 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 7 1. Introduction This document extends the RESTCONF protocol defined in [RFC8040] in order to support the Network Management Datastore Architecture (NMDA) defined in [I-D.ietf-netmod-revised-datastores]. This document updates [RFC8040] in order to enable RESTCONF clients to discover which datastores are supported by the RESTCONF server, as @@ -171,35 +173,62 @@ o Dynamic configuration datastores are excluded, as each dynamic configuration datastore definition needs to be reviewed for what protocol operations it supports. o Some datastores are read-only by nature (e.g., ), and hence any attempt to modify these datastores will fail. A server MUST return a response with a "405 Method Not Allowed" status- line, and error-tag value "operation-not-supported". - o The "with-defaults" query parameter ([RFC8040], Section 4.8.9) - does not apply when interacting with {+restconf}/ds/ietf- - datastores:operational. This means that all "in use" values, as - 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 The semantics of the "with-defaults" query parameter ([RFC8040], + Section 4.8.9) differs when interacting with the operational state + datastore. The semantics are described below, in Section 3.2.1. o [RFC8040], Section 3.5.4, paragraph 3 does not apply when 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 operation. If present, it requests that the server includes "origin" metadata annotations in its response, as detailed in the NMDA. This parameter is only valid when querying {+restconf}/ds/ietf- datastores:operational or any datastores with identities derived from the "operational" identity. Otherwise, if an invalid datastore is specified then the server MUST return a response with a "400 Bad Request" status-line, using an error-tag value of "invalid-value". "origin" metadata annotations are not included unless a client @@ -216,35 +245,39 @@ the value matches that of the parent node, as described in "ietf-origin" YANG module [I-D.ietf-netmod-revised-datastores]. The "with-origin" query parameter is optional to support. It is identified with the URI: urn:ietf:params:restconf:capability:with-origin:1.0 4. IANA Considerations - This document defines one capability in the "RESTCONF Capability - URNs" registry defined in [RFC8040]: + This document defines two capability identifier URNs in the "RESTCONF + 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 This documents extends the RESTCONF protocol by introducing new datastore resources. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC5246]. The RESTCONF protocol uses the network configuration access control model - [I-D.ietf-netconf-rfc6536bis], which provides the means to restrict access for particular RESTCONF users to a preconfigured subset of all available RESTCONF protocol operations and content. The security constraints for the base RESTCONF protocol (see Section 12 of [RFC8040] apply to the new RESTCONF datastore resources defined in this document. 6. Normative References @@ -247,23 +280,23 @@ defined in this document. 6. Normative References [I-D.ietf-netconf-rfc6536bis] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Module", draft-ietf-netconf-rfc6536bis-09 (work in progress), December 2017. [I-D.ietf-netconf-rfc7895bis] - Bierman, A., Bjorklund, M., and K. Watsen, "YANG Library", - draft-ietf-netconf-rfc7895bis-02 (work in progress), - October 2017. + Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K., + and R. Wilton, "YANG Library", draft-ietf-netconf- + rfc7895bis-05 (work in progress), February 2018. [I-D.ietf-netmod-revised-datastores] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture", draft-ietf-netmod-revised-datastores-10 (work in progress), January 2018. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ RFC2119, March 1997,