< draft-ietf-netconf-notification-capabilities-01.txt   draft-ietf-netconf-notification-capabilities-02.txt >
Netconf B. Lengyel NETCONF B. Lengyel
Internet-Draft Ericsson Internet-Draft Ericsson
Intended status: Standards Track A. Clemm Intended status: Standards Track A. Clemm
Expires: September 2, 2019 Huawei USA Expires: January 6, 2020 Futurewei
March 1, 2019 B. Claise
Cisco Systems, Inc.
July 5, 2019
YangPush Notification Capabilities Yang-Push Notification Capabilities
draft-ietf-netconf-notification-capabilities-01 draft-ietf-netconf-notification-capabilities-02
Abstract Abstract
This document proposes a YANG module that allows a YANG server to This document proposes a YANG module that allows a server to specify
specify server capabilities related to "Subscription to YANG server capabilities related to "Subscription to YANG Datastores"
Datastores" (YangPush). It proposes to use YANG Instance Data to (Yang-Push). It proposes to use YANG Instance Data to document this
document this information already in implementation time. information and make it already available at implementation time, but
also allow it to be reported at runtime.
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://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 September 2, 2019. This Internet-Draft will expire on January 6, 2020.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 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
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Notification Capability Model . . . . . . . . . . . . . . . . 4 3. Notification Capability Model . . . . . . . . . . . . . . . . 4
3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 5 3.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 5
3.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6 3.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6
4. Security Considerations . . . . . . . . . . . . . . . . . . . 9 4. Security Considerations . . . . . . . . . . . . . . . . . . . 10
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 9 5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 11
5.2. The YANG Module Names Registry . . . . . . . . . . . . . 9 5.2. The YANG Module Names Registry . . . . . . . . . . . . . 11
6. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 9 6. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 11
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 10 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 11
7.1. Normative References . . . . . . . . . . . . . . . . . . 10 7.1. Normative References . . . . . . . . . . . . . . . . . . 11
7.2. Informative References . . . . . . . . . . . . . . . . . 10 7.2. Informative References . . . . . . . . . . . . . . . . . 12
Appendix A. Changes between revisions . . . . . . . . . . . . . 10 Appendix A. Instance data examples . . . . . . . . . . . . . . . 13
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 Appendix B. Changes between revisions . . . . . . . . . . . . . 16
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 16
1. Terminology 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", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
The terms Yang-Push, On-change subscription and Periodic subscription The terms Yang-Push, On-change subscription and Periodic subscription
are used as defined in [I-D.ietf-netconf-yang-push] are used as defined in [I-D.ietf-netconf-yang-push]
On-change Notification Capability: The capability of the YANG server On-change Notification Capability: The capability of the server to
to support On-change subscriptions. support On-change subscriptions.
Implementation-time information: Information about the YANG server's The term Server is used as defined in [RFC8342]
Implementation-time information: Information about the server's
behavior that is made available during the implementation of the behavior that is made available during the implementation of the
server, available from a source other then a running Yang server. server, available from a source other then a running server.
Rutime-information: Information about the YANG server's behavior that Runtime-information: Information about the server's behavior that is
is available from the running YANG server via a protocol like available from the running server via management protocols such as
NETCONF, RESTCONF or HTTPS. NETCONF [RFC6241] or RESTCONF [RFC8040].
2. Introduction 2. Introduction
As defined in [I-D.ietf-netconf-yang-push] a YANG server may allow As defined in [I-D.ietf-netconf-yang-push] a server may allow clients
clients to subscribe to updates from a datastore and subsequently to subscribe to updates from a datastore and subsequently push such
push such update notifications to the client. Notifications may be update notifications to the client. Notifications may be sent
sent periodically or on-change (more or less immediately after each periodically or on-change (more or less immediately after each
change). change).
A YANG server supporting YANG-Push has a number of capabilities that A server supporting YANG-Push has a number of capabilities that are
are determined during the implementation of the server. These determined during the implementation of the server. These include:
include:
o Supported dampening periods for on-change subscriptions
o Supported (reporting) periods for periodic subscriptions o Supported (reporting) periods for periodic subscriptions
o Maximum number of objects that can be sent in an update o Maximum number of objects that can be sent in an update
If the optional on-change feature is supported, these include:
o Supported dampening periods for on-change subscriptions
o The set of data nodes for which on-change notification is o The set of data nodes for which on-change notification is
supported supported
Servers MAY have limitations in how many update notifications and how Servers MAY have limitations in how many update notifications and how
many datastore node updates they can send out in a certain time- many datastore node updates they can send out in a certain time-
period. period.
In some cases, a publisher supporting on-change notifications will In some cases, a publisher supporting on-change notifications will
not be able to push updates for some object types on-change. Reasons not be able to push updates for some object types on-change. Reasons
for this might be that the value of the datastore node changes for this might be that the value of the datastore node changes
skipping to change at page 3, line 37 skipping to change at page 3, line 46
degrees), or that the implementation is not capable of on-change degrees), or that the implementation is not capable of on-change
notification for a particular object. In those cases, it will be notification for a particular object. In those cases, it will be
important for client applications to have a way to identify for which important for client applications to have a way to identify for which
objects on-change notifications are supported and for which ones not. objects on-change notifications are supported and for which ones not.
Faced with the reality that support for on-change notification does Faced with the reality that support for on-change notification does
not mean that such notifications will be sent for any specific data not mean that such notifications will be sent for any specific data
node, client/management applications can not rely on the on-change node, client/management applications can not rely on the on-change
functionality unless the client has some means to identify for which functionality unless the client has some means to identify for which
objects on-change notifications are supported. YANG models are meant objects on-change notifications are supported. YANG models are meant
to be used as an interface contract. Without identification of data to be used as an interface contract. Without identification of the
nodes supporting on-change, this contract would only state the YANG data nodes actually supporting on-change, this contract would be
server may (or may not) send on-change notifications for a data node incomplete.
specified in a YANG module.
This document proposes a YANG module that allows a client to discover This document proposes a YANG module that allows a client to discover
YANG-Push related capabilities. YANG-Push related capabilities both at implementation-time and run-
time.
YANG-Push related capability information will be needed both in
implementation-time and run-time.
Implementation time information is needed by Network Management Implementation time information is needed by Network Management
System (NMS) implementers. During NMS implementation for any System (NMS) implementers. During NMS implementation for any
functionality that depends on the notifications the information about functionality that depends on the notifications the information about
on change notification capability is needed. If the information is on change notification capability is needed. If the information is
not available early in some document, but only as instance data from not available early in some document, but only as instance data from
the network node, the NMS implementation will be delayed, because it the network node once it is deployed, the NMS implementation will be
has to wait for the network node to be ready. Also assuming that all delayed, because it has to wait for the network node to be ready. In
NMS implementers will have a correctly configured network node addition, the assumption that all NMS implementers will have a
available to retrieve data from, is an expensive proposition. (An correctly configured network node available to retrieve data from, is
NMS may handle dozens of network node types.) Often a fully an expensive proposition and may not always hold. (An NMS may need
functional NMS is a requirement for introducing a new network node to be able to handle many dozens of network node types.) Often a
type into a network, so delaying the NMS effectively delays the fully functional NMS is a requirement for introducing a new network
availability of the network node as well. node type into a network, so delaying NMS readiness effectively also
delays the time at which a new network node type can be introduced
into the network.
Implementation time information is needed by system integrators. Implementation time information is needed by system integrators.
When introducing a network node type into their network, operators When introducing a network node type into their network, operators
often need to integrate the node type into their own management often need to integrate the node type into their own management
system. The NMS may have management functions that depend on on- system. The NMS may have management functions that depend on on-
change notifications. The network operator needs to plan his change notifications. The network operator needs to plan his
management practices and NMS implementation before he even decides to management practices and NMS implementation before he even decides to
buy the specific network node type. Moreover the decision to buy the buy the specific network node type. Moreover the decision to buy the
node type sometimes depends on these management possibilities. node type sometimes depends on these management possibilities.
Run-time information is needed Run-time information is needed:
o for any "purely model driven" client, e.g. a NETCONF-browser. As o for any "purely model driven" client, e.g. a NETCONF-browser. As
long as it has a valid model to read the capability information, long as it has a valid model to read the capability information,
it does not care which data nodes send notification, it will just it does not care which data nodes send notification, it will just
handle what is available. handle what is available.
o in case the capability might change during run-time e.g. due to o in case the capability might change during run-time e.g. due to
licensing, HW constraints etc. licensing, HW constraints etc.
o to check that early, implementation time capability information o to check that early, implementation time capability information
about the capabilities is indeed what the server implements (is about the capabilities is indeed what the server implements (is
the supplied documentation correct?) the supplied documentation correct?)
3. Notification Capability Model 3. Notification Capability Model
It is a goal to provide YangPush notification capability information It is a goal to provide Yang-Push notification capability information
in a format that is in a format that is:
o vendor independent (standard)
o formal (no freeform English text please) o vendor independent
o the same both in implementation-time and run-time o formal
o identical for implementation-time and run-time
The YANG module ietf-notification-capabilities is defined to provide The YANG module ietf-notification-capabilities is defined to provide
the information. It contains the information. It contains:
a set of capabilities related to the amount of notifications the a set of capabilities related to the amount of notifications the
server can send out server can send out
a default on-change notification capability separately for config a default on-change notification capability separately for config
false and config true data nodes false and config true data nodes
an on-change-notification-capability list containing a potentially an on-change-notification-capability list containing a potentially
different true/false notification capability for a few data nodes different true/false notification capability for a few data nodes
in the schema tree. Unless a node is in this list with a specific in the schema tree. Unless a node is in this list with a specific
capability value, it inherits its on-change-notification- capability value, it inherits its on-change-notification-
capability from its parent in the data tree, or from the relevant capability from its parent in the data tree, or from the relevant
default values. It is assumed that only a small number of nodes default values. It is assumed that only a small number of nodes
will be included in this list: special cases where the default will be included in this list: special cases where the default
skipping to change at page 5, line 21 skipping to change at page 5, line 29
capability from its parent in the data tree, or from the relevant capability from its parent in the data tree, or from the relevant
default values. It is assumed that only a small number of nodes default values. It is assumed that only a small number of nodes
will be included in this list: special cases where the default will be included in this list: special cases where the default
behavior is not followed. For a detailed description of the usage behavior is not followed. For a detailed description of the usage
of this list see the description in the YANG module. of this list see the description in the YANG module.
The information SHALL be provided in two ways both following the The information SHALL be provided in two ways both following the
ietf-notification-capabilities module: ietf-notification-capabilities module:
o It SHALL be provided by the implementer as YANG instance data file o It SHALL be provided by the implementer as YANG instance data file
complying to the [I-D.lengyel-netmod-yang-instance-data]. The complying to [I-D.ietf-netmod-yang-instance-file-format]. The
file SHALL be available already in implementation time retrievable file SHALL be available already in implementation time retrievable
in a way that does not depend on a live network node. E.g. in a way that does not depend on a live network node. E.g.
download from product Website. download from product Website.
o It SHALL be available via NETCONF or RESTCONF from the live YANG o It SHALL be available via NETCONF [RFC6241] or RESTCONF [RFC8040]
server during runtime. from the live server during runtime.
3.1. Tree Diagram 3.1. Tree Diagram
The following tree diagram [RFC8340] provides an overview of the data The following tree diagram [RFC8340] provides an overview of the data
model. model.
module: ietf-notification-capabilities module: ietf-notification-capabilities
+--ro yangpush-notification-capabilities +--ro datastore-subscription-capabilities
+--ro minimum-dampening-period? uint32
+--ro (update-period)? +--ro (update-period)?
| +--:(minimum-update-period) | +--:(minimum-update-period)
| | +--ro minimum-update-period? uint32 | | +--ro minimum-update-period? uint32
| +--:(supported-update-period) | +--:(supported-update-period)
| +--ro supported-update-period* uint32 | +--ro supported-update-period* uint32
+--ro max-objects-per-update? uint32 +--ro max-objects-per-update? uint32
+--ro notification-sent-for-config-default? boolean +--ro minimum-dampening-period? uint32 {yp:on-change}?
+--ro notification-sent-for-state-default? boolean +--ro on-change-capable-nodes* [datastore] {yp:on-change}?
+--ro on-change-notification-capability* [node-selector] +--ro datastore union
+--ro node-selector nacm:node-instance-identifier +--ro notification-sent-for-config-default? boolean
+--ro on-change-notification-sent boolean +--ro notification-sent-for-state-default? boolean
+--ro on-change-notification-capability* [node-selector]
+--ro node-selector nacm:node-instance-identifier
+--ro on-change-supported boolean
3.2. YANG Module 3.2. YANG Module
<CODE BEGINS> file "ietf-notification-capabilities.yang" <CODE BEGINS> file "ietf-notification-capabilities@2019-07-02.yang"
module ietf-notification-capabilities { module ietf-notification-capabilities {
yang-version 1.1; yang-version 1.1;
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-notification-capabilities"; "urn:ietf:params:xml:ns:yang:ietf-notification-capabilities";
prefix inc; prefix inc;
import ietf-netconf-acm { prefix nacm; } import ietf-netconf-acm { prefix nacm; }
import ietf-yang-push { prefix yp; }
import ietf-yang-library {
prefix yanglib;
description
"Requires revision 2019-01-04 or a revision derived from it.";
}
organization organization
"IETF NETCONF (Network Configuration) Working Group"; "IETF NETCONF (Network Configuration) Working Group";
contact contact
"WG Web: <https://datatracker.ietf.org/wg/netconf/> "WG Web: <https://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
WG Chair: Kent Watsen
<mailto:kwatsen@juniper.net>
WG Chair: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Balazs Lengyel Editor: Balazs Lengyel
<mailto:balazs.lengyel@ericsson.com>"; <mailto:balazs.lengyel@ericsson.com>";
description
"This module specifies YANG-Push related server
capabilities.
description "This module specifies YANG-Push related server The module contains
capabilities. It contains - capabilities related to the amount of notifications the
- capabilities related to the amount of notifications the server can send out. Note that for a specific subscription
server can send out the server MAY still allow only longer periods or smaller
- default and schema node specific information specifying updates depending on e.g. actual load conditions.
the set of data nodes for which the YANG server is capable - default and schema node specific information specifying
of sending on-change notifications. the set of data nodes for which the server is capable
of sending on-change notifications.
On-change notification capability is marked as true or false. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
This marking is inherited from the parent down the data tree 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
unless explicitly marked otherwise. 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.
On-change notifications SHALL be sent for a config=true Copyright (c) 2019 IETF Trust and the persons identified as
data node if one of the following is true: authors of the code. All rights reserved.
- if it is a top level data-node and is not specified in the
on-change-notification-capability list and the
notification-sent-for-config-default is true; or
- notifications are sent for its parent data node and it is
not specified in the on-change-notification-capability list; or
- it is specified in the on-change-notification-capability
list and has a on-change-notification-sent value true.
On-change notifications SHALL be sent for a config=false Redistribution and use in source and binary forms, with or
data node if one of the following is true: without modification, is permitted pursuant to, and subject
- if it is a top level data-node or has a config=true parent to the license terms contained in, the Simplified BSD License
data node and is not specified in the set forth in Section 4.c of the IETF Trust's Legal Provisions
on-change-notification-capability list and the Relating to IETF Documents
notification-sent-for-state-default is true; or (http://trustee.ietf.org/license-info).
- notifications are sent for its parent data node
which is also config=false and it is
not specified in the on-change-notification-capability list; or
- it is specified in the on-change-notification-capability
list and has an on-change-notification-sent value true or
";
revision 2019-02-28 { This version of this YANG module is part of RFC XXXX; see
description "Initial version"; the RFC itself for full legal notices.";
revision 2019-07-02 {
description
"Initial version";
reference reference
"RFC XXX: YangPush Notification Capabilities"; "RFC XXX: Yang-Push Notification Capabilities";
} }
container yangpush-notification-capabilities { container datastore-subscription-capabilities {
config false; config false;
description "YANG-Push related server capabilities"; description
"YANG-Push related server capabilities";
leaf minimum-dampening-period {
type uint32;
units msec;
description "The minimum dampening period supported for on-change
subscriptions.";
}
choice update-period { choice update-period {
description "Supported period values."; description
"Supported period values.";
leaf minimum-update-period { leaf minimum-update-period {
type uint32; type uint32;
units centiseconds; units "centiseconds";
description "Minimum update period supported for a description
periodic subscription."; "Minimum update period supported for a
periodic subscription. May be absent if the server is
not capable of providing a specific value.";
} }
leaf-list supported-update-period { leaf-list supported-update-period {
type uint32; type uint32;
units centiseconds; units "centiseconds";
description "Specific supported update period values description
for a periodic subscription"; "Specific supported update period values
for a periodic subscription.";
} }
} }
leaf max-objects-per-update { leaf max-objects-per-update {
type uint32; type uint32 {
description "Maximum number of objects that can be sent range "1..max";
in an update"; }
description
"Maximum number of objects that can be sent
in an update. May be absent if the server is
not capable of providing a specific value.";
} }
leaf notification-sent-for-config-default { leaf minimum-dampening-period {
type boolean; if-feature yp:on-change ;
default true; type uint32;
description "Specifies the default value for units "centiseconds";
top level configuration data nodes for the description
on-change-notification-sent capability."; "The minimum dampening period supported for on-change
subscriptions. May be absent if the server is
not capable of providing a specific value.";
} }
leaf notification-sent-for-state-default { list on-change-capable-nodes {
type boolean; if-feature yp:on-change ;
default false; key datastore ;
description "Specifies the default value description "Specifies per datastore the data nodes for which the
top level state data nodes for the server is capable of sending on-change notifications.
on-change-notification-sent capability."; If a datastore implemented by the server is not specified
} in this list and there is no list element for 'all' datastores
the datastore does not support any on-change notifications.
list on-change-notification-capability { On-change notification capability is marked as true or false.
key node-selector ; This marking is inherited from the parent down the data tree
description "A list of data nodes that have the unless explicitly marked otherwise.
on-change-notification-capability specifically defined.
Should be used when specific data nodes support On-change notifications SHALL be sent for a config=true
on-change notification in a module/subtree that data node if one of the following is true:
generally does not support it or when some data nodes - if it is a top level data-node and is not specified in the
do not support the notification in a module/subtree on-change-notification-capability list and the
that generally supports on-change notifications."; notification-sent-for-config-default is true; or
- notifications are sent for its parent data node and it is
not specified in the on-change-notification-capability list; or
- it is specified in the on-change-notification-capability
list and has an on-change-supported value true.
leaf node-selector { On-change notifications SHALL be sent for a config=false
type nacm:node-instance-identifier; data node if one of the following is true:
description "Selects the data nodes for which - if it is a top level data-node (a config=false data node with
on-change capability is specified."; a config=true parent SHALL be treated as a top level data node)
and is not specified in the on-change-notification-capability
list and the notification-sent-for-state-default is true; or
- notifications are sent for its parent data node
which is also config=false and it is
not specified in the on-change-notification-capability list; or
- it is specified in the on-change-notification-capability
list and has an on-change-supported value true";
leaf datastore {
type union {
type leafref {
path /yanglib:yang-library/yanglib:datastore/yanglib:name ;
}
type enumeration {
enum all ;
}
}
must '. != "all" or count(..) = "1" ' {
error-message
"If 'all' is present individual datastores cannot be " +
"specified.";
}
description "The datastore for which on-change capable
nodes are defined.";
} }
leaf on-change-notification-sent { leaf notification-sent-for-config-default {
type boolean; type boolean;
mandatory true; default "true";
description "Specifies whether the YANG server will description
send on-change notifications for the selected "Specifies the default value for
data nodes."; top level configuration data nodes for the
on-change-supported capability.";
} }
leaf notification-sent-for-state-default {
type boolean;
default "false";
description
"Specifies the default value
top level state data nodes for the
on-change-supported capability.";
}
list on-change-notification-capability {
key "node-selector";
description
"A list of data nodes that have the
on-change-notification-capability specifically defined.
Should be used only when specific data nodes support
on-change notification in a module/subtree that
generally does not support it or when some data nodes
do not support the notification in a module/subtree
that generally supports on-change notifications.";
leaf node-selector {
type nacm:node-instance-identifier;
description
"Selects the data nodes for which
on-change capability is specified.";
}
leaf on-change-supported {
type boolean;
mandatory true;
description
"Specifies whether the server is capable of
sending on-change notifications for the selected
data nodes.";
}
}
} }
} }
} }
<CODE ENDS> <CODE ENDS>
4. Security Considerations 4. Security Considerations
The YANG module defined in this document is designed to be accessed The YANG module specified in this document defines a schema for data
via YANG based management protocols, such as NETCONF and RESTCONF. that is designed to be accessed via network management protocols such
Both of these protocols have mandatory-to- implement secure transport as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
layers (e.g., SSH, TLS) with mutual authentication. is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
is HTTPS, and the mandatory-to-implement secure transport is TLS
[RFC8446].
The NETCONF access control model (NACM) provides the means to The Network Configuration Access Control Model (NACM) [RFC8341]
restrict access for particular users to a pre-configured subset of provides the means to restrict access for particular NETCONF or
all available protocol operations and content. RESTCONF users to a preconfigured subset of all available NETCONF or
RESTCONF protocol operations and content.
The data in this module is not security sensitive. The data in this module is not security sensitive.
5. IANA Considerations 5. IANA Considerations
5.1. The IETF XML Registry 5.1. The IETF XML Registry
This document registers one URI in the IETF XML registry [RFC3688]. This document registers one URI in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the following registrations are Following the format in [RFC3688], the following registrations are
requested: requested:
skipping to change at page 9, line 49 skipping to change at page 11, line 41
registry [RFC7950]. Following the format in [RFC7950], the the registry [RFC7950]. Following the format in [RFC7950], the the
following registrations are requested: following registrations are requested:
name: ietf-notification-capabilities name: ietf-notification-capabilities
namespace: urn:ietf:params:xml:ns:yang:ietf-notification-capabilities namespace: urn:ietf:params:xml:ns:yang:ietf-notification-capabilities
prefix: inc prefix: inc
reference: RFC XXXX reference: RFC XXXX
6. Open Issues 6. Open Issues
Do we need separate defaults/individual lists for every datastore? -
Proposal: no, it would be an overkill.
Should type nacm:node-instance-identifier be moved to yang-types?
It is useful for more then just nacm.
7. References 7. References
7.1. Normative References 7.1. Normative References
[I-D.ietf-netconf-yang-push] [I-D.ietf-netconf-yang-push]
Clemm, A., Voit, E., Prieto, A., Tripathy, A., Nilsen- Clemm, A. and E. Voit, "Subscription to YANG Datastores",
Nygaard, E., Bierman, A., and B. Lengyel, "Subscription to draft-ietf-netconf-yang-push-25 (work in progress), May
YANG Datastores", draft-ietf-netconf-yang-push-22 (work in 2019.
progress), February 2019.
[I-D.lengyel-netmod-yang-instance-data] [I-D.ietf-netmod-yang-instance-file-format]
Lengyel, B. and B. Claise, "YANG Based Instance Data Files Lengyel, B. and B. Claise, "YANG Instance Data File
Format", draft-lengyel-netmod-yang-instance-data-05 (work Format", draft-ietf-netmod-yang-instance-file-format-02
in progress), October 2018. (work in progress), February 2019.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016, RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>. <https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
7.2. Informative References 7.2. Informative 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, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>. <https://www.rfc-editor.org/info/rfc8340>.
Appendix A. Changes between revisions Appendix A. Instance data examples
The following example is instance-data describing the notification
capabilities of a hypothetical "acme-switch". The switch implements
the running, candidate and operational datastores. Every change can
be reported on-change from running, nothing from candidate and all
config=false data from operational.
<?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns=
"urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
<name>acme-switch-notification-capabilites</name>
<!-- Content-schema specification, revision date, contact, etc. -->
<description>Notification capabilities of acme-switch.
Acme-switch implements the running, candidate and operational
datastores. Every change can be reported on-change from running,
nothing from candidate and all config=false data from operational.
</description>
<content-data>
<datastore-subscription-capabilities>
<minimum-update-period>500</minimum-update-period>
<max-objects-per-update>2000</max-objects-per-update>
<minimum-dampening-period>100</minimum-dampening-period>
<on-change-capable-nodes>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
running
</datastore>
<!-- Neither notification-sent-for-config-default or
notification-sent-for-state-default are present as the
default values are in effect. -->
</on-change-capable-nodes>
<!-- The candidate datastore is implemented, but not present
here as it does not support any on-change notifications. -->
<on-change-capable-nodes>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
operational
</datastore>
<notification-sent-for-config-default>
false
</notification-sent-for-config-default>
<notification-sent-for-state-default>
true
</notification-sent-for-state-default>
</on-change-capable-nodes>
</datastore-subscription-capabilities>
</content-data>
</instance-data-set>
Figure 1: Notification Capabilities with default settings
The following is the instance-data describing the notification
capabilities of a hypothetical "acme-router". The router implements
the running, and operational datastores. Every change can be
reported on-change from running, but only config=true nodes and some
config=false data from operational. Interface statistics are not
reported on-change only 2 important counters.
<?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns=
"urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
<name>acme-router-notification-capabilites</name>
<!-- Content-schema specification, revision date, contact, etc. -->
<description>Defines the notification capabilities of an acme-router.
The router only has running, and operational datastores.
Every change can be reported on-change from running, but
only config=true nodes and some config=false data from operational.
Statistics are not reported on-change only 2 important counters.
</description>
<content-data>
<datastore-subscription-capabilities
xmlns="urn:ietf:params:xml:ns:yang:ietf-notification-capabilities">
<minimum-update-period>500</minimum-update-period>
<max-objects-per-update>2000</max-objects-per-update>
<minimum-dampening-period>100</minimum-dampening-period>
<on-change-capable-nodes>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
running
</datastore>
</on-change-capable-nodes>
<on-change-capable-nodes>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
operational
</datastore>
<notification-sent-for-state-default>
true
</notification-sent-for-state-default>
<on-change-notification-capability>
<node-selector>
/if:interfaces/if:interface/if:statistics</node-selector>
<on-change-supported>false</on-change-supported>
</on-change-notification-capability>
<on-change-notification-capability>
<node-selector>
/if:interfaces/if:interface/if:statistics/if:in-octets
</node-selector>
<on-change-supported>true</on-change-supported>
</on-change-notification-capability>
<on-change-notification-capability>
<node-selector>
/if:interfaces/if:interface/if:statistics/if:out-octets
</node-selector>
<on-change-supported>true</on-change-supported>
</on-change-notification-capability>
</on-change-capable-nodes>
</datastore-subscription-capabilities>
</content-data>
</instance-data-set>
Figure 2: Notification Capabilities with data node specific settings
Appendix B. Changes between revisions
v01 - v02
o Added instance data examples
o On-change capability can be defined per datastore
o Added "if-feature yp:on-change" where relevant
o Unified units used
v00 - v01 v00 - v01
o Add more capabilities: minimum period, supported period max-number o Add more capabilities: minimum period, supported period max-number
of objects, min dampening period, dampening supported of objects, min dampening period, dampening supported
Authors' Addresses Authors' Addresses
Balazs Lengyel Balazs Lengyel
Ericsson Ericsson
Magyar Tudosok korutja 11 Magyar Tudosok korutja 11
1117 Budapest 1117 Budapest
Hungary Hungary
Email: balazs.lengyel@ericsson.com Email: balazs.lengyel@ericsson.com
Alexander Clemm Alexander Clemm
Huawei USA Futurewei
2330 Central Expressway 2330 Central Expressway
Santa Clara, CA 95050 Santa Clara, CA 95050
USA USA
Email: ludwig@clemm.org Email: ludwig@clemm.org
Benoit Claise
Cisco Systems, Inc.
De Kleetlaan 6a b1
1831 Diegem
Belgium
Email: bclaise@cisco.com
 End of changes. 64 change blocks. 
190 lines changed or deleted 405 lines changed or added

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