Browse Prior Art Database

Defining and Using Metadata with YANG (RFC7952)

IP.com Disclosure Number: IPCOM000247396D
Original Publication Date: 2016-Aug-01
Included in the Prior Art Database: 2016-Sep-01
Document File: 42 page(s) / 36K

Publishing Venue

Internet Society Requests For Comment (RFCs)

Related People

L. Lhotka: AUTHOR

Abstract

There is a need to be able to annotate instances of YANG [RFC7950] data nodes with metadata. Typical use cases are as follows:

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 7% of the total text.

Internet Engineering Task Force (IETF)                         L. Lhotka Request for Comments: 7952                                        CZ.NIC Updates: 6110                                                August 2016 Category: Standards Track ISSN: 2070-1721

                  Defining and Using Metadata with YANG

Abstract

   This document defines a YANG extension that allows for defining    metadata annotations in YANG modules.  The document also specifies    XML and JSON encoding of annotations and other rules for annotating    instances of YANG data nodes.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force    (IETF).  It represents the consensus of the IETF community.  It has    received public review and has been approved for publication by the    Internet Engineering Steering Group (IESG).  Further information on    Internet Standards is available in Section 2 of RFC 7841.

   Information about the current status of this document, any errata,    and how to provide feedback on it may be obtained at    http://www.rfc-editor.org/info/rfc7952.

Copyright Notice

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

Lhotka                       Standards Track                    [Page 1]
 RFC 7952                      YANG Metadata                  August 2016

 Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3

   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   5

     2.1.  Key Words . . . . . . . . . . . . . . . . . . . . . . . .   5

     2.2.  Terms Defined in Other Documents  . . . . . . . . . . . .   5

     2.3.  Namespaces and Prefixes . . . . . . . . . . . . . . . . .   7

     2.4.  Definitions of New Terms  . . . . . . . . . . . . . . . .   7

   3.  Defining Annotations in YANG  . . . . . . . . . . . . . . . .   8

     3.1.  Example Definition  . . . . . . . . . . . . . . . . . . .   9

   4.  Using Annotations . . . . . . . . . . . . . . . . . . . . . . ...