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

Document Type Active Internet-Draft (netmod WG)
Last updated 2020-06-08 (latest revision 2020-04-14)
Replaces draft-lengyel-netmod-yang-instance-data
Stream IETF
Intended RFC status Proposed Standard
Formats plain text xml pdf htmlized (tools) htmlized bibtex
Yang Validation 2 errors, 0 warnings.
Reviews
Additional Resources
- Yang catalog entry for ietf-yang-instance-data@2020-04-02.yang
- Yang impact analysis for draft-ietf-netmod-yang-instance-file-format
- Mailing list discussion
Stream WG state In WG Last Call
Revised I-D Needed - Issue raised by WGLC, Doc Shepherd Follow-up Underway
Document shepherd Kent Watsen
IESG IESG state I-D Exists
Consensus Boilerplate Yes
Telechat date
Responsible AD (None)
Send notices to Kent Watsen <kent+ietf@watsen.net>
Netmod                                                        B. Lengyel
Internet-Draft                                                  Ericsson
Intended status: Standards Track                               B. Claise
Expires: October 16, 2020                            Cisco Systems, Inc.
                                                          April 14, 2020

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

Abstract

   There is a need to document data defined in YANG models when a live
   server is unavailable.  Data is often needed at design or
   implementation time or needed when a live running server is
   unavailable.  This document specifies a standard file format for YANG
   instance data, which follows the syntax and semantics of existing
   YANG models, and annotates it with metadata.

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 October 16, 2020.

Copyright Notice

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

Lengyel & Claise        Expires October 16, 2020                [Page 1]
Internet-Draft             YANG Instance Data                 April 2020

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   3
     1.2.  Principles  . . . . . . . . . . . . . . . . . . . . . . .   4
     1.3.  Delivery of Instance Data . . . . . . . . . . . . . . . .   4
     1.4.  Data Life cycle . . . . . . . . . . . . . . . . . . . . .   5
   2.  Instance Data File Format . . . . . . . . . . . . . . . . . .   5
     2.1.  Specifying the Content Schema . . . . . . . . . . . . . .   7
       2.1.1.  Inline Method . . . . . . . . . . . . . . . . . . . .   7
       2.1.2.  Simplified-Inline Method  . . . . . . . . . . . . . .   8
       2.1.3.  URI Method  . . . . . . . . . . . . . . . . . . . . .   8
     2.2.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .   8
       2.2.1.  Documentation of server capabilities  . . . . . . . .   8
       2.2.2.  Preloading default configuration data . . . . . . . .  10
       2.2.3.  Storing diagnostics data  . . . . . . . . . . . . . .  11
   3.  YANG Instance Data Model  . . . . . . . . . . . . . . . . . .  12
     3.1.  Tree Diagram  . . . . . . . . . . . . . . . . . . . . . .  12
     3.2.  YANG Model  . . . . . . . . . . . . . . . . . . . . . . .  13
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .  19
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  20
     5.1.  URI Registration  . . . . . . . . . . . . . . . . . . . .  20
     5.2.  YANG Module Name Registration . . . . . . . . . . . . . .  20
   6.  Acknowledgments . . . . . . . . . . . . . . . . . . . . . . .  20
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  20
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  20
     7.2.  Informative References  . . . . . . . . . . . . . . . . .  22
   Appendix A.  Changes between revisions  . . . . . . . . . . . . .  22
   Appendix B.  Backwards Compatibility  . . . . . . . . . . . . . .  25
   Appendix C.  Detailed Use Cases . . . . . . . . . . . . . . . . .  25
     C.1.  Use Case 1: Early Documentation of Server Capabilities  .  25
     C.2.  Use Case 2: Preloading Data . . . . . . . . . . . . . . .  26
     C.3.  Use Case 3: Documenting Factory Default Settings  . . . .  27
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  27

1.  Introduction

   There is a need to document data defined in YANG models when a live
   server is unavailable.  Data is often needed at design or
   implementation time or needed when a live running server is
Show full document text