draft-ietf-netconf-rfc7895bis-02.txt   draft-ietf-netconf-rfc7895bis-03.txt 
Network Working Group A. Bierman Network Working Group A. Bierman
Internet-Draft YumaWorks Internet-Draft YumaWorks
Obsoletes: rfc7895 (if approved) M. Bjorklund Obsoletes: rfc7895 (if approved) M. Bjorklund
Intended status: Standards Track Tail-f Systems Intended status: Standards Track Tail-f Systems
Expires: May 3, 2018 K. Watsen Expires: July 21, 2018 J. Schoenwaelder
Jacobs University
K. Watsen
Juniper Networks Juniper Networks
October 30, 2017 R. Wilton
Cisco Systems
January 17, 2018
YANG Library YANG Library
draft-ietf-netconf-rfc7895bis-02 draft-ietf-netconf-rfc7895bis-03
Abstract Abstract
This document describes a YANG library that provides information This document describes a YANG library that provides information
about all the YANG modules and datastores used by a network about all the YANG modules and datastores used by a network
management server (e.g., a Network Configuration Protocol (NETCONF) management server (e.g., a Network Configuration Protocol (NETCONF)
server). Simple caching mechanisms are provided to allow clients to server). Simple caching mechanisms are provided to allow clients to
minimize retrieval of this information. 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 41
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 May 3, 2018. This Internet-Draft will expire on July 21, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2018 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.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4 1.2. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 4
1.3. Motivation for rfc7895bis . . . . . . . . . . . . . . . . 4 1.3. Motivation for rfc7895bis . . . . . . . . . . . . . . . . 4
1.4. Summary of Changes from RFC 7895 . . . . . . . . . . . . 5 1.4. Summary of Changes from RFC 7895 . . . . . . . . . . . . 6
2. YANG Library . . . . . . . . . . . . . . . . . . . . . . . . 6 2. YANG Library . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1. yang-library . . . . . . . . . . . . . . . . . . . . . . 7 2.1. yang-library . . . . . . . . . . . . . . . . . . . . . . 7
2.1.1. yang-library/modules/module . . . . . . . . . . . . . 7 2.1.1. yang-library/checksum . . . . . . . . . . . . . . . . 7
2.1.2. yang-library/module-sets/module-set . . . . . . . . . 8 2.1.2. yang-library/datastore . . . . . . . . . . . . . . . 8
2.1.3. yang-library/datastores/datastore . . . . . . . . . . 8 2.1.3. yang-library/schema . . . . . . . . . . . . . . . . . 8
2.1.4. yang-library/module-set . . . . . . . . . . . . . . . 8
2.1.5. yang-library/module-set/module . . . . . . . . . . . 9
2.1.6. yang-library/module-set/import-only-module . . . . . 9
2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 9 2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 9
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 20 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 21
3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 20 3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 21
4. Security Considerations . . . . . . . . . . . . . . . . . . . 21 4. Security Considerations . . . . . . . . . . . . . . . . . . . 22
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 21 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 22
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 22 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.1. Normative References . . . . . . . . . . . . . . . . . . 22 6.1. Normative References . . . . . . . . . . . . . . . . . . 23
6.2. Informative References . . . . . . . . . . . . . . . . . 23 6.2. Informative References . . . . . . . . . . . . . . . . . 24
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 24
1. Introduction 1. Introduction
There is a need for standard mechanisms to provide the operational There is a need for standard mechanisms to provide the operational
state of a network management server. This includes, for instance, state of a network management server. This includes, for instance,
identifying the YANG modules and datastores that are in use by a identifying the YANG modules and datastores that are in use by a
server and how they relate to each other. server and how they relate to each other.
This document defines a YANG module that can be used to provide this This document defines a YANG module that can be used to provide this
informaton, in a way that is compatible with the NMDA informaton, in a way that is compatible with the NMDA
skipping to change at page 3, line 47 skipping to change at page 4, line 5
o modules: modules supported by the datastore, including any o modules: modules supported by the datastore, including any
features and deviations. features and deviations.
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].
The following terms are defined in [RFC6241]:
o client
o server
The following terms are defined in [RFC7950]: The following terms are defined in [RFC7950]:
o module o module
o submodule o submodule
The following terms are defined in ^NMDA": The following terms are defined in
[I-D.ietf-netmod-revised-datastores]:
o conventional configuration datastore o conventional configuration datastore
o operational datastore o operational state datastore
o operational state
o datastore schema o datastore schema
The following terms are used within this document: o client
o YANG library: A collection of metadata describing the server's o server
operational state.
1.2. Tree Diagrams 1.2. Tree Diagrams
A simplified graphical representation of the data model is used in Tree diagrams used in this document follow the notation defined in
this document. The meaning of the symbols in these diagrams is as [I-D.ietf-netmod-yang-tree-diagrams].
follows:
o Brackets "[" and "]" enclose list keys.
o Abbreviations before data node names: "rw" means configuration
data (read-write) and "ro" state data (read-only).
o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list.
o Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
o Ellipsis ("...") stands for contents of subtrees that are not
shown.
1.3. Motivation for rfc7895bis 1.3. Motivation for rfc7895bis
RFC Ed.: delete this section, including this note, at time of RFC Ed.: delete this section, including this note, at time of
publication. publication.
All NETCONF servers supporting YANG 1.1 [RFC7950] MUST support YANG All NETCONF servers supporting YANG 1.1 [RFC7950] are required to
Library (see Section 5.6.4 of RFC 7950). Similarly, all RESTCONF support YANG Library (see Section 5.6.4 of RFC 7950). Similarly, all
servers MUST support YANG Library (see Section 10 of RFC 8040). RESTCONF servers are required to support YANG Library (see Section 10
of RFC 8040). These requirements are independent of if the server
These requirements are independent of if the server supports NMDA or supports NMDA or not.
not.
RFC 7895 has a mandatory to implement 'modules-state' tree that a RFC 7895 has a mandatory to implement "modules-state" tree that a
server uses to advertise all the modules it supports. However, this server uses to advertise all the modules it supports. However, this
module was designed assuming the all modules would be in all module was designed assuming the all modules would be in all
datastores, and with the same number of features and deviations. datastores, and with the same number of features and deviations.
However, this is not the case with NMDA-compatible servers that may However, this is not the case with NMDA-compatible servers that may
have some modules that only appear in <operational> (e.g., ietf- have some modules that only appear in <operational> (e.g., ietf-
network-topo) or only also appear in a dynamic datastore (e.g., i2rs- network-topo) or only also appear in a dynamic datastore (e.g., i2rs-
ephemeral-rib). It is also possible that a server only implements a ephemeral-rib). It is also possible that a server only implements a
module in <running>, as it hasn't yet coded support for returning the module in <running>, as it hasn't yet coded support for returning the
module's opstate yet. Presumably, an NMDA-supporting server would module's opstate yet. Presumably, an NMDA-supporting server would
return all modules implemented in every datastore, but this would be return all modules implemented in every datastore, but this would be
misleading to existing clients and unhelpful to NMDA-aware clients. misleading to existing clients and unhelpful to NMDA-aware clients.
In the end, it appears that the 'modules-state' node should be for In the end, it appears that the "modules-state" node should be for
non-NMDA aware clients. For backwards compatability, an NMDA- non-NMDA aware clients. For backwards compatability, an NMDA-
supporting server SHOULD populate 'modules-state' in a backwards- supporting server SHOULD populate "modules-state" in a backwards-
compatible manner. The new 'yang-library' node would be ignored by compatible manner. The new "yang-library" node would be ignored by
legacy clients, while providing all the data needed for NMDA-aware legacy clients, while providing all the data needed for NMDA-aware
clients, which would themselves ignore the 'modules-state' tree. clients, which would themselves ignore the "modules-state" tree.
Design objectives:
1. As efficient as possible for a client to consume. Since the size
of the yang library can be quite large, it should be possible for
clients to cache the yang library information.
2. A dynamic configuration datastore must be able to implement a
module or feature that is not implemented in the conventional
datastores.
3. It must be possible to NOT implement a module or feature in
<operational>, even if it is implemented in some other datastore.
This is required for transition purposes; a server that wants to
implement <operational> should not have to implement all modules
at once.
4. A given module can only be implemented in one revision in all
datastores. If a module is implemented in more than one
datastores, the same revision is implemented in all these
datastores.
5. Multiple revisions can be used for import, if import-by revision
is used.
6. Nice to have: make it possible to be used by schema mount
The solution presented in this document is further motivated by the The solution presented in this document is further motivated by the
following desires: following desires:
o leverage Section 5.6.4 of RFC 7950 and Section 10 of RFC 8040. o leverage Section 5.6.4 of RFC 7950 and Section 10 of RFC 8040.
o indicate which modules are supported by each datastore o indicate which modules are supported by each datastore
o enable the features and deviations to vary by datastore o enable the features and deviations to vary by datastore
skipping to change at page 6, line 24 skipping to change at page 6, line 35
o Deprecates the "yang-library-change" notification. o Deprecates the "yang-library-change" notification.
2. YANG Library 2. YANG Library
The "ietf-yang-library" module provides information about the modules The "ietf-yang-library" module provides information about the modules
and datastores supported by a server. This module is defined using and datastores supported by a server. This module is defined using
YANG version 1.1, but it supports the description of YANG modules YANG version 1.1, but it supports the description of YANG modules
written in any revision of YANG. written in any revision of YANG.
All data nodes in "ietf-yang-library" are "config false", and thus
accessible in the operational state datastore.
Following is the YANG Tree Diagram for the "ietf-yang-library" Following is the YANG Tree Diagram for the "ietf-yang-library"
module, excluding the deprecated 'modules-state' tree: module, excluding the deprecated "modules-state" tree:
module: ietf-yang-library module: ietf-yang-library
+--ro yang-library +--ro yang-library
+--ro modules +--ro module-set* [name]
| +--ro module* [id] | +--ro name string
| +--ro id string | +--ro checksum string
| +--ro name yang:yang-identifier | +--ro module* [name]
| +--ro revision? revision-identifier | | +--ro name yang:yang-identifier
| +--ro schema? inet:uri | | +--ro revision? revision-identifier
| +--ro namespace inet:uri | | +--ro namespace inet:uri
| +--ro feature* yang:yang-identifier | | +--ro location* inet:uri
| +--ro deviation* [module] | | +--ro submodule* [name]
| | +--ro module -> ../../id | | | +--ro name yang:yang-identifier
| +--ro conformance-type enumeration | | | +--ro revision? revision-identifier
| +--ro submodule* [name] | | | +--ro location* inet:uri
| +--ro name yang:yang-identifier | | +--ro feature* [name]
| +--ro revision? revision-identifier | | | +--ro name yang:yang-identifier
| +--ro schema? inet:uri | | +--ro deviation* [module]
+--ro module-sets | | +--ro module -> ../../name
| +--ro module-set* [id] | +--ro import-only-module* [name revision]
| +--ro id string | +--ro name yang:yang-identifier
| +--ro module* -> ../../../modules/module/id | +--ro revision union
+--ro datastores | +--ro namespace inet:uri
| +--ro datastore* [name] | +--ro location* inet:uri
| +--ro name identityref | +--ro submodule* [name]
| +--ro module-set | +--ro name yang:yang-identifier
| -> ../../../module-sets/module-set/id | +--ro revision? revision-identifier
+--ro checksum string | +--ro location* inet:uri
+--ro schema* [name]
| +--ro name string
| +--ro checksum string
| +--ro module-set* -> ../../module-set/name
+--ro datastore* [name]
| +--ro name identityref
| +--ro schema -> ../../schema/name
+--ro checksum string
notifications: notifications:
+---n yang-library-update +---n yang-library-update
2.1. yang-library 2.1. yang-library
This container holds all of the server's metadata. This container holds all of the server's metadata.
2.1.1. yang-library/modules/module 2.1.1. yang-library/checksum
This list contains one entry for each unique instance of a module in This mandatory leaf contains a unique implementation-specific
use by the server. Each entry is distinguished by the module's name, identifier representing the current information in the YANG library
revisions, features, and deviations. on a specific server. The value of this leaf MUST change whenever
the the information in the YANG library changes. There is no
requirement that the same information always results in the same
"checksum" value.
A server cannot implement different revisions of the same module in This leaf allows a client to fetch all schema information once, cache
different datastores, so there MUST only be a single revision of a it, and only refetch it if the value of this leaf has been changed.
given module in the "module" list that has a "conformance-type" leaf
of "implement".
Although the server is at liberty to choose the unique "id" for each If the value of this leaf changes, the server also generates a
entry in the "module" list, it is suggested to use an "id" that would "yang-library-update" notification.
be meaningful to clients. For example, "ietf-interfaces@2017-08-17"
could be used as the "id" for a particular revision of the IETF
interfaces YANG module. For a module that holds deviations or
features specific to a datastore perhaps an "id" that also contains
the datastore name, like "ietf-interfaces-deviations@2017-08-17/
operational" could be used.
2.1.2. yang-library/module-sets/module-set Note that for a NETCONF server that implements YANG 1.1 [RFC7950], a
change of the "checksum" value results in a new value for the :yang-
library capability defined in [RFC7950]. 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 "checksum" changes.
A "module-set" represents the datastore schema that is used by one or 2.1.2. yang-library/datastore
more datastores.
This list contains one entry for each module set in use by the server This list contains one entry for each datastore supported by the
server, and identifies the datastore schema associated with a
datastore via a reference to an entry in the "schema" list. Each
supported conventional configuration datastore has a separate entry.
2.1.3. yang-library/schema
An entry in the "schema" list represents the datastore schema that is
used by one or more datastores.
This list contains one entry for each schema in use by the server
(e.g., presented by a datastore). (e.g., presented by a datastore).
All conventional configuration datastores use the same datastore All conventional configuration datastores and the operational state
schema, which can normally be modelled using a single module set. datastore use the same "schema" entry.
A dynamic configuration datastore may use a different datastore A dynamic configuration datastore may use a different datastore
schema from the conventional configuration datastores, and hence may schema from the conventional configuration datastores, and hence may
require a separate module set definition. require a separate "schema" entry.
The datastore schema for the operational datastore is the superset of
the datastore schema of all the configuration datastores, but can
have unsupported nodes removed via datastore specific deviations or
by omitting one or more modules from the module set associated with
the operational datastore.
However, where possible, the same module set used for conventional
configuration datatstores should also be used for the operational
datastore. For example, deviations that are specific to "config
false" nodes could still be applied to a common module instance that
is also included in the module set used for the conventional
datastores.
Although the server is at liberty to choose the unique "id" for the A schema has a leaf-list with references to entries in the
"module-set" list entry, it is suggested to choose an "id" that would "module-set" list. The schema consists of the sum of all modules in
be meaningful to clients, perhaps including the datastore name if the all referenced module sets.
module set is only relevant to a single datastore.
2.1.3. yang-library/datastores/datastore 2.1.4. yang-library/module-set
2.1.5. yang-library/module-set/module
This list contains one entry for each datastore supported by the 2.1.6. yang-library/module-set/import-only-module
server, and identifes the datastore schema associated with a
datastore via a reference to a module-set. Each supported
conventional configuration datastore has a separate entry.
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 modules "ietf-yang-types" and "ietf-inet-types" from [RFC6991] The modules "ietf-yang-types" and "ietf-inet-types" from [RFC6991]
and the module "ietf-datastores" from and the module "ietf-datastores" from
[I-D.ietf-netmod-revised-datastores] are used by this module for some [I-D.ietf-netmod-revised-datastores] are used by this module for some
type definitions. 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@2017-10-30.yang" <CODE BEGINS> file "ietf-yang-library@2018-01-17.yang"
module ietf-yang-library { module ietf-yang-library {
yang-version 1.1; yang-version 1.1;
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;
reference "RFC 6991: Common YANG Data Types."; reference "RFC 6991: Common YANG Data Types.";
} }
skipping to change at page 9, line 52 skipping to change at page 10, line 8
contact contact
"WG Web: <http://tools.ietf.org/wg/netconf/> "WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
Author: Andy Bierman Author: Andy Bierman
<mailto:andy@yumaworks.com> <mailto:andy@yumaworks.com>
Author: Martin Bjorklund Author: Martin Bjorklund
<mailto:mbj@tail-f.com> <mailto:mbj@tail-f.com>
Author: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de>
Author: Kent Watsen Author: Kent Watsen
<mailto:kwatsen@juniper.net>"; <mailto:kwatsen@juniper.net>
Author: Rob Wilton
<rwilton@cisco.com>";
description description
"This module contains information about the YANG server "This module contains information about the YANG server instance,
instance, including the modules and datastores the including the modules and datastores the server supports, and
server supports, and which modules are present in which modules are present in which datastores.
which datastores.
Copyright (c) 2017 IETF Trust and the persons identified as Copyright (c) 2018 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.: 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.
// RFC Ed.: replace XXXX with actual RFC number and remove this // RFC Ed.: replace XXXX with actual RFC number and remove this
// note. // note.
revision 2017-10-30 { revision 2018-01-17 {
description description
"Updated revision."; "Added support for multiple datastores.";
reference reference
"RFC XXXX: YANG Library."; "RFC XXXX: YANG Library.";
} }
revision 2016-04-09 { revision 2016-04-09 {
description description
"Initial revision."; "Initial revision.";
reference reference
"RFC 7895: YANG Module Library."; "RFC 7895: YANG Module Library.";
} }
skipping to change at page 11, line 30 skipping to change at page 11, line 38
} }
leaf revision { leaf revision {
type revision-identifier; type revision-identifier;
description description
"The YANG module or submodule revision date. If no revision "The YANG module or submodule revision date. If no revision
statement is present in the YANG module or submodule, this statement is present in the YANG module or submodule, this
leaf is not instantiated."; leaf is not instantiated.";
} }
} }
grouping schema-leaf { grouping location-leaf-list {
description description
"Common schema leaf parameter for modules and submodules."; "Common location leaf list parameter for modules and
submodules.";
leaf schema { leaf-list location {
type inet:uri; type inet:uri;
description description
"Contains a URL that represents the YANG schema "Contains a URL that represents the YANG schema
resource for this module or submodule. resource for this module or submodule.
This leaf will only be present if there is a URL This leaf will only be present if there is a URL
available for retrieval of the schema for this entry."; available for retrieval of the schema for this entry.";
} }
} }
grouping implementation-parameters { grouping implementation-parameters {
description description
"Parameters for describing the implementation of a module."; "Parameters for describing the implementation of a module.";
leaf-list feature { list feature {
type yang:yang-identifier; key "name";
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, regardless whether they are defined supported by the server, regardless whether they are defined
in the module or any included submodule."; in the module or any included submodule.";
leaf name {
type yang:yang-identifier;
description
"A feature supported by the server.";
}
} }
list deviation { list deviation {
key "module"; key "module";
description description
"List of YANG deviation modules used by "List of YANG deviation modules used by this server to modify
this server to modify the conformance of the module the conformance of the module associated with this entry.
associated with this entry. Note that the same module can Note that the same module can be used for deviations for
be used for deviations for multiple modules, so the same multiple modules, so the same entry MAY appear within
entry MAY appear within multiple 'module' entries."; multiple 'module' entries.";
leaf module { leaf module {
type leafref { type leafref {
path "../../id"; path "../../name";
} }
description description
"The module that deviates the module associated with this "A module that deviates the module associated with this
entry. The deviation modules MUST be part of the same entry.";
module-sets as the module it deviates.";
} }
} }
leaf conformance-type { }
type enumeration {
enum implement {
description
"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.
For YANG version 1 modules, there SHOULD NOT be more grouping module-set-parameters {
than one module entry for a particular module name."; description
} "A set of parameters that describe a module set.";
enum import {
description
"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 leaf name {
exist. This can occur if multiple modules import the type string;
same module, but specify different revision-dates in the description
import statements."; "An arbitrary name of the module set.";
} }
} leaf checksum {
type string;
config false;
mandatory true; mandatory true;
description description
"Indicates the type of conformance the server is claiming "A server-generated checksum of the contents of the module
for the YANG module identified by this entry."; set. The server MUST change the value of this leaf if the
information represented by the module set, except
'checksum', has changed.";
} }
} list module {
key "name";
grouping yang-library-parameters {
description
"The YANG library data structure is represented as a grouping
so it can be reused in configuration or another monitoring
data structure.";
container modules {
description description
"A container holding a list of modules. Modules being "An entry in this list represents a module implemented by the
listed here does not necessarily mean that they are server with a particular set of supported features and
supported by any particular datastore. deviations.
If a module has the value 'implemented' for it's The server implements one or more protocol-accessible
'conformance-type' leaf in the 'module' list, it means that objects defined in the YANG module identified in this entry.
the server supports the rpcs and notifications defined in This includes deviation statements defined in the module.";
the module (adjusted for features and deviations), even if
the module is not supported in any particular datastore.";
list module { uses module-identification-leafs;
key "id";
leaf namespace {
type inet:uri;
mandatory true;
description description
"Each entry represents a revision of a module currently "The XML namespace identifier for this module.";
supported by the server with a particular set of supported }
features and deviations";
leaf id { uses location-leaf-list;
type string;
description
"A unique identifier, independent of any other part
of this module instance.";
}
list submodule {
key "name";
description
"Each entry represents one submodule within the
parent module.";
uses module-identification-leafs; uses module-identification-leafs;
uses schema-leaf; uses location-leaf-list;
}
leaf namespace { uses implementation-parameters;
type inet:uri; }
mandatory true; list import-only-module {
description key "name revision";
"The XML namespace identifier for this module."; description
} "An entry in this list 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.
uses implementation-parameters; Multiple 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.";
list submodule { leaf name {
key "name"; type yang:yang-identifier;
description description
"Each entry represents one submodule within the "The YANG module name.";
parent module."; }
uses module-identification-leafs; leaf revision {
uses schema-leaf; type union {
type revision-identifier;
type string {
length 0;
}
} }
description
"The YANG module or revision date.
A zero-length string is used if no revision statement
is present in the YANG module.";
}
leaf namespace {
type inet:uri;
mandatory true;
description
"The XML namespace identifier for this module.";
} }
}
container module-sets { uses location-leaf-list;
description
"A container for the list of module-sets supported by the
server";
list module-set { list submodule {
key "id"; key "name";
description description
"An arbitrary module-set definition provided by the "Each entry represents one submodule within the
server. parent module.";
A module-set represents a datastore schema associated with uses module-identification-leafs;
one or more datastores. uses location-leaf-list;
}
}
}
Module-sets being listed here does not necessarily mean grouping yang-library-parameters {
that they are used by any particular datastore. description
"The YANG library data structure is represented as a grouping
so it can be reused in configuration or another monitoring
data structure.";
In the case of a configuration datastore, only the config list module-set {
true subset of a datastore schema is applicable to the key name;
datastore, any config false schema nodes and any action description
statements are ignored."; "A set of modules that may be used by one or more schemas.";
leaf id { uses module-set-parameters;
type string;
description
"A system-generated value that uniquely represents the
referenced set of modules. Any change to the number
of modules referenced, or to the modules themselves,
generates a different value.";
}
leaf-list module {
type leafref {
path "../../../modules/module/id";
}
description
"A module-instance supported by the server, including its
features and deviations.";
}
}
} }
container datastores { list schema {
key "name";
description description
"A container for the list of datastores supported by the "A datastore schema that may be used by one or more
server."; datastores.";
list datastore { leaf name {
key "name"; type string;
description description
"A datastore supported by this server. "An arbitrary name of the schema.";
}
leaf checksum {
type string;
config false;
mandatory true;
description
"A server-generated checksum of the contents of the schema.
The server MUST change the value of this leaf if the
information represented by the schema, except 'checksum',
has changed.";
}
leaf-list module-set {
type leafref {
path "../../module-set/name";
}
description
"A set of module-sets that are included in this schema.";
}
}
Each datastore indicates which module-set it supports. list datastore {
key "name";
description
"A datastore supported by this server.
The server MUST instantiate one entry in this list per Each datastore indicates which schema it supports.
specific datastore it supports.
Each datstore entry with the same datastore schema SHOULD The server MUST instantiate one entry in this list per
reference the same module-set."; specific datastore it supports.
leaf name { Each datstore entry with the same datastore schema SHOULD
type identityref { reference the same schema.";
base ds:datastore;
} leaf name {
description type identityref {
"The identity of the datastore."; base ds:datastore;
} }
leaf module-set { description
type leafref { "The identity of the datastore.";
path "../../../module-sets/module-set/id"; }
} leaf schema {
mandatory true; type leafref {
description path "../../schema/name";
"A reference to the module-set supported by this
datastore";
} }
mandatory true;
description
"A reference to the schema supported by this datastore.";
} }
} }
} }
/* /*
* Top-level container * Top-level container
*/ */
container yang-library { container yang-library {
config false; config false;
description description
"Container providing all the YANG meta information the "Container providing all the YANG meta information the
server possesses."; server possesses.";
skipping to change at page 16, line 18 skipping to change at page 16, line 42
container yang-library { container yang-library {
config false; config false;
description description
"Container providing all the YANG meta information the "Container providing all the YANG meta information the
server possesses."; server possesses.";
uses yang-library-parameters; uses yang-library-parameters;
leaf checksum { leaf checksum {
type string; type string;
config false;
mandatory true; mandatory true;
description description
"A server-generated checksum of the contents of the "A server-generated checksum of the contents of the
'yang-library' tree. The server MUST change the value of 'yang-library' tree. The server MUST change the value of
this leaf if the information represented by the this leaf if the information represented by the
'yang-library' tree, except yang-library/checksum, has 'yang-library' tree, except 'yang-library/checksum', has
changed."; changed.";
} }
} }
/* /*
* Notifications * Notifications
*/ */
notification yang-library-update { notification yang-library-update {
description description
"Generated when any YANG library information on the "Generated when any YANG library information on the
server has changed."; server has changed.";
} }
skipping to change at page 17, line 27 skipping to change at page 17, line 50
length 0; length 0;
} }
} }
status deprecated; status deprecated;
description description
"The YANG module or submodule revision date. "The YANG module or submodule revision date.
A zero-length 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 {
status deprecated;
description
"Common schema leaf parameter for modules and submodules.";
leaf schema {
type inet:uri;
description
"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 { list module {
key "name revision"; key "name revision";
status deprecated; status deprecated;
description description
"Each entry represents one revision of one module "Each entry represents one revision of one module
currently supported by the server."; currently supported by the server.";
uses common-leafs { uses common-leafs {
status deprecated; status deprecated;
skipping to change at page 21, line 17 skipping to change at page 22, line 7
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
reference: RFC 7895 reference: RFC 7895
This document takes over this registration entry made by RFC 7895. This document takes over this registration entry made by RFC 7895.
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 document is designed to be accessed
the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the via network management protocols such as NETCONF [RFC6241] or
secure transport layer and the mandatory-to-implement secure RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport
transport is SSH [RFC6242]. The NETCONF access control model layer, and the mandatory-to-implement secure transport is Secure
[RFC6536] provides the means to restrict access for particular Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the
NETCONF users to a pre-configured subset of all available NETCONF mandatory-to-implement secure transport is TLS [RFC5246].
protocol operations and content.
The NETCONF access control model [RFC6536] provides the means to
restrict access for particular NETCONF or RESTCONF users to a
preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content.
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-state/module: The module list used in a server o /yang-library/schema: The schema list used in a server
implementation may help an attacker identify the server implementation may help an attacker identify the server
capabilities and server implementations with known bugs. Although capabilities and server implementations with known bugs. Although
some of this information may be available to all users via the some of this information may be available to all users via the
NETCONF <hello> message (or similar messages in other management NETCONF <hello> message (or similar messages in other management
protocols), this YANG module potentially exposes additional protocols), this YANG module potentially exposes additional
details that could be of some assistance to an attacker. Server details that could be of some assistance to an attacker. Server
vulnerabilities may be specific to particular modules, module vulnerabilities may be specific to particular modules, module
revisions, module features, or even module deviations. This revisions, module features, or even module deviations. This
information is included in each module entry. For example, if a information is included in each module entry. For example, if a
particular operation on a particular data node is known to cause a particular operation on a particular data node is known to cause a
skipping to change at page 22, line 14 skipping to change at page 23, line 12
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. References 6. References
6.1. Normative References 6.1. Normative References
[I-D.ietf-netmod-revised-datastores] [I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-05 Architecture", draft-ietf-netmod-revised-datastores-10
(work in progress), October 2017. (work in progress), January 2018.
[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, Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/
DOI 10.17487/RFC2119, March 1997, <https://www.rfc- RFC2119, March 1997, <https://www.rfc-editor.org/info/
editor.org/info/rfc2119>. rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, <https://www.rfc- DOI 10.17487/RFC3688, January 2004, <https://www.rfc-
editor.org/info/rfc3688>. editor.org/info/rfc3688>.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, DOI 10.17487/
RFC5246, August 2008, <https://www.rfc-editor.org/info/
rfc5246>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, <https://www.rfc- DOI 10.17487/RFC6020, October 2010, <https://www.rfc-
editor.org/info/rfc6020>. 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, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://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, DOI 10.17487/RFC6242, June 2011, Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>. <https://www.rfc-editor.org/info/rfc6242>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, Protocol (NETCONF) Access Control Model", RFC 6536, DOI
DOI 10.17487/RFC6536, March 2012, <https://www.rfc- 10.17487/RFC6536, March 2012, <https://www.rfc-
editor.org/info/rfc6536>. editor.org/info/rfc6536>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC
RFC 6991, DOI 10.17487/RFC6991, July 2013, 6991, DOI 10.17487/RFC6991, July 2013, <https://www.rfc-
<https://www.rfc-editor.org/info/rfc6991>. editor.org/info/rfc6991>.
[RFC7895] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Module
Library", RFC 7895, DOI 10.17487/RFC7895, June 2016,
<https://www.rfc-editor.org/info/rfc7895>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>. <https://www.rfc-editor.org/info/rfc8040>.
6.2. Informative References 6.2. Informative References
[I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
ietf-netmod-yang-tree-diagrams-04 (work in progress),
December 2017.
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event
Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008,
<https://www.rfc-editor.org/info/rfc5277>. <https://www.rfc-editor.org/info/rfc5277>.
[RFC6470] Bierman, A., "Network Configuration Protocol (NETCONF) [RFC6470] Bierman, A., "Network Configuration Protocol (NETCONF)
Base Notifications", RFC 6470, DOI 10.17487/RFC6470, Base Notifications", RFC 6470, DOI 10.17487/RFC6470,
February 2012, <https://www.rfc-editor.org/info/rfc6470>. February 2012, <https://www.rfc-editor.org/info/rfc6470>.
[RFC7895] Bierman, A., Bjorklund, M., and K. Watsen, "YANG Module
Library", RFC 7895, DOI 10.17487/RFC7895, June 2016,
<https://www.rfc-editor.org/info/rfc7895>.
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
Juergen Schoenwaelder
Jacobs University
Email: j.schoenwaelder@jacobs-university.de
Kent Watsen Kent Watsen
Juniper Networks Juniper Networks
Email: kwatsen@juniper.net Email: kwatsen@juniper.net
Robert Wilton
Cisco Systems
Email: rwilton@cisco.com
 End of changes. 100 change blocks. 
307 lines changed or deleted 376 lines changed or added

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