RESTCONF Protocol
draft-ietf-netconf-restconf-00

The information below is for an old version of the document
Document Type Active Internet-Draft (netconf WG)
Last updated 2014-03-23
Stream IETF
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream WG state WG Document
Document shepherd None
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 23, 2014                               Tail-f Systems
                                                               K. Watsen
                                                        Juniper Networks
                                                             R. Fernando
                                                                   Cisco
                                                          March 22, 2014

                           RESTCONF Protocol
                     draft-ietf-netconf-restconf-00

Abstract

   This document describes a REST-like protocol that provides a
   programmatic interface over HTTP 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 23, 2014.

Copyright Notice

   Copyright (c) 2014 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

Bierman, et al.        Expires September 23, 2014               [Page 1]
Internet-Draft                  RESTCONF                      March 2014

   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 . . . . . . . . . . . . . . . . . . . . . . . . .  5
     1.1.  Simple Subset of NETCONF Functionality . . . . . . . . . .  5
     1.2.  Data Model Driven API  . . . . . . . . . . . . . . . . . .  6
     1.3.  Terminology  . . . . . . . . . . . . . . . . . . . . . . .  8
       1.3.1.  NETCONF  . . . . . . . . . . . . . . . . . . . . . . .  8
       1.3.2.  HTTP . . . . . . . . . . . . . . . . . . . . . . . . .  8
       1.3.3.  YANG . . . . . . . . . . . . . . . . . . . . . . . . .  9
       1.3.4.  Terms  . . . . . . . . . . . . . . . . . . . . . . . .  9
       1.3.5.  Tree Diagrams  . . . . . . . . . . . . . . . . . . . . 11
   2.  Operations . . . . . . . . . . . . . . . . . . . . . . . . . . 12
     2.1.  OPTIONS  . . . . . . . . . . . . . . . . . . . . . . . . . 12
     2.2.  HEAD . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
     2.3.  GET  . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
     2.4.  POST . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
       2.4.1.  Create Resource Mode . . . . . . . . . . . . . . . . . 14
       2.4.2.  Invoke Operation Mode  . . . . . . . . . . . . . . . . 15
     2.5.  PUT  . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
     2.6.  PATCH  . . . . . . . . . . . . . . . . . . . . . . . . . . 17
     2.7.  DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . 19
     2.8.  Query Parameters . . . . . . . . . . . . . . . . . . . . . 19
   3.  Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
     3.1.  Request URI Structure  . . . . . . . . . . . . . . . . . . 21
     3.2.  Message Headers  . . . . . . . . . . . . . . . . . . . . . 22
     3.3.  Message Encoding . . . . . . . . . . . . . . . . . . . . . 23
     3.4.  RESTCONF Meta-Data . . . . . . . . . . . . . . . . . . . . 23
       3.4.1.  JSON Encoding of RESTCONF Meta-Data  . . . . . . . . . 24
     3.5.  Return Status  . . . . . . . . . . . . . . . . . . . . . . 26
     3.6.  Message Caching  . . . . . . . . . . . . . . . . . . . . . 26
   4.  Resources  . . . . . . . . . . . . . . . . . . . . . . . . . . 27
     4.1.  RESTCONF Resource Types  . . . . . . . . . . . . . . . . . 27
     4.2.  Resource Discovery . . . . . . . . . . . . . . . . . . . . 28
     4.3.  API Resource (/restconf) . . . . . . . . . . . . . . . . . 28
       4.3.1.  /restconf/data . . . . . . . . . . . . . . . . . . . . 29
       4.3.2.  /restconf/modules  . . . . . . . . . . . . . . . . . . 30
Show full document text