CoAP Management Interface
draft-ietf-core-comi-00
|
| Document |
Type |
|
Active Internet-Draft (core WG)
|
|
Last updated |
|
2017-01-26
|
|
Replaces |
|
draft-vanderstok-core-comi
|
|
Stream |
|
IETF
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
pdf
xml
html
bibtex
|
| Stream |
WG state
|
|
WG Document
(wg milestone:
Aug 2016 - WG adoption for Mana...
)
|
|
Document shepherd |
|
No shepherd assigned
|
| IESG |
IESG state |
|
I-D Exists
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
CoRE P. van der Stok
Internet-Draft consultant
Intended status: Standards Track A. Bierman
Expires: July 30, 2017 YumaWorks
M. Veillette
Trilliant Networks Inc.
A. Pelov
Acklio
January 26, 2017
CoAP Management Interface
draft-ietf-core-comi-00
Abstract
This document describes a network management interface for
constrained devices and networks, called CoAP Management Interface
(CoMI). The Constrained Application Protocol (CoAP) is used to
access data resources specified in YANG, or SMIv2 converted to YANG.
CoMI uses the YANG to CBOR mapping and converts YANG identifier
strings to numeric identifiers for payload size reduction. CoMI
extends the set of YANG based protocols, NETCONF and RESTCONF, with
the capability to manage constrained devices and networks.
Note
Discussion and suggestions for improvement are requested, and should
be sent to core@ietf.org.
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 July 30, 2017.
van der Stok, et al. Expires July 30, 2017 [Page 1]
Internet-Draft CoMI January 2017
Copyright Notice
Copyright (c) 2017 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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
2. CoMI Architecture . . . . . . . . . . . . . . . . . . . . . . 5
2.1. Major differences between RESTCONF and CoMI . . . . . . . 7
2.2. Compression of YANG identifiers . . . . . . . . . . . . . 7
3. Example syntax . . . . . . . . . . . . . . . . . . . . . . . 8
4. CoAP Interface . . . . . . . . . . . . . . . . . . . . . . . 8
5. /c Function Set . . . . . . . . . . . . . . . . . . . . . . . 9
5.1. Using the 'k' query parameter . . . . . . . . . . . . . . 10
5.2. Data Retrieval . . . . . . . . . . . . . . . . . . . . . 11
5.2.1. Using the 'c' query parameter . . . . . . . . . . . . 12
5.2.2. Using the 'd' query parameter . . . . . . . . . . . . 12
5.2.3. GET . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.2.4. FETCH . . . . . . . . . . . . . . . . . . . . . . . . 15
5.3. Data Editing . . . . . . . . . . . . . . . . . . . . . . 16
5.3.1. Data Ordering . . . . . . . . . . . . . . . . . . . . 16
5.3.2. POST . . . . . . . . . . . . . . . . . . . . . . . . 16
5.3.3. PUT . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.3.4. iPATCH . . . . . . . . . . . . . . . . . . . . . . . 18
5.3.5. DELETE . . . . . . . . . . . . . . . . . . . . . . . 19
5.4. Full Data Store access . . . . . . . . . . . . . . . . . 19
5.4.1. Full Data Store examples . . . . . . . . . . . . . . 20
5.5. Notify functions . . . . . . . . . . . . . . . . . . . . 21
5.5.1. Notify Examples . . . . . . . . . . . . . . . . . . . 22
5.6. RPC statements . . . . . . . . . . . . . . . . . . . . . 22
5.6.1. RPC Example . . . . . . . . . . . . . . . . . . . . . 23
Show full document text