RESTCONF Protocol
draft-ietf-netconf-restconf-10
| The information below is for an old version of the document |
| Document |
Type |
|
Active Internet-Draft (netconf WG)
|
|
Last updated |
|
2016-03-16
|
|
Stream |
|
IETF
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
pdf
htmlized
bibtex
|
|
Reviews |
|
|
|
Additional URLs |
|
|
| Stream |
WG state
|
|
WG Document
|
|
Document shepherd |
|
No shepherd assigned
|
| IESG |
IESG state |
|
I-D Exists
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
Network Working Group A. Bierman
Internet-Draft YumaWorks
Intended status: Standards Track M. Bjorklund
Expires: September 17, 2016 Tail-f Systems
K. Watsen
Juniper Networks
March 16, 2016
RESTCONF Protocol
draft-ietf-netconf-restconf-10
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
provisions of BCP 78 and BCP 79.
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 September 17, 2016.
Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
Bierman, et al. Expires September 17, 2016 [Page 1]
Internet-Draft RESTCONF March 2016
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
carefully, as they describe your rights and restrictions with respect
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. Terminology . . . . . . . . . . . . . . . . . . . . . . . 5
1.1.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.2. HTTP . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.3. YANG . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1.4. Terms . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1.5. URI Template . . . . . . . . . . . . . . . . . . . . 9
1.1.6. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 9
1.2. Subset of NETCONF Functionality . . . . . . . . . . . . . 9
1.3. Data Model Driven API . . . . . . . . . . . . . . . . . . 10
1.4. Coexistence with NETCONF . . . . . . . . . . . . . . . . 11
1.5. RESTCONF Extensibility . . . . . . . . . . . . . . . . . 12
2. Transport Protocol Requirements . . . . . . . . . . . . . . . 13
2.1. Integrity and Confidentiality . . . . . . . . . . . . . . 13
2.2. HTTPS with X.509v3 Certificates . . . . . . . . . . . . . 13
2.3. Certificate Validation . . . . . . . . . . . . . . . . . 13
2.4. Authenticated Server Identity . . . . . . . . . . . . . . 14
2.5. Authenticated Client Identity . . . . . . . . . . . . . . 14
3. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.1. Root Resource Discovery . . . . . . . . . . . . . . . . . 15
3.2. RESTCONF Media Types . . . . . . . . . . . . . . . . . . 17
3.3. API Resource . . . . . . . . . . . . . . . . . . . . . . 17
3.3.1. {+restconf}/data . . . . . . . . . . . . . . . . . . 18
3.3.2. {+restconf}/operations . . . . . . . . . . . . . . . 18
3.3.3. {+restconf}/yang-library-version . . . . . . . . . . 19
3.4. Datastore Resource . . . . . . . . . . . . . . . . . . . 19
3.4.1. Edit Collision Detection . . . . . . . . . . . . . . 20
3.5. Data Resource . . . . . . . . . . . . . . . . . . . . . . 21
3.5.1. Encoding Data Resource Identifiers in the Request URI 22
3.5.2. Defaults Handling . . . . . . . . . . . . . . . . . . 25
3.6. Operation Resource . . . . . . . . . . . . . . . . . . . 25
3.6.1. Encoding Operation Resource Input Parameters . . . . 26
3.6.2. Encoding Operation Resource Output Parameters . . . . 29
3.6.3. Encoding Operation Resource Errors . . . . . . . . . 31
3.7. Schema Resource . . . . . . . . . . . . . . . . . . . . . 32
3.8. Event Stream Resource . . . . . . . . . . . . . . . . . . 33
Show full document text