CoAP Management Interface
draft-ietf-core-comi-08
|
| Document |
Type |
|
Active Internet-Draft (core WG)
|
|
Last updated |
|
2019-09-27
|
|
Replaces |
|
draft-vanderstok-core-comi
|
|
Stream |
|
IETF
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
xml
pdf
htmlized
bibtex
|
|
Yang Validation |
|
☯
0 errors, 0 warnings.
draft-ietf-core-comi-08.txt:
xym 0.4:
Extracting 'example-port'
Getting YANG file name from module name: example-port.yang
Extracting 'example-server-farm'
Getting YANG file name from module name: example-server-farm.yang
Extracting 'ietf-comi@2019-03-28.yang'
Removed 0 empty lines
ietf-comi@2019-03-28.yang:
pyang 2.1.1: pyang --verbose --ietf -p {libs} {model}:
# read ietf-comi@2019-03-28.yang (CL)
# read /a/www/ietf-datatracker/6.116.1/env/share/yang/modules/ietf/ietf-datastores.yang
# read /a/www/ietf-ftp/yang/rfcmod/ietf-datastores@2018-02-14.yang
# read /a/www/ietf-ftp/yang/rfcmod/ietf-restconf.yang
# read /a/www/ietf-datatracker/6.116.1/env/share/yang/modules/ietf/ietf-restconf.yang
yanglint 0.14.80: yanglint --verbose -p {rfclib} -p {draftlib} -p {tmplib} {model} -i:
No validation errors
|
|
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)
|
CoRE M. Veillette, Ed.
Internet-Draft Trilliant Networks Inc.
Intended status: Standards Track P. van der Stok, Ed.
Expires: March 30, 2020 consultant
A. Pelov
Acklio
A. Bierman
YumaWorks
I. Petrov, Ed.
Acklio
September 27, 2019
CoAP Management Interface
draft-ietf-core-comi-08
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 datastore and data node 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. The complete solution composed of CoMI,
[I-D.ietf-core-yang-cbor] and [I-D.ietf-core-sid] is called CORECONF.
CORECONF 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 yot@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 https://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
Veillette, et al. Expires March 30, 2020 [Page 1]
Internet-Draft CoMI September 2019
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 March 30, 2020.
Copyright Notice
Copyright (c) 2019 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
(https://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 CORECONF . . . . . 6
2.1.1. Differences due to CoAP and its efficient usage . . . 6
2.1.2. Differences due to the use of CBOR . . . . . . . . . 7
2.2. Compression of YANG identifiers . . . . . . . . . . . . . 7
2.3. Instance-identifier . . . . . . . . . . . . . . . . . . . 8
2.4. Content-Formats . . . . . . . . . . . . . . . . . . . . . 8
2.5. Unified datastore . . . . . . . . . . . . . . . . . . . . 10
3. Example syntax . . . . . . . . . . . . . . . . . . . . . . . 11
4. CoAP Interface . . . . . . . . . . . . . . . . . . . . . . . 11
4.1. Using the 'k' Uri-Query option . . . . . . . . . . . . . 13
4.2. Data Retrieval . . . . . . . . . . . . . . . . . . . . . 14
4.2.1. Using the 'c' Uri-Query option . . . . . . . . . . . 14
4.2.2. Using the 'd' Uri-Query option . . . . . . . . . . . 15
4.2.3. GET . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.2.4. FETCH . . . . . . . . . . . . . . . . . . . . . . . . 18
4.3. Data Editing . . . . . . . . . . . . . . . . . . . . . . 19
4.3.1. Data Ordering . . . . . . . . . . . . . . . . . . . . 19
4.3.2. POST . . . . . . . . . . . . . . . . . . . . . . . . 20
4.3.3. PUT . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.3.4. iPATCH . . . . . . . . . . . . . . . . . . . . . . . 21
4.3.5. DELETE . . . . . . . . . . . . . . . . . . . . . . . 22
Show full document text