draft-ietf-netconf-yang-library-03.txt   draft-ietf-netconf-yang-library-04.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: June 17, 2016 Tail-f Systems Expires: August 6, 2016 Tail-f Systems
K. Watsen K. Watsen
Juniper Networks Juniper Networks
December 15, 2015 February 3, 2016
YANG Module Library YANG Module Library
draft-ietf-netconf-yang-library-03 draft-ietf-netconf-yang-library-04
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 network management server (e.g.,
and protocol information. A YANG library can be shared by multiple a Network Configuration Protocol (NETCONF) server). Simple caching
protocols within the same device. Simple caching mechanisms are mechanisms are provided to allow clients to minimize retrieval of
needed to allow clients to minimize retrieval of this information. this information.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
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 June 17, 2016. This Internet-Draft will expire on August 6, 2016.
Copyright Notice Copyright Notice
Copyright (c) 2015 IETF Trust and the persons identified as the Copyright (c) 2016 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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
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.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4
1.1.2. YANG . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.3. Terms . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.4. Tree Diagrams . . . . . . . . . . . . . . . . . . . . 4
2. YANG Module Library . . . . . . . . . . . . . . . . . . . . . 4 2. YANG Module Library . . . . . . . . . . . . . . . . . . . . . 4
2.1. modules . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1. modules-state . . . . . . . . . . . . . . . . . . . . . . 5
2.1.1. modules/module-set-id . . . . . . . . . . . . . . . . 5 2.1.1. modules-state/module-set-id . . . . . . . . . . . . . 5
2.1.2. modules/yang-protocol . . . . . . . . . . . . . . . . 5 2.1.2. modules-state/module . . . . . . . . . . . . . . . . 5
2.1.3. modules/module . . . . . . . . . . . . . . . . . . . 5 2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 5
2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 6 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 11
3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 12 4. Security Considerations . . . . . . . . . . . . . . . . . . . 11
4. Security Considerations . . . . . . . . . . . . . . . . . . . 12 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 12
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 13 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 12
6. Normative References . . . . . . . . . . . . . . . . . . . . 13 6.1. Normative References . . . . . . . . . . . . . . . . . . 12
6.2. Informative References . . . . . . . . . . . . . . . . . 13
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 13 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 13
A.1. v02 to v03 . . . . . . . . . . . . . . . . . . . . . . . 13 A.1. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 13
A.2. v01 to v02 . . . . . . . . . . . . . . . . . . . . . . . 14 A.2. v02 to v03 . . . . . . . . . . . . . . . . . . . . . . . 14
A.3. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 14 A.3. v01 to v02 . . . . . . . . . . . . . . . . . . . . . . . 14
A.4. draft-ietf-netconf-restconf-03 to v00 . . . . . . . . . . 14 A.4. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 14
A.5. draft-ietf-netconf-restconf-03 to v00 . . . . . . . . . . 14
Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 14 Appendix B. Open Issues . . . . . . . . . . . . . . . . . . . . 14
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14
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 a server that utilizes YANG-based and submodules that are in use by a server that implements YANG data
data abstractions. If a large number of YANG modules are utilized by models. If a large number of YANG modules are utilized by the
the server, then the YANG library information needed can be server, then the YANG library contents needed can be relatively
relatively large. This information changes very infrequently, so it large. This information changes very infrequently, so it is
is important that clients be able to cache the YANG library and important that clients be able to cache the YANG library contents and
easily identify if their cache is out-of-date. easily identify whether 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, a firmware change at run-time or across a server reboot.
upgrade is required to change the set of YANG modules used by a
server. If the server implements multiple protocols to access the YANG-
defined data, each such protocol has it's own conceptual
instantiation of the YANG library.
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 name of the YANG module.
library.
o revision: Each YANG module and submodule within the library has a o revision: Each YANG module and submodule within the library has a
revision. This is derived from the most recent revision statement revision. This is derived from the most recent revision statement
within the module or submodule. If no such revision statement within the module or submodule. If no such revision statement
exists, the module's or submodule's revision is the empty string. exists, the module's or submodule's revision is the zero-length
string.
o submodule list: The name and revision of each submodule used by o submodule list: The name and revision of each submodule used by
the 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 MUST 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",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14, [RFC2119]. 14, [RFC2119].
1.1.1. NETCONF
The following terms are defined in [RFC6241]: The following terms are defined in [RFC6241]:
o client o client
o server o server
1.1.2. YANG
The following terms are defined in [RFC6020]: The following terms are defined in [RFC6020]:
o module o module
o submodule o submodule
1.1.3. Terms
The following terms are used within this document: The following terms are used within this document:
o YANG library: a collection of YANG modules and submodules used by o YANG library: a collection of YANG modules and submodules used by
a server a server
1.1.4. Tree Diagrams 1.2. Tree Diagrams
A simplified graphical representation of the data model is used in A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these diagrams is as this document. The meaning of the symbols in these diagrams is as
follows: follows:
o Brackets "[" and "]" enclose list keys. o Brackets "[" and "]" enclose list keys.
o Abbreviations before data node names: "rw" means configuration o Abbreviations before data node names: "rw" means configuration
data (read-write) and "ro" state data (read-only). data (read-write) and "ro" state data (read-only).
skipping to change at page 5, line 5 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-state
+--ro module-set-id string +--ro module-set-id string
+--ro yang-protocol* identityref +--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-type 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
+--ro restricted-protocol* identityref
2.1. modules 2.1. modules-state
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-state/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. 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 them, This leaf allows a client to fetch the module list once, cache it,
and only re-fetch them if the value of this leaf has been changed. and only re-fetch it if the value of this leaf has been changed.
2.1.2. modules/yang-protocol If the value of this leaf changes, the server also generates a
"yang-library-changed" notification, with the new value of
"module-set-id".
This leaf-list identifies the YANG-based protocols that are using the Note that for a NETCONF server that implements YANG 1.1
YANG library. It allows an operator to be aware that multi-protocol [I-D.ietf-netmod-rfc6020bis], a change of the "module-set-id" value
conflicts could potentially occur on a managed device. results in a new value for the :yang-library capability defined in
[I-D.ietf-netmod-rfc6020bis]. 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.
A corresponding leaf-list called 'restricted-protocol' is defined in 2.1.2. modules-state/module
the module entry to identify modules that are not supported by one or
more protocols.
2.1.3. 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 entry in this list module supported by the server. There MUST be an entry in this 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 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-10-18.yang" <CODE BEGINS> file "ietf-yang-library@2016-02-01.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 7, line 11 skipping to change at page 6, line 41
<mailto:mbj@tail-f.com> <mailto:mbj@tail-f.com>
Editor: Kent Watsen Editor: Kent Watsen
<mailto:kwatsen@juniper.net>"; <mailto:kwatsen@juniper.net>";
description description
"This module contains monitoring information about the YANG "This module contains monitoring information about the YANG
modules and submodules that are used within a YANG-based modules and submodules that are used within a YANG-based
server. server.
Copyright (c) 2015 IETF Trust and the persons identified as Copyright (c) 2016 IETF Trust and the persons identified as
authors of the code. All rights reserved. authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
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-03.txt // Note: extracted from draft-ietf-netconf-yang-library-04.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-12-08 { revision 2016-02-01 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC XXXX: YANG Module Library."; "RFC XXXX: YANG Module Library.";
} }
/*
* Typedefs
*/
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.";
} }
identity yang-protocol { /*
description * Groupings
"The base for all YANG-based protocol identifiers."; */
}
identity netconf1.0 {
base yang-protocol;
description "Version 1.0 of the NETCONF protocol";
reference "RFC 4271";
}
identity netconf1.1 {
base yang-protocol;
description "Version 1.1 of the NETCONF protocol";
reference "RFC 6241";
}
identity restconf1.0 {
base yang-protocol;
description "Version 1.0 of the RESTCONF protocol";
reference "draft-ietf-netconf-restconf";
}
grouping module-list { grouping module-list {
description description
"The module data structure is represented as a grouping "The module data structure is represented as a grouping
so it can be reused in configuration or another monitoring so it can be reused in configuration or another monitoring
data structure."; data structure.";
grouping common-leafs { grouping common-leafs {
description description
"Common parameters for YANG modules and submodules."; "Common parameters for YANG modules and submodules.";
skipping to change at page 8, line 44 skipping to change at page 8, line 11
description description
"The YANG module or submodule name."; "The YANG module or submodule name.";
} }
leaf revision { leaf revision {
type union { type union {
type revision-identifier; type revision-identifier;
type string { length 0; } type string { length 0; }
} }
description description
"The YANG module or submodule revision date. "The YANG module or submodule revision date.
An empty string is used if no revision statement A zero-length string is used if no revision statement
is present in the YANG module or submodule."; is present in the YANG module or submodule.";
} }
} }
grouping schema-leaf { grouping schema-leaf {
description description
"Common schema leaf parameter for modules and submodules."; "Common schema leaf parameter for modules and submodules.";
leaf schema { leaf schema {
type inet:uri; type inet:uri;
skipping to change at page 9, line 35 skipping to change at page 8, line 50
leaf namespace { leaf namespace {
type inet:uri; type inet:uri;
mandatory true; mandatory true;
description description
"The XML namespace identifier for this module."; "The XML namespace identifier for this module.";
} }
leaf-list feature { leaf-list feature {
type yang:yang-identifier; type yang:yang-identifier;
description description
"List of YANG feature names from this module that are "List of YANG feature names from this module that are
supported by the server."; supported by the server, regardless whether they are
defined in the module or any included submodule.";
} }
list deviation { list deviation {
key "name revision"; key "name revision";
description description
"List of YANG deviation module names and revisions "List of YANG deviation module names and revisions
used by this server to modify the conformance of used by this server to modify the conformance of
the module associated with this entry. Note that the module associated with this entry. Note that
the same module can be used for deviations for the same module can be used for deviations for
multiple modules, so the same entry MAY appear multiple modules, so the same entry MAY appear
within multiple 'module' entries. within multiple 'module' entries.
If the deviation module is available for download The deviation module MUST be present in the 'module'
from the server then a 'module' entry for that module list, with the same name and revision values.
will exist, with the same name and revision values. The 'conformance-type' value will be 'implement' for
The 'conformance' value will be 'implement' for
the deviation module."; the deviation module.";
uses common-leafs; uses common-leafs;
} }
leaf conformance { leaf conformance-type {
type enumeration { type enumeration {
enum implement { enum implement {
description description
"Indicates that the server implements one or more "Indicates that the server implements one or more
protocol-accessible objects defined in the YANG module protocol-accessible objects defined in the YANG module
identified in this entry. This includes deviation identified in this entry. This includes deviation
statements defined in the module. statements defined in the module.
For YANG 1.1 modules, there MUST NOT be more than one For YANG version 1.1 modules, there is at most one
module entry with conformance 'implement' for a module entry with conformance type 'implement' for a
particular module name. particular module name, since YANG 1.1 requires that
at most one revision of a module is implemented.
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 version 1 modules, there SHOULD NOT be more
one module entry for a particular module name."; than one module entry for a particular module name.";
} }
enum import { enum import {
description description
"Indicates that the server imports reusable definitions "Indicates that the server imports reusable definitions
from the specified revision of the module, but does from the specified revision of the module, but does
not implement any protocol accessible objects from not implement any protocol accessible objects from
this revision. this revision.
Multiple module entries for the same module name MAY Multiple module entries for the same module name MAY
exist. This can occur if multiple modules import the exist. This can occur if multiple modules import the
same module, but specify different revision-dates in same module, but specify different revision-dates in
the import statements. the import statements.";
For import statements that do not specify a revision
date, the most recent revision in the library SHOULD
be used by the server.";
} }
} }
mandatory true; mandatory true;
description description
"Indicates the type of conformance the server is claiming "Indicates the type of conformance the server is claiming
for the YANG module identified by this entry."; for the YANG module identified by this entry.";
} }
container submodules { container submodules {
description description
"Contains information about all the submodules used "Contains information about all the submodules used
skipping to change at page 11, line 17 skipping to change at page 10, line 22
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;
} }
} }
leaf-list restricted-protocol { }
type identityref { }
base yang-protocol;
}
description
"Identifies a protocol that does not use the module
described by this module instance.";
}
} // list module
} // grouping module
container modules { /*
* Operational state data nodes
*/
container modules-state {
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; 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.";
} }
leaf-list yang-protocol { uses module-list;
type identityref { }
base yang-protocol;
/*
* Notifications
*/
notification yang-library-change {
description
"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;
description description
"Identifies a protocol that is using modules described "Contains the module-set-id value representing the
in this library. There SHOULD be one instance of set of modules and submodules supported at the server at
this object for each protocol for each YANG-based the time the notification is generated.";
protocol using this library.";
} }
uses module-list;
} }
} }
<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]. Authorization for access to specific
portions of conceptual data and operations within this module is
provided by the NETCONF access control model (NACM) [RFC6536].
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
important to control read access (e.g., via get, get-config, or important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability: nodes and their sensitivity/vulnerability:
o /modules/module: The module list used in a server implementation o /modules-state/module: The module list used in a server
may help an attacker identify the server capabilities and server implementation may help an attacker identify the server
implementations with known bugs. Server vulnerabilities may be capabilities and server implementations with known bugs. Server
specific to particular modules, module revisions, module features, vulnerabilities may be specific to particular modules, module
or even module deviations. This information is included in each revisions, module features, or even module deviations. This
module entry. For example, if a particular operation on a information is included in each module entry. For example, if a
particular data node is known to cause a server to crash or particular operation on a particular data node is known to cause a
significantly degrade device performance, then the module list server to crash or significantly degrade device performance, then
information will help an attacker identify server implementations the module list information will help an attacker identify server
with such a defect, in order to launch a denial of service attack implementations with such a defect, in order to launch a denial of
on the device. service attack on the device.
5. Acknowledgements 5. Acknowledgements
Contributions to this material by Andy Bierman are based upon work Contributions to this material by Andy Bierman are based upon work
supported by the The Space & Terrestrial Communications Directorate supported by the The Space & Terrestrial Communications Directorate
(S&TCD) under Contract No. W15P7T-13-C-A616. Any opinions, findings (S&TCD) under Contract No. W15P7T-13-C-A616. Any opinions, findings
and conclusions or recommendations expressed in this material are and conclusions or recommendations expressed in this material are
those of the author(s) and do not necessarily reflect the views of those of the author(s) and do not necessarily reflect the views of
The Space & Terrestrial Communications Directorate (S&TCD). The Space & Terrestrial Communications Directorate (S&TCD).
6. Normative References 6. References
6.1. 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,
DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004. DOI 10.17487/RFC3688, January 2004,
<http://www.rfc-editor.org/info/rfc3688>.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010. DOI 10.17487/RFC6020, October 2010,
<http://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, June 2011. (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>.
[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, DOI 10.17487/RFC6242, June 2011,
<http://www.rfc-editor.org/info/rfc6242>.
[RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
July 2013. Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012,
<http://www.rfc-editor.org/info/rfc6536>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<http://www.rfc-editor.org/info/rfc6991>.
6.2. Informative References
[I-D.ietf-netmod-rfc6020bis]
Bjorklund, M., "The YANG 1.1 Data Modeling Language",
draft-ietf-netmod-rfc6020bis-09 (work in progress),
December 2015.
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event
Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008,
<http://www.rfc-editor.org/info/rfc5277>.
[RFC6470] Bierman, A., "Network Configuration Protocol (NETCONF)
Base Notifications", RFC 6470, DOI 10.17487/RFC6470,
February 2012, <http://www.rfc-editor.org/info/rfc6470>.
Appendix A. Change Log Appendix A. Change Log
-- RFC Ed.: remove this section before publication. -- RFC Ed.: remove this section before publication.
A.1. v02 to v03 A.1. v03 to v04
o editorial changes after WGLC
o one library instance per management protocol
o removed protocol defintions
o removed requirements on YANG 1.1 modules (text is moved to draft-
ietf-netmod-rfc6020bis)
o added notification yang-library-change
o changed top-level node name from "modules" to "modules-state"
o changed leaf "conformance" to "conformance-type"
A.2. v02 to v03
o added yang-protocol identity o added yang-protocol identity
o added identities for NETCONF and RESTCONF protocols o added identities for NETCONF and RESTCONF protocols
o added yang-protocol leaf-list to /modules o added yang-protocol leaf-list to /modules
o added restricted-protocol leaf-list to /modules/module o added restricted-protocol leaf-list to /modules/module
A.2. v01 to v02 A.3. v01 to v02
o clarify 'implement' conformance for YANG 1.1 modules o clarify 'implement' conformance for YANG 1.1 modules
A.3. v00 to v01 A.4. v00 to v01
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.4. draft-ietf-netconf-restconf-03 to v00 A.5. draft-ietf-netconf-restconf-03 to v00
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 [1] 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. 67 change blocks. 
188 lines changed or deleted 214 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/