--- 1/draft-ietf-netconf-restconf-04.txt 2015-06-04 21:15:01.164666257 -0700 +++ 2/draft-ietf-netconf-restconf-05.txt 2015-06-04 21:15:01.328670253 -0700 @@ -1,21 +1,21 @@ Network Working Group A. Bierman Internet-Draft YumaWorks Intended status: Standards Track M. Bjorklund -Expires: August 3, 2015 Tail-f Systems +Expires: December 6, 2015 Tail-f Systems K. Watsen Juniper Networks - January 30, 2015 + June 4, 2015 RESTCONF Protocol - draft-ietf-netconf-restconf-04 + draft-ietf-netconf-restconf-05 Abstract This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastores defined in NETCONF. Status of This Memo This Internet-Draft is submitted in full conformance with the @@ -24,21 +24,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 August 3, 2015. + This Internet-Draft will expire on December 6, 2015. Copyright Notice Copyright (c) 2015 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 @@ -46,202 +46,193 @@ to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1. Simple Subset of NETCONF Functionality . . . . . . . . . 5 1.2. Data Model Driven API . . . . . . . . . . . . . . . . . . 6 - 1.3. Terminology . . . . . . . . . . . . . . . . . . . . . . . 7 - 1.3.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 7 - 1.3.2. HTTP . . . . . . . . . . . . . . . . . . . . . . . . 8 - 1.3.3. YANG . . . . . . . . . . . . . . . . . . . . . . . . 9 - 1.3.4. Terms . . . . . . . . . . . . . . . . . . . . . . . . 9 - 1.3.5. URI Template . . . . . . . . . . . . . . . . . . . . 11 - 1.3.6. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 11 - 2. Transport Protocol Requirements . . . . . . . . . . . . . . . 11 - 2.1. Integrity and Confidentiality . . . . . . . . . . . . . . 11 + 1.3. Coexistence with NETCONF . . . . . . . . . . . . . . . . 7 + 1.4. Terminology . . . . . . . . . . . . . . . . . . . . . . . 8 + 1.4.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 8 + 1.4.2. HTTP . . . . . . . . . . . . . . . . . . . . . . . . 8 + 1.4.3. YANG . . . . . . . . . . . . . . . . . . . . . . . . 9 + 1.4.4. Terms . . . . . . . . . . . . . . . . . . . . . . . . 10 + 1.4.5. URI Template . . . . . . . . . . . . . . . . . . . . 11 + 1.4.6. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 11 + 2. Transport Protocol Requirements . . . . . . . . . . . . . . . 12 + 2.1. Integrity and Confidentiality . . . . . . . . . . . . . . 12 2.2. HTTPS with X.509v3 Certificates . . . . . . . . . . . . . 12 2.3. Certificate Validation . . . . . . . . . . . . . . . . . 12 2.4. Authenticated Server Identity . . . . . . . . . . . . . . 12 2.5. Authenticated Client Identity . . . . . . . . . . . . . . 12 3. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.1. Root Resource Discovery . . . . . . . . . . . . . . . . . 14 3.2. RESTCONF Resource Types . . . . . . . . . . . . . . . . . 15 3.3. API Resource . . . . . . . . . . . . . . . . . . . . . . 15 3.3.1. {+restconf}/data . . . . . . . . . . . . . . . . . . 16 3.3.2. {+restconf}/operations . . . . . . . . . . . . . . . 17 3.4. Datastore Resource . . . . . . . . . . . . . . . . . . . 17 3.4.1. Edit Collision Detection . . . . . . . . . . . . . . 18 - 3.5. Data Resource . . . . . . . . . . . . . . . . . . . . . . 19 + 3.5. Data Resource . . . . . . . . . . . . . . . . . . . . . . 18 3.5.1. Encoding Data Resource Identifiers in the Request URI 19 3.5.2. Defaults Handling . . . . . . . . . . . . . . . . . . 22 3.6. Operation Resource . . . . . . . . . . . . . . . . . . . 22 3.6.1. Encoding Operation Input Parameters . . . . . . . . . 23 3.6.2. Encoding Operation Output Parameters . . . . . . . . 24 - 3.7. Schema Resource . . . . . . . . . . . . . . . . . . . . . 24 - 3.8. Event Stream Resource . . . . . . . . . . . . . . . . . . 25 - 3.9. Errors Media Type . . . . . . . . . . . . . . . . . . . . 26 - 4. Operations . . . . . . . . . . . . . . . . . . . . . . . . . 26 - 4.1. OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . 27 - 4.2. HEAD . . . . . . . . . . . . . . . . . . . . . . . . . . 27 - 4.3. GET . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 - 4.4. POST . . . . . . . . . . . . . . . . . . . . . . . . . . 28 - 4.4.1. Create Resource Mode . . . . . . . . . . . . . . . . 29 - 4.4.2. Invoke Operation Mode . . . . . . . . . . . . . . . . 30 + 3.6.3. Encoding Operation Errors . . . . . . . . . . . . . . 25 + 3.7. Schema Resource . . . . . . . . . . . . . . . . . . . . . 25 + 3.8. Event Stream Resource . . . . . . . . . . . . . . . . . . 26 + 3.9. Errors Media Type . . . . . . . . . . . . . . . . . . . . 27 + 4. Operations . . . . . . . . . . . . . . . . . . . . . . . . . 27 + 4.1. OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . 28 + 4.2. HEAD . . . . . . . . . . . . . . . . . . . . . . . . . . 28 + 4.3. GET . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 + 4.4. POST . . . . . . . . . . . . . . . . . . . . . . . . . . 29 + 4.4.1. Create Resource Mode . . . . . . . . . . . . . . . . 30 + 4.4.2. Invoke Operation Mode . . . . . . . . . . . . . . . . 31 4.5. PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 4.6. PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . 32 - 4.6.1. Plain Patch . . . . . . . . . . . . . . . . . . . . . 32 - - 4.7. DELETE . . . . . . . . . . . . . . . . . . . . . . . . . 33 + 4.6.1. Plain Patch . . . . . . . . . . . . . . . . . . . . . 33 + 4.7. DELETE . . . . . . . . . . . . . . . . . . . . . . . . . 34 4.8. Query Parameters . . . . . . . . . . . . . . . . . . . . 34 - 4.8.1. Query Parameter URIs . . . . . . . . . . . . . . . . 35 - 4.8.2. The "defaults" Protocol Capability URI . . . . . . . 35 - 4.8.3. The "content" Query Parameter . . . . . . . . . . . . 36 - 4.8.4. The "depth" Query Parameter . . . . . . . . . . . . . 36 - 4.8.5. The "fields" Query Parameter . . . . . . . . . . . . 37 - 4.8.6. The "insert" Query Parameter . . . . . . . . . . . . 38 - 4.8.7. The "point" Query Parameter . . . . . . . . . . . . . 38 - 4.8.8. The "filter" Query Parameter . . . . . . . . . . . . 39 - 4.8.9. The "start-time" Query Parameter . . . . . . . . . . 40 - 4.8.10. The "stop-time" Query Parameter . . . . . . . . . . . 40 - 4.8.11. The "with-defaults" Query Parameter . . . . . . . . . 41 - 5. Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 42 - 5.1. Request URI Structure . . . . . . . . . . . . . . . . . . 42 + 4.8.1. The "content" Query Parameter . . . . . . . . . . . . 35 + 4.8.2. The "depth" Query Parameter . . . . . . . . . . . . . 36 + 4.8.3. The "fields" Query Parameter . . . . . . . . . . . . 36 + 4.8.4. The "insert" Query Parameter . . . . . . . . . . . . 37 + 4.8.5. The "point" Query Parameter . . . . . . . . . . . . . 38 + 4.8.6. The "filter" Query Parameter . . . . . . . . . . . . 38 + 4.8.7. The "start-time" Query Parameter . . . . . . . . . . 39 + 4.8.8. The "stop-time" Query Parameter . . . . . . . . . . . 40 + 4.8.9. The "with-defaults" Query Parameter . . . . . . . . . 40 + 5. Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 41 + 5.1. Request URI Structure . . . . . . . . . . . . . . . . . . 41 5.2. Message Headers . . . . . . . . . . . . . . . . . . . . . 43 5.3. Message Encoding . . . . . . . . . . . . . . . . . . . . 44 - 5.4. RESTCONF Meta-Data . . . . . . . . . . . . . . . . . . . 45 - 5.5. Return Status . . . . . . . . . . . . . . . . . . . . . . 45 + 5.4. RESTCONF Meta-Data . . . . . . . . . . . . . . . . . . . 44 + 5.5. Return Status . . . . . . . . . . . . . . . . . . . . . . 44 5.6. Message Caching . . . . . . . . . . . . . . . . . . . . . 45 - 6. Notifications . . . . . . . . . . . . . . . . . . . . . . . . 46 - 6.1. Server Support . . . . . . . . . . . . . . . . . . . . . 46 - 6.2. Event Streams . . . . . . . . . . . . . . . . . . . . . . 46 + 6. Notifications . . . . . . . . . . . . . . . . . . . . . . . . 45 + 6.1. Server Support . . . . . . . . . . . . . . . . . . . . . 45 + 6.2. Event Streams . . . . . . . . . . . . . . . . . . . . . . 45 6.3. Subscribing to Receive Notifications . . . . . . . . . . 48 6.3.1. NETCONF Event Stream . . . . . . . . . . . . . . . . 49 6.4. Receiving Event Notifications . . . . . . . . . . . . . . 49 7. Error Reporting . . . . . . . . . . . . . . . . . . . . . . . 51 - 7.1. Error Response Message . . . . . . . . . . . . . . . . . 52 + 7.1. Error Response Message . . . . . . . . . . . . . . . . . 53 8. RESTCONF module . . . . . . . . . . . . . . . . . . . . . . . 55 9. RESTCONF Monitoring . . . . . . . . . . . . . . . . . . . . . 61 - 9.1. restconf-state/capabilities . . . . . . . . . . . . . . . 62 - 9.2. restconf-state/streams . . . . . . . . . . . . . . . . . 62 - 9.3. RESTCONF Monitoring Module . . . . . . . . . . . . . . . 62 - 10. YANG Module Library . . . . . . . . . . . . . . . . . . . . . 66 - 10.1. modules . . . . . . . . . . . . . . . . . . . . . . . . 66 - 10.1.1. modules/module . . . . . . . . . . . . . . . . . . . 67 - 11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 67 - 11.1. The "restconf" Relation Type . . . . . . . . . . . . . . 67 - 11.2. YANG Module Registry . . . . . . . . . . . . . . . . . . 67 - 11.3. application/yang Media Sub Types . . . . . . . . . . . . 68 - 11.4. RESTCONF Capability URNs . . . . . . . . . . . . . . . . 69 - 12. Security Considerations . . . . . . . . . . . . . . . . . . . 70 - 13. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 71 - 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 71 - 14.1. Normative References . . . . . . . . . . . . . . . . . . 71 - 14.2. Informative References . . . . . . . . . . . . . . . . . 74 - Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 74 - A.1. 03 - 04 . . . . . . . . . . . . . . . . . . . . . . . . . 74 - A.2. 02 - 03 . . . . . . . . . . . . . . . . . . . . . . . . . 75 - A.3. 01 - 02 . . . . . . . . . . . . . . . . . . . . . . . . . 76 - A.4. 00 - 01 . . . . . . . . . . . . . . . . . . . . . . . . . 76 - A.5. bierman:restconf-04 to ietf:restconf-00 . . . . . . . . . 77 - Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 77 - Appendix C. Example YANG Module . . . . . . . . . . . . . . . . 78 - C.1. example-jukebox YANG Module . . . . . . . . . . . . . . . 78 - Appendix D. RESTCONF Message Examples . . . . . . . . . . . . . 84 - D.1. Resource Retrieval Examples . . . . . . . . . . . . . . . 84 - D.1.1. Retrieve the Top-level API Resource . . . . . . . . . 84 - D.1.2. Retrieve The Server Module Information . . . . . . . 85 - D.1.3. Retrieve The Server Capability Information . . . . . 86 - D.2. Edit Resource Examples . . . . . . . . . . . . . . . . . 87 - D.2.1. Create New Data Resources . . . . . . . . . . . . . . 87 - D.2.2. Detect Resource Entity Tag Change . . . . . . . . . . 88 - D.3. Query Parameter Examples . . . . . . . . . . . . . . . . 89 - D.3.1. "content" Parameter . . . . . . . . . . . . . . . . . 89 - D.3.2. "depth" Parameter . . . . . . . . . . . . . . . . . . 92 - D.3.3. "fields" Parameter . . . . . . . . . . . . . . . . . 95 - D.3.4. "insert" Parameter . . . . . . . . . . . . . . . . . 96 - D.3.5. "point" Parameter . . . . . . . . . . . . . . . . . . 97 - D.3.6. "filter" Parameter . . . . . . . . . . . . . . . . . 97 - D.3.7. "start-time" Parameter . . . . . . . . . . . . . . . 98 - D.3.8. "stop-time" Parameter . . . . . . . . . . . . . . . . 98 - D.3.9. "with-defaults" Parameter . . . . . . . . . . . . . . 98 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 100 + 9.1. restconf-state/capabilities . . . . . . . . . . . . . . . 61 + 9.1.1. Query Parameter URIs . . . . . . . . . . . . . . . . 62 + 9.1.2. The "defaults" Protocol Capability URI . . . . . . . 62 + 9.2. restconf-state/streams . . . . . . . . . . . . . . . . . 63 + 9.3. RESTCONF Monitoring Module . . . . . . . . . . . . . . . 63 + 10. YANG Module Library . . . . . . . . . . . . . . . . . . . . . 67 + 10.1. modules . . . . . . . . . . . . . . . . . . . . . . . . 67 + 10.1.1. modules/module . . . . . . . . . . . . . . . . . . . 68 + 11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 68 + 11.1. The "restconf" Relation Type . . . . . . . . . . . . . . 68 + 11.2. YANG Module Registry . . . . . . . . . . . . . . . . . . 68 + 11.3. application/yang Media Sub Types . . . . . . . . . . . . 69 + 11.4. RESTCONF Capability URNs . . . . . . . . . . . . . . . . 70 + 12. Security Considerations . . . . . . . . . . . . . . . . . . . 71 + 13. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 72 + 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 72 + 14.1. Normative References . . . . . . . . . . . . . . . . . . 72 + 14.2. Informative References . . . . . . . . . . . . . . . . . 75 + + Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 75 + A.1. 04 - 05 . . . . . . . . . . . . . . . . . . . . . . . . . 75 + A.2. 03 - 04 . . . . . . . . . . . . . . . . . . . . . . . . . 76 + A.3. 02 - 03 . . . . . . . . . . . . . . . . . . . . . . . . . 77 + A.4. 01 - 02 . . . . . . . . . . . . . . . . . . . . . . . . . 77 + A.5. 00 - 01 . . . . . . . . . . . . . . . . . . . . . . . . . 78 + A.6. bierman:restconf-04 to ietf:restconf-00 . . . . . . . . . 79 + Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 79 + Appendix C. Example YANG Module . . . . . . . . . . . . . . . . 79 + C.1. example-jukebox YANG Module . . . . . . . . . . . . . . . 80 + Appendix D. RESTCONF Message Examples . . . . . . . . . . . . . 85 + D.1. Resource Retrieval Examples . . . . . . . . . . . . . . . 86 + D.1.1. Retrieve the Top-level API Resource . . . . . . . . . 86 + D.1.2. Retrieve The Server Module Information . . . . . . . 87 + D.1.3. Retrieve The Server Capability Information . . . . . 88 + D.2. Edit Resource Examples . . . . . . . . . . . . . . . . . 89 + D.2.1. Create New Data Resources . . . . . . . . . . . . . . 89 + D.2.2. Detect Resource Entity Tag Change . . . . . . . . . . 90 + D.2.3. Edit a Datastore Resource . . . . . . . . . . . . . . 91 + D.3. Query Parameter Examples . . . . . . . . . . . . . . . . 92 + D.3.1. "content" Parameter . . . . . . . . . . . . . . . . . 92 + D.3.2. "depth" Parameter . . . . . . . . . . . . . . . . . . 95 + D.3.3. "fields" Parameter . . . . . . . . . . . . . . . . . 98 + D.3.4. "insert" Parameter . . . . . . . . . . . . . . . . . 99 + D.3.5. "point" Parameter . . . . . . . . . . . . . . . . . . 100 + D.3.6. "filter" Parameter . . . . . . . . . . . . . . . . . 101 + D.3.7. "start-time" Parameter . . . . . . . . . . . . . . . 101 + D.3.8. "stop-time" Parameter . . . . . . . . . . . . . . . . 101 + D.3.9. "with-defaults" Parameter . . . . . . . . . . . . . . 102 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 103 1. Introduction There is a need for standard mechanisms to allow Web applications to access the configuration data, operational data, data-model specific - protocol operations, and notification events within a networking + protocol operations, and event notifications within a networking device, in a modular and extensible manner. This document describes an HTTP [RFC7230] based protocol called RESTCONF, for accessing data defined in YANG [RFC6020], using datastores defined in NETCONF [RFC6241]. The NETCONF protocol defines configuration datastores and a set of Create, Retrieve, Update, Delete (CRUD) operations that can be used to access these datastores. The YANG language defines the syntax and semantics of datastore content, operational data, protocol - operations, and notification events. RESTCONF uses HTTP operations + operations, and event notifications. RESTCONF uses HTTP operations to provide CRUD operations on a NETCONF datastore containing YANG- defined data. Since NETCONF protocol operations are not relevant, the user should not need any prior knowledge of NETCONF in order to use RESTCONF. Configuration data and state data are exposed as resources that can be retrieved with the GET method. Resources representing configuration data can be modified with the DELETE, PATCH, POST, and PUT methods. Data is encoded with either XML [W3C.REC-xml-20081126] or JSON [RFC7158]. Data-model specific protocol operations defined with the YANG "rpc" statement can be invoked with the POST method. Data-model specific - notification events defined with the YANG "notification" statement + event notifications defined with the YANG "notification" statement can be accessed. 1.1. Simple Subset of NETCONF Functionality - The framework and meta-model used for an HTTP-based API does not need - to mirror those used by the NETCONF protocol, but it needs to be - compatible with NETCONF. Instead, a simplified framework and - protocol is needed that co-exists with the three NETCONF datastores - (candidate, running, startup), but hides the complexity of multiple - datastores from the client. - - A simplified transaction model is needed that allows basic CRUD - operations on a hierarchy of conceptual resources. This represents a - limited subset of the transaction capabilities of the NETCONF - protocol. + An HTTP-based management protocol does not need to mirror the + functionality of the NETCONF protocol, but it needs to be compatible + with NETCONF. A simplified transaction model is needed that allows + basic CRUD operations on a hierarchy of conceptual resources. This + represents a limited subset of the transaction capabilities of the + NETCONF protocol. The HTTP POST, PUT, PATCH, and DELETE methods are used to edit data resources represented by YANG data models. These basic edit operations allow the running configuration to be altered in an all- or-none fashion. This is similar to the "rollback-on-error" capability in NETCONF. Edits are usually applied to one data resource instance at a time. - Applications that require more complex transaction capabilities might - consider NETCONF instead of RESTCONF. The following transaction - features are not directly provided in RESTCONF: - - o datastore locking (full or partial) - - o candidate datastore - - o startup datastore - - o validate operation + The base RESTCONF protocol is intentionally simple to allow + deployment for as many use cases as possible. Additional + functionality can be defined in external documents, outside the scope + of this document. - o confirmed-commit procedure RESTCONF is not intended to replace NETCONF, but rather provide an additional simplified interface that follows REST principles and is compatible with a resource-oriented device abstraction. The following figure shows the system components: +-----------+ +-----------------+ | Web app | <-------> | | +-----------+ HTTP | network device | | | @@ -292,52 +283,76 @@ the YANG module definitions. Operational experience with CLI and SNMP indicates that operators learn the 'location' of specific service or device related data and do not expect such information to be arbitrary and discovered each time the client opens a management session to a server. The RESTCONF protocol operates on a conceptual datastore defined with the YANG data modeling language. The server lists each YANG module it supports using the "ietf-yang-library" YANG module, defined in - [I-D.ietf-netconf-yang-library]. + [I-D.ietf-netconf-yang-library]. The server MUST implement the + "ietf-yang-library" module, which SHOULD identify all the YANG + modules used by the server. The conceptual datastore contents, data-model-specific operations and - notification events are identified by this set of YANG modules. All + event notifications are identified by this set of YANG modules. All RESTCONF content identified as either a data resource, operation resource, or event stream resource is defined with the YANG language. The classification of data as configuration or non-configuration is derived from the YANG "config" statement. Data ordering behavior is derived from the YANG "ordered-by" statement. The RESTCONF datastore editing model is simple and direct, similar to - the behavior of the ":writable-running" capability in NETCONF. Each + the behavior of the :writable-running capability in NETCONF. Each RESTCONF edit of a datastore resource is activated upon successful completion of the transaction. -1.3. Terminology +1.3. Coexistence with NETCONF + + RESTCONF can be implemented on a device that supports NETCONF. + + If the device supports :writable-running, all edits to configuration + nodes in {+restconf}/data are performed in the running configuration + datastore. + + Otherwise, if the device supports :candidate, all edits to + configuration nodes in {+restconf}/data are performed in the + candidate configuration datastore. The candidate is automatically + committed to running after a successful edit. + + If the device supports :startup, the device automatically copies the + content of running to startup after running has been updated as a + consequence of a RESTCONF edit operation. + + If a datastore that would be modified by a RESTCONF operation has an + active lock, the RESTCONF edit operation MUST fail with a 409 + (Conflict) error code. + +1.4. Terminology The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14, [RFC2119]. -1.3.1. NETCONF +1.4.1. NETCONF The following terms are defined in [RFC6241]: o candidate configuration datastore o client o configuration data + o datastore o configuration datastore o protocol operation o running configuration datastore o server @@ -340,21 +355,21 @@ o running configuration datastore o server o startup configuration datastore o state data o user -1.3.2. HTTP +1.4.2. HTTP The following terms are defined in [RFC3986]: o fragment o path o query The following terms are defined in [RFC7230]: @@ -374,21 +389,21 @@ o method o request o resource The following terms are defined in [RFC7232]: o entity tag -1.3.3. YANG +1.4.3. YANG The following terms are defined in [RFC6020]: o container o data node o key leaf o leaf @@ -400,21 +415,21 @@ o presence container (or P-container) o RPC operation (now called protocol operation) o non-presence container (or NP-container) o ordered-by system o ordered-by user -1.3.4. Terms +1.4.4. Terms The following terms are used within this document: o API resource: a resource with the media type "application/ yang.api+xml" or "application/yang.api+json". o data resource: a resource with the media type "application/ yang.data+xml" or "application/yang.data+json". Containers, leafs, list entries and anyxml nodes can be data resources. @@ -423,22 +438,22 @@ Represents a datastore. o edit operation: a RESTCONF operation on a data resource using either a POST, PUT, PATCH, or DELETE method. o event stream resource: This resource represents an SSE (Server- Sent Events) event stream. The content consists of text using the media type "text/event-stream", as defined by the HTML5 specification. Each event represents one message generated by the server. It contains a conceptual system or data- - model specific event that is delivered within a notification event - stream. Also called a "stream resource". + model specific event that is delivered within an event + notification stream. Also called a "stream resource". o media-type: HTTP uses Internet media types [RFC2046] in the Content-Type and Accept header fields in order to provide open and extensible data typing and type negotiation. o operation: the conceptual RESTCONF operation for a message, derived from the HTTP method, request URI, headers, and message- body. o operation resource: a resource with the media type "application/ @@ -457,47 +472,42 @@ o RESTCONF capability: An optional RESTCONF protocol feature supported by the server, which is identified by an IANA registered NETCONF Capability URI, and advertised with an entry in the "capability" leaf-list in Section 9.3. o retrieval request: a request using the GET or HEAD methods. o target resource: the resource that is associated with a particular message, identified by the "path" component of the request URI. - o unified datastore: A conceptual representation of the device - running configuration. The server will hide all NETCONF datastore - details for edit operations, such as the ":candidate" and - ":startup" capabilities. - o schema resource: a resource with the media type "application/ yang". The YANG representation of the schema can be retrieved by the client with the GET method. o stream list: the set of data resource instances that describe the event stream resources available from the server. This information is defined in the "ietf-restconf-monitoring" module as the "stream" list. It can be retrieved using the target resource "{+restconf}/data/ietf-restconf-monitoring:restconf-state/streams/ stream". The stream list contains information about each stream, such as the URL to retrieve the event stream data. -1.3.5. URI Template +1.4.5. URI Template Throughout this document, the URI template [RFC6570] syntax "{+restconf}" is used to refer to the RESTCONF API entry point outside of an example. See Section 3.1 for details. For simplicity, all of the examples in this document assume "/restconf" as the discovered RESTCONF API root path. -1.3.6. Tree Diagrams +1.4.6. Tree Diagrams A simplified graphical representation of the data model is used in this document. The meaning of the symbols in these diagrams is as follows: o Brackets "[" and "]" enclose list keys. o Abbreviations before data node names: "rw" means configuration data (read-write) and "ro" state data (read-only). @@ -520,75 +530,70 @@ RESTCONF requires that the transport-layer protocol provides both data integrity and confidentiality, such as are provided by the TLS protocol [RFC5246]. 2.2. HTTPS with X.509v3 Certificates Given the nearly ubiquitous support for HTTP over TLS [RFC7230], RESTCONF implementations MUST support the "https" URI scheme, which has the IANA assigned default port 443. Consistent with the exclusive use of X.509v3 certificates for NETCONF over TLS - [draft-ietf-netconf-rfc5539bis-07], use of certificates in RESTCONF + [draft-ietf-netconf-rfc5539bis-10], use of certificates in RESTCONF is also limited to X.509v3 certificates. 2.3. Certificate Validation When presented an X.509 certificate, the RESTCONF peer MUST use X.509 certificate path validation [RFC5280] to verify the integrity of the certificate. The presented X.509 certificate MAY also be considered valid if it matches a locally configured certificate fingerprint. If X.509 certificate path validation fails and the presented X.509 certificate does not match a locally configured certificate fingerprint, the connection MUST be terminated as defined in [RFC5246]. 2.4. Authenticated Server Identity The RESTCONF client MUST carefully examine the certificate presented by the RESTCONF server to determine if it meets the client's - expectations. If the RESTCONF client has external information as to - the expected identity of the RESTCONF server, the hostname check MAY - be omitted. Otherwise, the RESTCONF client MUST check its - understanding of the RESTCONF server hostname against the server's - identity as presented in the server certificate message. Matching is - performed according to the rules and guidelines defined in [RFC6125]. - If the match fails, the RESTCONF client MUST either ask for explicit - user confirmation or terminate the connection with an indication that - the RESTCONF server's identity is suspect. + expectations. The RESTCONF client MUST check the identity of the + server according to Section 6 of [RFC6125], including processing the + outcome as described in Section 6.6 of [RFC6125]. 2.5. Authenticated Client Identity - The RESTCONF server MUST authenticate the client access to any - protected resource using HTTP Authentication [RFC7235]. If the - RESTCONF client is not authenticated to access a resource, the server - MUST send a response with status code 401 (Unauthorized) and a WWW- - Authenticate header field containing at least one challenge - applicable to the target resource. The RESTCONF server MAY advertise - support for any number of authentication schemes but, in order to - ensure interoperability, the RESTCONF server MUST advertise at least - one of the following authentication schemes: + The RESTCONF server MUST authenticate client access to any protected + resource using HTTP Authentication [RFC7235]. If the RESTCONF client + is not authenticated to access a resource, the server MUST send a + response with status code 401 (Unauthorized) and a WWW-Authenticate + header field containing at least one challenge applicable to the + target resource. The RESTCONF server MAY advertise support for any + number of authentication schemes but, in order to ensure + interoperability, the RESTCONF server MUST advertise at least one of + the following authentication schemes: o Basic [draft-ietf-httpauth-basicauth-update-03] + o Digest [draft-ietf-httpauth-digest-09] o ClientCertificate [draft-thomson-httpbis-cant-01] - These authentication schemes are selected due to their similarity to - authentication schemes supported by NETCONF. In particular, the + These authentication schemes are selected for to their similarity to + the authentication schemes supported by NETCONF. In particular, the Basic and Digest authentication schemes both directly provide an identity and verification of a shared secret, much like NETCONF over SSH, when using the SSH "password" authentication method [RFC4252]. Similarly, the ClientCertificate authentication scheme is much like NETCONF over TLS's use of X.509 client-certificates. When using the ClientCertificate authentication scheme, the RESTCONF server MUST - verify the identity of the RESTCONF client using the algorithm - defined in section 7 of [draft-ietf-netconf-rfc5539bis-07]. + derive the identity of the RESTCONF client using the algorithm + defined in Section 7 of [draft-ietf-netconf-rfc5539bis-10]. The RESTCONF client identity determined from any HTTP authentication scheme is hereafter known as the "RESTCONF username" and subject to the NETCONF Access Control Module (NACM) [RFC6536]. 3. Resources The RESTCONF protocol operates on a hierarchy of resources, starting with the top-level API resource itself (Section 3.1). Each resource represents a manageable component within the device. @@ -598,28 +603,28 @@ resources. The child resource types and methods allowed on them are data-model specific. A resource has its own media type identifier, represented by the "Content-Type" header in the HTTP response message. A resource can contain zero or more nested resources. A resource can be created and deleted independently of its parent resource, as long as the parent resource exists. All RESTCONF resources are defined in this document except specific - datastore contents, protocol operations, and notification events. + datastore contents, protocol operations, and event notifications. The syntax and semantics for these resource types are defined in YANG modules. The RESTCONF resources are accessed via a set of URIs defined in this document. The set of YANG modules supported by the server will determine the data model specific operations, top-level data node - resources, and notification event messages supported by the server. + resources, and event notification messages supported by the server. The RESTCONF protocol does not include a resource discovery mechanism. Instead, the definitions within the YANG modules advertised by the server are used to construct a predictable operation or data resource identifier. 3.1. Root Resource Discovery In line with the best practices defined by [RFC7320], RESTCONF enables deployments to specify where the RESTCONF API is located. @@ -640,22 +645,22 @@ Content-Type: application/xrd+xml Content-Length: nnn Once discovering the RESTCONF API root, the client MUST prepend it to any subsequent request to a RESTCONF resource. For instance, using the "/restconf" path discovered above, the client can now determine - the operations supported by the the server; e.g. in this example a - custom "play" operation is supported: + the operations supported by the the server. In this example a custom + "play" operation is supported: Request ------- GET /restconf/operations HTTP/1.1 Host: example.com Accept: application/yang.api+json Response -------- HTTP/1.1 200 OK @@ -687,36 +692,38 @@ | | application/yang.errors+json | | Operation | application/yang.operation+xml | | | application/yang.operation+json | | Schema | application/yang | +-----------+---------------------------------+ RESTCONF Media Types 3.3. API Resource - The API resource contains the state and access points for the - RESTCONF features. It is the top-level resource located at + The API resource contains the entry points for the RESTCONF datastore + and operation resources. It is the top-level resource located at {+restconf} and has the media type "application/yang.api+xml" or "application/yang.api+json". YANG Tree Diagram for an API Resource: +--rw restconf +--rw data +--rw operations The "application/yang.api" restconf-media-type extension in the "ietf-restconf" module defined in Section 8 is used to specify the structure and syntax of the conceptual child resources within the API resource. + The API resource can be retrieved with the GET method. + This resource has the following child resources: +----------------+--------------------------------+ | Child Resource | Description | +----------------+--------------------------------+ | data | Contains all data resources | | operations | Data-model specific operations | +----------------+--------------------------------+ RESTCONF API Resource @@ -725,114 +732,101 @@ This mandatory resource represents the combined configuration and operational data resources that can be accessed by a client. It cannot be created or deleted by the client. The datastore resource type is defined in Section 3.4. Example: This example request by the client would retrieve only the non- configuration data nodes that exist within the "library" resource, - using the "content" query parameter (see Section 4.8.3). + using the "content" query parameter (see Section 4.8.1). GET /restconf/data/example-jukebox:jukebox/library ?content=nonconfig HTTP/1.1 Host: example.com - Accept: application/yang.data+json + Accept: application/yang.data+xml The server might respond: HTTP/1.1 200 OK Date: Mon, 23 Apr 2012 17:01:30 GMT Server: example-server Cache-Control: no-cache Pragma: no-cache - Content-Type: application/yang.data+json + Content-Type: application/yang.data+xml - { - "example-jukebox:library" : { - "artist-count" : 42, - "album-count" : 59, - "song-count" : 374 - } - } + + 42 + 59 + 374 + 3.3.2. {+restconf}/operations This optional resource is a container that provides access to the data-model specific protocol operations supported by the server. The server MAY omit this resource if no data-model specific operations are advertised. Any data-model specific operations defined in the YANG modules advertised by the server MAY be available as child nodes of this resource. Operation resources are defined in Section 3.6. 3.4. Datastore Resource The "{+restconf}/data" subtree represents the datastore resource type, which is a collection of configuration and operational data nodes. - A "unified datastore" interface is used to simplify resource editing - for the client. The RESTCONF unified datastore is a conceptual - interface to the native configuration datastores that are present on - the device. - - The underlying NETCONF datastores (i.e., candidate, running, startup) - can be used to implement the unified datastore, but the server design - is not limited to the exact datastore procedures defined in NETCONF. + This resource type is an abstraction of the system's underlying + datastore implementation. It is used to simplify resource editing + for the client. The RESTCONF datastore resource is a conceptual + collection of all configuration and operational data that is present + on the device. - The "candidate" and "startup" datastores are not visible in the - RESTCONF protocol. Transaction management and configuration + Configuration edit transaction management and configuration persistence are handled by the server and not controlled by the - client. - - A datastore resource can only be written directly with the PATCH - method. Only the configuration data resources within the datastore - resource can be edited directly with all methods. - - Each RESTCONF edit of a datastore resource is saved to non-volatile - storage in an implementation-specific matter by the server. There is - no guarantee that configuration changes are saved immediately, or - that the saved configuration is always a mirror of the NETCONF - running datastore, if the server also supports NETCONF. + client. A datastore resource can only be written directly with the + PATCH method. Each RESTCONF edit of a datastore resource is saved to + non-volatile storage in an implementation-specific matter by the + server. 3.4.1. Edit Collision Detection Two "edit collision detection" mechanisms are provided in RESTCONF, for datastore and data resources. 3.4.1.1. Timestamp The last change time is maintained and the "Last-Modified" - ([RFC7232], section 2.2) header is returned in the response for a + ([RFC7232], Section 2.2) header is returned in the response for a retrieval request. The "If-Unmodified-Since" header can be used in edit operation requests to cause the server to reject the request if the resource has been modified since the specified timestamp. The server MUST maintain a last-modified timestamp for the top-level {+restconf}/data resource and SHOULD maintain last-modified timestamps for descendant resources. For all resources, the server MUST return the "Last-Modified" header when the resource is retrieved with the GET or HEAD methods. If the server does not maintain a timestamp for a resource, it MUST return the timestamp of the resource's ancestor, a process that may recurse up to the top-level {+restconf}/data resource. Only changes to configuration data resources within the datastore affect the timestamp. 3.4.1.2. Entity tag A unique opaque string is maintained and the "ETag" ([RFC7232], - section 2.3) header is returned in the response for a retrieval + Section 2.3) header is returned in the response for a retrieval request. The "If-Match" header can be used in edit operation requests to cause the server to reject the request if the resource entity tag does not match the specified value. The server MUST maintain an entity tag for the top-level {+restconf}/data resource and SHOULD maintain entity tags for descendant resources. For all resources, the server MUST return the "ETag" header when the resource is retrieved with the GET or HEAD methods. If the server does not maintain an entity tag for a resource, it MUST return the entity tag of the resource's ancestor, a @@ -891,34 +885,39 @@ nodes. A RESTCONF data resource identifier is not an XPath expression. It is encoded from left to right, starting with the top-level data node, according to the "api-path" rule in Section 3.5.1.1. The node name of each ancestor of the target resource node is encoded in order, ending with the node name for the target resource. If a data node in the path expression is a YANG list node, then the key values for the list (if any) MUST be encoded according to the - following rules. + following rules: o The key leaf values for a data resource representing a YANG list MUST be encoded using one path segment [RFC3986]. o If there is only one key leaf value, the path segment is constructed by having the list name followed by an "=" followed by the single key leaf value. o If there are multiple key leaf values, the value of each leaf identified in the "key" statement is encoded in the order specified in the YANG "key" statement, with a comma separating them. + o The key value is specified as a string, using the canonical + representation for the YANG data type. Any reserved characters + MUST be encoded with escape sequences, according to [RFC2396], + Section 2.4. + o All the components in the "key" statement MUST be encoded. Partial instance identifiers are not supported. o Quoted strings are supported in the key leaf values. Quoted strings MUST be used to express empty strings. (example: list=foo,'',baz). o The "list-instance" ABNF rule defined in Section 3.5.1.1 represents the syntax of a list instance identifier. @@ -956,147 +955,149 @@ api-path = "/" | ("/" api-identifier 0*("/" (api-identifier | list-instance ))) api-identifier = [module-name ":"] identifier ;; note 1 module-name = identifier list-instance = api-identifier "=" key-value ["," key-value]* - key-value = string + key-value = string ;; note 1 - string = + string = ;; An identifier MUST NOT start with ;; (('X'|'x') ('M'|'m') ('L'|'l')) identifier = (ALPHA / "_") *(ALPHA / DIGIT / "_" / "-" / ".") - Note 1: The syntax for "api-identifier" MUST conform to the JSON - identifier encoding rules in section 4 of + Note 1: The syntax for "api-identifier" and "key-value" MUST conform + to the JSON identifier encoding rules in Section 4 of [I-D.ietf-netmod-yang-json]. 3.5.2. Defaults Handling RESTCONF requires that a server report its default handling mode (see - Section 4.8.2 for details). If the optional "with-defaults" query + Section 9.1.2 for details). If the optional "with-defaults" query parameter is supported by the server, a client may use it to control - retrieval of default values (see Section 4.8.11 for details). + retrieval of default values (see Section 4.8.9 for details). If the target of a GET method is a data node that represents a leaf that has a default value, and the leaf has not been given a value yet, the server MUST return the default value that is in use by the server. If the target of a GET method is a data node that represents a container or list that has any child resources with default values, for the child resources that have not been given value yet, the server MAY return the default values that are in use by the server, in accordance with its reported default handing mode and query parameters passed by the client. 3.6. Operation Resource An operation resource represents a protocol operation defined with - the YANG "rpc" statement. + the YANG "rpc" statement. It is invoked using a POST method on the + operation resource. - All operation resources share the same module namespace as any top- - level data resources, so the name of an operation resource cannot - conflict with the name of a top-level data resource defined within - the same module. + POST {+restconf}/operations/ - If 2 different YANG modules define the same "rpc" identifier, then - the module name MUST be used in the request URI. For example, if - "module-A" and "module-B" both defined a "reset" operation, then - invoking the operation from "module-A" would be requested as follows: + The field identifies the module name and rpc identifier + string for the desired operation. + + For example, if "module-A" defined a "reset" operation, then invoking + the operation from "module-A" would be requested as follows: POST /restconf/operations/module-A:reset HTTP/1.1 Server example.com - Any usage of an operation resource from the same module, with the - same name, refers to the same "rpc" statement definition. This - behavior can be used to design protocol operations that perform the - same general function on different resource types. - If the "rpc" statement has an "input" section, then a message-body MAY be sent by the client in the request, otherwise the request - message MUST NOT include a message-body. If the "rpc" statement has - an "output" section, then a message-body MAY be sent by the server in - the response, otherwise the response message MUST NOT include a - message-body in the response message, and MUST send a "204 No - Content" status-line instead. + message MUST NOT include a message-body. + + If the operation is successfully invoked, and if the "rpc" statement + has an "output" section, then a message-body MAY be sent by the + server in the response, otherwise the response message MUST NOT + include a message-body in the response message, and MUST send a "204 + No Content" status-line instead. + + If the operation is not successfully invoked, then a message-body + SHOULD be sent by the server, containing an "errors" resource, as + defined in Section 3.9. 3.6.1. Encoding Operation Input Parameters If the "rpc" statement has an "input" section, then the "input" node is provided in the message-body, corresponding to the YANG data definition statements within the "input" section. Example: The following YANG definition is used for the examples in this section. + module example-ops { + namespace "https://example.com/ns/example-ops"; + prefix "ops"; + rpc reboot { input { leaf delay { units seconds; type uint32; default 0; } leaf message { type string; } leaf language { type string; } } } + rpc get-reboot-info { + output { + leaf reboot-time { + units seconds; + type uint32; + } + leaf message { type string; } + leaf language { type string; } + } + } + } + The client might send the following POST request message: POST /restconf/operations/example-ops:reboot HTTP/1.1 Host: example.com - Content-Type: application/yang.operation+json - - { - "example-ops:input" : { - "delay" : 600, - "message" : "Going down for system maintenance", - "language" : "en-US" - } - } + Content-Type: application/yang.operation+xml + + 600 + Going down for system maintenance + en-US + The server might respond: HTTP/1.1 204 No Content Date: Mon, 25 Apr 2012 11:01:00 GMT Server: example-server 3.6.2. Encoding Operation Output Parameters If the "rpc" statement has an "output" section, then the "output" node is provided in the message-body, corresponding to the YANG data definition statements within the "output" section. Example: - The following YANG definition is used for the examples in this - section. - - rpc get-reboot-info { - output { - leaf reboot-time { - units seconds; - type uint32; - } - leaf message { type string; } - leaf language { type string; } - } - } + The "example-ops" YANG module defined in Section 3.6.1 is used for + the examples in this section. The client might send the following POST request message: POST /restconf/operations/example-ops:get-reboot-info HTTP/1.1 Host: example.com Accept: application/yang.operation+json The server might respond: HTTP/1.1 200 OK @@ -1105,62 +1106,100 @@ Content-Type: application/yang.operation+json { "example-ops:output" : { "reboot-time" : 30, "message" : "Going down for system maintenance", "language" : "en-US" } } +3.6.3. Encoding Operation Errors + + If any errors occur while attempting to invoke the operation, then an + "errors" data structure is returned with the appropriate error + status. + + Using the "reset" operation example above, the client might send the + following POST request message: + + POST /restconf/operations/example-ops:reboot HTTP/1.1 + Host: example.com + Content-Type: application/yang.operation+xml + + + -33 + Going down for system maintenance + en-US + + + The server might respond with an "invalid-value" error: + + HTTP/1.1 400 Bad Request + Date: Mon, 25 Apr 2012 11:10:30 GMT + Server: example-server + Content-Type: application/yang.errors+xml + + + + protocol + invalid-value + + err:input/err:delay + + Invalid input parameter + + + 3.7. Schema Resource The server can optionally support retrieval of the YANG modules it - supports. To retrieve a YANG module, a client first needs to get the - URL for retrieving the schema. + supports, using the "ietf-yang-library" module, defined in + [I-D.ietf-netconf-yang-library]. + + To retrieve a YANG module, a client first needs to get the URL for + retrieving the schema. The client might send the following GET request message: GET /restconf/data/ietf-yang-library:modules/module= example-jukebox,2014-07-03/schema HTTP/1.1 Host: example.com Accept: application/yang.data+json The server might respond: HTTP/1.1 200 OK Date: Mon, 25 Apr 2012 11:10:30 GMT Server: example-server Content-Type: application/yang.data+json { "ietf-yang-library:schema": - "https://example.com/mymodules/example-jukebox/2014-07-03" + "https://example.com/mymodules/example-jukebox/2015-06-04" } Next the client needs to retrieve the actual YANG schema. The client might send the following GET request message: - GET https://example.com/mymodules/example-jukebox/2014-07-03 + GET https://example.com/mymodules/example-jukebox/2015-06-04 HTTP/1.1 Host: example.com Accept: application/yang The server might respond: module example-jukebox { - namespace "http://example.com/ns/example-jukebox"; - prefix "jbox"; + // contents of YANG module deleted for this example... - // rest of YANG module content deleted... } 3.8. Event Stream Resource An "event stream" resource represents a source for system generated event notifications. Each stream is created and modified by the server only. A client can retrieve a stream resource or initiate a long-poll server sent event stream, using the procedure specified in Section 6.3. @@ -1183,31 +1222,31 @@ behavior is defined in Section 7. 4. Operations The RESTCONF protocol uses HTTP methods to identify the CRUD operation requested for a particular resource. The following table shows how the RESTCONF operations relate to NETCONF protocol operations: - +----------+-------------------------------------+ + +----------+--------------------------------------------+ | RESTCONF | NETCONF | - +----------+-------------------------------------+ + +----------+--------------------------------------------+ | OPTIONS | none | | HEAD | none | | GET | , | | POST | (operation="create") | - | PUT | (operation="replace") | + | PUT | (operation="create/replace") | | PATCH | (operation="merge") | | DELETE | (operation="delete") | - +----------+-------------------------------------+ + +----------+--------------------------------------------+ Table 1: CRUD Methods in RESTCONF The NETCONF "remove" operation attribute is not supported by the HTTP DELETE method. The resource must exist or the DELETE method will fail. The PATCH method is equivalent to a "merge" operation when using a plain patch (see Section 4.6.1), other media-types may provide more granular control. Access control mechanisms may be used to limit what operations can be @@ -1240,74 +1279,72 @@ defined in [RFC5789]. 4.2. HEAD The HEAD method is sent by the client to retrieve just the headers that would be returned for the comparable GET method, without the response message-body. It is supported for all resource types, except operation resources. The request MUST contain a request URI that contains at least the - entry point component. The same query parameters supported by the - GET method are supported by the HEAD method. + entry point. The same query parameters supported by the GET method + are supported by the HEAD method. The access control behavior is enforced as if the method was GET instead of HEAD. The server MUST respond the same as if the method was GET instead of HEAD, except that no response message-body is included. 4.3. GET The GET method is sent by the client to retrieve data and meta-data for a resource. It is supported for all resource types, except operation resources. The request MUST contain a request URI that - contains at least the entry point component. + contains at least the entry point. The server MUST NOT return any data resources for which the user does not have read privileges. If the user is not authorized to read the target resource, an error response containing a "403 Forbidden" or "404 Not Found" status-line is returned to the client. If the user is authorized to read some but not all of the target resource, the unauthorized content is omitted from the response message-body, and the authorized content is returned to the client. Example: The client might request the response headers for a JSON representation of the "library" resource: GET /restconf/data/example-jukebox:jukebox/ library/artist=Foo%20Fighters/album HTTP/1.1 Host: example.com - Accept: application/yang.data+json + Accept: application/yang.data+xml The server might respond: HTTP/1.1 200 OK Date: Mon, 23 Apr 2012 17:02:40 GMT Server: example-server - Content-Type: application/yang.data+json + Content-Type: application/yang.data+xml Cache-Control: no-cache Pragma: no-cache ETag: a74eefc993a2b Last-Modified: Mon, 23 Apr 2012 11:02:14 GMT - { - "example-jukebox:album" : [ - { - "name" : "Wasting Light", - "genre" : "example-jukebox:alternative", - "year" : 2011 - } - ] - } + + Wasting Light + + g:alternative + + 2011 + 4.4. POST The POST method is sent by the client to create a data resource or invoke an operation resource. The server uses the target resource media type to determine how to process the request. +-----------+------------------------------------------------+ | Type | Description | +-----------+------------------------------------------------+ @@ -1344,26 +1381,29 @@ Example: To create a new "jukebox" resource, the client might send: POST /restconf/data HTTP/1.1 Host: example.com Content-Type: application/yang.data+json { "example-jukebox:jukebox" : [null] } - If the resource is created, the server might respond as follows: + If the resource is created, the server might respond as follows. + Note that the "Location" header line is wrapped for display purposes + only: HTTP/1.1 201 Created Date: Mon, 23 Apr 2012 17:01:00 GMT Server: example-server - Location: https://example.com/restconf/data/example-jukebox:jukebox + Location: https://example.com/restconf/data/ + example-jukebox:jukebox Last-Modified: Mon, 23 Apr 2012 17:01:00 GMT ETag: b3a3e673be2 Refer to Appendix D.2.1 for more resource creation examples. 4.4.2. Invoke Operation Mode If the target resource type is an operation resource, then the POST method is treated as a request to invoke that operation. The message-body (if any) is processed as the operation input parameters. @@ -1404,21 +1444,21 @@ 4.5. PUT The PUT method is sent by the client to create or replace the target resource. The only target resource media type that supports PUT is the data resource. The message-body is expected to contain the content used to create or replace the target resource. - The "insert" (Section 4.8.6) and "point" (Section 4.8.7) query + The "insert" (Section 4.8.4) and "point" (Section 4.8.5) query parameters are supported by the PUT method for data resources. Consistent with [RFC7231], if the PUT request creates a new resource, a "201 Created" status-line is returned. If an existing resource is modified, either "200 OK" or "204 No Content" are returned. If the user is not authorized to create or replace the target resource an error response containing a "403 Forbidden" or "404 Not Found" status-line is returned to the client. All other error responses are handled according to the procedures defined in @@ -1494,48 +1534,34 @@ To replace just the "year" field in the "album" resource (instead of replacing the entire resource with the PUT method), the client might send a plain patch as follows. Note that the request-line is wrapped for display purposes only: PATCH /restconf/data/example-jukebox:jukebox/ library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1 Host: example.com If-Match: b8389233a4c - Content-Type: application/yang.data+json + Content-Type: application/yang.data+xml - { - "example-jukebox:album" : { - "year" : 2011 - } - } + + 2011 + If the field is updated, the server might respond: HTTP/1.1 204 No Content Date: Mon, 23 Apr 2012 17:49:30 GMT Server: example-server Last-Modified: Mon, 23 Apr 2012 17:49:30 GMT ETag: b2788923da4c - The XML encoding for the same request might be: - - PATCH /restconf/data/example-jukebox:jukebox/ - library/artist=Foo%20Fighters/album=Wasting%20Light HTTP/1.1 - Host: example.com - If-Match: b8389233a4c - Content-Type: application/yang.data+xml - - - 2011 - - 4.7. DELETE The DELETE method is used to delete the target resource. If the DELETE request succeeds, a "204 No Content" status-line is returned, and there is no response message-body. If the user is not authorized to delete the target resource then an error response containing a "403 Forbidden" or "404 Not Found" status-line is returned to the client. All other error responses are handled according to the procedures defined in Section 7. @@ -1589,78 +1615,21 @@ Query parameters can be given in any order. Each parameter can appear at most once in a request URI. A default value may apply if the parameter is missing. Refer to Appendix D.3 for examples of query parameter usage. If vendors define additional query parameters, they SHOULD use a prefix (such as the enterprise or organization name) for query parameter names in order to avoid collisions with other parameters. -4.8.1. Query Parameter URIs - - A new set of RESTCONF Capability URIs are defined to identify the - specific query parameters and protocol features supported by the - server. - - +--------------+----------------------------------------------------+ - | Name | URI | - +--------------+----------------------------------------------------+ - | defaults | urn:ietf:params:restconf:capability:defaults:1.0 | - | depth | urn:ietf:params:restconf:capability:depth:1.0 | - | fields | urn:ietf:params:restconf:capability:fields:1.0 | - | filter | urn:ietf:params:restconf:capability:filter:1.0 | - | insert | urn:ietf:params:restconf:capability:insert:1.0 | - | replay | urn:ietf:params:restconf:capability:replay:1.0 | - | with- | urn:ietf:params:restconf:capability:with- | - | defaults | defaults:1.0 | - +--------------+----------------------------------------------------+ - - RESTCONF Query Parameter URIs - -4.8.2. The "defaults" Protocol Capability URI - - This URI identifies the defaults handling mode that is used by the - server for processing default leafs in the unified datastore. A - parameter named "basic-mode" is required for this capability URI. - The "basic-mode" definitions are specified in the "With-Defaults - Capability for NETCONF" [RFC6243]. - - This protocol capability URI MUST be supported by the server, and the - MUST be listed in the "capability" leaf-list in Section 9.3. - - +------------+------------------------------------------------------+ - | Value | Description | - +------------+------------------------------------------------------+ - | report-all | No data nodes are considered default | - | trim | Values set to the YANG default-stmt value are | - | | default | - | explicit | Values set by the client are never considered | - | | default | - +------------+------------------------------------------------------+ - If the "basic-mode" is set to "report-all" then the server MUST - adhere to the defaults handling behavior defined in section 2.1 of - [RFC6243]. - - If the "basic-mode" is set to "trim" then the server MUST adhere to - the defaults handling behavior defined in section 2.2 of [RFC6243]. - - If the "basic-mode" is set to "explicit" then the server MUST adhere - to the defaults handling behavior defined in section 2.3 of - [RFC6243]. - - Example: (split for display purposes only) - - urn:ietf:params:restconf:capability:defaults:1.0? - basic-mode=explicit - -4.8.3. The "content" Query Parameter +4.8.1. The "content" Query Parameter The "content" parameter controls how descendant nodes of the requested data nodes will be processed in the reply. The allowed values are: +-----------+-----------------------------------------------------+ | Value | Description | +-----------+-----------------------------------------------------+ | config | Return only configuration descendant data nodes | @@ -1672,45 +1641,45 @@ resources. A 400 Bad Request error is returned if used for other methods or resource types. The default value is determined by the "config" statement value of the requested data nodes. If the "config" value is "false", then the default for the "content" parameter is "nonconfig". If "config" is "true" then the default for the "content" parameter is "config". This query parameter MUST be supported by the server. -4.8.4. The "depth" Query Parameter +4.8.2. The "depth" Query Parameter The "depth" parameter is used to specify the number of nest levels returned in a response for a GET method. The first nest-level consists of the requested data node itself. Any child nodes which are contained within a parent node have a depth value that is 1 greater than its parent. The value of the "depth" parameter is either an integer between 1 and 65535, or the string "unbounded". "unbounded" is the default. This parameter is only allowed for GET methods on API, datastore, and data resources. A 400 Bad Request error is returned if it used for other methods or resource types. By default, the server will include all sub-resources within a retrieved resource, which have the same resource type as the requested resource. Only one level of sub-resources with a different media type than the target resource will be returned. - If this query parameter is supported by the server, then the "depth" - query parameter URI MUST be listed in the "capability" leaf-list in - Section 9.3. + If the "depth" query parameter URI is listed in the "capability" + leaf-list in Section 9.3, then the server supports the "depth" query + parameter. -4.8.5. The "fields" Query Parameter +4.8.3. The "fields" Query Parameter The "fields" query parameter is used to optionally identify data nodes within the target resource to be retrieved in a GET method. The client can use this parameter to retrieve a subset of all nodes in a resource. A value of the "fields" query parameter matches the following rule: fields-expr = path '(' fields-expr / '*' ')' / path ';' fields-expr / @@ -1727,25 +1696,25 @@ album, use: "fields=admin(label;catalogue-number)". "/" is used in a path to retrieve a child node of a node. For example, to retrieve only the "label" of an album, use: "fields=admin/label". This parameter is only allowed for GET methods on api, datastore, and data resources. A 400 Bad Request error is returned if used for other methods or resource types. - If this query parameter is supported by the server, then the "fields" - query parameter URI MUST be listed in the "capability" leaf-list in - Section 9.3. + If the "fields" query parameter URI is listed in the "capability" + leaf-list in Section 9.3, then the server supports the "fields" + parameter. -4.8.6. The "insert" Query Parameter +4.8.4. The "insert" Query Parameter The "insert" parameter is used to specify how a resource should be inserted within a user-ordered list. The allowed values are: +--------+----------------------------------------------------------+ | Value | Description | +--------+----------------------------------------------------------+ | first | Insert the new data as the new first entry. | @@ -1760,51 +1729,46 @@ This parameter is only supported for the POST and PUT methods. It is also only supported if the target resource is a data resource, and that data represents a YANG list or leaf-list that is ordered by the user. If the values "before" or "after" are used, then a "point" query parameter for the insertion parameter MUST also be present, or a 400 Bad Request error is returned. - If this query parameter is supported by the server, then the "insert" - query parameter URI MUST be listed in the "capability" leaf-list in - Section 9.3. The "point" query parameter MUST also be supported by - the server. + The "insert" query parameter MUST be supported by the server. -4.8.7. The "point" Query Parameter +4.8.5. The "point" Query Parameter The "point" parameter is used to specify the insertion point for a data resource that is being created or moved within a user ordered list or leaf-list. - The value of the "point" parameter is of type - "data-resource-identifier", defined in the "ietf-restconf" YANG - module Section 8. + The value of the "point" parameter is a string that identifies the + path to the insertion point object. The format is the same as a + target resource URI string. This parameter is only supported for the POST and PUT methods. It is also only supported if the target resource is a data resource, and that data represents a YANG list or leaf-list that is ordered by the user. If the "insert" query parameter is not present, or has a value other than "before" or "after", then a 400 Bad Request error is returned. This parameter contains the instance identifier of the resource to be used as the insertion point for a POST or PUT method. - If the server includes the "insert" query parameter URI in the - "capability" leaf-list in Section 9.3, then the "point" query - parameter MUST be supported. + The "point" query parameter MUST be supported by the server. -4.8.8. The "filter" Query Parameter +4.8.6. The "filter" Query Parameter The "filter" parameter is used to indicate which subset of all possible events are of interest. If not present, all events not precluded by other parameters will be sent. This parameter is only allowed for GET methods on a text/event-stream data resource. A 400 Bad Request error is returned if used for other methods or resource types. The format of this parameter is an XPath 1.0 expression, and is @@ -1815,30 +1779,30 @@ is the YANG module name, and the namespace is as defined by the "namespace" statement in the YANG module. o The function library is the core function library defined in XPath 1.0. o The set of variable bindings is empty. o The context node is the root node. - The filter is used as defined in [RFC5277], section 3.6. If the + The filter is used as defined in [RFC5277], Section 3.6. If the boolean result of the expression is true when applied to the - conceptual "notification" document root, then the notification event + conceptual "notification" document root, then the event notification is delivered to the client. - If this query parameter is supported by the server, then the "filter" - query parameter URI MUST be listed in the "capability" leaf-list in - Section 9.3. + If the "filter" query parameter URI is listed in the "capability" + leaf-list in Section 9.3, then the server supports the "filter" query + parameter. -4.8.9. The "start-time" Query Parameter +4.8.7. The "start-time" Query Parameter The "start-time" parameter is used to trigger the notification replay feature and indicate that the replay should start at the time specified. If the stream does not support replay, per the "replay-support" attribute returned by stream list entry for the stream resource, then the server MUST return the HTTP error code 400 Bad Request. The value of the "start-time" parameter is of type "date-and-time", defined in the "ietf-yang" YANG module [RFC6991]. @@ -1855,21 +1819,21 @@ If this query parameter is supported by the server, then the "replay" query parameter URI MUST be listed in the "capability" leaf-list in Section 9.3. The "stop-time" query parameter MUST also be supported by the server. If the "replay-support" leaf is present in the "stream" entry (defined in Section 9.3) then the server MUST support the "start-time" and "stop-time" query parameters for that stream. -4.8.10. The "stop-time" Query Parameter +4.8.8. The "stop-time" Query Parameter The "stop-time" parameter is used with the replay feature to indicate the newest notifications of interest. This parameter MUST be used with and have a value later than the "start-time" parameter. The value of the "stop-time" parameter is of type "date-and-time", defined in the "ietf-yang" YANG module [RFC6991]. This parameter is only allowed for GET methods on a text/event-stream data resource. A 400 Bad Request error is returned if used for other @@ -1881,28 +1845,28 @@ If this query parameter is supported by the server, then the "replay" query parameter URI MUST be listed in the "capability" leaf-list in Section 9.3. The "start-time" query parameter MUST also be supported by the server. If the "replay-support" leaf is present in the "stream" entry (defined in Section 9.3) then the server MUST support the "start-time" and "stop-time" query parameters for that stream. -4.8.11. The "with-defaults" Query Parameter +4.8.9. The "with-defaults" Query Parameter The "with-defaults" parameter is used to specify how information about default data nodes should be returned in response to GET requests on data resources. If the server supports this capability, then it MUST implement the - behavior in section 4.5.1 of [RFC6243], except applied to the + behavior in Section 4.5.1 of [RFC6243], except applied to the RESTCONF GET operation, instead of the NETCONF operations. +-------------------+-----------------------------------------------+ | Value | Description | +-------------------+-----------------------------------------------+ | report-all | All data nodes are reported | | trim | Data nodes set to the YANG default are not | | | reported | | explicit | Data nodes set by the client are not reported | | report-all-tagged | All data nodes are reported and defaults are | @@ -1901,41 +1865,40 @@ +-------------------+-----------------------------------------------+ | Value | Description | +-------------------+-----------------------------------------------+ | report-all | All data nodes are reported | | trim | Data nodes set to the YANG default are not | | | reported | | explicit | Data nodes set by the client are not reported | | report-all-tagged | All data nodes are reported and defaults are | | | tagged | +-------------------+-----------------------------------------------+ - If the "with-defaults" parameter is set to "report-all" then the server MUST adhere to the defaults reporting behavior defined in - section 3.1 of [RFC6243]. + Section 3.1 of [RFC6243]. If the "with-defaults" parameter is set to "trim" then the server - MUST adhere to the defaults reporting behavior defined in section 3.2 + MUST adhere to the defaults reporting behavior defined in Section 3.2 of [RFC6243]. If the "with-defaults" parameter is set to "explicit" then the server - MUST adhere to the defaults reporting behavior defined in section 3.3 + MUST adhere to the defaults reporting behavior defined in Section 3.3 of [RFC6243]. If the "with-defaults" parameter is set to "report-all-tagged" then the server MUST adhere to the defaults reporting behavior defined in - section 3.4 of [RFC6243]. + Section 3.4 of [RFC6243]. If the "with-defaults" parameter is not present then the server MUST adhere to the defaults reporting behavior defined in its "basic-mode" parameter for the "defaults" protocol capability URI, defined in - Section 4.8.2. + Section 9.1.2. If the server includes the "with-defaults" query parameter URI in the "capability" leaf-list in Section 9.3, then the "with-defaults" query parameter MUST be supported. 5. Messages The RESTCONF protocol uses HTTP entities for messages. A single HTTP message corresponds to a single protocol method. Most messages can perform a single task on a single resource, such as retrieving a @@ -1979,22 +1941,22 @@ o query: the set of parameters associated with the RESTCONF message. These have the familiar form of "name=value" pairs. All query parameters are optional to implement by the server and optional to use by the client. Each query parameter is identified by a URI. The server MUST list the query parameter URIs it supports in the "capabilities" list defined in Section 9.3. There is a specific set of parameters defined, although the server MAY choose to support query parameters not defined in this document. The contents of the any query parameter value MUST be encoded - according to [RFC2396], section 3.4. Any reserved characters MUST be - encoded with escape sequences, according to [RFC2396], section 2.4. + according to [RFC2396], Section 3.4. Any reserved characters MUST be + encoded with escape sequences, according to [RFC2396], Section 2.4. o fragment: This field is not used by the RESTCONF protocol. When new resources are created by the client, a "Location" header is returned, which identifies the path of the newly created resource. The client MUST use this exact path identifier to access the resource once it has been created. The "target" of an operation is a resource. The "path" field in the request URI represents the target resource for the operation. @@ -2154,89 +2116,91 @@ NETCONF default NETCONF event stream true 2007-07-08T00:00:00Z - - xml - https://example.com/streams/NETCONF - - - json - https://example.com/streams/NETCONF-JSON - + + xml + https://example.com/streams/NETCONF + + + + json + https://example.com/streams/NETCONF-JSON + + SNMP SNMP notifications false - - xml - https://example.com/streams/SNMP - + + xml + https://example.com/streams/SNMP + syslog-critical Critical and higher severity true 2007-07-01T00:00:00Z - - xml - + + xml + https://example.com/streams/syslog-critical - - + + 6.3. Subscribing to Receive Notifications RESTCONF clients can determine the URL for the subscription resource (to receive notifications) by sending an HTTP GET request for the - "events" leaf with the stream list entry. The value returned by the - server can be used for the actual notification subscription. + "location" leaf with the stream list entry. The value returned by + the server can be used for the actual notification subscription. The client will send an HTTP GET request for the URL returned by the server with the "Accept" type "text/event-stream". The server will treat the connection as an event stream, using the Server Sent Events [W3C.CR-eventsource-20121211] transport strategy. The server MAY support query parameters for a GET method on this resource. These parameters are specific to each notification stream. For example: The client might send the following request: GET /restconf/data/ietf-restconf-monitoring:restconf-state/ - streams/stream=NETCONF/encoding=xml/events HTTP/1.1 + streams/stream=NETCONF/encoding=xml/location HTTP/1.1 Host: example.com Accept: application/yang.data+xml The server might send the following response: HTTP/1.1 200 OK Content-Type: application/yang.api+xml - https://example.com/streams/NETCONF - + The RESTCONF client can then use this URL value to start monitoring the event stream: GET /streams/NETCONF HTTP/1.1 Host: example.com Accept: text/event-stream Cache-Control: no-cache Connection: keep-alive @@ -2254,63 +2218,84 @@ The server SHOULD support the "NETCONF" notification stream defined in [RFC5277]. For this stream, RESTCONF notification subscription requests MAY specify parameters indicating the events it wishes to receive. These query parameters are optional to implement, and only available if the server supports them. +------------+---------+-------------------------+ | Name | Section | Description | +------------+---------+-------------------------+ - | start-time | 4.8.9 | replay event start time | - | stop-time | 4.8.10 | replay event stop time | - | filter | 4.8.8 | boolean content filter | + | start-time | 4.8.7 | replay event start time | + | stop-time | 4.8.8 | replay event stop time | + | filter | 4.8.6 | boolean content filter | +------------+---------+-------------------------+ NETCONF Stream Query Parameters The semantics and syntax for these query parameters are defined in the sections listed above. The YANG encoding MUST be converted to URL-encoded string for use in the request URI. Refer to Appendix D.3.6 for filter parameter examples. 6.4. Receiving Event Notifications RESTCONF notifications are encoded according to the definition of the event stream. The NETCONF stream defined in [RFC5277] is encoded in XML format. The structure of the event data is based on the "notification" - element definition in section 4 of [RFC5277]. It MUST conform to the - schema for the "notification" element in section 4 of [RFC5277], + element definition in Section 4 of [RFC5277]. It MUST conform to the + schema for the "notification" element in Section 4 of [RFC5277], except the XML namespace for this element is defined as: urn:ietf:params:xml:ns:yang:ietf-restconf - For JSON encoding purposes, the module name is "ietf-restconf". + For JSON encoding purposes, the module name for the "notification" + element is "ietf-restconf". - An example SSE notification encoded using XML: + Two child nodes within the "notification" container are expected, + representing the event time and the event payload. The "event-time" + node is defined within the "ietf-restconf" module namespace. The + name and namespace of the payload element are determined by the YANG + module containing the notification-stmt. + + In the following example, the YANG module "example-mod" is used: + + module example-mod { + namespace "http://example.com/event/1.0"; + + notification event { + leaf event-class { type string; } + container reporting-entity { + leaf card { type string; } + } + leaf severity { type string; } + } + } + + An example SSE event notification encoded using XML: data: data: 2013-12-21T00:01:00Z data: data: fault data: data: Ethernet0 data: data: major data: data: - An example SSE notification encoded using JSON: + An example SSE event notification encoded using JSON: data: { data: "ietf-restconf:notification": { data: "event-time": "2013-12-21T00:01:00Z", data: "example-mod:event": { data: "event-class": "fault", data: "reporting-entity": { "card": "Ethernet0" }, data: "severity": "major" data: } data: } @@ -2436,25 +2421,21 @@ document, except for the one below, assume the default XML encoding will be returned if there is an error. YANG Tree Diagram for Data: +--ro errors +--ro error +--ro error-type enumeration +--ro error-tag string +--ro error-app-tag? string - +--ro (error-node)? - | +--:(error-path) - | | +--ro error-path? instance-identifier - | +--:(error-urlpath) - | +--ro error-urlpath? data-resource-identifier + +--ro error-path? instance-identifier +--ro error-message? string +--ro error-info The semantics and syntax for RESTCONF error messages are defined in the "application/yang.errors" restconf-media-type extension in Section 8. Examples: The following example shows an error returned for an "lock-denied" @@ -2520,21 +2501,21 @@ The "ietf-restconf" module defines conceptual definitions within an extension and two groupings, which are not meant to be implemented as datastore contents by a server. E.g., the "restconf" container is not intended to be implemented as a top-level data node (under the "/restconf/data" entry point). RFC Ed.: update the date below with the date of RFC publication and remove this note. - file "ietf-restconf@2015-01-30.yang" + file "ietf-restconf@2015-06-04.yang" module ietf-restconf { namespace "urn:ietf:params:xml:ns:yang:ietf-restconf"; prefix "rc"; organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: @@ -2576,40 +2556,42 @@ Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: remove this note - // Note: extracted from draft-ietf-netconf-restconf-04.txt + // Note: extracted from draft-ietf-netconf-restconf-05.txt // RFC Ed.: update the date below with the date of RFC publication // and remove this note. - revision 2015-01-30 { + revision 2015-06-04 { description "Initial revision."; reference "RFC XXXX: RESTCONF Protocol."; } extension restconf-media-type { argument media-type-id { yin-element true; } + // RFC Ed.: replace draft-ietf-netmod-yang-json with RFC number + // in the description below, and remove this note. description "This extension is used to specify a YANG data structure which - represents a conceptual RESTCONF media type template. + represents a conceptual RESTCONF media type. Data definition statements within this extension specify - the 'generic syntax' for the specific media type. + the generic syntax for the specific media type. YANG is mapped to specific encoding formats outside the scope of this extension statement. RFC 6020 defines XML encoding rules for all RESTCONF media types that use the '+xml' suffix. draft-ietf-netmod-yang-json defines JSON encoding rules for all RESTCONF media types that use the '+json' suffix. The 'media-type-id' parameter value identifies the media type that is being defined. It contains the string associated @@ -2651,56 +2633,29 @@ - The list-stmt is not required to have a key-stmt defined. - The if-feature-stmt is ignored if present. - The config-stmt is ignored if present. - The available identity values for any 'identityref' leaf or leaf-list nodes is limited to the module containing this extension statement, and the modules imported into that module. "; } + rc:restconf-media-type "application/yang.errors" { uses errors; } rc:restconf-media-type "application/yang.api" { uses restconf; } - typedef data-resource-identifier { - type string { - length "1 .. max"; - } - description - "Contains a Data Resource Identifier formatted string - to identify a specific data resource instance. - The document root for all data resources is a - datastore resource container. Each top-level YANG - data nodes supported by the server will be represented - as a child node of the document root. - - The canonical representation of a data resource identifier - includes the full server specification that is returned - in the Location header when a new data resource is created - with the POST method. - - The abbreviated representation does not contain any server - location identification. Instead the identifier will start - with the '/' character to represent the datastore document - root for the data resource instance. - - The server MUST accept either representation and SHOULD - return the canonical representation in any response message."; - reference - "RFC XXXX: [sec. 5.3.1.1 ABNF For Data Resource Identifiers]"; - } - grouping errors { description "A grouping that contains a YANG container representing the syntax and semantics of a YANG Patch errors report within a response message."; container errors { description "Represents an error report returned by the server if a request results in an error."; @@ -2738,61 +2694,40 @@ description "The enumerated error tag."; } leaf error-app-tag { type string; description "The application-specific error tag."; } - choice error-node { - description - "The server will return the location of the error node - in a format that is appropriate for the protocol. - If no specific node within the request message body - caused the error then this choice will not be present."; - leaf error-path { type instance-identifier; description "The YANG instance identifier associated - with the error node. This leaf will only be - present if the error node is not a data resource, - e.g., the error node is an input parameter - for an operation resource."; - } - leaf error-urlpath { - type data-resource-identifier; - description - "The target data resource identifier associated - with the error node. This leaf will only be - present if the error node is associated with - a data resource (either within the server or - in the request message)."; - } + with the error node."; } leaf error-message { type string; description "A message describing the error."; } - anyxml error-info { description "Arbitrary XML that represents a container of additional information for the error report."; } } } - } // grouping errors + } grouping restconf { description "Conceptual container representing the application/yang.api resource type."; container restconf { description "Conceptual container representing the application/yang.api resource type."; @@ -2819,89 +2754,170 @@ E.g.; POST /restconf/operations/show-log-errors leaf show-log-errors { type empty; } "; } - } // container restconf - } // grouping restconf + + } + } } 9. RESTCONF Monitoring The "ietf-restconf-monitoring" module provides information about the - RESTCONF protocol capabilities and notification event streams + RESTCONF protocol capabilities and event notification streams available from the server. Implementation is mandatory for RESTCONF - servers, if any protocol capabilities or notification event streams + servers, if any protocol capabilities or event notification streams are supported. YANG Tree Diagram for "ietf-restconf-monitoring" module: +--ro restconf-state +--ro capabilities | +--ro capability* inet:uri +--ro streams +--ro stream* [name] +--ro name string +--ro description? string +--ro replay-support? boolean +--ro replay-log-creation-time? yang:date-and-time - +--ro encoding* [type] - +--ro type string - +--ro events inet:uri + +--ro access* [type] + +--ro encoding string + +--ro location inet:uri 9.1. restconf-state/capabilities This mandatory container holds the RESTCONF protocol capability URIs supported by the server. The server MUST maintain a last-modified timestamp for this container, and return the "Last-Modified" header when this data node is retrieved with the GET or HEAD methods. The server SHOULD maintain an entity-tag for this container, and return the "ETag" header when this data node is retrieved with the GET or HEAD methods. + The server MUST include a "capability" URI leaf-list entry for the + "defaults" mode used by the server, defined in Section 9.1.2. + + The server MUST include a "capability" URI leaf-list entry + identifying each supported optional protocol feature. This includes + optional query parameters and MAY include other capability URIs + defined outside this document. + +9.1.1. Query Parameter URIs + + A new set of RESTCONF Capability URIs are defined to identify the + specific query parameters (defined in Section 4.8) supported by the + server. + + The server MUST include a "capability" leaf-list entry for each + optional query parameter that it supports. + + +------------+--------+---------------------------------------------+ + | Name | Sectio | URI | + | | n | | + +------------+--------+---------------------------------------------+ + | depth | 4.8.2 | urn:ietf:params:restconf:capability:depth:1 | + | | | .0 | + | fields | 4.8.3 | urn:ietf:params:restconf:capability:fields: | + | | | 1.0 | + | filter | 4.8.6 | urn:ietf:params:restconf:capability:filter: | + | | | 1.0 | + | replay | 4.8.7 | urn:ietf:params:restconf:capability:replay: | + | | 4.8.8 | 1.0 | + | with- | 4.8.9 | urn:ietf:params:restconf:capability:with- | + | defaults | | defaults:1.0 | + +------------+--------+---------------------------------------------+ + + RESTCONF Query Parameter URIs + +9.1.2. The "defaults" Protocol Capability URI + + This URI identifies the defaults handling mode that is used by the + server for processing default leafs in requests for data resources. + A parameter named "basic-mode" is required for this capability URI. + The "basic-mode" definitions are specified in the "With-Defaults + Capability for NETCONF" [RFC6243]. + + +----------+--------------------------------------------------+ + | Name | URI | + +----------+--------------------------------------------------+ + | defaults | urn:ietf:params:restconf:capability:defaults:1.0 | + +----------+--------------------------------------------------+ + + RESTCONF defaults capability URI + + This protocol capability URI MUST be supported by the server, and the + MUST be listed in the "capability" leaf-list in Section 9.3. + + +------------+------------------------------------------------------+ + | Value | Description | + +------------+------------------------------------------------------+ + | report-all | No data nodes are considered default | + | trim | Values set to the YANG default-stmt value are | + | | default | + | explicit | Values set by the client are never considered | + | | default | + +------------+------------------------------------------------------+ + + If the "basic-mode" is set to "report-all" then the server MUST + adhere to the defaults handling behavior defined in Section 2.1 of + [RFC6243]. + + If the "basic-mode" is set to "trim" then the server MUST adhere to + the defaults handling behavior defined in Section 2.2 of [RFC6243]. + + If the "basic-mode" is set to "explicit" then the server MUST adhere + to the defaults handling behavior defined in Section 2.3 of + [RFC6243]. + + Example: (split for display purposes only) + + urn:ietf:params:restconf:capability:defaults:1.0? + basic-mode=explicit + 9.2. restconf-state/streams - This optional container provides access to the notification event + This optional container provides access to the event notification streams supported by the server. The server MAY omit this container - if no notification event streams are supported. + if no event notification streams are supported. The server will populate this container with a stream list entry for each stream type it supports. Each stream contains a leaf called "events" which contains a URI that represents an event stream resource. Stream resources are defined in Section 3.8. Notifications are defined in Section 6. 9.3. RESTCONF Monitoring Module The "ietf-restconf-monitoring" module defines monitoring information for the RESTCONF protocol. The "ietf-yang-types" and "ietf-inet-types" modules from [RFC6991] are used by this module for some type definitions. RFC Ed.: update the date below with the date of RFC publication and remove this note. - file "ietf-restconf-monitoring@2015-01-30.yang" + file "ietf-restconf-monitoring@2015-06-04.yang" module ietf-restconf-monitoring { namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring"; prefix "rcmon"; import ietf-yang-types { prefix yang; } import ietf-inet-types { prefix inet; } organization "IETF NETCONF (Network Configuration) Working Group"; @@ -2938,25 +2954,25 @@ set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: remove this note - // Note: extracted from draft-ietf-netconf-restconf-04.txt + // Note: extracted from draft-ietf-netconf-restconf-05.txt // RFC Ed.: update the date below with the date of RFC publication // and remove this note. - revision 2015-01-30 { + revision 2015-06-04 { description "Initial revision."; reference "RFC XXXX: RESTCONF Protocol."; } container restconf-state { config false; description "Contains RESTCONF protocol monitoring information."; @@ -3014,43 +3030,43 @@ } type yang:date-and-time; description "Indicates the time the replay log for this stream was created."; reference "RFC 5277, Section 3.4, element."; } - list encoding { + list access { key type; min-elements 1; description "The server will create an entry in this list for each encoding format that is supported for this stream. The media type 'application/yang.stream' is expected for all event streams. This list identifies the sub-types supported for this stream."; - leaf type { + leaf encoding { type string; description "This is the secondary encoding format within the 'text/event-stream' encoding used by all streams. The type 'xml' is supported for the media type 'application/yang.stream+xml'. The type 'json' is supported for the media type 'application/yang.stream+json'."; } - leaf events { + leaf location { type inet:uri; mandatory true; description "Contains a URL that represents the entry point for establishing notification delivery via server sent events."; } } } } @@ -3159,89 +3175,95 @@ - data - datastore - errors - operation - stream Type name: application Subtype name: yang.xxx - Required parameters: TBD + Required parameters: none - Optional parameters: TBD + Optional parameters: See section 4.8 in RFC XXXX - Encoding considerations: TBD + Encoding considerations: 8-bit - Security considerations: TBD + Security considerations: See Section 12 in RFC XXXX - Interoperability considerations: TBD + Interoperability considerations: none // RFC Ed.: replace XXXX with RFC number and remove this note Published specification: RFC XXXX 11.4. RESTCONF Capability URNs [Note to RFC Editor: The RESTCONF Protocol Capability Registry does not yet exist; Need to ask IANA to create it; remove this note for publication ] + This document defines a registry for RESTCONF capability identifiers. + The name of the registry is "RESTCONF Capability URNs". The registry + shall record for each entry: + + o the name of the RESTCONF capability. By convention, this name is + prefixed with the colon ':' character. + + o the URN for the RESTCONF capability. + This document registers several capability identifiers in "RESTCONF - Protocol Capability URNs" registry + Capability URNs" registry: + Index Capability Identifier ------------------------ :defaults urn:ietf:params:restconf:capability:defaults:1.0 :depth urn:ietf:params:restconf:capability:depth:1.0 :fields urn:ietf:params:restconf:capability:fields:1.0 :filter urn:ietf:params:restconf:capability:filter:1.0 - :insert - urn:ietf:params:restconf:capability:insert:1.0 - :replay urn:ietf:params:restconf:capability:replay:1.0 :with-defaults urn:ietf:params:restconf:capability:with-defaults:1.0 12. Security Considerations This section provides security considerations for the resources defined by the RESTCONF protocol. Security considerations for HTTPS are defined in [RFC2818]. Security considerations for the content manipulated by RESTCONF can be found in the documents defining data models. This document does not specify an authentication scheme, but it does require that an authenticated NETCONF username be associated with each HTTP request. The authentication scheme MAY be implemented in the underlying transport layer (e.g., client certificates) or within the HTTP layer (e.g., Basic Auth, OAuth, etc.). RESTCONF does not - itself define an authentication mechanism, authentication MUST occur + itself define an authentication mechanism. Authentication MUST occur in a lower layer. Implementors SHOULD provide a comprehensive authorization scheme with RESTCONF and ensure that the resulting NETCONF username is made available to the RESTCONF server. Authorization of individual user access to operations and data MAY be configured via NETCONF Access Control Model (NACM) [RFC6536], as - specified in Section 4. Other authorization models MAY be used, but - are outside of the scope of this document. + specified in Section 4. Configuration information is by its very nature sensitive. Its transmission in the clear and without integrity checking leaves devices open to classic eavesdropping and false data injection attacks. Configuration information often contains passwords, user names, service descriptions, and topological information, all of which are sensitive. Because of this, this protocol SHOULD be implemented carefully with adequate attention to all manner of attack one might expect to experience with other management interfaces. @@ -3267,22 +3289,22 @@ Library", draft-ietf-netconf-yang-library-00 (work in progress), January 2015. [I-D.ietf-netmod-yang-json] Lhotka, L., "JSON Encoding of Data Modeled with YANG", draft-ietf-netmod-yang-json-02 (work in progress), November 2014. [I-D.lhotka-netmod-yang-metadata] Lhotka, L., "Defining and Using Metadata with YANG", - draft-lhotka-netmod-yang-metadata-00 (work in progress), - September 2014. + draft-lhotka-netmod-yang-metadata-01 (work in progress), + February 2015. [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types", RFC 2046, November 1996. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC2396] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, @@ -3370,72 +3392,109 @@ Consortium CR CR-eventsource-20121211, December 2012, . [W3C.REC-xml-20081126] Yergeau, F., Maler, E., Paoli, J., Sperberg-McQueen, C., and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", World Wide Web Consortium Recommendation REC- xml-20081126, November 2008, . + [XPath] Clark, J. and S. DeRose, "XML Path Language (XPath) + Version 1.0", World Wide Web Consortium Recommendation + REC-xpath-19991116, November 1999, + . + [draft-ietf-httpauth-basicauth-update-03] Reschke, J., "The 'Basic' HTTP Authentication Scheme", draft-ietf-httpauth-basicauth-update-03 (work in progress), Dec 2014. [draft-ietf-httpauth-digest-09] Shekh-Yusef, R., Reschke, D., and S. Bremer, "HTTP Digest Access Authentication", draft-ietf-httpauth-digest-09 (work in progress), Dec 2014. - [draft-ietf-netconf-rfc5539bis-07] + [draft-ietf-netconf-rfc5539bis-10] Badra, M., Luchuk, A., and J. Schoenwaelder, "Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509 Authentication", draft-ietf-netconf- - rfc5539bis-07 (work in progress), Dec 2014. + rfc5539bis-10 (work in progress), Dec 2014. [draft-thomson-httpbis-cant-01] Thomson, M., "Client Authentication over New TLS Connection", draft-thomson-httpbis-cant-01 (work in progress), Jul 2014. - [rest-dissertation] - Fielding, R., "Architectural Styles and the Design of - Network-based Software Architectures", 2000. - 14.2. Informative References [I-D.ietf-netconf-yang-patch] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Patch Media Type", draft-ietf-netconf-yang-patch-03 (work in progress), January 2015. - [XPath] Clark, J. and S. DeRose, "XML Path Language (XPath) - Version 1.0", World Wide Web Consortium Recommendation - REC-xpath-19991116, November 1999, - . + [rest-dissertation] + Fielding, R., "Architectural Styles and the Design of + Network-based Software Architectures", 2000. Appendix A. Change Log -- RFC Ed.: remove this section before publication. The RESTCONF issue tracker can be found here: https://github.com/ netconf-wg/restconf/issues -A.1. 03 - 04 +A.1. 04 - 05 + + o changed term 'notification event' to 'event notification' + + o removed intro text about framework and meta-model + + o removed early mention of API resources + o removed term unified datastore and cleaned up text about NETCONF + datastores + + o removed text about not immediate persistence of edits + + o removed RESTCONF-specific data-resource-identifier typedef and its + usage + + o clarified encoding of key leafs + + o changed several examples from JSON to XML encoding + + o made 'insert' and 'point' query parameters mandatory to implement + + o removed ":insert" capability URI + + o renamed stream/encoding to stream/access + + o renamed stream/encoding/type to stream/access/encoding + + o renamed stream/encoding/events to stream/access/location + + o changed XPath from informative to normative reference + + o changed rest-dissertation from normative to informative reference + + o changed example-jukebox playlist 'id' from a data-resource- + identifier to a leafref pointing at the song name + +A.2. 03 - 04 o renamed 'select' to 'fields' (#1) o moved collection resource and page capability to draft-ietf- netconf-restconf-collection-00 (#3) o added mandatory "defaults" protocol capability URI (#4) + o added optional "with-defaults" query parameter URI (#4) o clarified authentication procedure (#9) o moved ietf-yang-library module to draft-ietf-netconf-yang- library-00 (#13) o clarified that JSON encoding of module name in a URI MUST follow the netmod-yang-json encoding rules (#14) @@ -3434,35 +3493,35 @@ o clarified authentication procedure (#9) o moved ietf-yang-library module to draft-ietf-netconf-yang- library-00 (#13) o clarified that JSON encoding of module name in a URI MUST follow the netmod-yang-json encoding rules (#14) o added restconf-media-type extension (#15) - o remove 'content" query parameter URI and made this parameter + o remove "content" query parameter URI and made this parameter mandatory (#16) o clarified datastore usage o changed lock-denied error example o added with-defaults query parameter example o added term "RESTCONF Capability" o changed NETCONF Capability URI registry usage to new RESTCONF Capability URI Registry usage -A.2. 02 - 03 +A.3. 02 - 03 o added collection resource o added "page" query parameter capability o added "limit" and "offset" query parameters, which are available if the "page" capability is supported o added "stream list" term @@ -3470,31 +3529,30 @@ o added "encoding" list within the "stream" list to allow different URLs for XML and JSON encoding. o made XML MUST implement and JSON MAY implement for servers o re-add JSON notification examples (previously removed) o updated JSON references -A.3. 01 - 02 +A.4. 01 - 02 o moved query parameter definitions from the YANG module back to the plain text sections o made all query parameters optional to implement o defined query parameter capability URI o moved 'streams' to new YANG module (ietf-restconf-monitoring) - o added 'capabilities' container to new YANG module (ietf-restconf- monitoring) o moved 'modules' container to new YANG module (ietf-yang-library) o added new leaf 'module-set-id' (ietf-yang-library) o added new leaf 'conformance' (ietf-yang-library) o changed 'schema' leaf to type inet:uri that returns the location @@ -3508,21 +3566,21 @@ information is no longer in this resource o closed issue #1 'select parameter' since no objections to the proposed syntax o closed "encoding of list keys" issue since no objection to new encoding of list keys in a target resource URI. o moved open issues list to the issue tracker on github -A.4. 00 - 01 +A.5. 00 - 01 o fixed content=nonconfig example (non-config was incorrect) o closed open issue 'message-id'. There is no need for a message-id field, and RFC 2392 does not apply. o closed open issue 'server support verification'. The headers used by RESTCONF are widely supported. o removed encoding rules from section on RESTCONF Meta-Data. This @@ -3552,88 +3610,87 @@ the RESTCONF API using the /.well-known/host-meta. o added an "error" media type to for structured error messages o added Secure Transport section requiring TLS o added Security Considerations section o removed all references to "REST-like" -A.5. bierman:restconf-04 to ietf:restconf-00 +A.6. bierman:restconf-04 to ietf:restconf-00 o updated open issues section Appendix B. Open Issues -- RFC Ed.: remove this section before publication. The RESTCONF issues are tracked on github.com: https://github.com/netconf-wg/restconf/issues Appendix C. Example YANG Module The example YANG module used in this document represents a simple media jukebox interface. YANG Tree Diagram for "example-jukebox" Module - - +--rw jukebox? + +--rw jukebox! +--rw library - | +--rw artist [name] + | +--rw artist* [name] | | +--rw name string - | | +--rw album [name] + | | +--rw album* [name] | | +--rw name string | | +--rw genre? identityref | | +--rw year? uint16 | | +--rw admin | | | +--rw label? string | | | +--rw catalogue-number? string - | | +--rw song [name] + | | +--rw song* [name] | | +--rw name string | | +--rw location string | | +--rw format? string | | +--rw length? uint32 | +--ro artist-count? uint32 | +--ro album-count? uint32 | +--ro song-count? uint32 - +--rw playlist [name] + +--rw playlist* [name] | +--rw name string | +--rw description? string - | +--rw song [index] + | +--rw song* [index] | +--rw index uint32 - | +--rw id instance-identifier + | +--rw id leafref +--rw player +--rw gap? decimal64 rpcs: +---x play +--ro input +--ro playlist string +--ro song-number uint32 C.1. example-jukebox YANG Module module example-jukebox { namespace "http://example.com/ns/example-jukebox"; prefix "jbox"; - import ietf-restconf { prefix rc; } organization "Example, Inc."; contact "support at example.com"; description "Example Jukebox Data Model Module"; - revision "2014-07-03" { + revision "2015-04-04" { description "Initial version."; reference "example.com document 1-4673"; + } identity genre { description "Base for all genre types"; } // abbreviated list of genre classifications identity alternative { base genre; description "Alternative music"; @@ -3803,26 +3860,27 @@ list song { key index; ordered-by user; description "Example nested configuration data resource"; leaf index { // not really needed type uint32; description - "An arbitrary integer index for this - playlist song."; - + "An arbitrary integer index for this playlist song."; } leaf id { - type rc:data-resource-identifier; + type leafref { + path "/jbox:jukebox/jbox:library/jbox:artist/" + + "jbox:album/jbox:song/jbox:name"; + } mandatory true; description "Song identifier. Must identify an instance of /jukebox/library/artist/album/song/name."; } } } container player { description @@ -3983,60 +4039,72 @@ D.1.3. Retrieve The Server Capability Information In this example the client is retrieving the capability information from the server in JSON format, and the server supports all the RESTCONF query parameters, plus one vendor parameter: GET /restconf/data/ietf-restconf-monitoring:restconf-state/ capabilities HTTP/1.1 Host: example.com - Accept: application/yang.data+json + Accept: application/yang.data+xml - The server might respond as follows. + The server might respond as follows. The extra whitespace in + 'capability' elements for display purposes only. HTTP/1.1 200 OK Date: Mon, 23 Apr 2012 17:02:00 GMT Server: example-server Cache-Control: no-cache Pragma: no-cache Last-Modified: Sun, 22 Apr 2012 01:00:14 GMT - Content-Type: application/yang.data+json - - { - "ietf-restconf-monitoring:capabilities": { - "capability": [ - "urn:ietf:params:restconf:capability:content:1.0", - "urn:ietf:params:restconf:capability:depth:1.0", - "urn:ietf:params:restconf:capability:fields:1.0", - "urn:ietf:params:restconf:capability:filter:1.0", - "urn:ietf:params:restconf:capability:insert:1.0", - "urn:ietf:params:restconf:capability:point:1.0", - "urn:ietf:params:restconf:capability:start-time:1.0", - "urn:ietf:params:restconf:capability:stop-time:1.0", - "http://example.com/capabilities/myparam" - ] - } - } + Content-Type: application/yang.data+xml + + + urn:ietf:params:restconf:capability:content:1.0 + + + urn:ietf:params:restconf:capability:depth:1.0 + + + urn:ietf:params:restconf:capability:fields:1.0 + + + urn:ietf:params:restconf:capability:filter:1.0 + + + urn:ietf:params:restconf:capability:point:1.0 + + + urn:ietf:params:restconf:capability:start-time:1.0 + + + urn:ietf:params:restconf:capability:stop-time:1.0 + + + http://example.com/capabilities/myparam + + D.2. Edit Resource Examples D.2.1. Create New Data Resources To create a new "artist" resource within the "library" resource, the client might send the following request. POST /restconf/data/example-jukebox:jukebox/library HTTP/1.1 Host: example.com Content-Type: application/yang.data+json - { "example-jukebox:artist" : { + { + "example-jukebox:artist" : { "name" : "Foo Fighters" } } If the resource is created, the server might respond as follows. Note that the "Location" header line is wrapped for display purposes only: HTTP/1.1 201 Created Date: Mon, 23 Apr 2012 17:02:00 GMT @@ -4081,36 +4149,65 @@ In this example, the server just supports the mandatory datastore last-changed timestamp. The client has previously retrieved the "Last-Modified" header and has some value cached to provide in the following request to patch an "album" list entry with key value "Wasting Light". Only the "year" field is being updated. PATCH /restconf/data/example-jukebox:jukebox/ library/artist=Foo%20Fighters/album=Wasting%20Light/year HTTP/1.1 Host: example.com - Accept: application/yang.data+json If-Unmodified-Since: Mon, 23 Apr 2012 17:01:00 GMT Content-Type: application/yang.data+json { "example-jukebox:year" : "2011" } In this example the datastore resource has changed since the time specified in the "If-Unmodified-Since" header. The server might respond: HTTP/1.1 412 Precondition Failed Date: Mon, 23 Apr 2012 19:01:00 GMT Server: example-server Last-Modified: Mon, 23 Apr 2012 17:45:00 GMT ETag: b34aed893a4c +D.2.3. Edit a Datastore Resource + + In this example, the client modifies two different data nodes by + sending a PATCH to the datastore resource: + + PATCH /restconf/data HTTP/1.1 + Host: example.com + Content-Type: application/yang.datastore+xml + + + + + + Foo Fighters + + Wasting Light + 2011 + + + + Nick Cave + + Tender Prey + 1988 + + + + + + D.3. Query Parameter Examples D.3.1. "content" Parameter The "content" parameter is used to select the type of data child resources (configuration and/or not configuration) that are returned by the server for a GET method request. In this example, a simple YANG list that has configuration and non- configuration child resources. @@ -4235,20 +4332,25 @@ } ] } } D.3.2. "depth" Parameter The "depth" parameter is used to limit the number of levels of child resources that are returned by the server for a GET method request. + The depth parameter starts counting levels at the level of the target + resource that is specified, so that a depth level of "1" includes + just the target resource level itself. A depth level of "2" includes + the target resource level and its child nodes. + This example shows how different values of the "depth" parameter would affect the reply content for retrieval of the top-level "jukebox" data resource. Example 1: depth=unbounded To retrieve all the child resources, the "depth" parameter is not present or set to the default value "unbounded". Note that some strings are wrapped for display purposes only. @@ -4398,30 +4500,39 @@ HTTP/1.1 200 OK Date: Mon, 23 Apr 2012 17:01:00 GMT Server: example-server Content-Type: application/yang.data+json { "ietf-yang-library:modules": { "module": [ { "name" : "example-jukebox", - "revision" : "2014-07-03" + "revision" : "2015-06-04" + }, + { + "name" : "ietf-inet-types", + "revision" : "2013-07-15" }, { "name" : "ietf-restconf-monitoring", - "revision" : "2015-01-30" + "revision" : "2015-06-04" }, { "name" : "ietf-yang-library", "revision" : "2015-01-30" + }, + { + "name" : "ietf-yang-types", + "revision" : "2013-07-15" } + ] } } D.3.4. "insert" Parameter In this example, a new first entry in the "Foo-One" playlist is being created. Request from client: