module ietf-netconf {
yang-version 1;
namespace
"urn:ietf:params:xml:ns:netconf:base:1.0";
prefix nc;
import ietf-inet-types {
prefix inet;
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
WG Chair: Bert Wijnen
<mailto:bertietf@bwijnen.net>
WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com>
Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>
Editor: Juergen Schoenwaelder
<mailto:j.schoenwaelder@jacobs-university.de>
Editor: Andy Bierman
<mailto:andy.bierman@brocade.com>";
description
"NETCONF Protocol Data Types and Protocol Operations.
Copyright (c) 2010 IETF Trust and the persons identified as
the document authors. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
revision "2011-03-08" {
description "Initial revision";
reference
"RFC XXXX: Network Configuration Protocol";
}
extension get-filter-element-attributes {
description
"If this extension is present within the
an 'anyxml' statement named 'filter', which must be
conceptually defined within the RPC input section
for the 'get' and 'get-config' protocol operations,
then the following unqualified XML attribute is
supported within the 'filter' element, within
a 'get' or 'get-config' protocol operation:
type : optional attribute with allowed
value strings 'subtree' and 'xpath'.
If missing, the default value is 'subtree'.
If the 'xpath' feature is supported, then the
following unqualified XML attribute is
also supported:
select: optional attribute containing a
string representing an XPath expression.
The 'type' attribute must be equal to 'xpath'
if this attribute is present.";
}
feature writable-running {
description
"NETCONF :writable-running capability;
If the server advertises the :writable-running
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.2.";
}
feature candidate {
description
"NETCONF :candidate capability;
If the server advertises the :candidate
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.3.";
}
feature confirmed-commit {
if-feature candidate;
description
"NETCONF :confirmed-commit:1.1 capability;
If the server advertises the :confirmed-commit:1.1
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.4.";
}
feature rollback-on-error {
description
"NETCONF :rollback-on-error capability;
If the server advertises the :rollback-on-error
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.5.";
}
feature validate {
description
"NETCONF :validate:1.1 capability;
If the server advertises the :validate:1.1
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.6.";
}
feature startup {
description
"NETCONF :startup capability;
If the server advertises the :startup
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.7.";
}
feature url {
description
"NETCONF :url capability;
If the server advertises the :url
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.8.";
}
feature xpath {
description
"NETCONF :xpath capability;
If the server advertises the :xpath
capability for a session, then this feature must
also be enabled for that session. Otherwise,
this feature must not be enabled.";
reference
"RFC XXXX, section 8.9.";
}
typedef session-id-type {
type uint32 {
range "1..max";
}
description "NETCONF Session Id";
}
typedef session-id-or-zero-type {
type uint32;
description
"NETCONF Session Id or Zero to indicate none";
}
typedef error-tag-type {
type enumeration {
enum "in-use" {
value 0;
description
"The request requires a resource that
already is in use.";
}
enum "invalid-value" {
value 1;
description
"The request specifies an unacceptable value for one
or more parameters.";
}
enum "too-big" {
value 2;
description
"The request or response (that would be generated) is
too large for the implementation to handle.";
}
enum "missing-attribute" {
value 3;
description
"An expected attribute is missing.";
}
enum "bad-attribute" {
value 4;
description
"An attribute value is not correct; e.g., wrong type,
out of range, pattern mismatch.";
}
enum "unknown-attribute" {
value 5;
description
"An unexpected attribute is present.";
}
enum "missing-element" {
value 6;
description
"An expected element is missing.";
}
enum "bad-element" {
value 7;
description
"An element value is not correct; e.g., wrong type,
out of range, pattern mismatch.";
}
enum "unknown-element" {
value 8;
description
"An unexpected element is present.";
}
enum "unknown-namespace" {
value 9;
description
"An unexpected namespace is present.";
}
enum "access-denied" {
value 10;
description
"Access to the requested protocol operation, or
data model is denied because authorization failed.";
}
enum "lock-denied" {
value 11;
description
"Access to the requested lock is denied because the
lock is currently held by another entity.";
}
enum "resource-denied" {
value 12;
description
"Request could not be completed because of
insufficient resources.";
}
enum "rollback-failed" {
value 13;
description
"Request to rollback some configuration change (via
rollback-on-error or discard-changes operations) was
not completed for some reason.";
}
enum "data-exists" {
value 14;
description
"Request could not be completed because the relevant
data model content already exists. For example,
a 'create' operation was attempted on data that
already exists.";
}
enum "data-missing" {
value 15;
description
"Request could not be completed because the relevant
data model content does not exist. For example,
a 'delete' operation was attempted on
data that does not exist.";
}
enum "operation-not-supported" {
value 16;
description
"Request could not be completed because the requested
operation is not supported by this implementation.";
}
enum "operation-failed" {
value 17;
description
"Request could not be completed because the requested
operation failed for some reason not covered by
any other error condition.";
}
enum "partial-operation" {
value 18;
description
"This error-tag is obsolete, and SHOULD NOT be sent
by servers conforming to this document.";
}
enum "malformed-message" {
value 19;
description
"A message could not be handled because it failed to
be parsed correctly. For example, the message is not
well-formed XML or it uses an invalid character set.";
}
}
description "NETCONF Error Tag";
reference
"RFC XXXX, Appendix A.";
}
typedef error-severity-type {
type enumeration {
enum "error" {
value 0;
description "Error severity";
}
enum "warning" {
value 1;
description "Warning severity";
}
}
description "NETCONF Error Severity";
reference
"RFC XXXX, section 4.3.";
}
typedef edit-operation-type {
type enumeration {
enum "merge" {
value 0;
description
"The configuration data identified by the
element containing this attribute is merged
with the configuration at the corresponding
level in the configuration datastore identified
by the target parameter.";
}
enum "replace" {
value 1;
description
"The configuration data identified by the element
containing this attribute replaces any related
configuration in the configuration datastore
identified by the target parameter. If no such
configuration data exists in the configuration
datastore, it is created. Unlike a
<copy-config> operation, which replaces the
entire target configuration, only the configuration
actually present in the config parameter is affected.";
}
enum "create" {
value 2;
description
"The configuration data identified by the element
containing this attribute is added to the
configuration if and only if the configuration
data does not already exist in the configuration
datastore. If the configuration data exists, an
<rpc-error> element is returned with an
<error-tag> value of 'data-exists'.";
}
enum "delete" {
value 3;
description
"The configuration data identified by the element
containing this attribute is deleted from the
configuration if and only if the configuration
data currently exists in the configuration
datastore. If the configuration data does not
exist, an <rpc-error> element is returned with
an <error-tag> value of 'data-missing'.";
}
enum "remove" {
value 4;
description
"The configuration data identified by the element
containing this attribute is deleted from the
configuration if the configuration
data currently exists in the configuration
datastore. If the configuration data does not
exist, the 'remove' operation is silently ignored
by the server.";
}
}
default "merge";
description
"NETCONF 'operation' attribute values";
reference
"RFC XXXX, section 7.2.";
}
rpc get-config {
description
"Retrieve all or part of a specified configuration.";
reference
"RFC XXXX, section 7.1.";
input {
container source {
description
"Particular configuration to retrieve.";
choice config-source {
mandatory true;
description
"The configuration to retrieve.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config source.";
}
leaf running {
type empty;
description
"The running configuration is the config source.";
}
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config source.
This is optional-to-implement on the server because
not all servers will support filtering for this
datastore.";
}
} // choice config-source
} // container source
anyxml filter {
nc:get-filter-element-attributes;
description
"Subtree or XPath filter to use.";
}
}
output {
anyxml data {
description
"Copy of the source datastore subset which matched
the filter criteria (if any). An empty data container
indicates that the request did not produce any results.";
}
}
} // rpc get-config
rpc edit-config {
description
"The 'edit-config' operation loads all or part of a specified
configuration to the specified target configuration.";
reference
"RFC XXXX, section 7.2.";
input {
container target {
description
"Particular configuration to edit.";
choice config-target {
mandatory true;
description
"The configuration target.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config target.";
}
leaf running {
if-feature writable-running;
type empty;
description
"The running configuration is the config source.";
}
} // choice config-target
} // container target
leaf default-operation {
type enumeration {
enum "merge" {
value 0;
description
"The default operation is merge.";
}
enum "replace" {
value 1;
description
"The default operation is replace.";
}
enum "none" {
value 2;
description
"There is no default operation.";
}
}
default "merge";
description
"The default operation to use.";
}
leaf test-option {
if-feature validate;
type enumeration {
enum "test-then-set" {
value 0;
description
"The server will test and then set if no errors.";
}
enum "set" {
value 1;
description
"The server will set without a test first.";
}
enum "test-only" {
value 2;
description
"The server will only test and not set, even
if there are no errors.";
}
}
default "test-then-set";
description
"The test option to use.";
}
leaf error-option {
type enumeration {
enum "stop-on-error" {
value 0;
description
"The server will stop on errors.";
}
enum "continue-on-error" {
value 1;
description
"The server may continue on errors.";
}
enum "rollback-on-error" {
value 2;
description
"The server will rollback on errors.
This value can only be used if the 'rollback-on-error'
feature is supported.";
}
}
default "stop-on-error";
description
"The error option to use.";
}
choice edit-content {
mandatory true;
description
"The content for the edit operation";
anyxml config {
description
"Inline Config content.";
}
leaf url {
if-feature url;
type inet:uri;
description
"URL based config content.";
}
} // choice edit-content
}
} // rpc edit-config
rpc copy-config {
description
"Create or replace an entire configuration datastore with the
contents of another complete configuration datastore.";
reference
"RFC XXXX, section 7.3.";
input {
container target {
description
"Particular configuration to copy to.";
choice config-target {
mandatory true;
description
"The configuration target of the copy operation.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config target.";
}
leaf running {
if-feature writable-running;
type empty;
description
"The running configuration is the config target.
This is optional-to-implement on the server.";
}
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config target.";
}
leaf url {
if-feature url;
type inet:uri;
description
"The URL-based configuration is the config target.";
}
} // choice config-target
} // container target
container source {
description
"Particular configuration to copy from.";
choice config-source {
mandatory true;
description
"The configuration source for the copy operation.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config source.";
}
leaf running {
type empty;
description
"The running configuration is the config source.";
}
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config source.";
}
leaf url {
if-feature url;
type inet:uri;
description
"The URL-based configuration is the config source.";
}
anyxml config {
description
"Inline Config content: 'config' element. Represents
an entire configuration datastore, not
a subset of the running datastore.";
}
} // choice config-source
} // container source
}
} // rpc copy-config
rpc delete-config {
description
"Delete a configuration datastore.";
reference
"RFC XXXX, section 7.4.";
input {
container target {
description
"Particular configuration to delete.";
choice config-target {
mandatory true;
description
"The configuration target to delete.";
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config target.";
}
leaf url {
if-feature url;
type inet:uri;
description
"The URL-based configuration is the config target.";
}
} // choice config-target
} // container target
}
} // rpc delete-config
rpc lock {
description
"The lock operation allows the client to lock the configuration
system of a device.";
reference
"RFC XXXX, section 7.5.";
input {
container target {
description
"Particular configuration to lock";
choice config-target {
mandatory true;
description
"The configuration target to lock.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config target.";
}
leaf running {
type empty;
description
"The running configuration is the config target.";
}
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config target.";
}
} // choice config-target
} // container target
}
} // rpc lock
rpc unlock {
description
"The unlock operation is used to release a configuration lock,
previously obtained with the 'lock' operation.";
reference
"RFC XXXX, section 7.6.";
input {
container target {
description
"Particular configuration to unlock.";
choice config-target {
mandatory true;
description
"The configuration target to unlock.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config target.";
}
leaf running {
type empty;
description
"The running configuration is the config target.";
}
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config target.";
}
} // choice config-target
} // container target
}
} // rpc unlock
rpc get {
description
"Retrieve running configuration and device state information.";
reference
"RFC XXXX, section 7.7.";
input {
anyxml filter {
nc:get-filter-element-attributes;
description
"This parameter specifies the portion of the system
configuration and state data to retrieve.";
}
}
output {
anyxml data {
description
"Copy of the running datastore subset and/or state
data which matched the filter criteria (if any).
An empty data container indicates that the request did not
produce any results.";
}
}
} // rpc get
rpc close-session {
description
"Request graceful termination of a NETCONF session.";
reference
"RFC XXXX, section 7.8.";
} // rpc close-session
rpc kill-session {
description
"Force the termination of a NETCONF session.";
reference
"RFC XXXX, section 7.9.";
input {
leaf session-id {
type session-id-type;
mandatory true;
description
"Particular session to kill.";
}
}
} // rpc kill-session
rpc commit {
if-feature candidate;
description
"Commit the candidate configuration as the device's new
current configuration";
reference
"RFC XXXX, section 8.3.4.1.";
input {
leaf confirmed {
if-feature confirmed-commit;
type empty;
description
"Requests a confirmed commit.";
reference
"RFC XXXX, section 8.3.4.1.";
}
leaf confirm-timeout {
if-feature confirmed-commit;
type uint32 {
range "1..max";
}
units "seconds";
default "600";
description
"The timeout interval for a confirmed commit.";
reference
"RFC XXXX, section 8.3.4.1.";
}
leaf persist {
if-feature confirmed-commit;
type string;
description
"This parameter is used to make a confirmed commit
persistent. A persistent confirmed commit is not aborted
if the NETCONF session terminates. The only way to abort a
persistent confirmed commit it to let the timer expire, or
to use the cancel-commit operation.
The value of this parameter is a token that must be given
in the 'persist-id' parameter of commit or cancel-commit in
order to confirm or cancel the persistent confirmed commit.
The token should be a random string.";
reference
"RFC XXXX, section 8.3.4.1.";
}
leaf persist-id {
if-feature confirmed-commit;
type string;
description
"This parameter is given in order to commit a persistent
confirmed commit. The value must be equal to the value
given in the 'persist' parameter to the commit operation.
If it does not match, the operation fails with an
'invalid-value' error.";
reference
"RFC XXXX, section 8.3.4.1.";
}
}
} // rpc commit
rpc discard-changes {
if-feature candidate;
description
"Revert the candidate configuration to the current
running configuration.";
reference
"RFC XXXX, section 8.3.4.2.";
} // rpc discard-changes
rpc cancel-commit {
if-feature confirmed-commit;
description
"This operation is used to cancel an ongoing confirmed commit.
If the confirmed commit is persistent, the parameter
'persist-id' must be given, and it must match the value of the
'persist' parameter.";
reference
"RFC XXXX, section 8.4.4.1.";
input {
leaf persist-id {
type string;
description
"This parameter is given in order to cancel a persistent
confirmed commit. The value must be equal to the value
given in the 'persist' parameter to the commit operation.
If it does not match, the operation fails with an
'invalid-value' error.";
}
}
} // rpc cancel-commit
rpc validate {
if-feature validate;
description
"Validates the contents of the specified configuration.";
reference
"RFC XXXX, section 8.6.4.1.";
input {
container source {
description
"Particular configuration to validate.";
choice config-source {
mandatory true;
description
"The configuration source to validate.";
leaf candidate {
if-feature candidate;
type empty;
description
"The candidate configuration is the config source.";
}
leaf running {
type empty;
description
"The running configuration is the config source.";
}
leaf startup {
if-feature startup;
type empty;
description
"The startup configuration is the config source.";
}
leaf url {
if-feature url;
type inet:uri;
description
"The URL-based configuration is the config source.";
}
anyxml config {
description
"Inline Config content: 'config' element. Represents
an entire configuration datastore, not
a subset of the running datastore.";
}
} // choice config-source
} // container source
}
} // rpc validate
} // module ietf-netconf
