RESTCONF Protocol
draft-ietf-netconf-restconf-16
| The information below is for an old version of the document |
| Document |
Type |
|
Active Internet-Draft (netconf WG)
|
|
Last updated |
|
2016-09-19
(latest revision 2016-08-15)
|
|
Stream |
|
IETF
|
|
Intended RFC status |
|
Proposed Standard
|
|
Formats |
|
pdf
htmlized
bibtex
|
|
Reviews |
|
|
|
Additional URLs |
|
|
| Stream |
WG state
|
|
Submitted to IESG for Publication
|
|
Document shepherd |
|
Mehmet Ersue
|
|
Shepherd write-up |
|
Show
(last changed 2016-05-01)
|
| IESG |
IESG state |
|
Waiting for AD Go-Ahead
|
|
Consensus Boilerplate |
|
Yes
|
|
Telechat date |
|
|
|
Responsible AD |
|
Benoît Claise
|
|
Send notices to |
|
(None)
|
| IANA |
IANA review state |
|
Version Changed - Review Needed
|
Network Working Group A. Bierman
Internet-Draft YumaWorks
Intended status: Standards Track M. Bjorklund
Expires: February 16, 2017 Tail-f Systems
K. Watsen
Juniper Networks
August 15, 2016
RESTCONF Protocol
draft-ietf-netconf-restconf-16
Abstract
This document describes an HTTP-based protocol that provides a
programmatic interface for accessing data defined in YANG, using the
datastore concepts 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 February 16, 2017.
Copyright Notice
Copyright (c) 2016 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
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
Bierman, et al. Expires February 16, 2017 [Page 1]
Internet-Draft RESTCONF August 2016
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.2. HTTP . . . . . . . . . . . . . . . . . . . . . . . . 6
1.1.3. YANG . . . . . . . . . . . . . . . . . . . . . . . . 7
1.1.4. NETCONF Notifications . . . . . . . . . . . . . . . . 7
1.1.5. Terms . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1.6. URI Template and Examples . . . . . . . . . . . . . . 10
1.1.7. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 10
1.2. Subset of NETCONF Functionality . . . . . . . . . . . . . 11
1.3. Data Model Driven API . . . . . . . . . . . . . . . . . . 12
1.4. Coexistence with NETCONF . . . . . . . . . . . . . . . . 13
1.5. RESTCONF Extensibility . . . . . . . . . . . . . . . . . 14
2. Transport Protocol Requirements . . . . . . . . . . . . . . . 15
2.1. Integrity and Confidentiality . . . . . . . . . . . . . . 15
2.2. HTTPS with X.509v3 Certificates . . . . . . . . . . . . . 15
2.3. Certificate Validation . . . . . . . . . . . . . . . . . 15
2.4. Authenticated Server Identity . . . . . . . . . . . . . . 16
2.5. Authenticated Client Identity . . . . . . . . . . . . . . 16
3. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.1. Root Resource Discovery . . . . . . . . . . . . . . . . . 17
3.2. RESTCONF Media Types . . . . . . . . . . . . . . . . . . 19
3.3. API Resource . . . . . . . . . . . . . . . . . . . . . . 19
3.3.1. {+restconf}/data . . . . . . . . . . . . . . . . . . 20
3.3.2. {+restconf}/operations . . . . . . . . . . . . . . . 20
3.3.3. {+restconf}/yang-library-version . . . . . . . . . . 21
3.4. Datastore Resource . . . . . . . . . . . . . . . . . . . 21
3.4.1. Edit Collision Prevention . . . . . . . . . . . . . . 22
3.5. Data Resource . . . . . . . . . . . . . . . . . . . . . . 23
3.5.1. Timestamp . . . . . . . . . . . . . . . . . . . . . . 24
3.5.2. Entity-Tag . . . . . . . . . . . . . . . . . . . . . 24
3.5.3. Encoding Data Resource Identifiers in the Request URI 24
3.5.4. Default Handling . . . . . . . . . . . . . . . . . . 28
3.6. Operation Resource . . . . . . . . . . . . . . . . . . . 29
3.6.1. Encoding Operation Resource Input Parameters . . . . 30
3.6.2. Encoding Operation Resource Output Parameters . . . . 34
Show full document text