YANG Data Structure Extensions
draft-ietf-netmod-yang-data-ext-04

Document Type Active Internet-Draft (netmod WG)
Last updated 2019-11-05 (latest revision 2019-07-15)
Replaces draft-bierman-netmod-yang-data-ext
Stream IETF
Intended RFC status Proposed Standard
Formats plain text xml pdf htmlized bibtex
Yang Validation 0 errors, 0 warnings.
Reviews
Additional URLs
- Yang catalog entry for ietf-yang-structure-ext@2019-03-07.yang
- Yang impact analysis for draft-ietf-netmod-yang-data-ext
- Mailing list discussion
Stream WG state Submitted to IESG for Publication
Document shepherd Joel Jaeggli
Shepherd write-up Show (last changed 2019-10-12)
IESG IESG state IESG Evaluation
Consensus Boilerplate Yes
Telechat date On agenda of 2019-12-05 IESG telechat
Needs 7 more YES or NO OBJECTION positions to pass.
Responsible AD Ignas Bagdonas
Send notices to Joel Jaeggli <joelja@gmail.com>
IANA IANA review state IANA OK - Actions Needed
IANA expert review state Expert Reviews OK
Network Working Group                                         A. Bierman
Internet-Draft                                                 YumaWorks
Updates: 8340 (if approved)                                 M. Bjorklund
Intended status: Standards Track                                   Cisco
Expires: January 16, 2020                                      K. Watsen
                                                         Watsen Networks
                                                           July 15, 2019

                     YANG Data Structure Extensions
                   draft-ietf-netmod-yang-data-ext-04

Abstract

   This document describes YANG mechanisms for defining abstract data
   structures with YANG.

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

Copyright Notice

   Copyright (c) 2019 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
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Bierman, et al.         Expires January 16, 2020                [Page 1]
Internet-Draft               YANG Structure                    July 2019

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   3
       1.1.1.  NMDA  . . . . . . . . . . . . . . . . . . . . . . . .   3
       1.1.2.  YANG  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Definitions . . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  YANG Data Structures in YANG Tree Diagrams  . . . . . . . . .   4
   4.  YANG Data Structure Extensions Module . . . . . . . . . . . .   5
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   9
     5.1.  YANG Module Registry  . . . . . . . . . . . . . . . . . .   9
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .  10
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  10
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  10
     7.2.  Informative References  . . . . . . . . . . . . . . . . .  11
   Appendix A.  Examples . . . . . . . . . . . . . . . . . . . . . .  11
     A.1.  "structure" Example . . . . . . . . . . . . . . . . . . .  11
     A.2.  "augment-structure" Example . . . . . . . . . . . . . . .  13
     A.3.  XML Encoding Example  . . . . . . . . . . . . . . . . . .  13
     A.4.  JSON Encoding Example . . . . . . . . . . . . . . . . . .  14
     A.5.  "structure" example that defines a non-top-level
           structure . . . . . . . . . . . . . . . . . . . . . . . .  14
   Appendix B.  Change Log . . . . . . . . . . . . . . . . . . . . .  15
     B.1.  v02 to v03  . . . . . . . . . . . . . . . . . . . . . . .  15
     B.2.  v01 to v02  . . . . . . . . . . . . . . . . . . . . . . .  15
     B.3.  v00 to v01  . . . . . . . . . . . . . . . . . . . . . . .  15
   Appendix C.  Open Issues  . . . . . . . . . . . . . . . . . . . .  16
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  16

1.  Introduction

   There is a need for standard mechanisms to allow the definition of
   abstract data that is not intended to be implemented as configuration
   or operational state.  The "yang-data" extension statement from RFC
   8040 [RFC8040] was defined for this purpose but it is limited in its
   functionality.

   The intended use of the "yang-data" extension was to model all or
   part of a protocol message, such as the "errors" definition in the
   YANG module "ietf-restconf" [RFC8040], or the contents of a file.
   However, protocols are often layered such that the header or payload
   portions of the message can be extended by external documents.  The
   YANG statements that model a protocol need to support this
   extensibility that is already found in that protocol.

   The "yang-data" extension from [RFC8040] has been copied here,
Show full document text