draft-ietf-netconf-yang-library-01.txt   draft-ietf-netconf-yang-library-02.txt 
Network Working Group A. Bierman Network Working Group A. Bierman
Internet-Draft YumaWorks Internet-Draft YumaWorks
Intended status: Standards Track M. Bjorklund Intended status: Standards Track M. Bjorklund
Expires: January 7, 2016 Tail-f Systems Expires: April 20, 2016 Tail-f Systems
K. Watsen K. Watsen
Juniper Networks Juniper Networks
July 6, 2015 October 18, 2015
YANG Module Library YANG Module Library
draft-ietf-netconf-yang-library-01 draft-ietf-netconf-yang-library-02
Abstract Abstract
This document describes a YANG library, which provides information This document describes a YANG library, which provides information
about all the YANG modules used by a device to represent management about all the YANG modules used by a device to represent management
and protocol information. A YANG library can be shared by multiple and protocol information. A YANG library can be shared by multiple
protocols within the same device. Simple caching mechanisms are protocols within the same device. Simple caching mechanisms are
needed to allow clients to minimize retrieval of this information. needed to allow clients to minimize retrieval of this information.
Status of This Memo Status of This Memo
skipping to change at page 1, line 37 skipping to change at page 1, line 37
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 7, 2016. This Internet-Draft will expire on April 20, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the Copyright (c) 2015 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 17 skipping to change at page 2, line 17
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 3 1.1.1. NETCONF . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2. YANG . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1.2. YANG . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.3. Terms . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1.3. Terms . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.4. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 4 1.1.4. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 4
2. YANG Module Library . . . . . . . . . . . . . . . . . . . . . 4 2. YANG Module Library . . . . . . . . . . . . . . . . . . . . . 4
2.1. modules . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1. modules . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1.1. modules/module-set-id . . . . . . . . . . . . . . . . 5 2.1.1. modules/module-set-id . . . . . . . . . . . . . . . . 5
2.1.2. modules/module . . . . . . . . . . . . . . . . . . . 5 2.1.2. modules/module . . . . . . . . . . . . . . . . . . . 5
2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 5 2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 5
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10
3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 10 3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 10
4. Security Considerations . . . . . . . . . . . . . . . . . . . 10 4. Security Considerations . . . . . . . . . . . . . . . . . . . 11
5. Normative References . . . . . . . . . . . . . . . . . . . . 11 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 11
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 11 6. Normative References . . . . . . . . . . . . . . . . . . . . 11
A.1. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 12 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 12
A.2. draft-ietf-netconf-restconf-03 to 00 . . . . . . . . . . 12 A.1. 01 to 02 . . . . . . . . . . . . . . . . . . . . . . . . 12
A.2. 00 to 01 . . . . . . . . . . . . . . . . . . . . . . . . 12
A.3. draft-ietf-netconf-restconf-03 to 00 . . . . . . . . . . 12
Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 12 Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 12
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12
1. Introduction 1. Introduction
There is a need for standard mechanisms to identify the YANG modules There is a need for standard mechanisms to identify the YANG modules
and submodules that are in use by each server that utilizes YANG- and submodules that are in use by a server that utilizes YANG-based
based data abstraction. If a large number of YANG modules are data abstractions. If a large number of YANG modules are utilized by
utilized by the server, then the YANG library information needed can the server, then the YANG library information needed can be
be relatively large. This information changes very infrequently, so relatively large. This information changes very infrequently, so it
it is important that clients be able to cache the YANG library and is important that clients be able to cache the YANG library and
easily identify if their cache is out-of-date. easily identify if their cache is out-of-date.
YANG library information can be different on every server, and can YANG library information can be different on every server, and can
change at run-time or across a server reboot. Typically firmware change at run-time or across a server reboot. Typically, a firmware
upgrades are required to change the set of YANG modules used by a upgrade is required to change the set of YANG modules used by a
server. server.
The following information is needed by a client application (for each The following information is needed by a client application (for each
YANG module in the library) to fully utilize the YANG data modeling YANG module in the library) to fully utilize the YANG data modeling
language. language:
o name: The mandatory YANG module name MUST be unique within a YANG o name: The mandatory YANG module name MUST be unique within a YANG
library. All modules and submodules share the same namespace, library.
including modules used for deviations.
o revision date: Each YANG module within the library MUST have a o revision: Each YANG module and submodule within the library has a
revision date. This is derived from the most recent revision revision. This is derived from the most recent revision statement
statement within the module or submodule. within the module or submodule. If no such revision statement
exists, the module's or submodule's revision is the empty string.
o submodule list: The name and revision date of each submodule used o submodule list: The name and revision of each submodule used by
by main module MUST be identified. the module MUST be identified.
o feature list: The name of each YANG feature supported by the o feature list: The name of each YANG feature supported by the
server MUST be identified. server MUST be identified.
o deviation list: The name of each YANG module used for deviation o deviation list: The name of each YANG module used for deviation
statements SHOULD be identified. statements SHOULD be identified.
1.1. Terminology 1.1. Terminology
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
skipping to change at page 4, line 32 skipping to change at page 4, line 32
o Ellipsis ("...") stands for contents of subtrees that are not o Ellipsis ("...") stands for contents of subtrees that are not
shown. shown.
2. YANG Module Library 2. YANG Module Library
The "ietf-yang-library" module provides information about the YANG The "ietf-yang-library" module provides information about the YANG
library used by a server. library used by a server.
YANG Tree Diagram for "ietf-yang-library" module: YANG Tree Diagram for "ietf-yang-library" module:
+--ro modules +--ro modules
+--ro module-set-id? string +--ro module-set-id string
+--ro module* [name revision] +--ro module* [name revision]
+--ro name yang:yang-identifier +--ro name yang:yang-identifier
+--ro revision union +--ro revision union
+--ro schema? inet:uri +--ro schema? inet:uri
+--ro namespace inet:uri +--ro namespace inet:uri
+--ro feature* yang:yang-identifier +--ro feature* yang:yang-identifier
+--ro deviation* [name revision] +--ro deviation* [name revision]
| +--ro name yang:yang-identifier | +--ro name yang:yang-identifier
| +--ro revision union | +--ro revision union
+--ro conformance enumeration +--ro conformance enumeration
+--ro submodules +--ro submodules
+--ro submodule* [name revision] +--ro submodule* [name revision]
+--ro name yang:yang-identifier +--ro name yang:yang-identifier
+--ro revision union +--ro revision union
+--ro schema? inet:uri +--ro schema? inet:uri
2.1. modules 2.1. modules
This mandatory container holds the identifiers for the YANG data This mandatory container holds the identifiers for the YANG data
model modules supported by the server. model modules supported by the server.
2.1.1. modules/module-set-id 2.1.1. modules/module-set-id
This mandatory leaf contains a unique implementation-specific This mandatory leaf contains a unique implementation-specific
identifier representing the current set of modules and submodules. identifier representing the current set of modules and submodules.
This can for example be a checksum of all modules and submodules. This can for example be a checksum of all modules and submodules.
This leaf allows a client to fetch the module list once, cache them, This leaf allows a client to fetch the module list once, cache them,
skipping to change at page 5, line 22 skipping to change at page 5, line 19
This mandatory leaf contains a unique implementation-specific This mandatory leaf contains a unique implementation-specific
identifier representing the current set of modules and submodules. identifier representing the current set of modules and submodules.
This can for example be a checksum of all modules and submodules. This can for example be a checksum of all modules and submodules.
This leaf allows a client to fetch the module list once, cache them, This leaf allows a client to fetch the module list once, cache them,
and only re-fetch them if the value of this leaf has been changed. and only re-fetch them if the value of this leaf has been changed.
2.1.2. modules/module 2.1.2. modules/module
This mandatory list contains one entry for each YANG data model This mandatory list contains one entry for each YANG data model
module supported by the server. There MUST be an instance of this module supported by the server. There MUST be an entry in this list
list for every YANG module that is used by the server. for every YANG module that is used by the server.
2.2. YANG Library Module 2.2. YANG Library Module
The "ietf-yang-library" module defines monitoring information for the The "ietf-yang-library" module defines monitoring information for the
YANG modules used by a RESTCONF server. YANG modules used by a server.
The "ietf-yang-types" and "ietf-inet-types" modules from [RFC6991] The "ietf-yang-types" and "ietf-inet-types" modules from [RFC6991]
are used by this module for some type definitions. are used by this module for some type definitions.
RFC Ed.: update the date below with the date of RFC publication and RFC Ed.: update the date below with the date of RFC publication and
remove this note. remove this note.
<CODE BEGINS> file "ietf-yang-library@2015-07-03.yang" <CODE BEGINS> file "ietf-yang-library@2015-10-18.yang"
module ietf-yang-library { module ietf-yang-library {
namespace "urn:ietf:params:xml:ns:yang:ietf-yang-library"; namespace "urn:ietf:params:xml:ns:yang:ietf-yang-library";
prefix "yanglib"; prefix "yanglib";
import ietf-yang-types { import ietf-yang-types {
prefix yang; prefix yang;
} }
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
skipping to change at page 6, line 44 skipping to change at page 6, line 41
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this // RFC Ed.: replace XXXX with actual RFC number and remove this
// note. // note.
// RFC Ed.: remove this note // RFC Ed.: remove this note
// Note: extracted from draft-ietf-netconf-yang-library-01.txt // Note: extracted from draft-ietf-netconf-yang-library-02.txt
// RFC Ed.: update the date below with the date of RFC publication // RFC Ed.: update the date below with the date of RFC publication
// and remove this note. // and remove this note.
revision 2015-07-03 { revision 2015-10-18 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: YANG Module Library."; "RFC XXXX: YANG Module Library.";
} }
typedef revision-identifier { typedef revision-identifier {
type string { type string {
pattern '\d{4}-\d{2}-\d{2}'; pattern '\d{4}-\d{2}-\d{2}';
} }
description description
"Represents a specific date in YYYY-MM-DD format."; "Represents a specific date in YYYY-MM-DD format.";
} }
grouping module { grouping module {
description description
skipping to change at page 9, line 11 skipping to change at page 9, line 8
enum implement { enum implement {
description description
"Indicates the server implements one or more "Indicates the server implements one or more
protocol-accessible objects defined in the protocol-accessible objects defined in the
YANG module identified in this entry. This includes YANG module identified in this entry. This includes
deviation statements defined in the module. deviation statements defined in the module.
For YANG 1.1 modules, there MUST NOT be more than For YANG 1.1 modules, there MUST NOT be more than
one module entry for a particular module name. one module entry for a particular module name.
For YANG 1.1 modules that use the import statement
without specifying a revision date, the implemented
revision of the imported module MUST be used.
If the imported module is not implemented, then
the most recent revision of the imported module
used by the server (and contained in the module list)
MUST be used.
For YANG 1.0 modules, there SHOULD NOT be more than For YANG 1.0 modules, there SHOULD NOT be more than
one module entry for a particular module name."; one module entry for a particular module name.";
} }
enum import { enum import {
description description
"Indicates the server imports reusable definitions from "Indicates the server imports reusable definitions from
the specified revision of the module, but does not the specified revision of the module, but does not
implement any protocol accessible objects from this implement any protocol accessible objects from this
revision. revision.
skipping to change at page 9, line 48 skipping to change at page 10, line 4
"Contains information about all the submodules used "Contains information about all the submodules used
by the parent module entry"; by the parent module entry";
list submodule { list submodule {
key "name revision"; key "name revision";
description description
"Each entry represents one submodule within the "Each entry represents one submodule within the
parent module."; parent module.";
uses common-leafs; uses common-leafs;
uses schema-leaf; uses schema-leaf;
} }
} }
} // list module } // list module
} // grouping module } // grouping module
container modules { container modules {
config false; config false;
description description
"Contains YANG module monitoring information."; "Contains YANG module monitoring information.";
leaf module-set-id { leaf module-set-id {
type string; type string;
mandatory true;
description description
"Contains a server-specific identifier representing "Contains a server-specific identifier representing
the current set of modules and submodules. The the current set of modules and submodules. The
server MUST change the value of this leaf if the server MUST change the value of this leaf if the
information represented by the 'module' list instances information represented by the 'module' list instances
has changed."; has changed.";
} }
uses module; uses module;
} }
skipping to change at page 10, line 34 skipping to change at page 10, line 41
<CODE ENDS> <CODE ENDS>
3. IANA Considerations 3. IANA Considerations
3.1. YANG Module Registry 3.1. YANG Module Registry
This document registers one URI in the IETF XML registry [RFC3688]. This document registers one URI in the IETF XML registry [RFC3688].
Following the format in RFC 3688, the following registration is Following the format in RFC 3688, the following registration is
requested to be made. requested to be made.
URI: urn:ietf:params:xml:ns:yang:ietf-yang-library URI: urn:ietf:params:xml:ns:yang:ietf-yang-library
Registrant Contact: The NETMOD WG of the IETF. Registrant Contact: The NETMOD WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
This document registers one YANG module in the YANG Module Names This document registers one YANG module in the YANG Module Names
registry [RFC6020]. registry [RFC6020].
name: ietf-yang-library name: ietf-yang-library
namespace: urn:ietf:params:xml:ns:yang:ietf-yang-library namespace: urn:ietf:params:xml:ns:yang:ietf-yang-library
prefix: yanglib prefix: yanglib
// RFC Ed.: replace XXXX with RFC number and remove this note // RFC Ed.: replace XXXX with RFC number and remove this note
reference: RFC XXXX reference: RFC XXXX
4. Security Considerations 4. Security Considerations
The YANG module defined in this memo is designed to be accessed via The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the
secure transport layer and the mandatory-to-implement secure secure transport layer and the mandatory-to-implement secure
transport is SSH [RFC6242]. transport is SSH [RFC6242].
Some of the readable data nodes in this YANG module may be considered Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
skipping to change at page 11, line 25 skipping to change at page 11, line 36
implementations with known bugs. Server vulnerabilities may be implementations with known bugs. Server vulnerabilities may be
specific to particular modules, module revisions, module features, specific to particular modules, module revisions, module features,
or even module deviations. This information is included in each or even module deviations. This information is included in each
module entry. For example, if a particular operation on a module entry. For example, if a particular operation on a
particular data node is known to cause a server to crash or particular data node is known to cause a server to crash or
significantly degrade device performance, then the module list significantly degrade device performance, then the module list
information will help an attacker identify server implementations information will help an attacker identify server implementations
with such a defect, in order to launch a denial of service attack with such a defect, in order to launch a denial of service attack
on the device. on the device.
5. Normative References 5. Acknowledgements
Contributions to this material by Andy Bierman are based upon work
supported by the The Space & Terrestrial Communications Directorate
(S&TCD) under Contract No. W15P7T-13-C-A616. Any opinions, findings
and conclusions or recommendations expressed in this material are
those of the author(s) and do not necessarily reflect the views of
The Space & Terrestrial Communications Directorate (S&TCD).
6. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004. January 2004.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)", RFC 6020, Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010. October 2010.
skipping to change at page 11, line 49 skipping to change at page 12, line 21
(NETCONF)", RFC 6241, June 2011. (NETCONF)", RFC 6241, June 2011.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011. Shell (SSH)", RFC 6242, June 2011.
[RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, [RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991,
July 2013. July 2013.
Appendix A. Change Log Appendix A. Change Log
-- RFC Ed.: remove this section before publication. -- RFC Ed.: remove this section before publication.
A.1. 00 to 01 A.1. 01 to 02
o clarify 'implement' conformance for YANG 1.1 modules
A.2. 00 to 01
o change conformance leaf to enumeration o change conformance leaf to enumeration
o filled in security considerations section o filled in security considerations section
A.2. draft-ietf-netconf-restconf-03 to 00 A.3. draft-ietf-netconf-restconf-03 to 00
o moved ietf-yang-library from RESTCONF draft to new draft o moved ietf-yang-library from RESTCONF draft to new draft
Appendix B. Open Issues Appendix B. Open Issues
-- RFC Ed.: remove this section before publication. -- RFC Ed.: remove this section before publication.
The YANG Library issue tracker can be found here: The YANG Library issue tracker can be found here:
https://github.com/netconf-wg/yang-library/issues https://github.com/netconf-wg/yang-library/issues
Authors' Addresses Authors' Addresses
Andy Bierman Andy Bierman
YumaWorks YumaWorks
Email: andy@yumaworks.com Email: andy@yumaworks.com
Martin Bjorklund Martin Bjorklund
Tail-f Systems Tail-f Systems
Email: mbj@tail-f.com Email: mbj@tail-f.com
Kent Watsen Kent Watsen
Juniper Networks Juniper Networks
Email: kwatsen@juniper.net Email: kwatsen@juniper.net
 End of changes. 33 change blocks. 
65 lines changed or deleted 88 lines changed or added

This html diff was produced by rfcdiff 1.42. The latest version is available from http://tools.ietf.org/tools/rfcdiff/