draft-ietf-netconf-with-defaults-05.txt   draft-ietf-netconf-with-defaults-06.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: September 6, 2010 Ericsson Expires: September 29, 2010 Ericsson
March 5, 2010 March 28, 2010
With-defaults capability for NETCONF With-defaults capability for NETCONF
draft-ietf-netconf-with-defaults-05 draft-ietf-netconf-with-defaults-06
Abstract Abstract
The NETCONF protocol defines ways to read configuration data from a The NETCONF protocol defines ways to read configuration data from a
NETCONF server. Part of this data is not set by the NETCONF client, NETCONF server. Part of this data is not set by the NETCONF client,
but rather a default value is used. In many situations the NETCONF but rather a default value is used. In many situations the NETCONF
client has a priori knowledge about default data, so the NETCONF client has a priori knowledge about default data, so the NETCONF
server does not need to send it to the client. In other situations server does not need to send it to the client. In other situations
the NETCONF client will need this data as part of the NETCONF <rpc- the NETCONF client will need this data as part of the NETCONF <rpc-
reply> messages. This document defines a capability-based extension reply> messages. This document defines a capability-based extension
skipping to change at page 1, line 46 skipping to change at page 1, line 46
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."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
This Internet-Draft will expire on September 6, 2010. This Internet-Draft will expire on September 29, 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
skipping to change at page 3, line 17 skipping to change at page 3, line 17
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
1.2. Current handling of default data . . . . . . . . . . . . . 5 1.2. Current handling of default data . . . . . . . . . . . . . 5
2. With-defaults Capability . . . . . . . . . . . . . . . . . . . 6 2. With-defaults Capability . . . . . . . . . . . . . . . . . . . 6
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 6 2.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 6
2.3. Conformance . . . . . . . . . . . . . . . . . . . . . . . 6 2.3. Conformance . . . . . . . . . . . . . . . . . . . . . . . 6
2.4. Capability Identifier . . . . . . . . . . . . . . . . . . 6 2.4. Capability Identifier . . . . . . . . . . . . . . . . . . 6
2.5. New Operations . . . . . . . . . . . . . . . . . . . . . . 7 2.5. New Operations . . . . . . . . . . . . . . . . . . . . . . 7
2.6. Modifications to Existing Operations . . . . . . . . . . . 7 2.6. Modifications to Existing Operations . . . . . . . . . . . 7
2.7. Interactions with Other Capabilities . . . . . . . . . . . 9 2.7. Interactions with Other Capabilities . . . . . . . . . . . 8
3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 9 3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 8
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10
5. Security Considerations . . . . . . . . . . . . . . . . . . . 12 5. Security Considerations . . . . . . . . . . . . . . . . . . . 11
6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 13 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 11
7. Normative References . . . . . . . . . . . . . . . . . . . . . 13 7. Normative References . . . . . . . . . . . . . . . . . . . . . 11
Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . . 13 Appendix A. Usage Examples . . . . . . . . . . . . . . . . . . . 12
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 14 A.1. Example YANG Module . . . . . . . . . . . . . . . . . . . 12
B.1. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 A.2. Example Data Set . . . . . . . . . . . . . . . . . . . . . 14
B.2. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 14 A.3. Protocol Operation Examples . . . . . . . . . . . . . . . 15
B.3. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 14 A.3.1. <with-defaults> = 'report-all' . . . . . . . . . . . . 15
B.4. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 14 A.3.2. <with-defaults> = 'trim' . . . . . . . . . . . . . . . 16
B.5. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.3.3. <with-defaults> = 'explicit' . . . . . . . . . . . . . 17
B.6. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 15 B.1. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 19
B.2. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 19
B.3. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 20
B.4. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 20
B.5. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 20
B.6. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 20
B.7. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 21
1. Introduction 1. Introduction
The NETCONF protocol [RFC4741] defines ways to read configuration The NETCONF protocol [RFC4741] defines ways to read configuration and
data from a NETCONF server. Part of this data is not set by the state data from a NETCONF server. Part of the configuration data may
NETCONF client, but rather a default value is used. In many not be set by the NETCONF client, but rather by a default value from
situations the NETCONF client has a priori knowledge about default the data model. In many situations the NETCONF client has a priori
data, so the NETCONF server does not need to send it to the client. knowledge about default data, so the NETCONF server does not need to
A priori knowledge can be e.g., a document formally describing the send it to the client. A priori knowledge can be e.g., a document
data models supported by the NETCONF server. formally describing the data models supported by the NETCONF server.
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 node:
skipping to change at page 5, line 12 skipping to change at page 5, line 12
Data model schema: A document or set of documents describing the Data model schema: A document or set of documents describing the
data models supported by the NETCONF server. data models supported by the NETCONF server.
Management Application: A computer program running outside the Management Application: A computer program running outside the
NETCONF server that configures or supervises the NETCONF server. NETCONF server that configures or supervises the NETCONF server.
A management application can reach the device e.g. via the A management application can reach the device e.g. via the
NETCONF, CLI or SNMP. NETCONF, CLI or SNMP.
Default data: Data specified in the data model schema as default, Default data: Data specified in the data model schema as default,
that is set or used by the device whenever the NETCONF client or that is set or used by the device whenever the NETCONF client or
other management application/user does not provide a specific other management application/user does not provide a specific
value for the relevant data item. Default data MAY or MAY NOT be value for the relevant data item. Default data MAY or may not be
stored as part of a configuration datastore. stored as part of a configuration datastore.
Explicitly set data: Data that is set to any value by a NETCONF Explicitly set data: Data that is set to any value by a NETCONF
client or other management application by the way of an actual client or other management application by the way of an actual
management operation, including any data model schema default management operation, including any data model schema default
value. Any value set by the NETCONF server which is not the value. Any value set by the NETCONF server which is not the
schema defined default value is also considered explicitly set schema defined default value is also considered explicitly set
data. data.
In addition the following terms are defined in RFC 4741 and are not In addition the following terms are defined in RFC 4741 and are not
redefined here: redefined here:
o client o client
o operation o operation
o RPC
o RPC request
o RPC response
o server o server
1.2. Current handling of default data 1.2. Current handling of default data
NETCONF does not define whether default data is part of the NETCONF does not define whether default data is part of the
datastore/data model, or if it is meta-data that influences the datastore/data model, or if it is meta-data that influences the
behavior of the NETCONF server, but is not actually part of the behavior of the NETCONF server, but is not actually part of the
datastore. This document is intended to support either type of datastore. This document is intended to support either type of
implementation, without deciding which approach is better. implementation, without deciding which approach is better.
As a consequence of this approach, NETCONF servers that do not As a consequence of this approach, NETCONF servers that do not
implement the :with-defaults capability may or may not return default implement the :with-defaults capability may or may not return default
data. data.
Different NETCONF servers report default data in different ways. Different NETCONF servers report default data in different ways.
This document specifies the following three basic modes: This document specifies the following three basic modes:
report-all: All default data is always reported. report-all: All default data is always reported.
trim: Values are not reported if they match the default value (as trim: Values are not reported if they match the default value (as
specified in the data model schema). 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 explicit: Report only values that match the definition of explicitly
set data. set data. For non-configuration data, this has the same affect as
'report-all'.
2. With-defaults Capability 2. With-defaults Capability
2.1. Overview 2.1. Overview
The :with-defaults capability indicates that the NETCONF server makes The :with-defaults capability indicates that the NETCONF server makes
it possible for the NETCONF client to control whether default data is it possible for the NETCONF client to control whether default data is
part of NETCONF <rpc-reply> messages. The capability affects both part of NETCONF <rpc-reply> messages. The capability affects both
configuration and state data (while acknowledging that the usage of configuration and state data (while acknowledging that the usage of
default values for state data is less prevalent). Sending of default default values for state data is less prevalent). Sending of default
data is controlled for each individual operation separately. data is controlled for each individual operation separately.
A NETCONF server implementing the :with-defaults capability MUST A NETCONF server implementing the :with-defaults capability MUST
indicate its basic behavior, whether it sends default data in the indicate its basic behavior, whether it sends default data in the
absence of any specific request from the NETCONF client; and MUST absence of any specific request from the NETCONF client; and MUST
support the 'report-all' handling mode and MAY support other modes. support the 'report-all' handling mode and MAY support other modes.
A server indicating 'explicit' either in the basic or the also- A server indicating 'explicit' either in the 'basic-mode' or the
supported parameter MUST be able to differentiate between normal 'also-supported' parameter MUST be able to differentiate between
default data and explicitly set data. normal default data and explicitly set data.
2.2. Dependencies 2.2. Dependencies
None None
2.3. Conformance 2.3. Conformance
Every NETCONF server SHOULD implement this capability. Every NETCONF server SHOULD implement this capability.
2.4. Capability Identifier 2.4. Capability Identifier
urn:ietf:params:netconf:capability:with-defaults:1.0 urn:ietf:params:netconf:capability:with-defaults
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 reports default data in <rpc-reply> messages, in the
case the client does not specify the required behavior in the <rpc> case the client does not specify the required behavior in the <rpc>
request. The allowed values of this parameter are report-all, trim, request. The allowed values of this parameter are report-all, trim,
explicit as listed in Section 1.2. explicit as listed in Section 1.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 two modes that are supported beside the mode indicated
in the basic parameter. Possible modes are taken from the list in in the 'basic-mode' parameter. Possible modes are taken from the
Section 1.2. list in Section 1.2.
In addition to these parameters, the identifier MUST have the YANG In addition to these parameters, the identifier MUST have the YANG
'module' and 'revision' parameters if the ietf-with-defaults YANG 'module' and 'revision' parameters if the ietf-with-defaults YANG
module is supported, as defined in section 5.6.4 of module is supported, as defined in section 5.6.4 of
[I-D.ietf-netmod-yang]. [I-D.ietf-netmod-yang].
Example: Example:
urn:ietf:params:netconf:capability:with-defaults:1.0?module=ietf- urn:ietf:params:netconf:capability:with-defaults?module=ietf-netconf-
netconf-with-defaults&revision=2010-03-05&basic-mode=report-all with-defaults&revision=2010-03-25&basic-mode=report-all
urn:ietf:params:netconf:capability:with-defaults:1.0?module=ietf- urn:ietf:params:netconf:capability:with-defaults?module=ietf-netconf-
netconf-with-defaults&revision=2010-03-05&basic-mode=report-all& with-defaults&revision=2010-03-25&basic-mode=report-all&
also-supported=trim,explicit also-supported=trim,explicit
2.5. New Operations 2.5. New Operations
None None
2.6. Modifications to Existing Operations 2.6. Modifications to Existing Operations
A new <with-defaults> XML [W3C.REC-xml-20001006] child element is A new <with-defaults> XML child element is added to the <get>, <get-
added to the method-name element. This is the element that indicates config> and <copy-config> operations. If the <with-defaults> element
the type of the operation e.g. <get>, <get-config> or <copy-config>. is present, it controls the reporting of default data. The server
If the <with-defaults> element is present, it controls the reporting MUST return default data in the NETCONF <rpc-reply> messages
of default data. The server MUST return default data in the NETCONF according to the value of the element.
<rpc-reply> messages according to the value of the element.
The <with-defaults> element is defined in the XML namespace for the
ietf-netconf-with-defaults.yang module in Section 3, not the XML
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 1.2. The allowed values are restricted to the values that
the device indicates support for in the with-defaults capability in the device indicates support for in the with-defaults capability in
the basic and also-supported parameters. the basic and also-supported parameters.
If an unsupported value is used, the NETCONF server SHALL return an If an unsupported value is used, the NETCONF server MUST return an
<rpc-reply> with an <rpc-error> element. The <error-tag> SHALL be <rpc-reply> with an <rpc-error> element. The <error-tag> MUST be
'operation-not-supported', and the <error-app-tag> SHALL be 'with- 'operation-not-supported', and the <error-app-tag> MUST be 'with-
defaults-mode-not-supported'. defaults-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 follows its
basic behavior as indicated by the capability identifier's parameter basic behavior as indicated by the capability identifier's 'basic-
see Section 2.4. mode' parameter see Section 2.4.
Affected operations: Affected operations:
o <get> o <get>
o <get-config> o <get-config>
o <copy-config> o <copy-config>
<copy-config> is only affected if the target of the operation is a <copy-config> is only affected if the target of the operation is a
URL. If the target is a NETCONF datastore (running, candidate or URL. If the target is a NETCONF datastore (running, candidate or
startup) the capability has no effect; the with-defaults parameter, startup) the capability has no effect; the with-defaults parameter,
if present, SHALL be silently ignored. if present, MUST be silently ignored.
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.
The following example shows a <get-config> operation which is using
the 'with-defaults' element. The client is retrieving the
'interfaces' object, defined in the example.com data model. (In this
simple example, the 'name' field is defined as the key, and the 'mtu'
field is the only other data in the <interface> element). The
default value of mtu is '1500'. The basic default handling for the
server is "trim". As the 'with-defaults' element has the value
'report-all', the mtu is returned not just for eth0 but also for
eth1.
<rpc message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get-config>
<source>
<running/>
</source>
<filter type="subtree">
<interfaces xmlns="http://example.com/interfaces/1.2"/>
</filter>
<with-defaults
xmlns="urn:ietf:params:netconf:capability:with-defaults:1.0">
report-all
</with-defaults>
</get-config>
</rpc>
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/interfaces/1.2">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
</interface>
<interface>
<name>eth1</name>
<mtu>1500</mtu>
</interface>
</interfaces>
</data>
</rpc-reply>
Figure 1
2.7. Interactions with Other Capabilities 2.7. Interactions with Other Capabilities
None None
3. YANG Module 3. YANG Module
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 SHOULD implement this YANG module.
-- RFC Ed.: Insert license information for code as appropriate
<CODE BEGINS> file="ietf-netconf-with-defaults.yang" <CODE BEGINS> file="ietf-netconf-with-defaults.yang"
module ietf-netconf-with-defaults { module ietf-netconf-with-defaults {
namespace "urn:ietf:params:netconf:capability:with-defaults:1.0"; namespace "urn:ietf:params:netconf:capability:with-defaults";
prefix nwd; prefix nwd;
import ietf-netconf { prefix nc; } import ietf-netconf { prefix nc; }
organization organization
"IETF NETCONF (Network Configuration Protocol) Working Group"; "IETF NETCONF (Network Configuration Protocol) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netconf/> "WG Web: <http://tools.ietf.org/wg/netconf/>
skipping to change at page 11, line 11 skipping to change at page 9, line 32
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-05.txt // Note: extracted from draft-ietf-netmod-with-defaults-06.txt
revision 2010-03-05 { revision 2010-03-25 {
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
skipping to change at page 12, line 29 skipping to change at page 11, line 5
<CODE ENDS> <CODE ENDS>
4. IANA Considerations 4. IANA Considerations
This document registers one capability identifier URN from the This document registers one capability identifier URN from the
'Network Configuration Protocol [RFC4741] Capability URNs' registry, 'Network Configuration Protocol [RFC4741] Capability URNs' registry,
and registers the same URN for the NETCONF XML namespace in the "IETF and registers the same URN for the NETCONF XML namespace in the "IETF
XML registry" [RFC3688]. Note that the capability URN is compliant XML registry" [RFC3688]. Note that the capability URN is compliant
to [RFC4741] section 10.3. to [RFC4741] section 10.3.
+---------------+---------------------------------------------------+ +----------------+--------------------------------------------------+
| Index | Capability Identifier | | Index | Capability Identifier |
+---------------+---------------------------------------------------+ +----------------+--------------------------------------------------+
| :with-default | urn:ietf:params:netconf:capability:with-defaults: | | :with-defaults | urn:ietf:params:netconf:capability:with-defaults |
| s | 1.0 | +----------------+--------------------------------------------------+
+---------------+---------------------------------------------------+
This document also registers one module name in the 'YANG Module
Names' registry, defined in [I-D.ietf-netmod-yang] . The following
data should be recorded in this registry:
+----------------+--------------------------------------------------+
| Field | Value |
+----------------+--------------------------------------------------+
| Module Name | ietf-netconf-with-defaults |
| Module Prefix | nwd |
| XML Namespace | urn:ietf:params:netconf:capability:with-defaults |
| Module RFC | XXXX // RFC Ed.: replace XXXX and remove |
+----------------+--------------------------------------------------+
5. Security Considerations 5. 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 database. They only suppress data that can already be retrieved with
skipping to change at page 13, line 33 skipping to change at page 12, line 19
Enns, R., Bjorklund, M., Schoenwaelder, J., and A. Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
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-11 (work in progress), NETCONF", draft-ietf-netmod-yang-11 (work in progress),
February 2010. February 2010.
[W3C.REC-xml-20001006] [W3C.REC-xml-20081126]
Sperberg-McQueen, C., Maler, E., Paoli, J., and T. Bray, Yergeau, F., Bray, T., Maler, E., Paoli, J., and C.
"Extensible Markup Language (XML) 1.0 (Second Edition)", Sperberg-McQueen, "Extensible Markup Language (XML) 1.0
World Wide Web Consortium FirstEdition REC-xml-20001006, (Fifth Edition)", World Wide Web Consortium
October 2000, Recommendation REC-xml-20081126, November 2008,
<http://www.w3.org/TR/2000/REC-xml-20001006>. <http://www.w3.org/TR/2008/REC-xml-20081126>.
Appendix A. Open Issues Appendix A. Usage Examples
This section will be removed. The open issues are closed in this A.1. Example YANG Module
revision of the draft, pending working group approval.
Is the definition of defaults OK? [The definition of explicitly set The following YANG module defines an example interfaces table to
default data has been changed to 'explicitly set data', and now demonstrate how the <with-defaults> parameter behaves for a specific
aligns with the YANG definition.] data model.
Shall we wait for YANG and 4741bis and make the YANG normative? Note that this is not a real module, and implementation of this
[Yes.] module is not required for conformance to the :with-defaults protocol
Shall we make with-defaults mandatory? [No. It is SHOULD, not capability, defined in Section 2. This module is not to be
MUST.] registered with IANA. It is intentionally very terse, and include
few descriptive statements.
Appendix B. Change Log <CODE BEGINS> file="example.yang"
-- RFC Ed.: remove this section before publication. module example {
B.1. -00 namespace "http://example.com/ns/interfaces";
Created from draft-bierman-netconf-with-defaults-01.txt prefix exam;
It was decided by the NETCONF mailing list, that with-defaults should typedef itf-status-type {
be a sub-element of each affected operation. While this violates the description "Interface status";
XSD of RFC4741 this is acceptable and follows the ideas behind type enumeration {
NETCONF and YANG. enum ok;
enum 'waking up';
enum 'not feeling so good';
enum 'better check it out';
enum 'better call for help';
}
default ok;
}
Hopefully it will be clarified in the 4741bis RFC whether such container interfaces {
extensions are allowed. description "Example interfaces group";
B.2. 00-01 list interface {
description "Example interface entry";
key name;
Changed value set of with-default capability and element leaf name {
description
"The administrative name of the interface.
This is an identifier which is only unique
within the scope of this list, and only
within a specific server.";
type string {
length "1 .. max";
}
}
Added version to URI leaf mtu {
description
"The maximum transmission unit (MTU) value assigned to
this interface.";
type uint32;
default 1500;
}
B.3. 01-02 leaf itf-status {
description
"The current status of this interface.";
type itf-status-type;
config false;
}
}
}
}
report-all made mandatory <CODE ENDS>
Placeholder for YAM added, XSD will be removed when 4741 provides the A.2. Example Data Set
NETCONF YAM
with-defaults is valid for state data as well (if state data has a The following figure shows the conceptual contents of the example
defined default which might not be so frequent). The definition of server for the protocol operation examples in the next section. This
explicit was modified for state data. includes all the configuration data nodes, non-configuration data
nodes, and default leafs.
B.4. 02-03 <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-example">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<itf-status>up</itf-status>
</interface>
<interface>
<name>eth1</name>
<mtu>1500</mtu>
<itf-status>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>1500</mtu>
<itf-status>waking up</itf-status>
</interface>
</interfaces>
</data>
Clarifications In this example, the 'mtu' field for each interface entry is set in
the following manner:
YAM added +--------------+--------------+--------------+
| name | set by | mtu |
+--------------+--------------+--------------+
| eth0 | client | 8192 |
| eth1 | server | 1500 |
| eth2 | client | 9000 |
| eth3 | client | 1500 |
+--------------+--------------+--------------+
Use the same URN for the capability and the XML namespace to A.3. Protocol Operation Examples
accommodate YANG, and avoid two separate URN/URIs being advertised in
the HELLO message, for such a small function.
B.5. 03-04 The following examples shows some <get> operations which are using
the 'with-defaults' element. The data model used for these examples
is defined in Appendix A.1.
Clarifications The client is retrieving all the data nodes within the 'interfaces'
object, filtered with the <with-defaults> parameter.
Added non-netconf interfaces to the definition of explicitly set A.3.1. <with-defaults> = 'report-all'
default data
B.6. 04-05 The behavior of the <with-defaults > parameter handling for the value
'report-all' is demonstrated in this example.
<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:netconf:capability:with-defaults">
report-all
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<itf-status>up</itf-status>
</interface>
<interface>
<name>eth1</name>
<mtu>1500</mtu>
<itf-status>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>1500</mtu>
<itf-status>waking up</itf-status>
</interface>
</interfaces>
</data>
</rpc-reply>
A.3.2. <with-defaults> = 'trim'
The behavior of the <with-defaults > parameter handling for the value
'trim' is demonstrated in this example.
<rpc message-id="103"
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:netconf:capability:with-defaults">
trim
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
</interface>
<interface>
<name>eth1</name>
</interface>
<interface>
<name>eth2</name>
<mtu>9000</mtu>
<itf-status>not feeling so good</itf-status>
</interface>
<interface>
<name>eth3</name>
<itf-status>waking up</itf-status>
</interface>
</interfaces>
</data>
</rpc-reply>
A.3.3. <with-defaults> = 'explicit'
The behavior of the <with-defaults > parameter handling for the value
'explicit' is demonstrated in this example.
<rpc message-id="104"
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:netconf:capability:with-defaults">
explicit
</with-defaults>
</get>
</rpc>
<rpc-reply message-id="104"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<interfaces xmlns="http://example.com/ns/interfaces">
<interface>
<name>eth0</name>
<mtu>8192</mtu>
<itf-status>up</itf-status>
</interface>
<interface>
<name>eth1</name>
<itf-status>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>1500</mtu>
<itf-status>waking up</itf-status>
</interface>
</interfaces>
</data>
</rpc-reply>
Appendix B. Change Log
-- RFC Ed.: remove this section before publication.
B.1. 05-06
Removed ':1.0' from capability URI.
Removed open issues section because all known issues are closed.
Moved examples to a separate appendix, and expanded them.
Added example.yang as an appendix to properly explain the examples
used within the document.
Replaced normative term 'SHALL' with 'MUST' to be consistent within
this document.
Clarified <with-defaults> behavior for non-configuration data nodes.
Clarified various sections based on WGLC comments on mailing list.
Removed some unused terms.
Reversed the order of the change log sections so the most recent
changes are shown first.
B.2. 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.
Made the YANG module a normative section instead of non-normative Made the YANG module a normative section instead of non-normative
appendix. appendix.
Changed YANG from an informative to a normative reference, Changed YANG from an informative to a normative reference,
Changed 4741bis from an informative to a normative reference because Changed 4741bis from an informative to a normative reference because
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 RPC 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.3. 03-04
Clarifications
Added non-netconf interfaces to the definition of explicitly set
default data
B.4. 02-03
Clarifications
YAM added
Use the same URN for the capability and the XML namespace to
accommodate YANG, and avoid two separate URN/URIs being advertised in
the HELLO message, for such a small function.
B.5. 01-02
report-all made mandatory
Placeholder for YAM added, XSD will be removed when 4741 provides the
NETCONF YAM
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
explicit was modified for state data.
B.6. 00-01
Changed value set of with-default capability and element
Added version to URI
B.7. -00
Created from draft-bierman-netconf-with-defaults-01.txt
It was decided by the NETCONF mailing list, that with-defaults should
be a sub-element of each affected operation. While this violates the
XSD of RFC4741 this is acceptable and follows the ideas behind
NETCONF and YANG.
Hopefully it will be clarified in the 4741bis RFC whether such
extensions are allowed.
Authors' Addresses Authors' Addresses
Andy Bierman Andy Bierman
InterWorking Labs InterWorking Labs
303 Potrero Street, Suite 52 303 Potrero Street, Suite 52
Santa Cruz, CA 95060-2760 Santa Cruz, CA 95060-2760
USA USA
Phone: +1 831 460 7010 Phone: +1 831 460 7010
Email: andyb@iwl.com Email: andyb@iwl.com
 End of changes. 52 change blocks. 
157 lines changed or deleted 400 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/