YANG Instance Data Files and their use for Documenting Server Capabilities
draft-lengyel-netmod-yang-instance-data-03

• Status
• IESG evaluation record
• IESG writeups
• Email expansions
• History

• Versions
• 00
• 01
• 02
• 03

draft-lengyel-netmod-yang-instance-data-03.txt:
xym 0.4:
Extracting 'ietf-yang-instance-data.yang'
   Removed 0 empty lines


ietf-yang-instance-data@2018-06-30.yang:
pyang 1.7.5: pyang --verbose --ietf -p {libs} {model}:
ietf-yang-instance-data@2018-06-30.yang:37: error: RFC 6087: 4.12: statement "leaf" must have a "description" substatement
ietf-yang-instance-data@2018-06-30.yang:78: error: RFC 6087: 4.12: statement "leaf" must have a "description" substatement

yanglint 0.14.80: yanglint --verbose -p {rfclib} -p {draftlib} -p {tmplib} {model} -i:
No validation errors

Network Working Group                                         B. Lengyel
Internet-Draft                                                  Ericsson
Intended status: Standards Track                               B. Claise
Expires: January 23, 2019                            Cisco Systems, Inc.
                                                           July 22, 2018

     YANG Instance Data Files and their use for Documenting Server
                              Capabilities
               draft-lengyel-netmod-yang-instance-data-03

Abstract

   This document specifies a standard file format for YANG instance
   data, that is data that could be stored in a datastore and whose
   syntax and semantics is defined by YANG models.  Instance data files
   can be used to provide information that is defined in design time.
   There is a need to document Server capabilities (which are often
   specified in design time).  Defining server capabilities is foreseen
   as the most important use of YANG instance data files.

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."

   This Internet-Draft will expire on January 23, 2019.

Copyright Notice

   Copyright (c) 2018 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

Lengyel & Claise        Expires January 23, 2019                [Page 1]
Internet-Draft             YANG Instance Data                  July 2018

   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.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     2.1.  Data Life cycle . . . . . . . . . . . . . . . . . . . . .   4
     2.2.  Delivery of Instance Data . . . . . . . . . . . . . . . .   4
     2.3.  Use Case 1: Early Documentation of Server Capabilites . .   5
     2.4.  Use Case 2: Preloading Data . . . . . . . . . . . . . . .   5
     2.5.  Use Case 3: Dcoumenting Factory Default Settings  . . . .   5
   3.  Instance Data File Format . . . . . . . . . . . . . . . . . .   6
   4.  YANG Model  . . . . . . . . . . . . . . . . . . . . . . . . .   8
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .  10
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  10
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  10
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  10
     7.2.  Informative References  . . . . . . . . . . . . . . . . .  11
   Appendix A.  Open Issues  . . . . . . . . . . . . . . . . . . . .  11
   Appendix B.  Changes between revisions  . . . . . . . . . . . . .  11
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  12

1.  Terminology

   Design time: A time during which a YANG model and the implementation
   behind it is created.  Sometimes in other documents this period is
   divided into design and implementation time.

   Instance Data Set: A named set of data items that can be used as
   instance data in a YANG data tree.

   Instance Data File: A file containing an instance data set formatted
   according to the rules described in this document.

   Target YANG Module: A YANG module for which the instance data set
   contains instance data, like ietf-yang-library in the examples.

2.  Introduction

   A YANG server has a number of server-capabilities that can be
   retrieved from the server using protocols like NETCONF or RESTCONF.
   YANG server capabilities include

Lengyel & Claise        Expires January 23, 2019                [Page 2]
Internet-Draft             YANG Instance Data                  July 2018

   o  data defined in ietf-yang-library: YANG modules, submodules,
      features, deviations, schema-mounts
      ([I-D.ietf-netconf-rfc7895bis])

   o  datastores supported

   o  alarms supported ([I-D.ietf-ccamp-alarm-module])