idnits 2.17.1 draft-dsdt-netconf-restconf-nmda-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The abstract seems to contain references ([I-D.ietf-netmod-revised-datastores], [RFC8040]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. -- The draft header indicates that this document updates RFC8040, but the abstract doesn't seem to directly say this. It does mention RFC8040 though, so this could be OK. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (July 3, 2017) is 2461 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Outdated reference: A later version (-10) exists of draft-ietf-netmod-revised-datastores-02 == Outdated reference: A later version (-01) exists of draft-nmdsdt-netconf-rfc7895bis-00 Summary: 1 error (**), 0 flaws (~~), 3 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group M. Bjorklund 3 Internet-Draft Tail-f Systems 4 Updates: 8040 (if approved) J. Schoenwaelder 5 Intended status: Standards Track Jacobs University 6 Expires: January 4, 2018 P. Shafer 7 K. Watsen 8 Juniper Networks 9 R. Wilton 10 Cisco Systems 11 July 3, 2017 13 RESTCONF Update to Support the NMDA 14 draft-dsdt-netconf-restconf-nmda-00 16 Abstract 18 This document updates RESTCONF [RFC8040] in order to support the 19 Network Management Datastore Architecture (NMDA) defined in 20 [I-D.ietf-netmod-revised-datastores]. 22 Editorial Note (To be removed by RFC Editor) 24 This draft contains many placeholder values that need to be replaced 25 with finalized values at the time of publication. This note 26 summarizes all of the substitutions that are needed. No other RFC 27 Editor instructions are specified elsewhere in this document. 29 Artwork in this document contains shorthand references to drafts in 30 progress. Please apply the following replacements: 32 o "XXXX" --> the assigned RFC value for this draft 34 Artwork in this document contains placeholder values for the date of 35 publication of this draft. Please apply the following replacement: 37 o "2017-07-03" --> the publication date of this draft 39 The following two Appendix sections are to be removed prior to 40 publication: 42 o Appendix A. Change Log 44 Status of This Memo 46 This Internet-Draft is submitted in full conformance with the 47 provisions of BCP 78 and BCP 79. 49 Internet-Drafts are working documents of the Internet Engineering 50 Task Force (IETF). Note that other groups may also distribute 51 working documents as Internet-Drafts. The list of current Internet- 52 Drafts is at http://datatracker.ietf.org/drafts/current/. 54 Internet-Drafts are draft documents valid for a maximum of six months 55 and may be updated, replaced, or obsoleted by other documents at any 56 time. It is inappropriate to use Internet-Drafts as reference 57 material or to cite them other than as "work in progress." 59 This Internet-Draft will expire on January 4, 2018. 61 Copyright Notice 63 Copyright (c) 2017 IETF Trust and the persons identified as the 64 document authors. All rights reserved. 66 This document is subject to BCP 78 and the IETF Trust's Legal 67 Provisions Relating to IETF Documents 68 (http://trustee.ietf.org/license-info) in effect on the date of 69 publication of this document. Please review these documents 70 carefully, as they describe your rights and restrictions with respect 71 to this document. Code Components extracted from this document must 72 include Simplified BSD License text as described in Section 4.e of 73 the Trust Legal Provisions and are provided without warranty as 74 described in the Simplified BSD License. 76 Table of Contents 78 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 79 2. Requirements Language . . . . . . . . . . . . . . . . . . . . 3 80 3. Summary of Updates to RFC 8040 . . . . . . . . . . . . . . . 3 81 4. Conformance . . . . . . . . . . . . . . . . . . . . . . . . . 3 82 5. The {+restconf}/ds/ Resource . . . . . . . . . . . 4 83 6. Protocol Operations . . . . . . . . . . . . . . . . . . . . . 4 84 7. Security Considerations . . . . . . . . . . . . . . . . . . . 4 85 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 86 9. Normative References . . . . . . . . . . . . . . . . . . . . 4 87 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 89 1. Introduction 91 This document updates RESTCONF [RFC8040] in order to support the 92 Network Management Datastore Architecture (NMDA) defined in 93 [I-D.ietf-netmod-revised-datastores]. 95 The solution presented in this document is backwards compatible with 96 [RFC8040]. This is achieved by it only adding new top-level 97 resources, and thereby leaving the semantics of all existing 98 resources alone. 100 2. Requirements Language 102 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 103 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 104 "OPTIONAL" in this document are to be interpreted as described in BCP 105 14 [RFC2119] [RFC8174] when, and only when, they appear in all 106 capitals, as shown here. 108 3. Summary of Updates to RFC 8040 110 This document updates [RFC8040] in the following ways: 112 o Adds new top-level resource "/ds". 114 o Add new query parameter 'with-origin'. 116 o Section 3.5.4, Paragraph 3 doesn't apply for . 118 4. Conformance 120 A RESTCONF server identifies that it supports NMDA both by supporting 121 the datastore, as well as by supporting at least 122 revision YANG_LIBRARY_REVISION of the "ietf-yang-library" module, as 123 specified in [I-D.nmdsdt-netconf-rfc7895bis]. 125 RESTCONF clients MAY test if a server supports NMDA using the HEAD 126 method on the datastore resource, described later in 127 this document. 129 RESTCONF clients MAY also test if a server supports the NMDA using 130 either the HEAD or GET methods on 'ietf-yang-library:yang-library' 131 resource, under either {+restconf}/data or , though only 132 the latter resource SHOULD be used so that the client doesn't need to 133 have any ongoing need to use the {+restconf}/data resource. 135 RESTCONF clients MAY also test if a server supports the NMDA by 136 checking the revision number for the "ietf-yang-library" module 137 listed under 'ietf-yang-library:modules-state', under either 138 {+restconf}/data or . This approach might be preferred 139 by some existing clients, but new clients should avoid using the 140 deprecated 'modules-state' resource. 142 5. The {+restconf}/ds/ Resource 144 Knowing which datastores a server supports, from querying the ietf- 145 yang-library module, a RESTCONF client interacts with specific 146 datastores using the resource path template: 148 {+restconf}/ds/ 150 Where is encoded as an 'identity'. For instance: 152 {+restconf}/ds/ietf-datastores:running 153 {+restconf}/ds/ietf-datastores:intended 154 {+restconf}/ds/ietf-datastores:operational 155 {+restconf}/ds/example-ds-ephemeral:ds-ephemeral 157 6. Protocol Operations 159 All existing protocol operations defined in [RFC8040] for the 160 {+restconf}/data resource are available for all of the new datastore 161 resources with the following exceptions: 163 o Dynamic datastores are excluded, as each dynamic datastore 164 definition needs to be reviewed for what protocol operations it 165 supports. 167 o Some datastores are read-only by nature (e.g., ), and 168 hence any attempt to modify these datastores will fail. 170 o RFC 8040, Section 3.5.4, Paragraph 3 does not apply when 171 interacting with . 173 o New boolean query parameter 'with-origin' (default: false) is 174 defined to request the 'origin' attributes when querying 175 . 177 7. Security Considerations 179 TBD 181 8. IANA Considerations 183 TBD 185 9. Normative References 187 [I-D.ietf-netmod-revised-datastores] 188 Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 189 and R. Wilton, "Network Management Datastore 190 Architecture", draft-ietf-netmod-revised-datastores-02 191 (work in progress), May 2017. 193 [I-D.nmdsdt-netconf-rfc7895bis] 194 Bierman, A., Bjorklund, M., and K. Watsen, "YANG Module 195 Library", draft-nmdsdt-netconf-rfc7895bis-00 (work in 196 progress), May 2017. 198 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 199 Requirement Levels", BCP 14, RFC 2119, 200 DOI 10.17487/RFC2119, March 1997, 201 . 203 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 204 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 205 . 207 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 208 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 209 May 2017, . 211 Authors' Addresses 213 Martin Bjorklund 214 Tail-f Systems 216 EMail: mbj@tail-f.com 218 Juergen Schoenwaelder 219 Jacobs University 221 EMail: j.schoenwaelder@jacobs-university.de 223 Phil Shafer 224 Juniper Networks 226 EMail: phil@juniper.net 228 Kent Watsen 229 Juniper Networks 231 EMail: kwatsen@juniper.net 232 Rob Wilton 233 Cisco Systems 235 EMail: rwilton@cisco.com