CoAP Management Interface (CORECONF)
draft-ietf-core-comi-11
|
Document |
Type |
|
Active Internet-Draft (core WG)
|
|
Authors |
|
Michel Veillette
,
Peter Van der Stok
,
Alexander Pelov
,
Andy Bierman
,
Ivaylo Petrov
|
|
Last updated |
|
2021-01-17
|
|
Replaces |
|
draft-vanderstok-core-comi
|
|
Stream |
|
Internent Engineering Task Force (IETF)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
pdf
htmlized (tools)
htmlized
bibtex
|
|
Yang Validation |
|
☯
0 errors, 0 warnings.
draft-ietf-core-comi-11.txt:
xym 0.5:
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-coreconf@2019-03-28.yang'
Removed 0 empty lines
ietf-coreconf@2019-03-28.yang:
pyang 2.4.0: pyang --verbose --ietf -p {libs} {model}:
# module search path: a/www/ietf-ftp/yang/rfcmod/:/a/www/ietf-ftp/yang/draftmod/:/a/www/ietf-ftp/yang/ianamod/:/a/www/ietf-ftp/yang/catalogmod/:.:/var/lib/wwwrun/yang/modules:/a/www/ietf-datatracker/7.27.0/env/share/yang/modules
# read ietf-coreconf@2019-03-28.yang (CL)
# read /a/www/ietf-datatracker/7.27.0/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/7.27.0/env/share/yang/modules/ietf/ietf-restconf.yang
yanglint SO 1.6.7: yanglint --verbose -p {tmplib} -p {rfclib} -p {draftlib} -p {ianalib} -p {cataloglib} {model} -i:
No validation errors
|
|
Additional Resources |
|
|
Stream |
WG state
|
|
WG Consensus: Waiting for Write-Up
|
|
On Agenda |
|
core at IETF-110
|
|
Document shepherd |
|
Carsten Bormann
|
IESG |
IESG state |
|
I-D Exists
|
|
Consensus Boilerplate |
|
Unknown
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
Carsten Bormann <cabo@tzi.org>
|
CoRE M. Veillette, Ed.
Internet-Draft Trilliant Networks Inc.
Intended status: Standards Track P. van der Stok, Ed.
Expires: July 21, 2021 consultant
A. Pelov
Acklio
A. Bierman
YumaWorks
I. Petrov, Ed.
Acklio
January 17, 2021
CoAP Management Interface (CORECONF)
draft-ietf-core-comi-11
Abstract
This document describes a network management interface for
constrained devices and networks, called CoAP Management Interface
(CORECONF). The Constrained Application Protocol (CoAP) is used to
access datastore and data node resources specified in YANG, or SMIv2
converted to YANG. CORECONF uses the YANG to CBOR mapping and
converts YANG identifier strings to numeric identifiers for payload
size reduction. 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
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
Veillette, et al. Expires July 21, 2021 [Page 1]
Internet-Draft CORECONF January 2021
This Internet-Draft will expire on July 21, 2021.
Copyright Notice
Copyright (c) 2021 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. CORECONF 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. Media-Types . . . . . . . . . . . . . . . . . . . . . . . 8
2.5. Unified datastore . . . . . . . . . . . . . . . . . . . . 10
3. Example syntax . . . . . . . . . . . . . . . . . . . . . . . 11
4. CoAP Interface . . . . . . . . . . . . . . . . . . . . . . . 11
4.1. Using the 'k' query parameter . . . . . . . . . . . . . . 13
4.2. Data Retrieval . . . . . . . . . . . . . . . . . . . . . 15
4.2.1. Using the 'c' query parameter . . . . . . . . . . . . 15
4.2.2. Using the 'd' query parameter . . . . . . . . . . . . 16
4.2.3. GET . . . . . . . . . . . . . . . . . . . . . . . . . 16
4.2.4. FETCH . . . . . . . . . . . . . . . . . . . . . . . . 19
4.3. Data Editing . . . . . . . . . . . . . . . . . . . . . . 20
4.3.1. Data Ordering . . . . . . . . . . . . . . . . . . . . 20
4.3.2. POST . . . . . . . . . . . . . . . . . . . . . . . . 20
4.3.3. PUT . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.3.4. iPATCH . . . . . . . . . . . . . . . . . . . . . . . 22
4.3.5. DELETE . . . . . . . . . . . . . . . . . . . . . . . 23
4.4. Full datastore access . . . . . . . . . . . . . . . . . . 24
Show full document text