draft-ietf-netconf-rfc7895bis-00.txt   draft-ietf-netconf-rfc7895bis-01.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
Updates: rfc7950, rfc8040 (if approved) Tail-f Systems Intended status: Standards Track Tail-f Systems
Intended status: Standards Track K. Watsen Expires: March 4, 2018 K. Watsen
Expires: February 25, 2018 Juniper Networks Juniper Networks
August 24, 2017 August 31, 2017
YANG Library YANG Library
draft-ietf-netconf-rfc7895bis-00 draft-ietf-netconf-rfc7895bis-01
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 used by a network management server (e.g., about all the YANG modules used by a network management server (e.g.,
a Network Configuration Protocol (NETCONF) server). Simple caching a Network Configuration Protocol (NETCONF) server). Simple caching
mechanisms are provided to allow clients to minimize retrieval of mechanisms are provided to allow clients to minimize retrieval of
this information. this information.
Status of This Memo Status of This Memo
skipping to change at page 1, line 37 skipping to change at page 1, line 37
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on February 25, 2018. This Internet-Draft will expire on March 4, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 15 skipping to change at page 2, line 15
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 . . . . . . . . . . . . 5
1.5. Summary of Updates to RFC 7950 . . . . . . . . . . . . . 6 2. YANG Library . . . . . . . . . . . . . . . . . . . . . . . . 5
1.6. Summary of Updates to RFC 8040 . . . . . . . . . . . . . 6 2.1. yang-library . . . . . . . . . . . . . . . . . . . . . . 6
1.7. Open Issues . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.1. yang-library/modules/module . . . . . . . . . . . . . 6
2. YANG Library . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.2. yang-library/module-sets/module-set . . . . . . . . . 7
2.1. yang-library . . . . . . . . . . . . . . . . . . . . . . 9 2.1.3. yang-library/datastores/datastore . . . . . . . . . . 7
2.1.1. yang-library/modules/module . . . . . . . . . . . . . 9 2.2. YANG Library Module . . . . . . . . . . . . . . . . . . . 7
2.1.2. yang-library/module-sets/module-set . . . . . . . . . 9 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18
2.1.3. yang-library/datastores/datastore . . . . . . . . . . 9 3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 18
2.2. modules-state . . . . . . . . . . . . . . . . . . . . . . 9 4. Security Considerations . . . . . . . . . . . . . . . . . . . 18
2.2.1. modules-state/module-set-id . . . . . . . . . . . . . 9 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 19
2.2.2. modules-state/module . . . . . . . . . . . . . . . . 10 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 19
2.3. YANG Library Module . . . . . . . . . . . . . . . . . . . 10 6.1. Normative References . . . . . . . . . . . . . . . . . . 19
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 20 6.2. Informative References . . . . . . . . . . . . . . . . . 20
3.1. YANG Module Registry . . . . . . . . . . . . . . . . . . 20 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 21
4. Security Considerations . . . . . . . . . . . . . . . . . . . 21
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 21
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.1. Normative References . . . . . . . . . . . . . . . . . . 21
6.2. Informative References . . . . . . . . . . . . . . . . . 23
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23
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 the server. This includes, for instance, identifying the state of the server. This includes, for instance, identifying the
YANG modules and datastores that are in use by a server and how they YANG modules and datastores that are in use by a server and how they
relate to each other. relate to each other.
If a large number of YANG modules are utilized by the server, then If a large number of YANG modules are utilized by the server, then
the YANG library contents needed can be relatively large. This the YANG library contents needed can be relatively large. This
skipping to change at page 3, line 14 skipping to change at page 3, line 10
If the server implements multiple protocols to access the YANG- If the server implements multiple protocols to access the YANG-
defined data, each such protocol has its own conceptual instantiation defined data, each such protocol has its own conceptual instantiation
of the YANG library. 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 identifier: a unique identifier for the module that includes the o identifier: a unique identifier for the module that includes the
module's name, revision, features, and deviations. module's name, revision, submodules, features, and deviations.
o name: The name of the YANG module. o name: The name of the YANG module.
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 zero-length exists, the module's or submodule's revision is the zero-length
string. 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
skipping to change at page 3, line 39 skipping to change at page 3, line 35
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, in a given context, MUST be identified. statements, in a given context, MUST be identified.
The following information is needed by a client application (for each The following information is needed by a client application (for each
datastore supported by the server) to fully access all the YANG- datastore supported by the server) to fully access all the YANG-
modelled data available on the server: modelled data available on the server:
o identity: the YANG identity for the datastore. o identity: the YANG identity for the datastore.
o properties: properties supported by the datastore.
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].
skipping to change at page 5, line 43 skipping to change at page 5, line 37
o provide a top-level container for all server metadata o provide a top-level container for all server metadata
1.4. Summary of Changes from RFC 7895 1.4. Summary of Changes from RFC 7895
This document updates [RFC7895] in the following ways: This document updates [RFC7895] in the following ways:
o Renames document title from "YANG Module Library" to "YANG o Renames document title from "YANG Module Library" to "YANG
Library". Library".
o Adds new top-level "yang-library" container to hold many types of o Adds a new top-level "yang-library" container to hold many types
server metadata: modules supported, datastores supported, of server metadata: modules supported, datastores supported,
relationships between datastores and modules, etc. relationships between datastores and modules, etc.
o Deprecates the modules-state tree. o Deprecates the "modules-state" tree.
1.5. Summary of Updates to RFC 7950
This document updates [RFC7950] in the following ways:
1. Section 5.6.4 says:
A NETCONF server MUST announce the modules it implements (see
Section 5.6.5) by implementing the YANG module "ietf-yang-library"
defined in [RFC7895] and listing all implemented modules in the
"/modules-state/module" list.
This should be updated to allow for also listing all implemented
modules in the "/yang-library/modules/module" list or, more
generally, use the entire YANG Library.
2. Section 5.6.4 also says:
The parameter "module-set-id" has the same value as the leaf
"/modules-state/module-set-id" from "ietf-yang-library". This
parameter MUST be present.
This should be updated to say that, for NMDA-capable servers, this
parameter has the same value as the leaf
"/yang-library/module-sets/module-set/id", for the module-set that is
used by <running>.
1.6. Summary of Updates to RFC 8040
This document updates [RFC8040] in the following ways:
1. Section 10.1 says that the "modules-state/module" list is
mandatory. This should be updated to allow for also listing all
supported modules in the "/yang-library/modules/module" list or, more
generally, use the entire YANG Library.
1.7. Open Issues
o The per-datastore 'properties' idea is still being discussed. o Deprecates the "module-list" grouping.
It's included here so as to provide something to point at.
o There's debate if there should be a list of module-sets or if o Deprecates the "yang-library-change" notification.
instead each 'module-set' should be embeded into the datastore
definition. This discussion goes into if a datastore can
reference more than one module-set.
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
used by a server. This module is defined using YANG version 1, but used by a server. This module is defined using YANG version 1, but
it supports the description of YANG modules written in any revision it supports the description of YANG modules written in any revision
of YANG. of YANG.
Following is the YANG Tree Diagram for the "ietf-yang-library" Following is the YANG Tree Diagram for the "ietf-yang-library"
module, including the deprecated 'modules-state' tree: module, excluding the deprecated 'modules-state' tree:
+--ro yang-library module: ietf-yang-library
| +--ro modules +--ro yang-library
| | +--ro module* [id] +--ro modules
| | +--ro id string | +--ro module* [id]
| | +--ro name? yang:yang-identifier | +--ro id string
| | +--ro revision? union | +--ro name yang:yang-identifier
| | +--ro schema? inet:uri | +--ro revision union
| | +--ro namespace inet:uri | +--ro schema? inet:uri
| | +--ro feature* yang:yang-identifier | +--ro namespace inet:uri
| | +--ro deviation* [name revision] | +--ro feature* yang:yang-identifier
| | | +--ro name yang:yang-identifier | +--ro deviation* [name revision]
| | | +--ro revision union | | +--ro name yang:yang-identifier
| | +--ro conformance-type enumeration | | +--ro revision union
| | +--ro submodule* [name revision] | +--ro conformance-type enumeration
| | +--ro name yang:yang-identifier | +--ro submodule* [name revision]
| | +--ro revision union | +--ro name yang:yang-identifier
| | +--ro schema? inet:uri | +--ro revision union
| +--ro module-sets | +--ro schema? inet:uri
| | +--ro module-set* +--ro module-sets
| | +--ro id? string | +--ro module-set* [id]
| | +--ro module* -> /yang-library/modules/module/id | +--ro id string
| +--ro datastores | +--ro module* -> ../../../modules/module/id
| +--ro datastore* [name] +--ro datastores
| +--ro name identityref | +--ro datastore* [name]
| +--ro properties | +--ro name identityref
| | +--ro property* identityref | +--ro module-set?
| +--ro module-set? -> /yang-library/module-sets/module-set/id | -> ../../../module-sets/module-set/id
x--ro modules-state +--ro checksum string
+--ro module-set-id string
+--ro module* [name revision] notifications:
+--ro name yang:yang-identifier +---n yang-library-update
+--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. yang-library 2.1. yang-library
This mandatory container holds all of the server's metadata. This mandatory container holds all of the server's metadata.
2.1.1. yang-library/modules/module 2.1.1. yang-library/modules/module
This mandatory list contains one entry for each unique instance of a This mandatory list contains one entry for each unique instance of a
module in use by the server. Each entry is distiguished by the module in use by the server. Each entry is distiguished by the
module's name, revisions, features, and deviations. module's name, revisions, features, and deviations.
skipping to change at page 9, line 26 skipping to change at page 7, line 16
This mandatory list contains one entry for each module-set in use by This mandatory list contains one entry for each module-set in use by
the server (e.g., presented by a datastore). the server (e.g., presented by a datastore).
2.1.3. yang-library/datastores/datastore 2.1.3. yang-library/datastores/datastore
This mandatory list contains one entry for each datastore supported This mandatory list contains one entry for each datastore supported
by the server. Each datastore entry both identifies any special by the server. Each datastore entry both identifies any special
propoerties it has and any module-sets it uses. propoerties it has and any module-sets it uses.
2.2. modules-state 2.2. YANG Library Module
This mandatory container holds the identifiers for the YANG data
model modules supported by the server.
2.2.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 [RFC7950], a
change of the "module-set-id" 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
"module-set-id" changes.
2.2.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.3. 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-07-03.yang" <CODE BEGINS> file "ietf-yang-library@2017-08-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.";
} }
import ietf-inet-types { import ietf-inet-types {
prefix inet; prefix inet;
reference "RFC 6991: Common YANG Data Types."; reference "RFC 6991: Common YANG Data Types.";
} }
import ietf-datastores { import ietf-datastores {
prefix ds; prefix ds;
reference "I-D.ietf-revised-datastoes: reference "I-D.ietf-revised-datastores:
Network Management Datastore Architecture."; Network Management Datastore Architecture.";
} }
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
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: Kent Watsen Author: Kent Watsen
<mailto:kwatsen@juniper.net>"; <mailto:kwatsen@juniper.net>";
description description
"This module contains monitoring information about the YANG "This module contains information about the YANG server
modules and submodules that are used within a YANG-based instance, including the modules and datastores the
server. server supports, and which modules are present in
which datastores.
Copyright (c) 2016 IETF Trust and the persons identified as Copyright (c) 2017 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-07-03 { revision 2017-08-17 {
description description
"Updated revision."; "Updated revision.";
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.";
} }
/* /*
* Typedefs * 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
"Represents a specific date in YYYY-MM-DD format.";
} }
description
"Represents a specific date in YYYY-MM-DD format.";
}
/* /*
* Groupings * Groupings
*/ */
grouping common-leafs2 {
description
"Common parameters for YANG modules and submodules.";
leaf name { grouping module-identification-leafs {
type yang:yang-identifier;
description description
"The YANG module or submodule name."; "Parameters for identifying YANG modules and submodules.";
leaf name {
type yang:yang-identifier;
mandatory true;
description
"The YANG module or submodule name.";
}
leaf revision {
type union {
type revision-identifier;
type string { length 0; }
}
mandatory true;
description
"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.";
}
} }
leaf revision {
type union { grouping schema-leaf {
type revision-identifier; description
type string { length 0; } "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.";
} }
}
grouping implementation-parameters {
description description
"The YANG module or submodule revision date. "Parameters for describing the implementation of a module.";
A zero-length string is used if no revision statement
is present in the YANG module or submodule."; leaf-list feature {
type yang:yang-identifier;
description
"List of YANG feature names from this module that are
supported by the server, regardless whether they are defined
in the module or any included submodule.";
}
list deviation {
key "name revision";
description
"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 module-identification-leafs;
}
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
than one module entry for a particular module name.";
}
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
exist. This can occur if multiple modules import the
same module, but specify different revision-dates in the
import statements.";
}
}
mandatory true;
description
"Indicates the type of conformance the server is claiming
for the YANG module identified by this entry.";
}
} }
}
grouping schema-leaf2 { grouping yang-library-parameters {
description description
"Common schema leaf parameter for modules and submodules."; "The YANG library data structure is represented as a grouping
so it can be reused in configuration or another monitoring
data structure.";
leaf schema { container modules {
type inet:uri; description
"A container holding a list of modules. Note, modules being
listed here does not mean that they are supported by any
particular datastore.";
list module {
key "id";
description
"Each entry represents one revision of one module
currently supported by the server.";
leaf id {
type string;
description
"A stable identifier, independent of any other part
of this module instance.";
}
uses module-identification-leafs;
uses schema-leaf;
leaf namespace {
type inet:uri;
mandatory true;
description
"The XML namespace identifier for this module.";
}
uses implementation-parameters;
list submodule {
key "name revision";
description
"Each entry represents one submodule within the
parent module.";
uses module-identification-leafs;
uses schema-leaf;
}
}
}
container module-sets {
description
"A container for a list of module-sets. Module-sets being
listed here does not mean that they are used by any
particular datastore.";
list module-set {
key "id";
description
"An arbitrary module-set definition provided by the
server.";
leaf id {
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 {
description
"A container for a list of datastores supported by the
server. Each datastore indicates which module-sets it
supports.";
list datastore {
key "name";
leaf name {
type identityref {
base ds:datastore;
}
description
"The identity of the datastore.";
}
leaf module-set {
type leafref {
path "../../../module-sets/module-set/id";
}
description
"A reference to a module-set supported by this
datastore";
}
description
"A datastore supported by this server.";
}
}
}
/*
* Top-level container
*/
container yang-library {
config false;
description description
"Contains a URL that represents the YANG schema "Container providing all the YANG meta information the
resource for this module or submodule. server possesses.";
This leaf will only be present if there is a URL uses yang-library-parameters;
available for retrieval of the schema for this entry.";
leaf checksum {
type string;
config false;
mandatory true;
description
"A server-generated checksum of the contents of the
'yang-library' tree. The server MUST change the value of
this leaf if the information represented by the
'yang-library' tree, except yang-library/checksum, has
changed.";
}
} }
}
/* /*
* Top-level container * Notifications
*/ */
container yang-library {
config false;
description
"Top-level resource providing all the meta information the
server possesses.";
container modules { notification yang-library-update {
description description
"A container holding a list of modules. Note, modules being "Generated when any YANG library information on the
listed here does not mean that they are supported by any server has changed.";
particular datastore."; }
list module { /*
key "id"; * Legacy groupings
*/
grouping module-list {
status deprecated;
description
"The module data structure is represented as a grouping
so it can be reused in configuration or another monitoring
data structure.";
grouping common-leafs {
status deprecated;
description description
"Each entry represents one revision of one module "Common parameters for YANG modules and submodules.";
currently supported by the server.";
leaf id { leaf name {
type string; type yang:yang-identifier;
status deprecated;
description description
"A system-generated value that uniquely represents the "The YANG module or submodule name.";
module listing, including its name, revision, features,
and deviations.";
} }
leaf revision {
type union {
type revision-identifier;
type string {
length 0;
}
}
status deprecated;
description
"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.";
}
}
uses common-leafs2; list module {
uses schema-leaf2; key "name revision";
status deprecated;
description
"Each entry represents one revision of one module
currently supported by the server.";
uses common-leafs {
status deprecated;
}
uses schema-leaf {
status deprecated;
}
leaf namespace { leaf namespace {
type inet:uri; type inet:uri;
mandatory true; mandatory true;
status deprecated;
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;
status deprecated;
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 supported by the server, regardless whether they are
defined in the module or any included submodule."; defined in the module or any included submodule.";
} }
list deviation { list deviation {
key "name revision"; key "name revision";
status deprecated;
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.
The deviation module MUST be present in the 'module' The deviation module MUST be present in the 'module'
list, with the same name and revision values. list, with the same name and revision values.
The 'conformance-type' value will be 'implement' for The 'conformance-type' value will be 'implement' for
the deviation module."; the deviation module.";
uses common-leafs2; uses common-leafs {
status deprecated;
}
} }
leaf conformance-type { 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.
skipping to change at page 15, line 4 skipping to change at page 16, line 42
"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.";
} }
} }
mandatory true; mandatory true;
status deprecated;
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.";
} }
list submodule { list submodule {
key "name revision"; key "name revision";
status deprecated;
description description
"Each entry represents one submodule within the "Each entry represents one submodule within the
parent module."; parent module.";
uses common-leafs2; uses common-leafs {
uses schema-leaf2; status deprecated;
}
}
}
container module-sets {
description
"A container for a list of module-sets. Module-sets being
listed here does not mean that they are used by any
particular datastore.";
list module-set {
description
"An arbitrary module-set definition provided by the server.";
leaf id {
type string;
description
"A server-supplied identifier for this set of modules.";
}
leaf-list module {
type leafref {
path "/yang-library/modules/module/id";
}
description
"A module-instance supported by the server, including its
features and deviations.";
}
}
}
container datastores {
description
"A container for a list of datastores supported by the server.
Each datastore indicates which module-sets it supports.";
list datastore {
key name;
leaf name {
type identityref {
base ds:datastore;
}
description
"The identity of the datastore.";
}
container properties {
leaf-list property {
type identityref {
base ds:property;
}
description
"A property of the datastore.";
} }
description uses schema-leaf {
"A list of properties supported by this datastore."; status deprecated;
}
leaf module-set {
type leafref {
path "/yang-library/module-sets/module-set/id";
} }
description
"A reference to a module-set supported by this datastore";
} }
description
"A datastore supported by this server.";
}
} // end 'datastores'
} // end 'yang-library'
/*
* Legacy groupings
*/
grouping module-list {
description
"The module data structure is represented as a grouping
so it can be reused in configuration or another monitoring
data structure.";
grouping common-leafs {
description
"Common parameters for YANG modules and submodules.";
leaf name {
type yang:yang-identifier;
description
"The YANG module or submodule name.";
}
leaf revision {
type union {
type revision-identifier;
type string { length 0; }
}
description
"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 { /*
description * Legacy operational state data nodes
"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 { container modules-state {
key "name revision"; config false;
status deprecated;
description description
"Each entry represents one revision of one module "Contains YANG module monitoring information.";
currently supported by the server.";
uses common-leafs;
uses schema-leaf;
leaf namespace { leaf module-set-id {
type inet:uri; type string;
mandatory true; mandatory true;
status deprecated;
description description
"The XML namespace identifier for this module."; "Contains a server-specific identifier representing
} the current set of modules and submodules. The
leaf-list feature { server MUST change the value of this leaf if the
type yang:yang-identifier; information represented by the 'module' list instances
description has changed.";
"List of YANG feature names from this module that are
supported by the server, regardless whether they are
defined in the module or any included submodule.";
} }
list deviation {
key "name revision";
description
"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' uses module-list {
list, with the same name and revision values. status deprecated;
The 'conformance-type' value will be 'implement' for
the deviation module.";
uses common-leafs;
} }
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 * Legacy notifications
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 notification yang-library-change {
than one module entry for a particular module name."; status deprecated;
} description
enum import { "Generated when the set of modules and submodules supported
description by the server has changed.";
"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 module-set-id {
exist. This can occur if multiple modules import the type leafref {
same module, but specify different revision-dates in path "/yanglib:modules-state/yanglib:module-set-id";
the import statements.";
}
} }
mandatory true; mandatory true;
status deprecated;
description description
"Indicates the type of conformance the server is claiming "Contains the module-set-id value representing the
for the YANG module identified by this entry."; set of modules and submodules supported at the server
} at the time the notification is generated.";
list submodule {
key "name revision";
description
"Each entry represents one submodule within the
parent module.";
uses common-leafs;
uses schema-leaf;
} }
} }
}
/*
* Legacy operational state data nodes
*/
container modules-state {
config false;
status deprecated;
description
"Contains YANG module monitoring information.";
leaf module-set-id {
type string;
mandatory true;
description
"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 {
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
"Contains the module-set-id value representing the
set of modules and submodules supported at the server at
the time the notification is generated.";
}
}
}
<CODE ENDS> <CODE ENDS>
3. IANA Considerations 3. IANA Considerations
3.1. YANG Module Registry 3.1. YANG Module Registry
RFC 7895 previously registered one URI in the IETF XML registry RFC 7895 previously registered one URI in the IETF XML registry
[RFC3688]. Following the format in RFC 3688, the following [RFC3688]. Following the format in RFC 3688, the following
registration was made: registration was made:
 End of changes. 78 change blocks. 
499 lines changed or deleted 452 lines changed or added

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