Network Working Group A. Bierman
Internet-Draft YumaWorks
Intended status: Standards Track M. Bjorklund
Expires: June 3, 2013 Tail-f Systems
November 30, 2012
YANG-API Protocol
draft-bierman-netconf-yang-api-01
Abstract
This document describes a RESTful 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 June 3, 2013.
Copyright Notice
Copyright (c) 2012 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
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Bierman & Bjorklund Expires June 3, 2013 [Page 1]
Internet-Draft YANG-API November 2012
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. Simple Subset of NETCONF Functionality . . . . . . . . . . 4
1.2. Data Model Driven API . . . . . . . . . . . . . . . . . . 5
1.3. Terminology . . . . . . . . . . . . . . . . . . . . . . . 6
1.3.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 6
1.3.2. HTTP . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.3.3. YANG . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.3.4. Terms . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4.1. Resource URI Map . . . . . . . . . . . . . . . . . . . 9
1.4.2. YANG-API Message Examples . . . . . . . . . . . . . . 9
2. Framework . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.1. Message Model . . . . . . . . . . . . . . . . . . . . . . 15
2.2. Resource Model . . . . . . . . . . . . . . . . . . . . . . 15
2.2.1. YANG-API Resource Types . . . . . . . . . . . . . . . 15
2.2.2. Resource Discovery . . . . . . . . . . . . . . . . . . 16
2.3. Datastore Model . . . . . . . . . . . . . . . . . . . . . 16
2.3.1. Content Model . . . . . . . . . . . . . . . . . . . . 17
2.3.2. Editing Model . . . . . . . . . . . . . . . . . . . . 17
2.3.3. Locking Model . . . . . . . . . . . . . . . . . . . . 19
2.3.4. Persistence Model . . . . . . . . . . . . . . . . . . 19
2.3.5. Defaults Model . . . . . . . . . . . . . . . . . . . . 19
2.4. Transaction Model . . . . . . . . . . . . . . . . . . . . 20
2.5. Extensibility Model . . . . . . . . . . . . . . . . . . . 20
2.6. Versioning Model . . . . . . . . . . . . . . . . . . . . . 20
2.7. Retrieval Filtering Model . . . . . . . . . . . . . . . . 21
2.8. Access Control Model . . . . . . . . . . . . . . . . . . . 21
3. Operations . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.1. OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.2. HEAD . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.3. GET . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.4. POST . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.5. PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.6. PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.7. DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.8. Query Parameters . . . . . . . . . . . . . . . . . . . . . 28
datatracker.ietf.org