YANG Instance Data File Format
draft-ietf-netmod-yang-instance-file-format-01
|
| Document |
Type |
|
Active Internet-Draft (netmod WG)
|
|
Last updated |
|
2018-12-06
|
|
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.
draft-ietf-netmod-yang-instance-file-format-01.txt:
xym 0.4:
Extracting 'ietf-yang-instance-data.yang'
Removed 0 empty lines
ietf-yang-instance-data@2018-11-30.yang:
pyang 1.7.5: pyang --verbose --ietf -p {libs} {model}:
ietf-yang-instance-data@2018-11-30.yang:7: error: module "ietf-yang-data-ext" not found in search path
ietf-yang-instance-data@2018-11-30.yang:67: error: RFC 6087: 4.12: statement "leaf" must have a "description" substatement
ietf-yang-instance-data@2018-11-30.yang:114: 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:
err : Data model "ietf-yang-data-ext" not found.
err : Importing "ietf-yang-data-ext" module into "ietf-yang-instance-data" failed.
err : Module "ietf-yang-instance-data" parsing failed.
|
|
Additional URLs |
|
|
| 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: June 9, 2019 Cisco Systems, Inc.
December 6, 2018
YANG Instance Data File Format
draft-ietf-netmod-yang-instance-file-format-01
Abstract
There is a need to document data defined in YANG models when a live
YANG server is not available. 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
instance data, which follows the syntax and semantic from existing
YANG models, re-using existing formats from <get> operation/request
and decorates them 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 June 9, 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
to this document. Code Components extracted from this document must
Lengyel & Claise Expires June 9, 2019 [Page 1]
Internet-Draft YANG Instance Data December 2018
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. High Level Principles . . . . . . . . . . . . . . . . . . 4
3. Instance Data File Format . . . . . . . . . . . . . . . . . . 4
3.1. Specifying the Target YANG Modules: target-ptr . . . . . 6
3.1.1. IN-LINE Method . . . . . . . . . . . . . . . . . . . 7
3.1.2. URI Method . . . . . . . . . . . . . . . . . . . . . 7
3.2. Examples . . . . . . . . . . . . . . . . . . . . . . . . 8
4. Data Life cycle . . . . . . . . . . . . . . . . . . . . . . . 11
5. Delivery of Instance Data . . . . . . . . . . . . . . . . . . 12
6. YANG Model . . . . . . . . . . . . . . . . . . . . . . . . . 12
7. Security Considerations . . . . . . . . . . . . . . . . . . . 15
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15
8.1. URI Registration . . . . . . . . . . . . . . . . . . . . 15
8.2. YANG Module Name Registration . . . . . . . . . . . . . . 15
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 16
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 16
10.1. Normative References . . . . . . . . . . . . . . . . . . 16
10.2. Informative References . . . . . . . . . . . . . . . . . 16
Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 17
Appendix B. Changes between revisions . . . . . . . . . . . . . 17
Appendix C. Detailed Use Cases - Non-Normative . . . . . . . . . 19
C.1. Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 19
C.1.1. Use Case 1: Early Documentation of Server
Capabilities . . . . . . . . . . . . . . . . . . . . 19
C.1.2. Use Case 2: Preloading Data . . . . . . . . . . . . . 20
C.1.3. Use Case 3: Documenting Factory Default Settings . . 20
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 21
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
Show full document text