idnits 2.17.1 draft-ietf-netconf-nmda-restconf-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 (August 24, 2017) is 2430 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-04 Summary: 1 error (**), 0 flaws (~~), 2 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network 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: February 25, 2018 P. Shafer 7 K. Watsen 8 Juniper Networks 9 R. Wilton 10 Cisco Systems 11 August 24, 2017 13 RESTCONF Update to Support the NMDA 14 draft-ietf-netconf-nmda-restconf-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 Status of This Memo 24 This Internet-Draft is submitted in full conformance with the 25 provisions of BCP 78 and BCP 79. 27 Internet-Drafts are working documents of the Internet Engineering 28 Task Force (IETF). Note that other groups may also distribute 29 working documents as Internet-Drafts. The list of current Internet- 30 Drafts is at http://datatracker.ietf.org/drafts/current/. 32 Internet-Drafts are draft documents valid for a maximum of six months 33 and may be updated, replaced, or obsoleted by other documents at any 34 time. It is inappropriate to use Internet-Drafts as reference 35 material or to cite them other than as "work in progress." 37 This Internet-Draft will expire on February 25, 2018. 39 Copyright Notice 41 Copyright (c) 2017 IETF Trust and the persons identified as the 42 document authors. All rights reserved. 44 This document is subject to BCP 78 and the IETF Trust's Legal 45 Provisions Relating to IETF Documents 46 (http://trustee.ietf.org/license-info) in effect on the date of 47 publication of this document. Please review these documents 48 carefully, as they describe your rights and restrictions with respect 49 to this document. Code Components extracted from this document must 50 include Simplified BSD License text as described in Section 4.e of 51 the Trust Legal Provisions and are provided without warranty as 52 described in the Simplified BSD License. 54 Table of Contents 56 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 57 2. Requirements Language . . . . . . . . . . . . . . . . . . . . 2 58 3. Summary of Updates to RFC 8040 . . . . . . . . . . . . . . . 2 59 4. Conformance . . . . . . . . . . . . . . . . . . . . . . . . . 3 60 5. The {+restconf}/ds/ Resource . . . . . . . . . . . 3 61 6. Protocol Operations . . . . . . . . . . . . . . . . . . . . . 3 62 7. Security Considerations . . . . . . . . . . . . . . . . . . . 4 63 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 64 9. Normative References . . . . . . . . . . . . . . . . . . . . 4 65 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 5 67 1. Introduction 69 This document updates RESTCONF [RFC8040] in order to support the 70 Network Management Datastore Architecture (NMDA) defined in 71 [I-D.ietf-netmod-revised-datastores]. 73 The solution presented in this document is backwards compatible with 74 [RFC8040]. This is achieved by it only adding new top-level 75 resources, and thereby leaving the semantics of all existing 76 resources alone. 78 2. Requirements Language 80 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 81 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 82 "OPTIONAL" in this document are to be interpreted as described in BCP 83 14 [RFC2119] [RFC8174] when, and only when, they appear in all 84 capitals, as shown here. 86 3. Summary of Updates to RFC 8040 88 This document updates [RFC8040] in the following ways: 90 o Adds new top-level resource "/ds". 92 o Adds new query parameter "with-origin". 94 o Section 3.5.4, Paragraph 3 doesn't apply for . 96 4. Conformance 98 A RESTCONF server identifies that it supports NMDA both by supporting 99 the datastore, as well as by supporting at least 100 revision YANG_LIBRARY_REVISION of the "ietf-yang-library" module, as 101 specified in [I-D.nmdsdt-netconf-rfc7895bis]. 103 RESTCONF clients MAY test if a server supports NMDA using the HEAD 104 method on the datastore resource, described later in 105 this document. 107 RESTCONF clients MAY also test if a server supports the NMDA using 108 either the HEAD or GET methods on "ietf-yang-library:yang-library" 109 resource, under either {+restconf}/data or , though only 110 the latter resource SHOULD be used so that the client doesn't need to 111 have any ongoing need to use the {+restconf}/data resource. 113 RESTCONF clients MAY also test if a server supports the NMDA by 114 checking the revision number for the "ietf-yang-library" module 115 listed under "ietf-yang-library:modules-state", under either 116 {+restconf}/data or . This approach might be preferred 117 by some existing clients, but new clients should avoid using the 118 deprecated "modules-state" resource. 120 5. The {+restconf}/ds/ Resource 122 Knowing which datastores a server supports, from querying the ietf- 123 yang-library module, a RESTCONF client interacts with specific 124 datastores using the resource path template: 126 {+restconf}/ds/ 128 Where is encoded as an "identity". For instance: 130 {+restconf}/ds/ietf-datastores:running 131 {+restconf}/ds/ietf-datastores:intended 132 {+restconf}/ds/ietf-datastores:operational 133 {+restconf}/ds/example-ds-ephemeral:ds-ephemeral 135 6. Protocol Operations 137 All existing protocol operations defined in [RFC8040] for the 138 {+restconf}/data resource are available for all of the new datastore 139 resources with the following exceptions: 141 o Dynamic datastores are excluded, as each dynamic datastore 142 definition needs to be reviewed for what protocol operations it 143 supports. 145 o Some datastores are read-only by nature (e.g., ), and 146 hence any attempt to modify these datastores will fail. 148 o RFC 8040, Section 3.5.4, Paragraph 3 does not apply when 149 interacting with . 151 o New boolean query parameter "with-origin" (default: false) is 152 defined to request the "origin" attributes when querying 153 . 155 7. Security Considerations 157 TBD 159 8. IANA Considerations 161 TBD 163 9. Normative References 165 [I-D.ietf-netmod-revised-datastores] 166 Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 167 and R. Wilton, "Network Management Datastore 168 Architecture", draft-ietf-netmod-revised-datastores-04 169 (work in progress), August 2017. 171 [I-D.nmdsdt-netconf-rfc7895bis] 172 Bierman, A., Bjorklund, M., and K. Watsen, "YANG Library", 173 draft-nmdsdt-netconf-rfc7895bis-01 (work in progress), 174 July 2017. 176 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 177 Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/ 178 RFC2119, March 1997, . 181 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 182 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 183 . 185 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 186 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 187 May 2017, . 189 Authors' Addresses 191 Martin Bjorklund 192 Tail-f Systems 194 Email: mbj@tail-f.com 196 Juergen Schoenwaelder 197 Jacobs University 199 Email: j.schoenwaelder@jacobs-university.de 201 Phil Shafer 202 Juniper Networks 204 Email: phil@juniper.net 206 Kent Watsen 207 Juniper Networks 209 Email: kwatsen@juniper.net 211 Robert Wilton 212 Cisco Systems 214 Email: rwilton@cisco.com