draft-ietf-netconf-with-defaults-13.txt   draft-ietf-netconf-with-defaults-14.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft Brocade Internet-Draft Brocade
Intended status: Standards Track B. Lengyel Intended status: Standards Track B. Lengyel
Expires: May 13, 2011 Ericsson Expires: May 15, 2011 Ericsson
November 9, 2010 November 11, 2010
With-defaults capability for NETCONF With-defaults capability for NETCONF
draft-ietf-netconf-with-defaults-13 draft-ietf-netconf-with-defaults-14
Abstract Abstract
The NETCONF protocol defines ways to read and edit configuration data The NETCONF protocol defines ways to read and edit configuration data
from a NETCONF server. In some cases, part of this data may not be from a NETCONF server. In some cases, part of this data may not be
set by the NETCONF client, but rather a default value known to the set by the NETCONF client, but rather a default value known to the
server is used instead. In many situations the NETCONF client has a server is used instead. In many situations the NETCONF client has a
priori knowledge about default data, so the NETCONF server does not priori knowledge about default data, so the NETCONF server does not
need to save it in a NETCONF configuration datastore or send it to need to save it in a NETCONF configuration datastore or send it to
the client in a retrieval operation reply. In other situations the the client in a retrieval operation reply. In other situations the
skipping to change at page 1, line 43 skipping to change at page 1, line 43
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 May 13, 2011. This Internet-Draft will expire on May 15, 2011.
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
skipping to change at page 3, line 17 skipping to change at page 3, line 17
10. Normative References . . . . . . . . . . . . . . . . . . . . . 20 10. Normative References . . . . . . . . . . . . . . . . . . . . . 20
Appendix A. Usage Examples . . . . . . . . . . . . . . . . . . . 20 Appendix A. Usage Examples . . . . . . . . . . . . . . . . . . . 20
A.1. Example YANG Module . . . . . . . . . . . . . . . . . . . 20 A.1. Example YANG Module . . . . . . . . . . . . . . . . . . . 20
A.2. Example Data Set . . . . . . . . . . . . . . . . . . . . . 22 A.2. Example Data Set . . . . . . . . . . . . . . . . . . . . . 22
A.3. Protocol Operation Examples . . . . . . . . . . . . . . . 23 A.3. Protocol Operation Examples . . . . . . . . . . . . . . . 23
A.3.1. <with-defaults> = 'report-all' . . . . . . . . . . . . 23 A.3.1. <with-defaults> = 'report-all' . . . . . . . . . . . . 23
A.3.2. <with-defaults> = 'report-all-tagged' . . . . . . . . 24 A.3.2. <with-defaults> = 'report-all-tagged' . . . . . . . . 24
A.3.3. <with-defaults> = 'trim' . . . . . . . . . . . . . . . 27 A.3.3. <with-defaults> = 'trim' . . . . . . . . . . . . . . . 27
A.3.4. <with-defaults> = 'explicit' . . . . . . . . . . . . . 28 A.3.4. <with-defaults> = 'explicit' . . . . . . . . . . . . . 28
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 29 Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 29
B.1. 12-13 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 B.1. 13-14 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.2. 11-12 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 B.2. 12-13 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.3. 10-11 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 B.3. 11-12 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.4. 09-10 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 B.4. 10-11 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.5. 08-09 . . . . . . . . . . . . . . . . . . . . . . . . . . 29 B.5. 09-10 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.6. 07-08 . . . . . . . . . . . . . . . . . . . . . . . . . . 30 B.6. 08-09 . . . . . . . . . . . . . . . . . . . . . . . . . . 29
B.7. 06-07 . . . . . . . . . . . . . . . . . . . . . . . . . . 30 B.7. 07-08 . . . . . . . . . . . . . . . . . . . . . . . . . . 30
B.8. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 30 B.8. 06-07 . . . . . . . . . . . . . . . . . . . . . . . . . . 30
B.9. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 31 B.9. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 30
B.10. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 31 B.10. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 31
B.11. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 31 B.11. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 31
B.12. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 32 B.12. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 31
B.13. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 32 B.13. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 32
B.14. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 B.14. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 32
B.15. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 32 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 32
1. Introduction 1. Introduction
The NETCONF protocol [RFC4741] defines ways to read configuration and The NETCONF protocol [I-D.ietf-netconf-4741bis] defines ways to read
state data from a NETCONF server. Part of the configuration data may configuration and state data from a NETCONF server. Part of the
not be set by the NETCONF client, but rather by a default value from configuration data may not be set by the NETCONF client, but rather
the data model. In many situations the NETCONF client has a priori by a default value from the data model. In many situations the
knowledge about default data, so the NETCONF server does not need to NETCONF client has a priori knowledge about default data, so the
send it to the client. A priori knowledge can be obtained, e.g., a NETCONF server does not need to send it to the client. A priori
document formally describing the data models supported by the NETCONF knowledge can be obtained, e.g., a document formally describing the
server. data models supported by the NETCONF server.
It can be important for a client to know exactly how a server It can be important for a client to know exactly how a server
implementation will handle default data. There are subtle implementation will handle default data. There are subtle
differences in some protocol operations where the defaults handling differences in some protocol operations where the defaults handling
behavior of the server will affect the outcome of the operation. behavior of the server will affect the outcome of the operation.
1.1. Terminology 1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
skipping to change at page 5, line 17 skipping to change at page 5, line 17
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.
<with-defaults> retrieval: Refers to a protocol operation which <with-defaults> retrieval: Refers to a protocol operation which
includes the <with-default> parameter to control the handling of includes the <with-default> parameter to control the handling of
default data. default data.
:with-defaults: The shorthand notation for the with-defaults :with-defaults: The shorthand notation for the with-defaults
capability identifier. capability identifier.
The following terms are defined in [RFC4741]: The following terms are defined in [I-D.ietf-netconf-4741bis]:
o client o client
o datastore o datastore
o operation o operation
o server o server
The following term is defined in [RFC6020]: The following term is defined in [RFC6020]:
o data node o data node
1.2. Defaults Handling Behavior 1.2. Defaults Handling Behavior
skipping to change at page 14, line 18 skipping to change at page 14, line 18
5. YANG Module for the <with-defaults> Parameter 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. element to the <get>, <get-config>, and <copy-config> operations.
The YANG language is defined in [RFC6020]. The above operations are The YANG language is defined in [RFC6020]. The above operations are
defined in YANG in [I-D.ietf-netconf-4741bis]. Every NETCONF server defined in YANG in [I-D.ietf-netconf-4741bis]. Every NETCONF server
which supports the :with-defaults capability MUST implement this YANG which supports the :with-defaults capability MUST implement this YANG
module. module.
<CODE BEGINS> file="ietf-netconf-with-defaults@2010-11-09.yang" <CODE BEGINS> file="ietf-netconf-with-defaults@2010-11-11.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 ncwd; prefix ncwd;
import ietf-netconf { prefix nc; } import ietf-netconf { prefix nc; }
organization organization
skipping to change at page 15, line 21 skipping to change at page 15, line 21
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-13.txt // Note: extracted from draft-ietf-netmod-with-defaults-14.txt
revision 2010-11-09 { revision 2010-11-11 {
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 Ed.: replace XXXX with actual
// RFC number and remove this note // RFC number and remove this note
typedef with-defaults-mode { typedef with-defaults-mode {
description description
skipping to change at page 19, line 12 skipping to change at page 19, line 12
<CODE ENDS> <CODE ENDS>
7. IANA Considerations 7. IANA Considerations
This document registers the following capability identifier URN in This document registers the following capability identifier URN in
the 'Network Configuration Protocol Capability URNs registry': the 'Network Configuration Protocol Capability URNs registry':
urn:ietf:params:netconf:capability:with-defaults:1.0 urn:ietf:params:netconf:capability:with-defaults:1.0
Note that the capability URN is compliant to [RFC4741] section 10.3. Note that the capability URN is compliant to
[I-D.ietf-netconf-4741bis] section 10.3.
This document registers two XML namespace URNs in the 'IETF XML This document registers two XML namespace URNs in the 'IETF XML
registry', following the format defined in [RFC3688]. registry', following the format defined in [RFC3688].
URI: urn:ietf:params:xml:ns:netconf:default:1.0 URI: urn:ietf:params:xml:ns:netconf:default:1.0
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults URI: urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URIs are XML namespaces. XML: N/A, the requested URIs are XML namespaces.
skipping to change at page 20, line 13 skipping to change at page 20, line 13
NETCONF WG for providing important input to this document. NETCONF WG for providing important input to this document.
10. 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,
December 2006.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)", RFC 6020, Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010. October 2010.
[I-D.ietf-netconf-4741bis] [I-D.ietf-netconf-4741bis]
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-06 (work in progress), draft-ietf-netconf-4741bis-06 (work in progress),
October 2010. October 2010.
[W3C.REC-xml-20081126] [W3C.REC-xml-20081126]
Yergeau, F., Maler, E., Paoli, J., Sperberg-McQueen, C., Maler, E., Yergeau, F., Sperberg-McQueen, C., Paoli, J.,
and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth and T. Bray, "Extensible Markup Language (XML) 1.0 (Fifth
Edition)", World Wide Web Consortium Recommendation REC- Edition)", World Wide Web Consortium Recommendation REC-
xml-20081126, November 2008, xml-20081126, November 2008,
<http://www.w3.org/TR/2008/REC-xml-20081126>. <http://www.w3.org/TR/2008/REC-xml-20081126>.
[W3C.REC-xmlschema-0-20041028] [W3C.REC-xmlschema-0-20041028]
Walmsley, P. and D. Fallside, "XML Schema Part 0: Primer Walmsley, P. and D. Fallside, "XML Schema Part 0: Primer
Second Edition", World Wide Web Consortium Second Edition", World Wide Web Consortium
Recommendation REC-xmlschema-0-20041028, October 2004, Recommendation REC-xmlschema-0-20041028, October 2004,
<http://www.w3.org/TR/2004/REC-xmlschema-0-20041028>. <http://www.w3.org/TR/2004/REC-xmlschema-0-20041028>.
skipping to change at page 29, line 9 skipping to change at page 29, line 9
<status>waking up</status> <status>waking up</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. 12-13 B.1. 13-14
Removed reference to RFC 4741 and using 4741bis instead.
B.2. 12-13
Removed with-defaults capability conformance section. Removed with-defaults capability conformance section.
Changed 'wd:default' to 'default'. Changed 'wd:default' to 'default'.
Added normative reference to XSD. Added normative reference to XSD.
Clarified conditional support for with-defaults enumerations, based Clarified conditional support for with-defaults enumerations, based
on capability parameters. on capability parameters.
Clarified that all xs:boolean encoding values must be supported. Clarified that all xs:boolean encoding values must be supported.
Clarified purpose of also-supported parameter in capability URI. Clarified purpose of also-supported parameter in capability URI.
B.2. 11-12 B.3. 11-12
Made editorial clarifications based on AD review. Made editorial clarifications based on AD review.
B.3. 10-11 B.4. 10-11
Changed term 'database' to 'configuration datastore' or generic Changed term 'database' to 'configuration datastore' or generic
'datastore'. 'datastore'.
B.4. 09-10 B.5. 09-10
Changed term 'datastore' to 'database'. Changed term 'datastore' to 'database'.
Added term 'default value'. Added term 'default value'.
Clarified verbage for data node containing a default value. Clarified verbage for data node containing a default value.
B.5. 08-09 B.6. 08-09
Removed non-volatile server requirements. Removed non-volatile server requirements.
Moved some text from basic-mode section into the the retrieval modes Moved some text from basic-mode section into the the retrieval modes
section. section.
Added description and reference statements to the YANG module. Added description and reference statements to the YANG module.
Many bugfixes and clarifications, based on WGLC review comments. Many bugfixes and clarifications, based on WGLC review comments.
B.6. 07-08 B.7. 07-08
Added report-all-tagged mode. Added report-all-tagged mode.
Changed conformance so report-all or report-all-tagged mode SHOULD be Changed conformance so report-all or report-all-tagged mode SHOULD be
supported. supported.
Clarified capability requirements for each mode, for edit-config and Clarified capability requirements for each mode, for edit-config and
NV storage requirements. NV storage requirements.
Changed rpc-error details for unsupported with-defaults value. Changed rpc-error details for unsupported with-defaults value.
Added XSD for wd:default attribute Added XSD for wd:default attribute
Expanded example to show report-all-tagged for a basic-mode=trim Expanded example to show report-all-tagged for a basic-mode=trim
server. server.
B.7. 06-07 B.8. 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.8. 05-06 B.9. 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 31, line 6 skipping to change at page 31, line 8
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.9. 04-05 B.10. 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 31, line 34 skipping to change at page 31, line 36
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.10. 03-04 B.11. 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.11. 02-03 B.12. 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.12. 01-02 B.13. 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.13. 00-01 B.14. 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.14. -00 B.15. -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.
 End of changes. 26 change blocks. 
49 lines changed or deleted 52 lines changed or added

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