draft-ietf-netconf-with-defaults-03.txt   draft-ietf-netconf-with-defaults-04.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft Netconf Central Internet-Draft Netconf Central
Intended status: Standards Track B. Lengyel Intended status: Standards Track B. Lengyel
Expires: February 6, 2010 Ericsson Expires: April 25, 2010 Ericsson
August 05, 2009 October 22, 2009
With-defaults capability for NETCONF With-defaults capability for NETCONF
draft-ietf-netconf-with-defaults-03 draft-ietf-netconf-with-defaults-04
Status of this Memo Status of this Memo
This Internet-Draft is submitted to IETF in full conformance with the This Internet-Draft is submitted to IETF 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), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet- other groups may also distribute working documents as Internet-
Drafts. Drafts.
skipping to change at page 1, line 33 skipping to change at page 1, line 33
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 February 6, 2010. This Internet-Draft will expire on April 25, 2010.
Copyright Notice Copyright Notice
Copyright (c) 2009 IETF Trust and the persons identified as the Copyright (c) 2009 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 in effect on the date of Provisions Relating to IETF Documents in effect on the date of
publication of this document (http://trustee.ietf.org/license-info). publication of this document (http://trustee.ietf.org/license-info).
Please review these documents carefully, as they describe your rights Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. and restrictions with respect to this document.
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 manger 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
to the NETCONF protocol that allows the NETCONF client to control to the NETCONF protocol that allows the NETCONF client to control
whether default values are part of NETCONF <rpc-reply> messages. whether default values are part of NETCONF <rpc-reply> messages or
<copy-config> output to the target URL.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1. Requirements Notation . . . . . . . . . . . . . . . . 3
1.1.2. NETCONF Terms . . . . . . . . . . . . . . . . . . . . 4
1.2. Current handling of default data . . . . . . . . . . . . . 4 1.2. Current handling of default data . . . . . . . . . . . . . 4
2. With-defaults Capability . . . . . . . . . . . . . . . . . . . 4 2. With-defaults Capability . . . . . . . . . . . . . . . . . . . 5
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 5 2.2. Dependencies . . . . . . . . . . . . . . . . . . . . . . . 5
2.3. Capability Identifier . . . . . . . . . . . . . . . . . . 5 2.3. Capability Identifier . . . . . . . . . . . . . . . . . . 5
2.4. New Operations . . . . . . . . . . . . . . . . . . . . . . 5 2.4. New Operations . . . . . . . . . . . . . . . . . . . . . . 6
2.5. Modifications to Existing Operations . . . . . . . . . . . 6 2.5. Modifications to Existing Operations . . . . . . . . . . . 6
3. Interactions with Other Capabilities . . . . . . . . . . . . . 7 3. Interactions with Other Capabilities . . . . . . . . . . . . . 7
4. Data Model XSD . . . . . . . . . . . . . . . . . . . . . . . . 7 4. Data Model XSD . . . . . . . . . . . . . . . . . . . . . . . . 8
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
6. Security Considerations . . . . . . . . . . . . . . . . . . . 9 6. Security Considerations . . . . . . . . . . . . . . . . . . . 9
7. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 9 7. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 9
7.1. Other default handling modes in the real world? . . . . . 9
8. Appendix A - YANG Module for with-defaults (non-normative) . 9 8. Appendix A - YANG Module for with-defaults (non-normative) . 9
9. Appendix B - Change Log . . . . . . . . . . . . . . . . . . 12 9. Appendix B - Change Log . . . . . . . . . . . . . . . . . . 12
9.1. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 12 9.1. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
9.2. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 12 9.2. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
9.3. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 12 9.3. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
9.4. -00 . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 9.4. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
9.5. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 13 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 13
11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 13 11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 14
11.1. Normative References . . . . . . . . . . . . . . . . . . . 13 11.1. Normative References . . . . . . . . . . . . . . . . . . . 14
11.2. Informative References . . . . . . . . . . . . . . . . . . 13 11.2. Informative References . . . . . . . . . . . . . . . . . . 14
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 14 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 14
1. Introduction 1. Introduction
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. A priori knowledge server does not need to send it to the client. A priori knowledge
can be e.g., a document formally describing the data models supported can be e.g., a document formally describing the data models supported
skipping to change at page 3, line 35 skipping to change at page 3, line 35
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 theses 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 capability-based extension to the NETCONF
protocol that allows the NETCONF client to control whether default protocol that allows the NETCONF client to control whether default
data is part of NETCONF <rpc-reply> messages. data is part of NETCONF <rpc-reply> messages.
1.1. Terminology 1.1. Terminology
1.1.1. Requirements Notation
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
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
1.1.2. NETCONF Terms o Data model schema is a document or set of documents describing the
data models supported by the NETCONF server.
o Default data: Data that is set or used by the NETCONF server o Default data: Data specified in the data model schema as default,
whenever the NETCONF client does not provide a specific value for that is set or used by the device whenever the NETCONF client or
the relevant data item. Default values SHOULD be specified in other external management application/user does not provide a
documents describing the data models supported by the NETCONF specific value for the relevant data item. External management
server. application/user can reach the device e.g. via the NETCONF, CLI,
SNMP, GUI. Default data MAY or MAY NOT be stored as part of a
configuration datastore.
o Explicitly set default data: Data that is explicitly set by the o Explicitly set default data: Is default data that is set by a
NETCONF client to its default value. Some servers MAY treat NETCONF client or other external management application/user by
the way of an actual management operation to the value specified
as its default in the data model schema. Some servers MAY treat
explicitly set default data as simple default data, as they may explicitly set default data as simple default data, as they may
not be able to differentiate between them. not be able to differentiate between them.
Data, that is set to a value other then its default value, is not
default data, so its handling is outside the scope of this
document.
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 application o application
o client o client
o operation o operation
o RPC o RPC
o RPC request o RPC request
o RPC response 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 issue, NETCONF servers that do not implement As a consequence of this issue, NETCONF servers that do not implement
the :with-defaults capability may or may not return default data in the :with-defaults capability may or may not return default data.
NETCONF <rpc-reply> messages.
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:
o report-all: All default data is always reported. o report-all: All default data is always reported.
o trim: Values are not reported if they match the default. o trim: Values are not reported if they match the default.
o explicit: Report values if they are explicitly set. For state o explicit: Default data is not reported except explicitly set
data this has the same effect as report-all default data. For state data this has the same effect 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 servers 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-
supported parameter MUST be able to differentiate between normal
default data and explicitly set default data.
2.2. Dependencies 2.2. Dependencies
None None
2.3. Capability Identifier 2.3. Capability Identifier
urn:ietf:params:netconf:capability:with-defaults:1.0 urn:ietf:params:netconf:capability:with-defaults:1.0
The identifier MUST have a parameter: "basic". This indicates how The identifier MUST have a parameter: "basic". This indicates how
the server reports default data in <rpc-reply> messages, in the case the server reports default data in <rpc-reply> messages, in the case
the client does not specify the required behavior in the <rpc> 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
indicates what other default handling modes does the server support. parameter indicates which additional default handling modes the
The value of the parameter is a comma separated list of one or two server supports. The value of the parameter is a comma separated
modes that are supported beside the mode indicated in the basic list of one or two modes that are supported beside the mode indicated
parameter Possible modes are taken from the list in Section 1.2. in the basic parameter. Possible modes are taken from the list in
Section 1.2.
Example: Example:
urn:ietf:params:netconf:capability:with-defaults:1.0?basic=report-all urn:ietf:params:netconf:capability:with-defaults:1.0?basic=report-all
urn:ietf:params:netconf:capability:with-defaults:1.0?basic=report- urn:ietf:params:netconf:capability:with-defaults:1.0?basic=report-
all&also-supported=trim,explicit all&also-supported=trim,explicit
2.4. New Operations 2.4. New Operations
skipping to change at page 6, line 18 skipping to change at page 6, line 22
element. This is the element that indicates the type of the element. This is the element that indicates the type of the
operation e.g. <get>, <get-config> or <copy-config>. If the <with- operation e.g. <get>, <get-config> or <copy-config>. If the <with-
defaults> element is present, it controls the reporting of default defaults> element is present, it controls the reporting of default
data. The server MUST return default data in the NETCONF <rpc-reply> data. The server MUST return default data in the NETCONF <rpc-reply>
messages according to the value of the element. messages according to the value of the element.
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 a not allowed value is used the NETCONF server SHALL return an
<rpc-reply> with an <rpc-error> element. The <error-tag> SHALL be
'operation-not-supported', the <error-app-tag> SHALL be "with-
defaults-mode-not-supported', and <error-info> SHALL contain the
requested mode.
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 parameter
see Section 2.3. see Section 2.3.
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. startup) the capability has no effect; the with-defaults parameter,
if present, SHALL 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 following example shows a <get-config> operation which is using
the 'with-defaults' element. The client is retrieving the the 'with-defaults' element. The client is retrieving the
skipping to change at page 8, line 5 skipping to change at page 8, line 11
3. Interactions with Other Capabilities 3. Interactions with Other Capabilities
None None
4. Data Model XSD 4. Data Model XSD
This section contains an XML Schema Definition This section contains an XML Schema Definition
[W3C.REC-xmlschema-2-20041028] which defines the XML syntax [W3C.REC-xmlschema-2-20041028] which defines the XML syntax
associated for the with-defaults XML element. associated for the with-defaults XML element.
-- RFC Ed.: Insert license information for code as appropriate
<CODE BEGINS>
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="urn:ietf:params:netconf:capability:with-defaults:1.0" <xs:schema xmlns="urn:ietf:params:netconf:capability:with-defaults:1.0"
targetNamespace="urn:ietf:params:netconf:capability:with-defaults:1.0" targetNamespace="urn:ietf:params:netconf:capability:with-defaults:1.0"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified" elementFormDefault="qualified" attributeFormDefault="unqualified"
xml:lang="en"> xml:lang="en">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
Schema defining the with-defaults element. Schema defining the with-defaults element.
Organization: "IETF NETCONF Working Group" Organization: "IETF NETCONF Working Group"
Contact Info: balazs.lengyel@ericsson.com Contact Info: balazs.lengyel@ericsson.com
</xs:documentation> </xs:documentation>
</xs:annotation> </xs:annotation>
<xs:attribute name="with-defaults" > <xs:element name="with-defaults" >
<xs:simpleType> <xs:simpleType>
<xs:restriction base="xs:string"> <xs:restriction base="xs:string">
<xs:enumeration value="report-all"/> <xs:enumeration value="report-all"/>
<xs:enumeration value="trim"/> <xs:enumeration value="trim"/>
<xs:enumeration value="explicit"/> <xs:enumeration value="explicit"/>
</xs:restriction> </xs:restriction>
</xs:simpleType> </xs:simpleType>
</xs:attribute> </xs:element>
</xs:schema> </xs:schema>
<CODE ENDS>
5. IANA Considerations 5. IANA Considerations
This document registers one capability identifier URN from the This document registers one capability identifier URN from the
"Network Configuration Protocol (NETCONF) Capability URNs" registry, "Network Configuration Protocol [NETCONF] 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 [NETCONF] section 10.3. to [NETCONF] section 10.3.
+---------------+---------------------------------------------------+ +---------------+---------------------------------------------------+
| Index | Capability Identifier | | Index | Capability Identifier |
+---------------+---------------------------------------------------+ +---------------+---------------------------------------------------+
| :with-default | urn:ietf:params:netconf:capability:with-defaults: | | :with-default | urn:ietf:params:netconf:capability:with-defaults: |
| s | 1.0 | | s | 1.0 |
+---------------+---------------------------------------------------+ +---------------+---------------------------------------------------+
6. Security Considerations 6. 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 risks operations. It does not introduce any new or increased security
into the management system. risks into the management system.
The 'with-defaults' capability provides client controls 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
the standard protocol operations, and do not add any data to the the standard protocol operations, and do not add any data to the
configuration database. configuration database.
7. Open Issues 7. Open Issues
7.1. Other default handling modes in the real world? Is the definition of defaults OK?
Are there any other basic default handling modes out there we need to Shall we wait for YANG and 4741bis and make the YANG normative?
include?
Shall we make with-defaults mandatory?
8. Appendix A - YANG Module for with-defaults (non-normative) 8. Appendix A - YANG Module for with-defaults (non-normative)
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]. operations are defined in YANG in [I-D.ietf-netconf-4741bis].
-- RFC Ed.: Insert license information for code as appropriate
<CODE BEGINS>
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:1.0";
prefix nwd; prefix nwd;
// for the uri data type // for the uri data type
import ietf-netconf { prefix nc; } import ietf-netconf { prefix nc; }
description description
"This module defines a capability-based extension to the "This module defines a capability-based extension to the
NETCONF protocol that allows the NETCONF client to control NETCONF protocol that allows the NETCONF client to control
whether default values are part of NETCONF whether default values are part of NETCONF
<rpc-reply> messages. <rpc-reply> messages or <copy-config> output to the target URL.
Copyright (c) 2009 IETF Trust and the persons identified as Copyright (c) 2009 IETF Trust and the persons identified as
the document authors. All rights reserved. the document authors. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the without modification, are permitted provided that the
following conditions are met: following conditions are met:
- Redistributions of source code must retain the above - Redistributions of source code must retain the above
copyright notice, this list of conditions and the copyright notice, this list of conditions and the
skipping to change at page 11, line 14 skipping to change at page 11, line 33
revision 2009-07-01 { revision 2009-07-01 {
description description
"Initial version"; "Initial version";
} }
// with-defaults capability defined as a feature // with-defaults capability defined as a feature
feature with-defaults { feature with-defaults {
description description
"NETCONF :with-defaults capability; "NETCONF :with-defaults capability;
If the agent advertises the :with-defaults If the server advertises the :with-defaults
capability for a session, then this feature MUST capability for a session, then this feature MUST
also be enabled for that session. Otherwise, also be enabled for that session. Otherwise,
this feature MUST NOT be enabled."; this feature MUST NOT be enabled.";
// RFC Ed.: replace XXXX with actual RFC number and // RFC Ed.: replace XXXX with actual RFC number and
// remove this note // remove this note
reference "RFC XXXX"; reference "RFC XXXX";
} }
typedef with-defaults-mode-type { 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 always reported.";
} }
enum trim { enum trim {
description description
skipping to change at page 11, line 48 skipping to change at page 12, line 19
"Report values if they are explicitly set. "Report values if they are explicitly set.
For state data this has the same effect For state data this has the same effect
as report-all"; as report-all";
} }
} }
} }
// extending the get-config operation // extending the get-config operation
augment /nc:get-config/nc:input { augment /nc:get-config/nc:input {
leaf with-defaults { leaf with-defaults {
type with-defaults-mode-type; type with-defaults-mode;
} }
} }
// extending the get operation // extending the get operation
augment /nc:get/nc:input { augment /nc:get/nc:input {
leaf with-defaults { leaf with-defaults {
type with-defaults-mode-type; type with-defaults-mode;
} }
} }
// extending the copy-congig operation // extending the copy-congig operation
augment /nc:copy-config/nc:input { augment /nc:copy-config/nc:input {
leaf with-defaults { leaf with-defaults {
type with-defaults-mode-type; type with-defaults-mode;
} }
} }
} }
<CODE ENDS>
9. Appendix B - Change Log 9. Appendix B - Change Log
9.1. 02-03 9.1. -00
Clarifications Created from draft-bierman-netconf-with-defaults-01.txt
YAM added 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.
Use the same URN for the capability and the XML namespace to Hopefully it will be clarified in the 4741bis RFC whether such
accommodate YANG, and avoid two separate URN/URIs being advertised in extensions are allowed.
the HELLO message, for such a small function.
9.2. 01-02 9.2. 00-01
Changed value set of with-default capability and element
Added version to URI
9.3. 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.
9.3. 00-01 9.4. 02-03
Changed value set of with-default capability and element Clarifications
Added version to URI YAM added
9.4. -00 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.
Created from draft-bierman-netconf-with-defaults-01.txt 9.5. 03-04
It was decided by the NETCONF mailing list, that with-defaults should Clarifications
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 Added non-netconf interfaces to the definition of explicitly set
extensions are allowed. default data
10. Acknowledgements 10. 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.
11. References 11. References
11.1. Normative References 11.1. Normative References
skipping to change at page 13, line 46 skipping to change at page 14, line 28
[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.
11.2. Informative References 11.2. Informative References
[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-07 (work in progress), NETCONF", draft-ietf-netmod-yang-08 (work in progress),
July 2009. October 2009.
[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, "NETCONF Configuration Protocol", Bierman, "NETCONF Configuration Protocol",
draft-ietf-netconf-4741bis-01 (work in progress), draft-ietf-netconf-4741bis-01 (work in progress),
July 2009. July 2009.
Authors' Addresses Authors' Addresses
Andy Bierman Andy Bierman
Netconf Central Netconf Central
Simi Valley, CA Simi Valley, CA
USA USA
 End of changes. 56 change blocks. 
78 lines changed or deleted 113 lines changed or added

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