Internet Engineering Task Force (IETF)                        A. Bierman
Request for Comments: 7895                                     YumaWorks
Category: Standards Track                                   M. Bjorklund
ISSN: 2070-1721                                           Tail-f Systems
                                                               K. Watsen
                                                        Juniper Networks
                                                               June 2016

YANG Module Library




This document describes a YANG library that provides information about all the YANG modules used by a network management server (e.g., a Network Configuration Protocol (NETCONF) server). Simple caching mechanisms are provided to allow clients to minimize retrieval of this information.


Status of This Memo


This is an Internet Standards Track document.

これはInternet Standards Trackドキュメントです。

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.

このドキュメントは、IETF(Internet Engineering Task Force)の製品です。これは、IETFコミュニティのコンセンサスを表しています。公開レビューを受け、インターネットエンジニアリングステアリンググループ(IESG)による公開が承認されました。インターネット標準の詳細については、RFC 7841のセクション2をご覧ください。

Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at


Copyright Notice


Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.

Copyright(c)2016 IETF Trustおよびドキュメントの作成者として識別された人物。全著作権所有。

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents ( 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.

この文書は、BCP 78およびIETF文書に関するIETFトラストの法的規定(の対象であり、この文書の発行日に有効です。これらのドキュメントは、このドキュメントに関するあなたの権利と制限を説明しているため、注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、Trust Legal Provisionsのセクション4.eに記載されているSimplified BSD Licenseのテキストが含まれている必要があり、Simplified BSD Licenseに記載されているように保証なしで提供されます。

Table of Contents


   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   3
     1.2.  Tree Diagrams . . . . . . . . . . . . . . . . . . . . . .   3
   2.  YANG Module Library . . . . . . . . . . . . . . . . . . . . .   4
     2.1.  modules-state . . . . . . . . . . . . . . . . . . . . . .   4
       2.1.1.  modules-state/module-set-id . . . . . . . . . . . . .   4
       2.1.2.  modules-state/module  . . . . . . . . . . . . . . . .   5
     2.2.  YANG Library Module . . . . . . . . . . . . . . . . . . .   5
   3.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  11
     3.1.  YANG Module Registry  . . . . . . . . . . . . . . . . . .  11
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .  11
   5.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  12
     5.1.  Normative References  . . . . . . . . . . . . . . . . . .  12
     5.2.  Informative References  . . . . . . . . . . . . . . . . .  12
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  13
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  13
1. Introduction
1. はじめに

There is a need for standard mechanisms to identify the YANG modules and submodules that are in use by a server that implements YANG data models. If a large number of YANG modules are utilized by the server, then the YANG library contents needed can be relatively large. This information changes very infrequently, so it is important that clients be able to cache the YANG library contents and easily identify whether their cache is out of date.


YANG library information can be different on every server and can change at runtime or across a server reboot.


If the server implements multiple protocols to access the YANG-defined data, each such protocol has its own conceptual instantiation of the YANG library.


The following information is needed by a client application (for each YANG module in the library) to fully utilize the YANG data modeling language:


o name: The name of the YANG module.

o name:YANGモジュールの名前。

o revision: Each YANG module and submodule within the library has a revision. This is derived from the most recent revision statement within the module or submodule. If no such revision statement exists, the module's or submodule's revision is the zero-length string.

o リビジョン:ライブラリ内の各YANGモジュールとサブモジュールにはリビジョンがあります。これは、モジュールまたはサブモジュール内の最新のリビジョンステートメントから導出されます。そのようなリビジョンステートメントが存在しない場合、モジュールまたはサブモジュールのリビジョンは長さがゼロの文字列です。

o submodule list: The name and revision of each submodule used by the module MUST be identified.

o サブモジュールリスト:モジュールが使用する各サブモジュールの名前とリビジョンを識別する必要があります。

o feature list: The name of each YANG feature supported by the server MUST be identified.

o 機能リスト:サーバーがサポートする各YANG機能の名前を識別する必要があります。

o deviation list: The name of each YANG module used for deviation statements MUST be identified.

o 偏差リスト:偏差ステートメントに使用される各YANGモジュールの名前を識別する必要があります。

1.1. Terminology
1.1. 用語

The keywords "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, [RFC2119].


The following terms are defined in [RFC6241]:


o client

o クライアント

o server

o サーバ

The following terms are defined in [YANG1.1]:


o module

o モジュール

o submodule

o サブモジュール

The following terms are used within this document:


o YANG library: A collection of YANG modules and submodules used by a server.

o YANGライブラリー:サーバーが使用するYANGモジュールとサブモジュールのコレクション。

1.2. Tree Diagrams
1.2. ツリー図

A simplified graphical representation of the data model is used in this document. The meaning of the symbols in these diagrams is as follows:


o Brackets "[" and "]" enclose list keys.

o 大括弧 "["と "]"はリストキーを囲みます。

o Abbreviations before data node names: "rw" means configuration data (read-write) and "ro" state data (read-only).

o データノード名の前の略語:「rw」は構成データ(読み取り/書き込み)および「ro」状態データ(読み取り専用)を意味します。

o Symbols after data node names: "?" means an optional node, "!" means a presence container, and "*" denotes a list and leaf-list.

o データノード名の後の記号: "?"オプションのノード「!」を意味しますプレゼンスコンテナを意味し、「*」はリストとリーフリストを意味します。

o Parentheses enclose choice and case nodes, and case nodes are also marked with a colon (":").

o 括弧は選択ノードとケースノードを囲み、ケースノードもコロン( ":")でマークされます。

o Ellipsis ("...") stands for contents of subtrees that are not shown.

o 省略記号( "...")は、表示されていないサブツリーのコンテンツを表します。

2. YANG Module Library
2. YANGモジュールライブラリ

The "ietf-yang-library" module provides information about the YANG library used by a server. This module is defined using YANG version 1, but it supports the description of YANG modules written in any revision of YANG.


Following is the YANG Tree Diagram for the "ietf-yang-library" module:


      +--ro modules-state
         +--ro module-set-id    string
         +--ro module* [name revision]
            +--ro name                yang:yang-identifier
            +--ro revision            union
            +--ro schema?             inet:uri
            +--ro namespace           inet:uri
            +--ro feature*            yang:yang-identifier
            +--ro deviation* [name revision]
            |  +--ro name        yang:yang-identifier
            |  +--ro revision    union
            +--ro conformance-type    enumeration
            +--ro submodule* [name revision]
               +--ro name        yang:yang-identifier
               +--ro revision    union
               +--ro schema?     inet:uri
2.1. modules-state
2.1. モジュールの状態

This mandatory container holds the identifiers for the YANG data model modules supported by the server.


2.1.1. modules-state/module-set-id
2.1.1. modules-state / module-set-id

This mandatory leaf contains a unique implementation-specific identifier representing the current set of modules and submodules on a specific server. The value of this leaf MUST change whenever the set of modules and submodules in the YANG library changes. There is no requirement that the same set always results in the same "module-set-id" value.


This leaf allows a client to fetch the module list once, cache it, and only refetch it if the value of this leaf has been changed.


If the value of this leaf changes, the server also generates a "yang-library-change" notification, with the new value of "module-set-id".


Note that for a NETCONF server that implements YANG 1.1 [YANG1.1], a change of the "module-set-id" value results in a new value for the :yang-library capability defined in [YANG1.1]. Thus, if such a server implements NETCONF notifications [RFC5277], and the notification "netconf-capability-change" [RFC6470], a "netconf-capability-change" notification is generated whenever the "module-set-id" changes.

YANG 1.1 [YANG1.1]を実装するNETCONFサーバーの場合、「module-set-id」値を変更すると、[YANG1.1]で定義されている:yang-library機能の新しい値が生成されることに注意してください。したがって、そのようなサーバーがNETCONF通知[RFC5277]および通知「netconf-capability-change」[RFC6470]を実装している場合、「module-set-id」が変更されるたびに「netconf-capability-change」通知が生成されます。

2.1.2. modules-state/module
2.1.2. modules-state / module

This mandatory list contains one entry for each YANG data model module supported by the server. There MUST be an entry in this list for each revision of each YANG module that is used by the server. It is possible for multiple revisions of the same module to be imported, in addition to an entry for the revision that is implemented by the server.


2.2. YANG Library Module
2.2. YANGライブラリモジュール

The "ietf-yang-library" module defines monitoring information for the YANG modules used by a server.


The "ietf-yang-types" and "ietf-inet-types" modules from [RFC6991] are used by this module for some type definitions.


   <CODE BEGINS> file "ietf-yang-library@2016-06-21.yang"
   module ietf-yang-library {
     namespace "urn:ietf:params:xml:ns:yang:ietf-yang-library";
     prefix "yanglib";
     import ietf-yang-types {
       prefix yang;
     import ietf-inet-types {
       prefix inet;
       "IETF NETCONF (Network Configuration) Working Group";
       "WG Web:   <>
        WG List:  <>
        WG Chair: Mehmet Ersue
        WG Chair: Mahesh Jethanandani
        Editor:   Andy Bierman
        Editor:   Martin Bjorklund
        Editor:   Kent Watsen

description "This module contains monitoring information about the YANG modules and submodules that are used within a YANG-based server.

説明 "このモジュールには、YANGベースのサーバー内で使用されるYANGモジュールおよびサブモジュールに関する監視情報が含まれています。

Copyright (c) 2016 IETF Trust and the persons identified as authors of the code. All rights reserved.

Copyright(c)2016 IETF Trustおよびコードの作成者として識別された人物。全著作権所有。

Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (

ソースおよびバイナリ形式での再配布および使用は、変更の有無にかかわらず、IETF文書に関連するIETFトラストの法的規定のセクション4.cに記載されているSimplified BSD Licenseに従い、それに含まれるライセンス条項に従って許可されます(。

This version of this YANG module is part of RFC 7895; see the RFC itself for full legal notices.";

このYANGモジュールのこのバージョンはRFC 7895の一部です。完全な法的通知については、RFC自体を参照してください。 ";

     revision 2016-06-21 {
         "Initial revision.";
         "RFC 7895: YANG Module Library.";
      * Typedefs
     typedef revision-identifier {
       type string {
         pattern '\d{4}-\d{2}-\d{2}';
         "Represents a specific date in YYYY-MM-DD format.";
      * Groupings
     grouping module-list {
         "The module data structure is represented as a grouping
          so it can be reused in configuration or another monitoring
          data structure.";
       grouping common-leafs {
           "Common parameters for YANG modules and submodules.";
         leaf name {
           type yang:yang-identifier;
             "The YANG module or submodule name.";
         leaf revision {
           type union {
             type revision-identifier;
             type string { length 0; }
             "The YANG module or submodule revision date.
              A zero-length string is used if no revision statement
              is present in the YANG module or submodule.";
       grouping schema-leaf {
           "Common schema leaf parameter for modules and submodules.";
         leaf schema {
           type inet:uri;
             "Contains a URL that represents the YANG schema
              resource for this module or submodule.
              This leaf will only be present if there is a URL
              available for retrieval of the schema for this entry.";
       list module {
         key "name revision";
           "Each entry represents one revision of one module
            currently supported by the server.";
         uses common-leafs;
         uses schema-leaf;
         leaf namespace {
           type inet:uri;
           mandatory true;
             "The XML namespace identifier for this module.";
         leaf-list feature {
           type yang:yang-identifier;
             "List of YANG feature names from this module that are
              supported by the server, regardless of whether they are
              defined in the module or any included submodule.";
         list deviation {
           key "name revision";
             "List of YANG deviation module names and revisions
              used by this server to modify the conformance of
              the module associated with this entry.  Note that
              the same module can be used for deviations for
              multiple modules, so the same entry MAY appear
              within multiple 'module' entries.
              The deviation module MUST be present in the 'module'
              list, with the same name and revision values.
              The 'conformance-type' value will be 'implement' for
              the deviation module.";
           uses common-leafs;
         leaf conformance-type {
           type enumeration {
             enum implement {
                 "Indicates that the server implements one or more
                  protocol-accessible objects defined in the YANG module
                  identified in this entry.  This includes deviation
                  statements defined in the module.

For YANG version 1.1 modules, there is at most one module entry with conformance type 'implement' for a particular module name, since YANG 1.1 requires that, at most, one revision of a module is implemented.

YANGバージョン1.1モジュールの場合、特定のモジュール名の準拠タイプが「実装」であるモジュールエントリは最大で1つです。これは、YANG 1.1では、最大で1つのモジュールのリビジョンを実装する必要があるためです。

                  For YANG version 1 modules, there SHOULD NOT be more
                  than one module entry for a particular module name.";
             enum import {
                 "Indicates that the server imports reusable definitions
                  from the specified revision of the module but does
                  not implement any protocol-accessible objects from
                  this revision.
                  Multiple module entries for the same module name MAY
                  exist.  This can occur if multiple modules import the
                  same module but specify different revision dates in
                  the import statements.";
           mandatory true;
             "Indicates the type of conformance the server is claiming
              for the YANG module identified by this entry.";
         list submodule {
           key "name revision";
             "Each entry represents one submodule within the
              parent module.";
           uses common-leafs;
           uses schema-leaf;
      * Operational state data nodes
     container modules-state {
       config false;
         "Contains YANG module monitoring information.";
       leaf module-set-id {
         type string;
         mandatory true;
           "Contains a server-specific identifier representing
            the current set of modules and submodules.  The
            server MUST change the value of this leaf if the
            information represented by the 'module' list instances
            has changed.";
       uses module-list;
      * Notifications
     notification yang-library-change {
         "Generated when the set of modules and submodules supported
          by the server has changed.";
       leaf module-set-id {
         type leafref {
           path "/yanglib:modules-state/yanglib:module-set-id";
         mandatory true;
           "Contains the module-set-id value representing the
            set of modules and submodules supported at the server at
            the time the notification is generated.";




3. IANA Considerations
3. IANAに関する考慮事項
3.1. YANG Module Registry
3.1. そのレジストリモジュール

This document registers one URI in the "IETF XML Registry" [RFC3688]. Following the format in RFC 3688, the following registration has been made.

このドキュメントは、「IETF XMLレジストリ」[RFC3688]に1つのURIを登録します。 RFC 3688のフォーマットに従って、次の登録が行われました。

URI: urn:ietf:params:xml:ns:yang:ietf-yang-library Registrant Contact: The NETCONF WG of the IETF. XML: N/A, the requested URI is an XML namespace.

URI:urn:ietf:params:xml:ns:yang:ietf-yang-library登録者の連絡先:IETFのNETCONF WG。 XML:N / A、要求されたURIはXML名前空間です。

This document registers one YANG module in the "YANG Module Names" registry [RFC6020].


     name:         ietf-yang-library
     namespace:    urn:ietf:params:xml:ns:yang:ietf-yang-library
     prefix:       yanglib
     reference:    RFC 7895
4. Security Considerations
4. セキュリティに関する考慮事項

The YANG module defined in this memo is designed to be accessed via the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the secure transport layer and the mandatory-to-implement secure transport is SSH [RFC6242]. The NETCONF access control model [RFC6536] provides the means to restrict access for particular NETCONF users to a pre-configured subset of all available NETCONF protocol operations and content.

このメモで定義されているYANGモジュールは、NETCONFプロトコル[RFC6241]を介してアクセスされるように設計されています。最下層のNETCONF層はセキュアなトランスポート層であり、実装に必須のセキュアなトランスポートはSSH [RFC6242]です。 NETCONFアクセス制御モデル[RFC6536]は、特定のNETCONFユーザーのアクセスを、利用可能なすべてのNETCONFプロトコル操作とコンテンツの事前構成されたサブセットに制限する手段を提供します。

Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability:


o /modules-state/module: The module list used in a server implementation may help an attacker identify the server capabilities and server implementations with known bugs. Although some of this information may be available to all users via the NETCONF <hello> message (or similar messages in other management protocols), this YANG module potentially exposes additional details that could be of some assistance to an attacker. Server vulnerabilities may be specific to particular modules, module revisions, module features, or even module deviations. This information is included in each module entry. For example, if a particular operation on a particular data node is known to cause a server to crash or significantly degrade device performance, then the module list information will help an attacker identify server implementations with such a defect, in order to launch a denial-of-service attack on the device.

o / modules-state / module:サーバー実装で使用されるモジュールリストは、攻撃者が既知のバグのあるサーバー機能とサーバー実装を特定するのに役立つ場合があります。この情報の一部は、NETCONF <hello>メッセージ(または他の管理プロトコルの同様のメッセージ)を介してすべてのユーザーが利用できる場合がありますが、このYANGモジュールは、攻撃者に役立つ可能性がある追加の詳細を公開する可能性があります。サーバーの脆弱性は、特定のモジュール、モジュールリビジョン、モジュール機能、またはモジュールの逸脱に固有の場合があります。この情報は、各モジュールエントリに含まれています。たとえば、特定のデータノードでの特定の操作によってサーバーがクラッシュしたり、デバイスのパフォーマンスが大幅に低下したりすることがわかっている場合、モジュールリスト情報は、攻撃者がそのような欠陥のあるサーバーの実装を特定し、拒否を開始するのに役立ちます。デバイスに対するサービス妨害攻撃。

5. References
5. 参考文献
5.1. Normative References
5.1. 引用文献

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <>.

[RFC2119] Bradner、S。、「要件レベルを示すためにRFCで使用するキーワード」、BCP 14、RFC 2119、DOI 10.17487 / RFC2119、1997年3月、< rfc2119>。

[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, <>.

[RFC3688] Mealling、M。、「The IETF XML Registry」、BCP 81、RFC 3688、DOI 10.17487 / RFC3688、2004年1月、<>。

[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, <>.

[RFC6020] Bjorklund、M。、編、「YANG-ネットワーク構成プロトコル(NETCONF)のデータモデリング言語」、RFC 6020、DOI 10.17487 / RFC6020、2010年10月、<http://www.rfc-editor。 org / info / rfc6020>。

[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, <>.

[RFC6241] Enns、R。、編、Bjorklund、M。、編、Schoenwaelder、J。、編、およびA. Bierman、編、「Network Configuration Protocol(NETCONF)」、RFC 6241、DOI 10.17487 / RFC6241、2011年6月、<>。

[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, <>.

[RFC6242] Wasserman、M。、「Secure Shell(SSH)を介したNETCONFプロトコルの使用」、RFC 6242、DOI 10.17487 / RFC6242、2011年6月、<>。

[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration Protocol (NETCONF) Access Control Model", RFC 6536, DOI 10.17487/RFC6536, March 2012, <>.

[RFC6536] Bierman、A。およびM. Bjorklund、「Network Configuration Protocol(NETCONF)Access Control Model」、RFC 6536、DOI 10.17487 / RFC6536、2012年3月、< rfc6536>。

[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, <>.

[RFC6991] Schoenwaelder、J。、編、「Common YANG Data Types」、RFC 6991、DOI 10.17487 / RFC6991、2013年7月、<>。

5.2. Informative References
5.2. 参考引用

[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, <>.

[RFC5277] Chisholm、S。およびH. Trevino、「NETCONFイベント通知」、RFC 5277、DOI 10.17487 / RFC5277、2008年7月、<>。

[RFC6470] Bierman, A., "Network Configuration Protocol (NETCONF) Base Notifications", RFC 6470, DOI 10.17487/RFC6470, February 2012, <>.

[RFC6470] Bierman、A。、「Network Configuration Protocol(NETCONF)Base Notifications」、RFC 6470、DOI 10.17487 / RFC6470、2012年2月、<>。

[YANG1.1] Bjorklund, M., "The YANG 1.1 Data Modeling Language", Work in Progress, draft-ietf-netmod-rfc6020bis-12, April 2016.

[YANG1.1] Bjorklund、M。、「The YANG 1.1 Data Modeling Language」、Work in Progress、draft-ietf-netmod-rfc6020bis-12、2016年4月。



Contributions to this material by Andy Bierman are based upon work supported by the Space & Terrestrial Communications Directorate (S&TCD) under Contract No. W15P7T-13-C-A616. Any opinions, findings, 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).

Andy Biermanによるこの資料への貢献は、契約番号W15P7T-13-C-A616に基づいてSpace&Terrestrial Communications Directorate(S&TCD)によってサポートされた作業に基づいています。この資料に記載されている意見、調査結果、結論、または推奨事項は著者の意見であり、必ずしも宇宙通信局(S&TCD)の見解を反映するものではありません。

Authors' Addresses


Andy Bierman YumaWorks



Martin Bjorklund Tail-f Systems

Martin Bjorklund Tail-fシステム


Kent Watsen Juniper Networks