CoAP Management Interface
draft-vanderstok-core-comi-05

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Authors Peter Van der Stok  , Bert Greevenbosch  , Andy Bierman  , Jürgen Schönwälder  , Anuj Sehgal 
Last updated 2014-10-27
Replaced by draft-ietf-core-comi
Stream (None)
Formats pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
core                                                     P. van der Stok
Internet-Draft                                                consultant
Intended status: Standards Track                         B. Greevenbosch
Expires: April 30, 2015                              Huawei Technologies
                                                              A. Bierman
                                                               YumaWorks
                                                        J. Schoenwaelder
                                                               A. Sehgal
                                                       Jacobs University
                                                        October 27, 2014

                       CoAP Management Interface
                     draft-vanderstok-core-comi-05

Abstract

   This document describes a network management interface for
   constrained devices, called CoMI.  CoMI is an adaptation of the
   RESTCONF protocol for use in constrained devices and networks.  It is
   designed to reduce the message sizes, server code size, and
   application development complexity.  The Constrained Application
   Protocol (CoAP) is used to access management data resources specified
   in YANG, or SMIv2 converted to YANG.  The payload of the CoMI message
   is encoded in Concise Binary Object Representation (CBOR).

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 April 30, 2015.

van der Stok, et al.     Expires April 30, 2015                 [Page 1]
Internet-Draft                    CoMI                      October 2014

Copyright Notice

   Copyright (c) 2014 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.  Design considerations . . . . . . . . . . . . . . . . . .   4
     1.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   5
       1.2.1.  Tree Diagrams . . . . . . . . . . . . . . . . . . . .   6
   2.  CoMI Architecture . . . . . . . . . . . . . . . . . . . . . .   6
     2.1.  RESTCONF/YANG Architecture  . . . . . . . . . . . . . . .  10
   3.  CoAP Interface  . . . . . . . . . . . . . . . . . . . . . . .  11
   4.  MG Function Set . . . . . . . . . . . . . . . . . . . . . . .  12
     4.1.  Data Retrieval  . . . . . . . . . . . . . . . . . . . . .  13
       4.1.1.  GET . . . . . . . . . . . . . . . . . . . . . . . . .  13
       4.1.2.  Mapping of the 'select' Parameter . . . . . . . . . .  13
       4.1.3.  Retrieval Examples  . . . . . . . . . . . . . . . . .  13
     4.2.  Data Editing  . . . . . . . . . . . . . . . . . . . . . .  16
       4.2.1.  POST  . . . . . . . . . . . . . . . . . . . . . . . .  16
       4.2.2.  PUT . . . . . . . . . . . . . . . . . . . . . . . . .  17
       4.2.3.  DELETE  . . . . . . . . . . . . . . . . . . . . . . .  17
     4.3.  Module Discovery  . . . . . . . . . . . . . . . . . . . .  17
     4.4.  Error Return Codes  . . . . . . . . . . . . . . . . . . .  18
   5.  Mapping YANG to CoMI payload  . . . . . . . . . . . . . . . .  19
     5.1.  YANG Hash Generation  . . . . . . . . . . . . . . . . . .  20
     5.2.  Re-Hash Procedure . . . . . . . . . . . . . . . . . . . .  20
     5.3.  ietf-yang-hash YANG Module  . . . . . . . . . . . . . . .  21
       5.3.1.  YANG Re-Hash Example  . . . . . . . . . . . . . . . .  23
     5.4.  The 'keys' Query Parameter  . . . . . . . . . . . . . . .  24
   6.  Mapping YANG to CBOR  . . . . . . . . . . . . . . . . . . . .  25
     6.1.  Conversion from YANG datatypes to CBOR datatypes  . . . .  25
   7.  Examples  . . . . . . . . . . . . . . . . . . . . . . . . . .  27
Show full document text