CoAP Management Interface
draft-ietf-core-comi-01

Document Type Active Internet-Draft (core WG)
Last updated 2017-07-18
Replaces draft-vanderstok-core-comi
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Yang Validation 0 errors, 0 warnings.
Additional URLs
- Yang catalog entry for ietf-comi@2017-07-01.yang
- Yang impact analysis for draft-ietf-core-comi
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                                                   M. Veillette, Ed.
Internet-Draft                                   Trilliant Networks Inc.
Intended status: Standards Track                    P. van der Stok, Ed.
Expires: January 18, 2018                                     consultant
                                                                A. Pelov
                                                                  Acklio
                                                              A. Bierman
                                                               YumaWorks
                                                           July 17, 2017

                       CoAP Management Interface
                        draft-ietf-core-comi-01

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.  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 January 18, 2018.

Veillette, et al.       Expires January 18, 2018                [Page 1]
Internet-Draft                    CoMI                         July 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 . . . . . . .   6
     2.2.  Compression of YANG identifiers . . . . . . . . . . . . .   7
     2.3.  Instance identifier . . . . . . . . . . . . . . . . . . .   8
     2.4.  CBOR ordered map schematic  . . . . . . . . . . . . . . .   8
     2.5.  Content-Formats . . . . . . . . . . . . . . . . . . . . .   8
   3.  Example syntax  . . . . . . . . . . . . . . . . . . . . . . .  11
   4.  CoAP Interface  . . . . . . . . . . . . . . . . . . . . . . .  12
   5.  CoMI Collection Interface . . . . . . . . . . . . . . . . . .  13
     5.1.  Using the 'k' Uri-Query option  . . . . . . . . . . . . .  14
     5.2.  Data Retrieval  . . . . . . . . . . . . . . . . . . . . .  15
       5.2.1.  Using the 'c' Uri-Query option  . . . . . . . . . . .  16
       5.2.2.  Using the 'd' Uri-Query option  . . . . . . . . . . .  16
       5.2.3.  GET . . . . . . . . . . . . . . . . . . . . . . . . .  17
       5.2.4.  FETCH . . . . . . . . . . . . . . . . . . . . . . . .  19
     5.3.  Data Editing  . . . . . . . . . . . . . . . . . . . . . .  20
       5.3.1.  Data Ordering . . . . . . . . . . . . . . . . . . . .  20
       5.3.2.  POST  . . . . . . . . . . . . . . . . . . . . . . . .  20
       5.3.3.  PUT . . . . . . . . . . . . . . . . . . . . . . . . .  21
       5.3.4.  iPATCH  . . . . . . . . . . . . . . . . . . . . . . .  22
       5.3.5.  DELETE  . . . . . . . . . . . . . . . . . . . . . . .  23
     5.4.  Full datastore access . . . . . . . . . . . . . . . . . .  23
       5.4.1.  Full datastore examples . . . . . . . . . . . . . . .  24
Show full document text