| Network Working Group | A. Bierman |
| Internet-Draft | YumaWorks |
| Intended status: Standards Track | June 21, 2014 |
| Expires: December 23, 2014 |
YANG Conformance Specification
draft-bierman-netmod-yang-conformance-03
This document describes conformance specification and advertisement mechanisms for NETCONF servers implementing YANG data model modules.
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 23, 2014.
Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.
There is a need for standard mechanisms to allow YANG [RFC6020] data model designers to express more precise and robust conformance levels for server implementations of a particular YANG module, or set of YANG modules.
There is also a need for standard mechanisms to allow NETCONF [RFC6241] servers to precisely advertise the conformance level of each YANG module it supports.
This document describes some problems with the current conformance specifications mechanisms in YANG and conformance advertisement mechanisms in NETCONF. Solution proposals are also presented to address these problems.
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14, [RFC2119].
The following terms are defined in [RFC6241]:
The following terms are defined in [RFC6020]:
The following terms are used within this document:
This section describes some perceived deficiencies with the current data model conformance specification and server conformance advertisement mechanisms used in NETCONF.
The YANG data modeling language provides many powerful data modeling constructs to allow the automation of network configuration protocol operations. However it does not provide enough control over the precise server conformance levels that a client can expect. This has a negative impact on interoperability.
A YANG module is conceptually divided into the module base and zero or more purely optional YANG feature sets.
This approach does not allow enough flexibility and can become difficult to use as the module size and number of YANG feature statements increases. A set of boolean flags that are logically combined as an "AND" expression is too simplistic a mechanism for expressing the criteria for specifying conditional conformance requirements.
YANG provides a mechanism to import an exact revision of an external module in order to freeze conformance requirements for a module. If this is not used then the YANG compiler will most likely use the latest revision of the imported module that happens to be implemented by the server.
If new data nodes, notifications, or protocol operations are added to an imported module over time, then it can appear to a NETCONF client that the new objects are implemented if the imported module is updated but not all the modules that import it. Objects using imported typedefs will change syntax and semantics if the typedef (or any typedef it refines) is changed.
Unless import-by-revision is used everywhere an import is used within the dependency chain, the exact module definition cannot really be frozen for conformance purposes.
A server is not required to support multiple revisions of the same module at the same time. This may be very confusing to the client, and complex to implement as well. Instead, servers usually allow only one revision of each module to be implemented within the system.
If import-by-revision is used, then creating a new revision of the imported module requires that the import statements in all the importing modules be updated to use the new revision date. This requires a revision change, so any module that imports those modules also needs to be updated to specify the new revision date of those importing modules. This ripple effect can cause a lot of modules to be updated. It may not be possible to update a module import date in some cases, if that would incorrectly advertise to the client that new objects were implemented by the server.
Conformance requirements can change over time. New use cases and new consensus about optionality can occur. A conformance statement for each use-case is needed, not just one or more (implied) conformance statements per module.
There are no mechanisms to clearly specify external module dependencies. There is no way to indicate the exact portions of an imported module which are required to comply with a particular conformance level for the importing module. There is no way to specify that multiple modules are required to provide a high-level service.
It is impossible to predict all valid use cases at design time. Partitioning a module into a base plus purely optional features can only account for the features and use cases known at the time. Future designers cannot alter if-feature statements or add new if-feature statements to an augmented module.
YANG features are purely optional to implement. There is no way to specify that a set of objects are conditionally mandatory, based on some data-model specific criteria. Conditions could be expressed with XPath must or when expressions, but this has to be repeated everywhere it is used and the set of objects with the same conditionally mandatory properties is un-named and hard for the reader to identify.
YANG features are too simplistic. They are good for a small number of use-cases within one module. Once there are lots of features, interactions between features, and refined use-cases, they turn the module into a bowl of boolean spaghetti.
YANG features are not really purely optional in practice. Sometimes they are used to express separate roles or service subsets within the module. It is difficult for the reader to identify the valid combinations of purely optional YANG features that represent high-level roles. The YANG if-feature statements are logically combined as a boolean "AND" expression and not very flexible. YANG description statements are not really machine parsable, so these high-level roles or service groupings are not easily identifiable.
YANG deviations could possibly be used as a low-level conformance solution, but they are undesirable and not used by server vendors. YANG deviation statements provide a fairly comprehensive "patch" mechanism to conceptually alter YANG data definition statements. This alteration, or declaration of non-implementation, describes how a server deviates from the standard data definitions.
These statements are not allowed to appear in standard YANG modules, and it turns out that vendors would rather not specify exactly how their server is non-compliant to a standard YANG module. A vendor would rarely need a deviation statement for their own YANG data modules.
YANG deviation statements are too low-level anyway, even if vendors were willing to use them. They do not fully address the future use-case problem because they can only be used to make specific patches to data statements.
YANG conformance applies only to one module. There are no mechanisms to precisely identify the conformance relationship between modules. Since YANG is designed to be modular and reusable, it is quite likely that a high-level feature or service will be specified with more than one YANG module.
All the top-level definitions are imported from a module whether the importing module uses all the definitions or not. This is too general from a conformance perspective. Sometimes modules are imported just for typedefs or identities, which are always part of the base.
If a module augments a node in another module, it does not imply that it supports all other objects from that module. YANG conformance does not actually address any relationship between modules. There are no mechanisms to express multi-module conformance requirements.
It is difficult for a client application developer to identify the high level server capabilities from a large set of module capabilities. There are no formal mechanisms to identity the definition of a high-level service across multiple modules.
NETCONF servers advertise the YANG modules they support as <capability> URI strings in the <hello> message. The complete list of modules used by the server needs to be advertised in order for the client application to correctly parse the YANG modules and reproduce the schema tree used by the server. However the client does not really know which modules are advertised for full conformance, and which are advertised for partial conformance (such as importing typedef and identity statements from the module).
The solution in this document attempts to achieve several objectives:
A YANG package is a conformance definition for one or more YANG modules and/or NETCONF protocol capabilities. Each package has one or more conformance profiles that describe the server implementation requirements to conform to a specific profile within a package.
YANG packages are static representations of YANG conformance, meaning there are no server-dependent variables (e.g, set of purely optional YANG features selected by the server). Instead a conformance profile specifies which YANG features a server needs to support to conform to the profile. A particular revision of a YANG package can be considered a snapshot in time of the specific module and profile revisions required for package conformance.
YANG packages are defined using a text file similar to YANG modules. However they are separate from YANG modules, since a package can require more than one YANG module for conformance. Unlike YANG modules, YANG package definitions do not represent content that would appear in a protocol message. They represent server conformance requirements and are therefore separate from YANG module definitions.
A YANG package is advertised with a <capability> URI string, similar to a YANG module. A NETCONF server will advertise all its supported package capability statements in the <hello> message it sends to each client.
A YANG package file consists of UTF-8 characters. The basic syntax is exactly the same as for YANG modules. Several YANG statements are "imported" from the YANG ABNF, and some new statements are defined. Specifically, YANG package syntax is the same as RFC 6020, sections 6, 6.1, 6.2, and 6.3.
[FIXME: not all namespaces in sec. 6.2.1 are supported and a namespace for YANG package names is not defined there.]
At least one revision statement MUST be present in a YANG package file. A new revision MUST be added each time the YANG package file is published. This requirement is more strict than RFC 6020 to ensure that conformance requirements can be properly identified for each server implementation.
A conformance profile represents a conceptual set of server implementation requirements to meet one or more use-cases or variants of the conceptual service represented by the YANG package.
A conformance profile can overlap or even include other conformance profiles. It is a data-model specific matter what requirements make operational sense. A server can conform to one or more conformance profiles within a YANG package.
A new NETCONF capability URI is defined to advertise YANG package conformance. A server will announce conformance for one or more conformance profiles, for each YANG package it supports. Refer to Section 6 for details on YANG package conformance advertisement.
In this example, 1 conformance profile called "base" is defined for the YANG package named "ietf‑types‑pkg".
package ietf-types-pkg {
namespace "urn:ietf:params:xml:ns:yang:ietf-types-pkg";
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact " ** WG Chairs ** ";
description
"This package defines a conformance profile for the standard
typedef statements.";
revision 2013-12-23 {
description "First revision";
reference "TBD";
}
profile base {
description "Basic requirements for YANG types.";
require-module ietf-yang-types {
revision 2013-07-15;
require-conformance import;
description
"Support for YANG types is required.";
reference "RFC 6991, section 3.";
}
require-module ietf-inet-types {
revision 2013-07-15;
require-conformance import;
description
"Support for INET types is required.";
reference "RFC 6991, section 4.";
}
}
}
In this example, 3 different conformance profiles are defined for the YANG package named "ietf‑routing‑pkg":
package ietf-routing-pkg {
namespace "urn:ietf:params:xml:ns:yang:ietf-routing-pkg";
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact " ** WG Chairs ** ";
description
"This package defines conformance profiles for IPv4 and IPv6
routers.";
revision 2014-06-21 {
description "First revision";
reference "TBD";
}
profile base {
description "Base module requirements for routing";
require-package ietf-types-pkg {
revision 2013-12-23;
}
require-module ietf-routing {
revision 2014-05-24;
require-conformance full;
description "The base routing module is required";
reference "draft-ietf-netmod-routing-cfg-15.txt";
}
require-module ietf-interfaces {
revision 2014-05-08;
require-conformance augment;
description
"The interface and interface-state tables are augmented.";
reference "RFC 7223";
}
}
profile ipv4 {
description "Base module requirements for routing";
include-profile base;
require-module ietf-ipv4-unicast-routing {
revision 2014-05-24;
require-conformance full;
description "Require IPv4 unicast routing support";
reference "draft-ietf-netmod-routing-cfg-15.txt";
}
}
profile ipv6 {
description "Base module requirements for routing";
include-profile base;
require-module ietf-ipv6-unicast-routing {
revision 2014-05-24;
require-conformance full;
description "Require IPv6 unicast routing support";
reference "draft-ietf-netmod-routing-cfg-15.txt";
}
}
}
In this example, 5 different conformance profiles are defined for the YANG package named "ietf‑netconf‑pkg":
package ietf-netconf-pkg {
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-pkg";
organization
"IETF NETMOD (NETCONF Data Modeling Language) Working Group";
contact " ** WG Chairs ** ";
description
"This package defines some conformance profiles for the
NETCONF protocol.";
revision 2013-12-23 {
description "First revision";
reference "TBD";
}
profile core {
description
"Basic requirements for complete NETCONF servers.";
require-package ietf-types-pkg {
revision 2013-12-23;
}
require-capability "urn:ietf:params:netconf:base:1.1" {
description "NETCONF base protocol is required.";
reference "RFC 6241, section 8.1";
}
require-capability
"urn:ietf:params:netconf:capability:xpath:1.0" {
description "XPath filtering is required.";
reference "RFC 6241, section 8.9";
}
require-capability
"urn:ietf:params:netconf:capability:validate:1.1" {
description "NETCONF :validate capability is required.";
reference "RFC 6241, section 8.6";
}
require-capability
"urn:ietf:params:xml:ns:netconf:partial-lock:1.0" {
description
"Partial lock capability is required. The YANG module
ietf-netconf-partial-lock.yang is non-normative
so a require-module statement is not used instead.";
reference "RFC 5717, section 4";
}
require-capability
"urn:ietf:params:netconf:capability:with-defaults:1.0" {
description
"With defaults capability advertisement is required.";
reference "RFC 6243, section 4.3";
}
require-capability
"urn:ietf:params:netconf:capability:notification:1.0" {
description
"Notification delivery support is required.";
reference "RFC 5277, section 3.1";
}
require-capability
"urn:ietf:params:netconf:capability:interleave:1.0" {
description
"Interleave of commands is required while notification
delivery is active .";
reference "RFC 5277, section 6";
}
require-module ietf-netconf-with-defaults {
revision 2011-06-01;
description
"Support for <with-defaults> RPC parameter is required.";
reference "RFC 6243, section 5";
}
require-module ietf-netconf-acm {
revision 2012-02-22;
description
"Base module implementation of NACM is required.";
reference "RFC 6536, section 3.5.2";
}
require-module ietf-netconf-monitoring {
revision 2010-10-04;
description
"Implementation of NETCONF monitoring is required.";
reference "RFC 6022, section 5";
}
require-module ietf-netconf-notifications {
revision 2012-02-06;
description
"Implementation of NETCONF base notifications is
required.";
reference "RFC 6470, section 2.2";
}
}
profile running {
description
"Basic requirements for a complete NETCONF server
that supports writing directly to the the running
datastore.";
include-profile core;
require-capability
"urn:ietf:params:netconf:capability:writable-running:1.0" {
description
"NETCONF :writable-running capability is required.";
reference "RFC 6241, section 8.2";
}
require-capability
"urn:ietf:params:netconf:capability:rollback-on-error:1.0" {
description
"NETCONF :rollback-on-error capability is required.";
reference "RFC 6241, section 8.5";
}
}
profile startup {
description
"Basic requirements for a complete NETCONF server
that supports writing directly to the the running
datastore and also have a distinct startup datastore.";
include-profile running;
require-capability
"urn:ietf:params:netconf:capability:startup:1.0" {
description
"NETCONF distinct startup capability is required.";
reference "RFC 6241, section 8.7";
}
}
profile candidate {
description
"Basic requirements for a complete NETCONF server
that supports the candidate datastore.";
include-profile core;
require-capability
"urn:ietf:params:netconf:capability:candidate:1.0" {
description "NETCONF :candidate capability is required.";
reference "RFC 6241, section 8.3";
}
}
profile confirmed {
description
"Basic requirements for a complete NETCONF server
that supports the candidate datastore, and confirmed
commit functionality.";
include-profile candidate;
require-capability
"urn:ietf:params:netconf:capability:confirmed-commit:1.1" {
description
"NETCONF :confirmed-commit capability is required.";
reference "RFC 6241, section 8.4";
}
}
}
The "package" statement defines the YANG package's name, and contains all YANG package header information and conformance profile statements. The "package" statement's argument is the name of the YANG package, followed by a block of substatements that hold detailed package information. The package name follows the rules for identifiers in RFC 6020, section 6.2.
A YANG package name is defined in the same conceptual namespace as YANG module names. The same rules for selecting non-conflicting names apply as defined in RFC 6020, section 7.1.
An IANA registry for YANG package names will be needed, similar to mechanism described in RFC 6020, section 14.
| Substatement | Reference | Cardinality |
|---|---|---|
| contact | RFC 6020, 7.1.8 | 0..1 |
| description | RFC 6020, 7.19.3 | 0..1 |
| namespace | RFC 6020, 7.1.3 | 1 |
| organization | RFC 6020, 7.1.7 | 0..1 |
| profile | 4.3 | 1..n |
| reference | RFC 6020, 7.19.4 | 0..1 |
| revision | RFC 6020, 7.1.9 | 1..n |
| yangconf-version | 4.2 | 0..1 |
The optional "yangconf‑version" statement specifies which version of the YANG conformance specification language was used in developing the module. The statement's argument is a string. If present, it MUST contain the value "1", which is the current YANG Conformance language version and the default value.
Handling of the "yangconf‑version" statement for versions other than "1" (the version defined here) is out of scope for this specification. Any document that defines a higher version will need to define the backward compatibility of such a higher version.
The "profile" statement is used to define one conformance profile within a YANG package. It takes as an argument the profile name, which is followed by a block of substatements that hold detailed conformance information. The package name follows the rules for identifiers in RFC 6020, section 6.2.
A conformance profile SHOULD NOT require any capabilities, modules, definitions, within a module, that have an obsolete "status" statement value. If a conformance profile does reference obsolete definitions then it SHOULD be republished with an obsolete status, or a new YANG package revision published which updates the obsolete profile definition.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| include-profile | 4.4 | 0..n |
| reference | RFC 6020, 7.19.4 | 0..1 |
| require-capability | 4.12 | 0..n |
| require-module | 4.5 | 0..n |
| require-package | 4.10 | 0..n |
| status | RFC 6020, 7.19.2 | 0..1 |
The "include‑profile" statement is used to combine multiple conformance profiles from the same YANG package. It takes as an argument the name of the conformance profile to include. There are no substatements defined. All of the requirements in the included profile are also required in the profile that contains the include-profile statement.
If any require-module, require-package, and/or require-capability statements overlap due to multiple included profiles, then they are logically combined such that all requirements from all profiles are included.
A profile MUST NOT include itself or any conformance profile that would cause itself to be included via a dependency loop.
The "require‑module" statement is used to require support for some or all of the definitions in a specific module. It takes as an argument the name of the module to require, followed by a block of substatements that hold detailed module server support requirements.
A require-module statement MUST NOT specify the same module name as another require-module statement in the same profile statement.
Submodules are invisible for conformance purposes, because they are used as an implementation mechanism, and are not directly accessible from an external module.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| revision | 4.6 | 1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
| require-conformance | 4.7 | 0..1 |
| require-feature | 4.8 | 0..n |
| require-object | 4.9 | 0..n |
The "revision" statement is a mandatory statement used to specify the revision date for the required module needed for compliance to the conformance profile containing this statement.
It takes as argument a date string in the form "YYYY‑MM‑DD" where "YYYY" is the year, "MM" is the month, and "DD" is the day.
It is a data-model specific matter whether or not revisions of the required module released after this date are acceptable for profile conformance.
The "require‑conformance" statement is used to describe the type of module conformance that is needed to meet the conformance profile requirements. Its argument is an enumerated string value indicating the type of module conformance required.
There are 4 types of module conformance supported:
The "require‑feature" statement is used to indicate that the specified YANG feature set is required for profile conformance. It takes as argument the name of the YANG feature that is required, and is followed by a block of substatements that describe the YANG feature usage within the conformance profile.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
require-module ietf-ip {
revision 2013-02-11;
require-conformance full;
require-feature ipv4-non-contiguous-netmasks {
description
"Configuration of non-contiguous subnet masks
is required.";
reference
"RFC XXXX; Section XXXX";
}
}
The "require‑object" statement is used to indicate that the specified YANG object is required for profile conformance. It takes as argument the path string identifying the object. This is similar to a YANG "absolute‑schema‑nodeid" except that prefixes are not allowed. Only objects defined in the required module can be specified with this statement.
[FIXME: there is no way to specify that the objects that 1 module adds to another with augment-stmt are required in ad-hoc mode.]
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
require-module ietf-system {
revision 2013-07-4;
require-conformance ad-hoc;
require-object /system-state/clock/current-datetime {
description
"The current system time must be provided.";
reference
"RFC XXXX; Section XXXX";
}
}
The "require‑package" statement is used to require support for an external YANG package. It takes as an argument the name of the YANG package to require, followed by a block of substatements that hold detailed server support requirements.
A require-package statement MUST NOT specify the same YANG package name as another require-package statement in the same profile statement.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| revision | 4.6 | 1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
| require-profile | 4.11 | 0..1 |
require-package ietf-routing-pkg {
revision 2013-12-23;
require-profile ipv4;
description
"Support for IPv4 routing configuration is required.";
}
The "require‑profile" statement is used to require support for a specific conformance profile within an external YANG package. It takes as an argument the name of the conformance profile to require. The server MUST advertise support for the specified conformance profile name within the "profiles" list parameter in the capability URI for the required package.
The "require‑capability" statement is used to indicate that the specified NETCONF capability URI is required for profile conformance. It takes as argument a URI string identifying the NETCONF capability that is required, and is followed by a block of substatements that describe the NETCONF capability usage within the conformance profile.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
| require-parameter | 4.13 | 0..n |
profile full-notifications {
description
"A profile for requiring full standard NETCONF
notification functionality.";
require-capability
"urn:ietf:params:netconf:capability:notification:1.0" {
description
"Support for NETCONF notifications is required.";
reference "RFC 5277, section 3.1.1";
}
require-capability
"urn:ietf:params:netconf:capability:interleave:1.0" {
description
"Support for the ability to accept <rpc> requests when
NETCONF notification delivery is active is required.";
reference "RFC 5277, section 6.3";
}
}
The "require‑parameter" statement is used to indicate that the specified URI parameter for the parent NETCONF capability URI is required for profile conformance.
It takes as argument a string identifying the parameter name that is required, and MAY be followed by a block of substatements that describe the NETCONF parameter usage within the conformance profile. If no substatements are present then any value for the parameter is permitted for conformance.
If this parameter appears more than once within a "require‑capability" statement then all the specified parameters are required for the server to meet profile conformance requirements.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
| require-value | 4.14 | 0..n |
profile valid-url {
description
"A profile for requiring that the scheme parameter
be present in the :url capability. Any value is
allowed.";
require-capability
"urn:ietf:params:netconf:capability:url:1.0" {
description
"Support for the :url capability is required.";
reference "RFC 6241, section 8.8";
require-parameter scheme {
description
"Support for the scheme parameter is required.";
reference "RFC 6241, section 8.8.3";
}
}
The "require‑value" statement is used to indicate an acceptable value for the parent capability parameter for profile conformance.
It takes as argument a string identifying a parameter value that is required, and MAY be followed by a block of substatements that describe the NETCONF parameter value usage within the conformance profile.
If this parameter appears more than once within a "require‑parameter" statement then only one of the values is required to match for the server to meet profile conformance requirements.
| Substatement | Reference | Cardinality |
|---|---|---|
| description | RFC 6020, 7.19.3 | 0..1 |
| reference | RFC 6020, 7.19.4 | 0..1 |
profile ftp-support {
description
"A profile for requiring FTP support for the 'url'
capability.";
require-capability
"urn:ietf:params:netconf:capability:url:1.0" {
description
"Support for the :url capability is required.";
reference "RFC 6241, section 8.8";
require-parameter scheme {
description
"Support for the 'scheme' parameter is required.";
reference "RFC 6241, section 8.8.3";
require-value ftp {
description
"Support for 'ftp' transfer is required.";
}
}
}
}
A YANG conformance profile definition needs to be altered very carefully after it has been published, in order not to break old clients that expect certain server behavior.
When a new revision of a YANG package is published, the following restrictions apply:
The YANG Package Conformance capability is used to allow the client to quickly identify which packages and conformance profiles are supported by a particular NETCONF server. The server will advertise each supported YANG package, similar to the YANG module conformance advertisement in RFC 6020, section 5.6.4.
The YANG package namespace URI MUST be advertised as a capability in the NETCONF <hello> message to indicate support for a specific conformance profile within the YANG package. The capability URI MUST be of the form:
conf-capability-string = namespace-uri [ parameter-list ]
parameter-list = "?" parameter *( "&" parameter )
parameter = package-parameter /
revision-parameter /
profile-parameter
package-parameter = "package=" package-name
revision-parameter = "revision=" revision-date
profile-parameter = "profiles=" profile-list
profile-list = profile-name *("," profile-name)
Where:
All 3 parameters MUST be present in the capability string. Refer to Section 4.1 for details on the acceptable values for these parameters.
Example: (capability string wrapped for display purposes only)
<capability>urn:ietf:params:xml:ns:yang:ietf-routing-pkg?package=
ietf-routing-pkg&revision=2013-12-23&profiles=ipv4,ipv6
</capability>
<CODE BEGINS> file "yang‑conformance.abnf"
package-stmt = optsep package-keyword sep identifier-arg-str
optsep
"{" stmtsep
[yangconf-version-stmt]
namespace-stmt
meta-stmts
revision-stmts
package-body-stmts
"}" optsep
yangconf-version-stmt = yangconf-version-keyword sep
yangconf-version-arg-str
optsep stmtend
yangconf-version-arg-str = < a string that matches the rule
yangconf-version-arg >
yangconf-version-arg = "1"
namespace-stmt = namespace-keyword sep uri-str
optsep stmtend
package-body-stmts = 1*(profile-stmt stmtsep)
profile-stmt = profile-keyword sep identifier-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
[status-stmt stmtsep]
[description-stmt stmtsep]
[reference-stmt stmtsep]
*(include-profile-stmt stmtsep)
*(require-package-stmt stmtsep)
*(require-capability-stmt stmtsep)
*(require-module-stmt stmtsep)
"}")
include-profile-stmt = include-profile-keyword sep
identifier-arg-str stmtend
require-module-stmt = require-module-keyword sep
identifier-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
revision-stmt stmtsep
[require-conformance-stmt stmtsep]
[description-stmt stmtsep]
[reference-stmt stmtsep]
*(require-feature-stmt stmtsep)
*(require-object-stmt stmtsep)
"}")
require-object-stmt = require-object-keyword sep
require-object-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
[description-stmt stmtsep]
[reference-stmt stmtsep]
"}")
require-object-arg-str = < a string that matches the rule
require-object-arg >
require-object-arg = pkg-absolute-schema-nodeid
require-package-stmt = require-package-keyword sep
identifier-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
revision-stmt stmtsep
[require-profile-stmt stmtsep]
[description-stmt stmtsep]
[reference-stmt stmtsep]
"}")
require-profile-stmt = require-profile-keyword sep
identifier-arg-str stmtend
require-capability-stmt = require-capability-keyword sep
uri-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
[description-stmt stmtsep]
[reference-stmt stmtsep]
*(require-parameter-stmt stmtsep)
"}")
require-parameter-stmt = require-parameter-keyword sep
identifier-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
[description-stmt stmtsep]
[reference-stmt stmtsep]
*(require-value-stmt stmtsep)
"}")
require-value-stmt = require-value-keyword sep
value-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
[description-stmt stmtsep]
[reference-stmt stmtsep]
"}")
value-arg-str = <string containing allowed value>
revision-stmt = revision-keyword sep date-arg-str stmtend
require-feature-stmt = require-feature-keyword sep
identifier-arg-str optsep
(";" /
"{" stmtsep
;; these stmts can appear in any order
[description-stmt stmtsep]
[reference-stmt stmtsep]
"}")
require-conformance-stmt = require-conformance-keyword sep
require-conformance-arg-str stmtend
require-conformance-arg-str =
< a string that matches the rule
require-conformance-arg >
require-conformance-arg = full-keyword /
augment-keyword /
import-keyword /
ad-hoc-keyword
pkg-schema-nodeid = pkg-absolute-schema-nodeid /
pkg-descendant-schema-nodeid
pkg-absolute-schema-nodeid = 1*("/" pkg-node-identifier)
pkg-descendant-schema-nodeid =
pkg-node-identifier
pkg-absolute-schema-nodeid
pkg-node-identifier = identifier
;; new keywords
ad-hoc-keyword = 'ad-hoc'
augment-keyword = 'augment'
conformance-keyword = 'conformance'
full-keyword = 'full'
include-profile-keyword = 'include-profile'
package-keyword = 'package'
profile-keyword = 'profile'
require-capability-keyword = 'require-capability'
require-module-keyword = 'require-module'
require-feature-keyword = 'require-feature'
require-package-keyword = 'require-package'
require-parameter-keyword = 'require-parameter'
require-profile-keyword = 'require-profile'
require-value-keyword = 'require-value'
revision-keyword = 'revision'
yangconf-version-keyword = 'yangconf-version'
;; all other symbols are defined in RFC 6020, section 12
<CODE ENDS>
TBD
TBD
-- RFC Ed.: remove this section before publication.
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
| [RFC6020] | Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, October 2010. |
| [RFC6241] | Enns, R., Bjorklund, M., Schoenwaelder, J. and A. Bierman, "Network Configuration Protocol (NETCONF)", RFC 6241, June 2011. |