YANG Instance Data File Format
draft-ietf-netmod-yang-instance-file-format-00

Document Type Active Internet-Draft (netmod WG)
Last updated 2018-11-05
Replaces draft-lengyel-netmod-yang-instance-data
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Yang Validation 6 errors, 0 warnings.
Additional URLs
- Yang catalog entry for ietf-yang-instance-data@2018-06-30.yang
- Yang impact analysis for draft-ietf-netmod-yang-instance-file-format
- Mailing list discussion
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)
Netmod                                                        B. Lengyel
Internet-Draft                                                  Ericsson
Intended status: Standards Track                               B. Claise
Expires: May 8, 2019                                 Cisco Systems, Inc.
                                                        November 4, 2018

                     YANG Instance Data File Format
             draft-ietf-netmod-yang-instance-file-format-00

Abstract

   There is a need to document data defined in YANG models without the
   need to fetch it from a live YANG server.  Data is often needed
   already in design time or needed by groups that do not have a live
   running YANG server available.  This document specifies a standard
   file format for YANG Based Instance data, that is data that could be
   stored in a datastore and whose syntax and semantics is defined by
   YANG models.  Most important use cases foreseen include documenting
   server capabilities, factory-default settings, or vendor provided
   default configurations.

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 May 8, 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

Lengyel & Claise           Expires May 8, 2019                  [Page 1]
Internet-Draft          YANG Based Instance Data           November 2018

   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.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Use Cases . . . . . . . . . . . . . . . . . . . . . . . .   3
       2.1.1.  Use Case 1: Early Documentation of Server Capabilites   3
       2.1.2.  Use Case 2: Preloading Data . . . . . . . . . . . . .   4
       2.1.3.  Use Case 3: Dcoumenting Factory Default Settings  . .   4
   3.  Instance Data File Format . . . . . . . . . . . . . . . . . .   5
   4.  Data Life cycle . . . . . . . . . . . . . . . . . . . . . . .   8
   5.  Delivery of Instance Data . . . . . . . . . . . . . . . . . .   9
   6.  YANG Model  . . . . . . . . . . . . . . . . . . . . . . . . .   9
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .  11
   8.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  11
   9.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  11
     9.1.  Normative References  . . . . . . . . . . . . . . . . . .  11
     9.2.  Informative References  . . . . . . . . . . . . . . . . .  11
   Appendix A.  Open Issues  . . . . . . . . . . . . . . . . . . . .  12
   Appendix B.  Changes between revisions  . . . . . . . . . . . . .  13
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  14

1.  Terminology

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in BCP
   14 RFC 2119 [RFC2119] RFC 8174 [RFC8174] when, and only when, they
   appear in all capitals, as shown here.

   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.

Lengyel & Claise           Expires May 8, 2019                  [Page 2]
Internet-Draft          YANG Based Instance Data           November 2018
Show full document text