draft-ietf-netconf-with-defaults-07.txt   draft-ietf-netconf-with-defaults-08.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft InterWorking Labs Internet-Draft InterWorking Labs
Intended status: Standards Track B. Lengyel Intended status: Standards Track B. Lengyel
Expires: October 21, 2010 Ericsson Expires: November 21, 2010 Ericsson
April 19, 2010 May 20, 2010
With-defaults capability for NETCONF With-defaults capability for NETCONF
draft-ietf-netconf-with-defaults-07 draft-ietf-netconf-with-defaults-08
Abstract Abstract
The NETCONF protocol defines ways to read configuration data from a The NETCONF protocol defines ways to read and edit configuration data
NETCONF server. Part of this data is not set by the NETCONF client, from a NETCONF server. Part of this data may not be set by the
but rather a default value is used. In many situations the NETCONF NETCONF client, but rather a default value is used. In many
client has a priori knowledge about default data, so the NETCONF situations the NETCONF client has a priori knowledge about default
server does not need to send it to the client. In other situations data, so the NETCONF server does not need to save it in a NETCONF
the NETCONF client will need this data as part of the NETCONF <rpc- datastore or send it to the client in a retrieval operation reply.
reply> messages. This document defines a capability-based extension In other situations the NETCONF client will need this data as part of
to the NETCONF protocol that allows the NETCONF client to control the NETCONF <rpc-reply> messages. Not all server implementations
whether default values are part of NETCONF <rpc-reply> messages or treat this default data the same way. This document defines a
<copy-config> output to the target URL. capability-based extension to the NETCONF protocol that allows the
NETCONF client to identify how defaults are handled by the server,
and control whether default values are part of NETCONF <rpc-reply>
messages or <copy-config> output to a file.
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on October 21, 2010. This Internet-Draft will expire on November 21, 2010.
Copyright Notice Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the Copyright (c) 2010 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow
modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other
than English.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
1.2. Current handling of default data . . . . . . . . . . . . . 5 1.2. Defaults Handling Behavior . . . . . . . . . . . . . . . . 5
2. With-defaults Capability . . . . . . . . . . . . . . . . . . . 6 1.3. Client Controlled Retrieval of Default Data . . . . . . . 5
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 6 2. Defaults Handling Basic Modes . . . . . . . . . . . . . . . . 6
2.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 6 2.1. 'report-all' Basic Mode . . . . . . . . . . . . . . . . . 6
2.3. Conformance . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.1. 'report-all' Basic Mode Retrieval . . . . . . . . . . 6
2.4. Capability Identifier . . . . . . . . . . . . . . . . . . 6 2.1.2. 'report-all' <with-defaults> Retrieval . . . . . . . . 6
2.5. New Operations . . . . . . . . . . . . . . . . . . . . . . 7 2.1.3. 'report-all' <edit-config> Behavior . . . . . . . . . 6
2.6. Modifications to Existing Operations . . . . . . . . . . . 7 2.1.4. 'report-all' Non-volatile Storage Behavior . . . . . . 7
2.7. Interactions with Other Capabilities . . . . . . . . . . . 8 2.2. 'trim' Basic Mode . . . . . . . . . . . . . . . . . . . . 7
3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 8 2.2.1. 'trim' Basic Mode Retrieval . . . . . . . . . . . . . 7
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10 2.2.2. 'trim' <with-defaults> Retrieval . . . . . . . . . . . 7
5. Security Considerations . . . . . . . . . . . . . . . . . . . 11 2.2.3. 'trim' <edit-config> Behavior . . . . . . . . . . . . 7
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 11 2.2.4. 'trim' Non-volatile Storage Behavior . . . . . . . . . 8
7. Normative References . . . . . . . . . . . . . . . . . . . . . 11 2.3. 'explicit' Basic Mode . . . . . . . . . . . . . . . . . . 8
Appendix A. Usage Examples . . . . . . . . . . . . . . . . . . . 12 2.3.1. 'explicit' Basic Mode Retrieval . . . . . . . . . . . 8
A.1. Example YANG Module . . . . . . . . . . . . . . . . . . . 12 2.3.2. 'explicit' <with-defaults> Retrieval . . . . . . . . . 8
A.2. Example Data Set . . . . . . . . . . . . . . . . . . . . . 14 2.3.3. 'explicit' <edit-config> Behavior . . . . . . . . . . 8
A.3. Protocol Operation Examples . . . . . . . . . . . . . . . 15 2.3.4. 'explicit' Non-volatile Storage Behavior . . . . . . . 9
A.3.1. <with-defaults> = 'report-all' . . . . . . . . . . . . 15 3. Retrieval of Default Data . . . . . . . . . . . . . . . . . . 9
A.3.2. <with-defaults> = 'trim' . . . . . . . . . . . . . . . 16 3.1. 'report-all-tagged' Retrieval Mode . . . . . . . . . . . . 9
A.3.3. <with-defaults> = 'explicit' . . . . . . . . . . . . . 17 4. With-defaults Capability . . . . . . . . . . . . . . . . . . . 10
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 18 4.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 10
B.1. 06-07 . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 10
B.2. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.3. Conformance . . . . . . . . . . . . . . . . . . . . . . . 10
B.3. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.4. Capability Identifier . . . . . . . . . . . . . . . . . . 10
B.4. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.5. New Operations . . . . . . . . . . . . . . . . . . . . . . 11
B.5. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.6. Modifications to Existing Operations . . . . . . . . . . . 11
B.6. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.6.1. <get>, <get-config>, and <copy-config> Operations . . 11
B.7. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.6.2. <edit-config> Operation . . . . . . . . . . . . . . . 12
B.8. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.6.3. Other Operations . . . . . . . . . . . . . . . . . . . 12
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 21 4.7. Interactions with Other Capabilities . . . . . . . . . . . 13
5. YANG Module for the <with-defaults> Parameter . . . . . . . . 13
6. XSD for the 'wd:default' Attribute . . . . . . . . . . . . . . 15
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16
8. Security Considerations . . . . . . . . . . . . . . . . . . . 17
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 17
10. Normative References . . . . . . . . . . . . . . . . . . . . . 17
Appendix A. Usage Examples . . . . . . . . . . . . . . . . . . . 18
A.1. Example YANG Module . . . . . . . . . . . . . . . . . . . 18
A.2. Example Data Set . . . . . . . . . . . . . . . . . . . . . 20
A.3. Protocol Operation Examples . . . . . . . . . . . . . . . 21
A.3.1. <with-defaults> = 'report-all' . . . . . . . . . . . . 21
A.3.2. <with-defaults> = 'report-all-tagged' . . . . . . . . 22
A.3.3. <with-defaults> = 'trim' . . . . . . . . . . . . . . . 25
A.3.4. <with-defaults> = 'explicit' . . . . . . . . . . . . . 26
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 27
B.1. 07-08 . . . . . . . . . . . . . . . . . . . . . . . . . . 27
B.2. 06-07 . . . . . . . . . . . . . . . . . . . . . . . . . . 27
B.3. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 27
B.4. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 28
B.5. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 28
B.6. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 28
B.7. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.8. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.9. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 29
1. Introduction 1. Introduction
The NETCONF protocol [RFC4741] defines ways to read configuration and The NETCONF protocol [RFC4741] defines ways to read configuration and
state data from a NETCONF server. Part of the configuration data may state data from a NETCONF server. Part of the configuration data may
not be set by the NETCONF client, but rather by a default value from not be set by the NETCONF client, but rather by a default value from
the data model. In many situations the NETCONF client has a priori the data model. In many situations the NETCONF client has a priori
knowledge about default data, so the NETCONF server does not need to knowledge about default data, so the NETCONF server does not need to
send it to the client. A priori knowledge can be e.g., a document send it to the client. A priori knowledge can be e.g., a document
formally describing the data models supported by the NETCONF server. formally describing the data models supported by the NETCONF server.
It can be important for a client to know exactly how a server
implementation will handle default data. There are subtle
differences in some protocol operations where the defaults handling
behavior of the server will affect the outcome of the operation.
1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
Data model schema: A document or set of documents describing the
data models supported by the NETCONF server.
Management Application: A computer program running outside the
NETCONF server that configures or supervises the NETCONF server.
A management application can reach the device e.g. via NETCONF,
CLI or SNMP.
Schema default data: Data specified in the data model schema as
default, that is set or used by the device whenever the NETCONF
client or other management application/user does not provide a
specific value for the relevant data item. Schema default data
MAY or may not be stored as part of a configuration datastore,
depending on the basic mode used by a particular server.
Default data: Data considered by a particular server to contain a
default value. Default data is not kept in a configuration
datastore.
Explicitly set data: Data that is set to any value by a NETCONF
client or other management application by the way of an actual
management operation, including any data model schema default
value. Any value set by the NETCONF server which is not the
schema defined default value is also considered explicitly set
data.
The following terms are defined in [RFC4741]:
o client
o datastore
o operation
o server
The following term is defined in [I-D.ietf-netmod-yang]:
o data node
1.2. Defaults Handling Behavior
The defaults handling behavior used by a server will impact NETCONF
protocol operations in three ways:
1. Data retrieval: A server is normally allowed to exclude data
nodes which it considers to contain the default value. The
actual nodes omitted depends on the defaults handling behavior
used by the server. The nodes that are returned in this case are
the only nodes the server considers to exist in the datastore.
2. Create and delete operations: The <edit-config> 'operation'
attribute can be used to create and/or delete specific data
nodes. These operations depend on whether the target node
currently exists or not. The server's defaults handling behavior
will determine whether the requested node currently exists in the
datastore or not.
3. NV Storage: The server's defaults handling behavior will affect
which data nodes are saved in non-volatile storage.
1.3. Client Controlled Retrieval of Default Data
A networking device may have a large number of default values. Often A networking device may have a large number of default values. Often
the default values are not interesting or specifically defined with a the default values are not interesting or specifically defined with a
"reasonable" value, so that the management user does not have to "reasonable" value, so that the management user does not have to
handle them. For these reasons it is quite common for networking handle them. For these reasons it is quite common for networking
devices to suppress the output of parameters having the default devices to suppress the output of parameters having the default
value. value.
However there are use-cases when a NETCONF client will need the However, there are use-cases when a NETCONF client will need the
default data from the node: default data from the server:
o The management application often needs a single, definitive and o The management application often needs a single, definitive and
complete set of configuration values that determine how the a complete set of configuration values that determine how the a
networking device works. networking device works.
o Documentation about default values can be unreliable or o Documentation about default values can be unreliable or
unavailable. unavailable.
o Some management applications might not have the capabilities to o Some management applications might not have the capabilities to
correctly parse and interpret formal data models. correctly parse and interpret formal data models.
o Human users might want to understand the received data without o Human users might want to understand the received data without
consultation of the documentation. consultation of the documentation.
In all these cases the NETCONF client will need default data as part In all these cases the NETCONF client will need default data as part
of the NETCONF <rpc-reply> messages. of the NETCONF <rpc-reply> messages.
This document defines a capability-based extension to the NETCONF This document defines a NETCONF protocol capability to identify the
protocol that allows the NETCONF client to control whether default server defaults handling behavior, and a YANG module extension to the
data is part of NETCONF <rpc-reply> messages. NETCONF protocol that allows the NETCONF client to control whether
default data is returned in certain NETCONF <rpc-reply> messages.
1.1. Terminology 2. Defaults Handling Basic Modes
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", Not all server implementations treat default data in the same way.
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this Instead of forcing a single implementation strategy, this document
document are to be interpreted as described in [RFC2119]. allows a server to advertise a particular style of defaults handling,
and the client can adjust accordingly.
Data model schema: A document or set of documents describing the NETCONF servers report default data in different ways. This document
data models supported by the NETCONF server. specifies three standard defaults handling basic modes that a server
implementor may choose from:
Management Application: A computer program running outside the o report-all
NETCONF server that configures or supervises the NETCONF server. o trim
A management application can reach the device e.g. via NETCONF, o explicit
CLI or SNMP.
Default data: Data specified in the data model schema as default,
that is set or used by the device whenever the NETCONF client or
other management application/user does not provide a specific
value for the relevant data item. Default data MAY or may not be
stored as part of a configuration datastore.
Explicitly set data: Data that is set to any value by a NETCONF
client or other management application by the way of an actual
management operation, including any data model schema default
value. Any value set by the NETCONF server which is not the
schema defined default value is also considered explicitly set
data.
In addition the following terms are defined in RFC 4741 and are not A server MUST select one of the three basic modes defined in this
redefined here: section for handling default data.
o client
o operation
o server
1.2. Current handling of default data 2.1. 'report-all' Basic Mode
NETCONF does not define whether default data is part of the A server which uses the 'report-all' basic mode does not consider any
datastore/data model, or if it is meta-data that influences the data node to be default data.
behavior of the NETCONF server, but is not actually part of the
datastore. This document is intended to support either type of
implementation, without deciding which approach is better.
As a consequence of this approach, NETCONF servers that do not 2.1.1. 'report-all' Basic Mode Retrieval
implement the :with-defaults capability may or may not return default
data.
Different NETCONF servers report default data in different ways. All data nodes MUST be reported.
This document specifies the following three basic modes:
report-all: All default data is always reported. 2.1.2. 'report-all' <with-defaults> Retrieval
trim: Values are not reported if they match the default value (as
specified in the data model schema). Note that non-configuration
data nodes containing the schema default value are not reported
either.
explicit: Report only values that match the definition of explicitly
set data. For non-configuration data, this has the same affect as
'report-all'.
2. With-defaults Capability All data nodes MUST be reported, including any data nodes considered
to be default data by the server.
2.1. Overview 2.1.3. 'report-all' <edit-config> Behavior
The :with-defaults capability indicates that the NETCONF server makes The server MUST consider every data node to exist, even those
it possible for the NETCONF client to control whether default data is represented by a schema default value.
part of NETCONF <rpc-reply> messages. The capability affects both
configuration and state data (while acknowledging that the usage of
default values for state data is less prevalent). Sending of default
data is controlled for each individual operation separately.
A NETCONF server implementing the :with-defaults capability MUST o A valid 'create' operation for a data node that contains its
indicate its basic behavior, whether it sends default data in the schema default value MUST fail with a 'data-exists' error-tag.
absence of any specific request from the NETCONF client; and MUST o A valid 'delete' operation for a data node that contains its
support the 'report-all' handling mode and MAY support other modes. schema default value MUST succeed, even though the data node is
immediately replaced by the server with the default value.
A server indicating 'explicit' either in the 'basic-mode' or the 2.1.4. 'report-all' Non-volatile Storage Behavior
'also-supported' parameter MUST be able to differentiate between
normal default data and explicitly set data.
2.2. Dependencies All data nodes MUST be saved in non-volatile storage.
2.2. 'trim' Basic Mode
A server which uses the 'trim' basic mode MUST consider any data node
set to its schema default value to be default data.
2.2.1. 'trim' Basic Mode Retrieval
Data nodes MUST NOT be reported if they match the schema default
value. Non-configuration data nodes containing the schema default
value MUST NOT be reported.
2.2.2. 'trim' <with-defaults> Retrieval
Data nodes MUST NOT be reported if they match the schema default
value. Non-configuration data nodes containing the schema default
value MUST NOT be reported.
2.2.3. 'trim' <edit-config> Behavior
The server MUST consider any data node that does not contain its
schema default value to exist.
o A valid 'create' operation for a data node that has a schema
default value defined MUST succeed.
o A valid 'delete' operation for a missing data node that has a
schema default value MUST fail with a 'data-missing' error-tag.
o If a client sets a data node to its schema default value, using
any valid operation, it MUST succeed, although the data node MUST
NOT be saved in the NETCONF datastore. This has the same affect
as removing the data node and treating it as default data.
If the server supports the 'report-all-tagged' retrieval mode in its
with-defaults capability, then the 'wd:default' attribute MUST be
accepted in configuration input. If all NETCONF sub-operation
parameters are valid, then the server will treat a tagged data node
as a request to return that node to default data. If this request is
valid within the context of the requested NETCONF operation, then the
data node is removed and returned to its default value. If the data
node within the NETCONF message contains a value in this case, it
MUST be equal to the schema default value.
2.2.4. 'trim' Non-volatile Storage Behavior
All data nodes, except those set to their schema default value, MUST
be saved in non-volatile storage.
2.3. 'explicit' Basic Mode
A server which uses the 'explicit' basic mode MUST consider any data
node that is not explicitly set data to be default data.
2.3.1. 'explicit' Basic Mode Retrieval
If a client set a data node to its schema default value, it MUST
always be reported. If the server set a data node to its schema
default value, it MUST NOT be reported. Non-configuration data nodes
containing the schema default value MUST be reported.
2.3.2. 'explicit' <with-defaults> Retrieval
If a client set a data node to its schema default value, it MUST be
reported. If the server set a data node to its schema default value,
it MUST NOT be reported. Non-configuration data nodes containing the
schema default value MUST be reported.
2.3.3. 'explicit' <edit-config> Behavior
The server considers any data node that is explicitly set data to
exist.
o A valid 'create' operation for a data node that has been set by a
client to its schema default value MUST fail with a 'data-exists'
error-tag.
o A valid 'create' operation for a data node that has been set by
the server to its schema default value MUST succeed.
o A valid 'delete' operation for a data node that has been set by a
client to its schema default value MUST succeed.
o A valid 'delete' operation for a data node that has been set by
the server to its schema default value MUST fail with a 'data-
missing' error-tag.
If the server supports the 'report-all-tagged' retrieval mode in its
with-defaults capability, then the 'wd:default' attribute MUST be
accepted in configuration input. If all NETCONF sub-operation
parameters are valid, then the server will treat a tagged data node
as a request to return that node to default data. If this request is
valid within the context of the requested NETCONF operation, then the
data node is removed and returned to its default value. If the data
node within the NETCONF message contains a value in this case, it
MUST be equal to the schema default value.
2.3.4. 'explicit' Non-volatile Storage Behavior
All data nodes that are explicitly set data MUST be saved in non-
volatile storage.
3. Retrieval of Default Data
This document defines a new parameter, called <with-defaults>, which
can be added to specific NETCONF operation request messages to
control how retrieval of default data is treated by the server.
The server MUST accept the <with-defaults> parameter containing the
enumeration for any of the defaults handling modes it supports, as
defined in Section 5.
The <with-defaults> parameter contains one of the three basic mode
enumerations defined above, to request that the retrieval operation
be performed using the specified defaults handling basic mode.
3.1. 'report-all-tagged' Retrieval Mode
In addition to the basic modes, a special variant of 'report-all'
basic mode is available called 'report-all-tagged'. This mode MUST
be supported on a server if the 'also-supported' parameter in the
'with-defaults' capability contains the 'report-all-tagged' option.
Refer to Section 4 for encoding details for this capability.
In this mode the server returns all data nodes, just like the
'report-all' mode, except a data node that is considered by the
server to contain default data will include an XML attribute to
indicate this condition. This is useful for an application to
determine which nodes are considered to contain default data by the
server, within a single retrieval operation.
A server which supports 'report-all-tagged' MUST also accept the 'wd:
default' XML attribute it is present within configuration input to
the <edit-config> or <copy-config> operations. Refer to Section 6
for XML encoding details of the 'wd:default' XML attribute.
4. With-defaults Capability
4.1. Overview
The :with-defaults capability indicates that the NETCONF server
supports a specific defaults handling basic mode. It may also
indicate support for additional defaults retrieval modes. These
retrieval modes allow a NETCONF client to control whether default
data is part of NETCONF <rpc-reply> messages. The capability affects
both configuration and state data (while acknowledging that the usage
of default values for state data is less prevalent). Sending of
default data is controlled for each individual operation separately.
A NETCONF server implementing the :with-defaults capability:
o MUST indicate its basic mode behavior by including the 'basic-
mode' parameter in the capability URI, as defined in Section 4.4.
o MUST support the YANG module defined in Section 5.
o SHOULD support the 'report-all' or 'report-all-tagged' defaults
handling mode.
o MAY support additional defaults handling modes.
4.2. Dependencies
None None
2.3. Conformance 4.3. Conformance
Every NETCONF server SHOULD implement this capability. Every NETCONF server SHOULD implement this capability.
2.4. Capability Identifier 4.4. Capability Identifier
urn:ietf:params:netconf:capability:with-defaults urn:ietf:params:netconf:capability:with-defaults:1.0
The identifier MUST have a parameter: "basic-mode". This indicates The identifier MUST have a parameter: "basic-mode". This indicates
how the server reports default data in <rpc-reply> messages, in the how the server will treat default data, as defined in Section 2.
case the client does not specify the required behavior in the <rpc>
request. The allowed values of this parameter are report-all, trim, The allowed values of this parameter are 'report-all', 'trim', and
explicit as listed in Section 1.2. 'explicit', as defined in Section 2.
The identifier MAY have another parameter: "also-supported". This The identifier MAY have another parameter: "also-supported". This
parameter indicates which additional default handling modes the parameter indicates which additional default handling modes the
server supports. The value of the parameter is a comma separated server supports. The value of the parameter is a comma separated
list of one or two modes that are supported beside the mode indicated list of one or more modes that are supported beside the mode
in the 'basic-mode' parameter. Possible modes are taken from the indicated in the 'basic-mode' parameter. Possible modes are 'report-
list in Section 1.2. all', 'report-all-tagged', 'trim', and 'explicit', as defined in
Section 5.
Note that this protocol capability URI is separate from the YANG Note that this protocol capability URI is separate from the YANG
module capability URI for the YANG module in Section 3. A server module capability URI for the YANG module in Section 5. A server
which implements this module will also advertise a YANG module which implements this module MUST also advertise a YANG module
capability URI according to the rules specified in capability URI according to the rules specified in
[I-D.ietf-netmod-yang]. [I-D.ietf-netmod-yang].
Examples: Examples:
urn:ietf:params:netconf:capability:with-defaults?basic-mode=report- urn:ietf:params:netconf:capability:with-defaults:1.0?basic-
all mode=explicit
urn:ietf:params:netconf:capability:with-defaults?basic-mode=report- urn:ietf:params:netconf:capability:with-defaults:1.0?basic-
all&also-supported=trim,explicit mode=explicit&also-supported=report-all,report-all-tagged
2.5. New Operations 4.5. New Operations
None None
2.6. Modifications to Existing Operations 4.6. Modifications to Existing Operations
A new <with-defaults> XML child element is added to the <get>, <get- 4.6.1. <get>, <get-config>, and <copy-config> Operations
config> and <copy-config> operations. If the <with-defaults> element
is present, it controls the reporting of default data. The server A new <with-defaults> XML element is added to the input for the
MUST return default data in the NETCONF <rpc-reply> messages <get>, <get-config> and <copy-config> operations. If the <with-
according to the value of the element. defaults> element is present, it controls the reporting of default
data. The server MUST return default data in the NETCONF <rpc-reply>
messages according to the value of this element, if the server
supports the specified retrieval mode.
This parameter only controls these specified retrieval operations,
and does not impact any other operations or the non-volatile storage
of configuration data.
The <with-defaults> element is defined in the XML namespace for the The <with-defaults> element is defined in the XML namespace for the
ietf-netconf-with-defaults.yang module in Section 3, not the XML ietf-netconf-with-defaults.yang module in Section 5, not the XML
namespace for the <get>, <get-config> and <copy-config> operations. namespace for the <get>, <get-config> and <copy-config> operations.
Allowed values of the with-defaults element are taken from the list Allowed values of the with-defaults element are taken from the list
in Section 1.2. The allowed values are restricted to the values that in Section 2. The allowed values are restricted to the values that
the device indicates support for in the with-defaults capability in the device indicates it supports within the with-defaults capability,
the basic and also-supported parameters. in the 'basic-mode' and 'also-supported' parameters.
If an unsupported value is used, the NETCONF server MUST return an If an unsupported value is used, the NETCONF server MUST return an
<rpc-reply> with an <rpc-error> element. The <error-tag> MUST be <rpc-reply> with an <rpc-error> element. The <error-tag> SHOULD be
'operation-not-supported', and the <error-app-tag> MUST be 'with- 'invalid-value', and the <error-app-tag> SHOULD be 'with-defaults-
defaults-mode-not-supported'. mode-not-supported'.
If the <with-defaults> element is not present, the server follows its If the <with-defaults> element is not present, the server MUST follow
basic behavior as indicated by the capability identifier's 'basic- its basic mode behavior as indicated by the with-defaults capability
mode' parameter see Section 2.4. identifier's 'basic-mode' parameter, defined in Section 4.4.
Affected operations: The <copy-config> operation is only affected if the target of the
o <get> operation is specified with the <url> parameter. If the target is a
o <get-config> NETCONF datastore (i.e., running, candidate or startup), the
o <copy-config> capability has no effect. The server MUST use its basic mode when
copying data to a NETCONF datastore. If the with-defaults parameter
is present in this case, it MUST be silently ignored by the server.
<copy-config> is only affected if the target of the operation is a 4.6.2. <edit-config> Operation
URL. If the target is a NETCONF datastore (running, candidate or
startup) the capability has no effect; the with-defaults parameter, The <edit-config> operation has four sub-operations. The 'create'
if present, MUST be silently ignored. and 'delete' sub-operations are affected by the defaults handling
basic mode.
The 'create' sub-operation MUST fail with a 'data-exists' error-tag
value if the server considers the target data node to already have a
current value.
If the client sets a data node to its schema default value, the
server MUST accept the request if it is valid. The server MUST keep
or discard the new value based on its defaults handling basic mode.
For the 'trim' basic mode, all schema default values are discarded,
otherwise a client-provided schema default value is saved in a
NETCONF datastore.
If the server supports the 'report-all-tagged' mode, then the 'wd:
default' attribute defined in Section 6 also impacts the edit-config
operation. If the wd:default attribute is present and set to 'true',
then the server MUST treat the new data node as a request to return
that node to its default value (i.e., remove it from the database).
If this editing mode is used, then the effective sub-operation for
the target data node MUST be 'create', 'merge' or 'replace'. If
'create' is the effective sub-operation, then the create request must
be valid on its own (e.g., current data node MUST NOT exist). The
procedure for determining the effective sub-operation is defined in
[I-D.ietf-netconf-4741bis]. It is derived from the 'default-
operation' parameter and/or any 'nc:operation' attribute that are
present in the data node or any of its ancestor nodes, within the
<edit-config> request message.
4.6.3. Other Operations
Other operations that return configuration data SHOULD also handle Other operations that return configuration data SHOULD also handle
default data according to the rules set in this document, and default data according to the rules set in this document, and
explicitly state this in their documentation. If this is not explicitly state this in their documentation. If this is not
specified in the document defining the respective operation, the specified in the document defining the respective operation, the
default handling rules described herein do not affect these default handling rules described herein do not affect these
operations. operations.
2.7. Interactions with Other Capabilities 4.7. Interactions with Other Capabilities
None None
3. YANG Module 5. YANG Module for the <with-defaults> Parameter
The following YANG module defines the addition of the with-defaults The following YANG module defines the addition of the with-defaults
element to the <get>, <get-config> and <copy-config> operations. The element to the <get>, <get-config> and <copy-config> operations. The
YANG language is defined in [I-D.ietf-netmod-yang]. The above YANG language is defined in [I-D.ietf-netmod-yang]. The above
operations are defined in YANG in [I-D.ietf-netconf-4741bis]. Every operations are defined in YANG in [I-D.ietf-netconf-4741bis]. Every
NETCONF server SHOULD implement this YANG module. NETCONF server which supports the :with-defaults capability MUST
implement this YANG module.
<CODE BEGINS> file="ietf-netconf-with-defaults.yang" <CODE BEGINS> file="ietf-netconf-with-defaults@2010-05-19.yang"
module ietf-netconf-with-defaults { module ietf-netconf-with-defaults {
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"; namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults";
prefix nwd; prefix nwd;
import ietf-netconf { prefix nc; } import ietf-netconf { prefix nc; }
organization organization
skipping to change at page 9, line 32 skipping to change at page 14, line 26
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this note // RFC Ed.: replace XXXX with actual RFC number and remove this note
// RFC Ed.: remove this note // RFC Ed.: remove this note
// Note: extracted from draft-ietf-netmod-with-defaults-06.txt // Note: extracted from draft-ietf-netmod-with-defaults-08.txt
revision 2010-04-19 { revision 2010-05-19 {
description description
"Initial version."; "Initial version.";
reference reference
"RFC XXXX: With-defaults capability for NETCONF"; "RFC XXXX: With-defaults capability for NETCONF";
} }
// RFC Ed.: replace XXXX with actual RFC number and remove this note // RFC Ed.: replace XXXX with actual RFC number and remove this note
typedef with-defaults-mode { typedef with-defaults-mode {
description description
"Possible modes to report default data in "Possible modes to report default data in
rpc-reply messages."; rpc-reply messages.";
type enumeration { type enumeration {
enum report-all { enum report-all {
description description
"All default data is always reported."; "All default data is reported.";
}
enum report-all-tagged {
description
"All default data is reported.
Any nodes considered to be default data
will contain a 'wd:default' XML attribute,
set to 'true'.";
} }
enum trim { enum trim {
description description
"Values are not reported if they match the default."; "Values are not reported if they match the default.";
} }
enum explicit { enum explicit {
description description
"Report values that match the definition of "Report values that match the definition of
explicitly set data."; explicitly set data.";
} }
skipping to change at page 10, line 42 skipping to change at page 15, line 43
// extending the copy-config operation // extending the copy-config operation
augment /nc:copy-config/nc:input { augment /nc:copy-config/nc:input {
uses with-defaults-parameters; uses with-defaults-parameters;
} }
} }
<CODE ENDS> <CODE ENDS>
4. IANA Considerations 6. XSD for the 'wd:default' Attribute
This document registers one capability identifier URN from the The following XML Schema document defines the 'default' attribute,
'Network Configuration Protocol [RFC4741] Capability URNs' registry, described within this document. This XSD is only relevant if the
and registers the same URN for the NETCONF XML namespace in the "IETF server supports the 'report-all-tagged' defaults retrieval mode.
XML registry" [RFC3688]. Note that the capability URN is compliant
to [RFC4741] section 10.3.
+----------------+--------------------------------------------------+ <CODE BEGINS> file="defaults.xsd"
| Index | Capability Identifier |
+----------------+--------------------------------------------------+
| :with-defaults | urn:ietf:params:netconf:capability:with-defaults |
+----------------+--------------------------------------------------+
This document also registers one module name in the 'YANG Module <?xml version="1.0" encoding="UTF-8"?>
Names' registry, defined in [I-D.ietf-netmod-yang] . The following <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
data should be recorded in this registry: xmlns="urn:ietf:params:xml:ns:netconf:default:1.0"
targetNamespace="urn:ietf:params:xml:ns:netconf:default:1.0"
elementFormDefault="qualified"
attributeFormDefault="unqualified"
xml:lang="en">
+----------+--------------------------------------------------------+ <xs:annotation>
| Field | Value | <xs:documentation>
+----------+--------------------------------------------------------+ This schema defines the syntax for the 'default' attribute
| Module | ietf-netconf-with-defaults | described within this document.
| Name | | </xs:documentation>
| Module | nwd | </xs:annotation>
| Prefix | |
| XML | urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults |
| Namespac | |
| e | |
| Module | XXXX // RFC Ed.: replace XXXX and remove |
| RFC | |
+----------+--------------------------------------------------------+
5. Security Considerations <!--
default attribute
-->
<xs:attribute name="default"
type="xs:boolean"
form="qualified"
default="false">
<xs:annotation>
<xs:documentation>
This attribute indicates whether the data node represented
by the XML element containing this attribute is considered
by the server to be default data. If set to 'true' then
the data node is default data. If 'false', then the
data node is not default data.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:schema>
<CODE ENDS>
7. IANA Considerations
This document registers the following capability identifier URN in
the 'Network Configuration Protocol Capability URNs registry':
urn:ietf:params:netconf:capability:with-defaults:1.0
Note that the capability URN is compliant to [RFC4741] section 10.3.
This document registers two XML namespace URNs in the 'IETF XML
registry', following the format defined in [RFC3688].
URI: urn:ietf:params:xml:ns:netconf:default:1.0
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URIs are XML namespaces.
This document registers one module name in the 'YANG Module Names'
registry, defined in [I-D.ietf-netmod-yang] .
name: ietf-netconf-with-defaults
prefix: nwd
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
RFC: XXXX // RFC Ed.: replace XXXX and remove this comment
8. Security Considerations
This document defines a minor extension to existing NETCONF protocol This document defines a minor extension to existing NETCONF protocol
operations. It does not introduce any new or increased security operations. It does not introduce any new or increased security
risks into the management system. risks into the management system.
The 'with-defaults' capability gives client control over the The 'with-defaults' capability gives client control over the
retrieval of particular types of XML data from a configuration retrieval of particular types of XML data from a configuration
database. They only suppress data that can already be retrieved with datastore. They only suppress data that can already be retrieved
the standard protocol operations, and do not add any data to the with the standard protocol operations, and do not add any data to the
configuration database. configuration datastore.
6. Acknowledgements 9. Acknowledgements
Thanks to Martin Bjorklund, Sharon Chisholm, Phil Shafer, Juergen Thanks to Martin Bjorklund, Sharon Chisholm, Phil Shafer, Juergen
Schoenwaelder, Washam Fan and many other members of the NETCONF WG Schoenwaelder, Washam Fan and many other members of the NETCONF WG
for providing important input to this document. for providing important input to this document.
7. Normative References 10. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004. January 2004.
[RFC4741] Enns, R., "NETCONF Configuration Protocol", RFC 4741, [RFC4741] Enns, R., "NETCONF Configuration Protocol", RFC 4741,
December 2006. December 2006.
skipping to change at page 12, line 24 skipping to change at page 18, line 18
Bierman, "Network Configuration Protocol (NETCONF)", Bierman, "Network Configuration Protocol (NETCONF)",
draft-ietf-netconf-4741bis-02 (work in progress), draft-ietf-netconf-4741bis-02 (work in progress),
February 2010. February 2010.
[I-D.ietf-netmod-yang] [I-D.ietf-netmod-yang]
Bjorklund, M., "YANG - A data modeling language for Bjorklund, M., "YANG - A data modeling language for
NETCONF", draft-ietf-netmod-yang-12 (work in progress), NETCONF", draft-ietf-netmod-yang-12 (work in progress),
April 2010. April 2010.
[W3C.REC-xml-20081126] [W3C.REC-xml-20081126]
Yergeau, F., Maler, E., Paoli, J., Sperberg-McQueen, C., Yergeau, F., Maler, E., Bray, T., Paoli, J., and C.
and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth Sperberg-McQueen, "Extensible Markup Language (XML) 1.0
Edition)", World Wide Web Consortium Recommendation REC- (Fifth Edition)", World Wide Web Consortium
xml-20081126, November 2008, Recommendation REC-xml-20081126, November 2008,
<http://www.w3.org/TR/2008/REC-xml-20081126>. <http://www.w3.org/TR/2008/REC-xml-20081126>.
Appendix A. Usage Examples Appendix A. Usage Examples
A.1. Example YANG Module A.1. Example YANG Module
The following YANG module defines an example interfaces table to The following YANG module defines an example interfaces table to
demonstrate how the <with-defaults> parameter behaves for a specific demonstrate how the <with-defaults> parameter behaves for a specific
data model. data model.
Note that this is not a real module, and implementation of this Note that this is not a real module, and implementation of this
module is not required for conformance to the :with-defaults protocol module is not required for conformance to the :with-defaults protocol
capability, defined in Section 2. This module is not to be capability, defined in Section 4. This module is not to be
registered with IANA. It is intentionally very terse, and includes registered with IANA, and is not considered to be a code component.
few descriptive statements. It is intentionally very terse, and includes few descriptive
statements.
<CODE BEGINS> file="example.yang"
module example { module example {
namespace "http://example.com/ns/interfaces"; namespace "http://example.com/ns/interfaces";
prefix exam; prefix exam;
typedef itf-status-type { typedef itf-status-type {
description "Interface status"; description "Interface status";
type enumeration { type enumeration {
enum ok; enum ok;
enum 'waking up'; enum 'waking up';
enum 'not feeling so good'; enum 'not feeling so good';
enum 'better check it out'; enum 'better check it out';
enum 'better call for help'; enum 'better call for help';
skipping to change at page 14, line 4 skipping to change at page 19, line 45
} }
leaf itf-status { leaf itf-status {
description description
"The current status of this interface."; "The current status of this interface.";
type itf-status-type; type itf-status-type;
config false; config false;
} }
} }
} }
} }
<CODE ENDS>
A.2. Example Data Set A.2. Example Data Set
The following data element shows the conceptual contents of the The following data element shows the conceptual contents of the
example server for the protocol operation examples in the next example server for the protocol operation examples in the next
section. This includes all the configuration data nodes, non- section. This includes all the configuration data nodes, non-
configuration data nodes, and default leafs. configuration data nodes, and default leafs.
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<interfaces xmlns="http://example.com/ns/interfaces"> <interfaces xmlns="http://example.com/ns/interfaces">
<interface> <interface>
skipping to change at page 16, line 5 skipping to change at page 22, line 5
in Appendix A.1. in Appendix A.1.
The client is retrieving all the data nodes within the 'interfaces' The client is retrieving all the data nodes within the 'interfaces'
object, filtered with the <with-defaults> parameter. object, filtered with the <with-defaults> parameter.
A.3.1. <with-defaults> = 'report-all' A.3.1. <with-defaults> = 'report-all'
The behavior of the <with-defaults> parameter handling for the value The behavior of the <with-defaults> parameter handling for the value
'report-all' is demonstrated in this example. 'report-all' is demonstrated in this example.
<rpc message-id="102" <rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get> <get>
<filter type="subtree"> <filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/> <interfaces xmlns="http://example.com/ns/interfaces"/>
</filter> </filter>
<with-defaults <with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"> xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
report-all report-all
</with-defaults> </with-defaults>
</get> </get>
</rpc> </rpc>
<rpc-reply message-id="102" <rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data> <data>
<interfaces xmlns="http://example.com/ns/interfaces"> <interfaces xmlns="http://example.com/ns/interfaces">
<interface> <interface>
<name>eth0</name> <name>eth0</name>
<mtu>8192</mtu> <mtu>8192</mtu>
<itf-status>up</itf-status> <itf-status>up</itf-status>
</interface> </interface>
<interface> <interface>
<name>eth1</name> <name>eth1</name>
skipping to change at page 16, line 46 skipping to change at page 22, line 46
</interface> </interface>
<interface> <interface>
<name>eth3</name> <name>eth3</name>
<mtu>1500</mtu> <mtu>1500</mtu>
<itf-status>waking up</itf-status> <itf-status>waking up</itf-status>
</interface> </interface>
</interfaces> </interfaces>
</data> </data>
</rpc-reply> </rpc-reply>
A.3.2. <with-defaults> = 'trim' A.3.2. <with-defaults> = 'report-all-tagged'
The behavior of the <with-defaults > parameter handling for the value The behavior of the <with-defaults> parameter handling for the value
'report-all-tagged' is demonstrated in this example. A 'tagged' data
node is an element that contains the wd:default XML attribute, set to
'true'. Any subtrees within the element are also considered to be
tagged as dafault data.
The actual data nodes tagged by the server depends on the defaults
handling basic mode used by the server. Only the data nodes that are
considered to be default data will be tagged.
In this example, the server's basic mode is equal to 'trim', so all
data nodes that would contain the schema default value are tagged.
If the server's basic mode is 'explicit', then only data nodes that
are not explicitly set data are tagged. If the server's basic mode
is 'report-all', then no data nodes are tagged.
<rpc message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/>
</filter>
<with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
report-all-tagged
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:wd="urn:ietf:params:xml:ns:netconf:default:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<itf-status wd:default="true">up</itf-status>
</interface>
<interface>
<name>eth1</name>
<mtu wd:default="true">1500</mtu>
<itf-status wd:default="true">up</itf-status>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<itf-status>not feeling so good</itf-status>
</interface>
<interface>
<name>eth3</name>
<mtu wd:default="true">1500</mtu>
<itf-status>waking up</itf-status>
</interface>
</interfaces>
</data>
</rpc-reply>
A.3.3. <with-defaults> = 'trim'
The behavior of the <with-defaults> parameter handling for the value
'trim' is demonstrated in this example. 'trim' is demonstrated in this example.
<rpc message-id="103" <rpc message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get> <get>
<filter type="subtree"> <filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/> <interfaces xmlns="http://example.com/ns/interfaces"/>
</filter> </filter>
<with-defaults <with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"> xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
skipping to change at page 17, line 42 skipping to change at page 26, line 5
<itf-status>not feeling so good</itf-status> <itf-status>not feeling so good</itf-status>
</interface> </interface>
<interface> <interface>
<name>eth3</name> <name>eth3</name>
<itf-status>waking up</itf-status> <itf-status>waking up</itf-status>
</interface> </interface>
</interfaces> </interfaces>
</data> </data>
</rpc-reply> </rpc-reply>
A.3.3. <with-defaults> = 'explicit' A.3.4. <with-defaults> = 'explicit'
The behavior of the <with-defaults > parameter handling for the value The behavior of the <with-defaults> parameter handling for the value
'explicit' is demonstrated in this example. 'explicit' is demonstrated in this example.
<rpc message-id="104" <rpc message-id="104"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get> <get>
<filter type="subtree"> <filter type="subtree">
<interfaces xmlns="http://example.com/ns/interfaces"/> <interfaces xmlns="http://example.com/ns/interfaces"/>
</filter> </filter>
<with-defaults <with-defaults
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"> xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults">
skipping to change at page 19, line 5 skipping to change at page 27, line 9
<itf-status>waking up</itf-status> <itf-status>waking up</itf-status>
</interface> </interface>
</interfaces> </interfaces>
</data> </data>
</rpc-reply> </rpc-reply>
Appendix B. Change Log Appendix B. Change Log
-- RFC Ed.: remove this section before publication. -- RFC Ed.: remove this section before publication.
B.1. 06-07 B.1. 07-08
Added report-all-tagged mode.
Changed conformance so report-all or report-all-tagged mode SHOULD be
supported.
Clarified capability requirements for each mode, for edit-config and
NV storage requirements.
Changed rpc-error details for unsupported with-defaults value.
Added XSD for wd:default attribute
Expanded example to show report-all-tagged for a basic-mode=trim
server.
B.2. 06-07
Removed text in capability identifier section about adding YANG Removed text in capability identifier section about adding YANG
module capability URI parameters. module capability URI parameters.
Changed YANG module namespace to match YANG format, and updated Changed YANG module namespace to match YANG format, and updated
examples to use this new namespace. examples to use this new namespace.
Fixed some typos. Fixed some typos.
B.2. 05-06 B.3. 05-06
Removed ':1.0' from capability URI. Removed ':1.0' from capability URI.
Removed open issues section because all known issues are closed. Removed open issues section because all known issues are closed.
Moved examples to a separate appendix, and expanded them. Moved examples to a separate appendix, and expanded them.
Added example.yang as an appendix to properly explain the examples Added example.yang as an appendix to properly explain the examples
used within the document. used within the document.
skipping to change at page 19, line 38 skipping to change at page 28, line 10
Clarified <with-defaults> behavior for non-configuration data nodes. Clarified <with-defaults> behavior for non-configuration data nodes.
Clarified various sections based on WGLC comments on mailing list. Clarified various sections based on WGLC comments on mailing list.
Removed some unused terms. Removed some unused terms.
Reversed the order of the change log sections so the most recent Reversed the order of the change log sections so the most recent
changes are shown first. changes are shown first.
B.3. 04-05 B.4. 04-05
Updated I-D and YANG module boiler-plate. Updated I-D and YANG module boiler-plate.
Removed redundant 'with-defaults' YANG feature. Removed redundant 'with-defaults' YANG feature.
Changed definition of 'explicit' mode to match the YANG definition Changed definition of 'explicit' mode to match the YANG definition
Removed XSD because the YANG is normative and the XSD is Removed XSD because the YANG is normative and the XSD is
unconstrained, and does not properly extend the 3 affected NETCONF unconstrained, and does not properly extend the 3 affected NETCONF
operations. operations.
skipping to change at page 20, line 18 skipping to change at page 28, line 38
the YANG module imports the ietf-netconf module in order to augment the YANG module imports the ietf-netconf module in order to augment
some operations. some operations.
Updated capability requirements to include YANG module capability Updated capability requirements to include YANG module capability
parameters. parameters.
Added a description statement to the with-defaults leaf definition. Added a description statement to the with-defaults leaf definition.
Update open issues section; ready to close all open issues. Update open issues section; ready to close all open issues.
B.4. 03-04 B.5. 03-04
Clarifications Clarifications
Added non-netconf interfaces to the definition of explicitly set Added non-netconf interfaces to the definition of explicitly set
default data default data
B.5. 02-03 B.6. 02-03
Clarifications Clarifications
YAM added YAM added
Use the same URN for the capability and the XML namespace to Use the same URN for the capability and the XML namespace to
accommodate YANG, and avoid two separate URN/URIs being advertised in accommodate YANG, and avoid two separate URN/URIs being advertised in
the HELLO message, for such a small function. the HELLO message, for such a small function.
B.6. 01-02 B.7. 01-02
report-all made mandatory report-all made mandatory
Placeholder for YAM added, XSD will be removed when 4741 provides the Placeholder for YAM added, XSD will be removed when 4741 provides the
NETCONF YAM NETCONF YAM
with-defaults is valid for state data as well (if state data has a with-defaults is valid for state data as well (if state data has a
defined default which might not be so frequent). The definition of defined default which might not be so frequent). The definition of
explicit was modified for state data. explicit was modified for state data.
B.7. 00-01 B.8. 00-01
Changed value set of with-default capability and element Changed value set of with-default capability and element
Added version to URI Added version to URI
B.8. -00 B.9. -00
Created from draft-bierman-netconf-with-defaults-01.txt Created from draft-bierman-netconf-with-defaults-01.txt
It was decided by the NETCONF mailing list, that with-defaults should It was decided by the NETCONF mailing list, that with-defaults should
be a sub-element of each affected operation. While this violates the be a sub-element of each affected operation. While this violates the
XSD of RFC4741 this is acceptable and follows the ideas behind XSD of RFC4741 this is acceptable and follows the ideas behind
NETCONF and YANG. NETCONF and YANG.
Hopefully it will be clarified in the 4741bis RFC whether such Hopefully it will be clarified in the 4741bis RFC whether such
extensions are allowed. extensions are allowed.
Authors' Addresses Authors' Addresses
Andy Bierman Andy Bierman
InterWorking Labs InterWorking Labs
Santa Cruz, CA Scotts Valley, CA
USA USA
Phone: +1 831 460 7010 Phone: +1 831 460 7010
Email: andyb@iwl.com Email: andyb@iwl.com
Balazs Lengyel Balazs Lengyel
Ericsson Ericsson
Budapest, Budapest,
Hungary Hungary
Email: balazs.lengyel@ericsson.com Email: balazs.lengyel@ericsson.com
 End of changes. 80 change blocks. 
232 lines changed or deleted 600 lines changed or added

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