draft-ietf-netconf-notification-capabilities-02.txt   draft-ietf-netconf-notification-capabilities-03.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: January 6, 2020 Futurewei Expires: February 14, 2020 Futurewei
B. Claise B. Claise
Cisco Systems, Inc. Cisco Systems, Inc.
July 5, 2019 August 13, 2019
Yang-Push Notification Capabilities Yang-Push Notification Capabilities
draft-ietf-netconf-notification-capabilities-02 draft-ietf-netconf-notification-capabilities-03
Abstract Abstract
This document proposes a YANG module that allows a server to specify This document proposes a YANG module that allows a server to specify
server capabilities related to "Subscription to YANG Datastores" server capabilities related to "Subscription to YANG Datastores"
(Yang-Push). It proposes to use YANG Instance Data to document this (Yang-Push). It proposes to use YANG Instance Data to document this
information and make it already available at implementation time, but information and make it already available at implementation time, but
also allow it to be reported at runtime. also allow it to be reported at runtime.
Status of This Memo Status of This Memo
skipping to change at page 1, line 37 skipping to change at page 1, line 37
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 January 6, 2020. This Internet-Draft will expire on February 14, 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
skipping to change at page 2, line 15 skipping to change at page 2, line 15
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 . . . . . . . . . . . . . . . . . . . . . . . . 3 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 . . . . . . . . . . . . . . . . . . . 10 4. Security Considerations . . . . . . . . . . . . . . . . . . . 12
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 11 5.1. The IETF XML Registry . . . . . . . . . . . . . . . . . . 12
5.2. The YANG Module Names Registry . . . . . . . . . . . . . 11 5.2. The YANG Module Names Registry . . . . . . . . . . . . . 12
6. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 11 6. Open Issues . . . . . . . . . . . . . . . . . . . . . . . . . 12
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 11 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
7.1. Normative References . . . . . . . . . . . . . . . . . . 11 7.1. Normative References . . . . . . . . . . . . . . . . . . 13
7.2. Informative References . . . . . . . . . . . . . . . . . 12 7.2. Informative References . . . . . . . . . . . . . . . . . 13
Appendix A. Instance data examples . . . . . . . . . . . . . . . 13 Appendix A. Instance data examples . . . . . . . . . . . . . . . 14
Appendix B. Changes between revisions . . . . . . . . . . . . . 16 Appendix B. Changes between revisions . . . . . . . . . . . . . 17
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 16 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17
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
skipping to change at page 3, line 13 skipping to change at page 3, line 13
NETCONF [RFC6241] or RESTCONF [RFC8040]. NETCONF [RFC6241] or RESTCONF [RFC8040].
2. Introduction 2. Introduction
As defined in [I-D.ietf-netconf-yang-push] a server may allow clients As defined in [I-D.ietf-netconf-yang-push] a server may allow clients
to subscribe to updates from a datastore and subsequently push such to subscribe to updates from a datastore and subsequently push such
update notifications to the client. Notifications may be sent update notifications to the client. Notifications may be sent
periodically or on-change (more or less immediately after each periodically or on-change (more or less immediately after each
change). change).
A server supporting YANG-Push has a number of capabilities that are A server supporting YANG-Push has a number of capabilities defined in
determined during the implementation of the server. These include: [I-D.ietf-netconf-yang-push] that are often determined during the
implementation of the server. These include:
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: If the optional on-change feature is supported, additionally:
o Supported dampening periods for on-change subscriptions 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.
skipping to change at page 5, line 4 skipping to change at page 5, line 8
the supplied documentation correct?) the supplied documentation correct?)
3. Notification Capability Model 3. Notification Capability Model
It is a goal to provide Yang-Push 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 o vendor independent
o formal o formal
o identical for implementation-time and run-time 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 specification of which data nodes support on-change notifications.
false and config true data nodes
an on-change-notification-capability list containing a potentially Capability values can be specified on server level, datastore
different true/false notification capability for a few data nodes level or on specific data nodes (and their contained sub-tree) of
in the schema tree. Unless a node is in this list with a specific a specific datastore. Capability values on a smaller, more
capability value, it inherits its on-change-notification- specific part of the server's data always override more generic
capability from its parent in the data tree, or from the relevant values.
default values. It is assumed that only a small number of nodes
will be included in this list: special cases where the default On-change capability is not specified on a server level as
behavior is not followed. For a detailed description of the usage different datastores usually have different on-change
of this list see the description in the YANG module. capabilities. On a datastore level on-change capability for
configuration and state data can be specified separately.
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 For the implementation-time use-case: It SHALL be provided by the
complying to [I-D.ietf-netmod-yang-instance-file-format]. The implementer as YANG instance data file complying to
file SHALL be available already in implementation time retrievable [I-D.ietf-netmod-yang-instance-file-format]. The file SHALL be
in a way that does not depend on a live network node. E.g. available already in implementation time retrievable in a way that
download from product Website. does not depend on a live network node. E.g. download from
product Website.
o It SHALL be available via NETCONF [RFC6241] or RESTCONF [RFC8040] o For the run-time use-case: It SHALL be available via NETCONF
from the live server during runtime. [RFC6241] or RESTCONF [RFC8040] from the live server during
runtime. As these capabilities might change during run-time,
implementations that support the YANG-Push on-change feature,
SHOULD support sending on-change notifications about this module.
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 datastore-subscription-capabilities +--ro datastore-subscription-capabilities
+--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 minimum-dampening-period? uint32 {yp:on-change}? +--ro minimum-dampening-period? uint32 {yp:on-change}?
+--ro on-change-capable-nodes* [datastore] {yp:on-change}? +--ro datastore-capabilities* [datastore]
+--ro datastore union +--ro datastore union
+--ro notification-sent-for-config-default? boolean +--ro (update-period)?
+--ro notification-sent-for-state-default? boolean | +--:(minimum-update-period)
+--ro on-change-notification-capability* [node-selector] | | +--ro minimum-update-period? uint32
+--ro node-selector nacm:node-instance-identifier | +--:(supported-update-period)
+--ro on-change-supported boolean | +--ro supported-update-period* uint32
+--ro max-objects-per-update? uint32
+--ro minimum-dampening-period? uint32 {yp:on-change}?
+--ro on-change-supported-for-config? boolean {yp:on-change}?
+--ro on-change-supported-for-state? boolean {yp:on-change}?
+--ro per-node-capabilities* [node-selector]
+--ro node-selector nacm:node-instance-identifier
+--ro (update-period)?
| +--:(minimum-update-period)
| | +--ro minimum-update-period? uint32
| +--:(supported-update-period)
| +--ro supported-update-period* uint32
+--ro max-objects-per-update? uint32
+--ro minimum-dampening-period? uint32 {yp:on-change}?
+--ro on-change-supported boolean {yp:on-change}?
3.2. YANG Module 3.2. YANG Module
<CODE BEGINS> file "ietf-notification-capabilities@2019-07-02.yang" <CODE BEGINS> file "ietf-notification-capabilities@2019-08-13.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-push { prefix yp; }
import ietf-yang-library { import ietf-yang-library {
prefix yanglib; prefix yanglib;
description description
"Requires revision 2019-01-04 or a revision derived from it."; "Requires revision 2019-01-04 or a revision derived from it.";
} }
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
organization Editor: Balazs Lengyel
"IETF NETCONF (Network Configuration) Working Group"; <mailto:balazs.lengyel@ericsson.com>";
contact description
"WG Web: <https://datatracker.ietf.org/wg/netconf/> "This module specifies YANG-Push related server
WG List: <mailto:netconf@ietf.org> capabilities.
Editor: Balazs Lengyel The module contains
<mailto:balazs.lengyel@ericsson.com>"; - capabilities related to the amount of notifications the
description server can send out. (Note that for a specific subscription
"This module specifies YANG-Push related server the server MAY still allow only longer periods or smaller
capabilities. updates depending on e.g. actual load conditions.)
- specification of which data nodes support on-change
notifications.
The module contains Capability values on a
- capabilities related to the amount of notifications the smaller, more specific part of the server's data always override
server can send out. Note that for a specific subscription more generic values. The hierarchy of specifications from generic
the server MAY still allow only longer periods or smaller to more specific is:
updates depending on e.g. actual load conditions. 1) top level values valid for all datastores
- default and schema node specific information specifying 2) values for a specific datastore (including the special
the set of data nodes for which the server is capable 'all' datastore identifier)
of sending on-change notifications. 3) Value for a specific data node and its contained sub-tree
in one of the datastores. Such capability values are inherited
down the containment tree unless a more specific value is
provided, as described in 4)
4) A contained, smaller, more specific sub-tree in a specific
datastore (could be a single leaf)
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', Any capability value MAY be absent if a more generic capability
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', value is already provided or if the server is not capable of
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document providing a value.
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.
Copyright (c) 2019 IETF Trust and the persons identified as The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
authors of the code. All rights reserved. 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'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.
Redistribution and use in source and binary forms, with or Copyright (c) 2019 IETF Trust and the persons identified as
without modification, is permitted pursuant to, and subject authors of the code. All rights reserved.
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see Redistribution and use in source and binary forms, with or
the RFC itself for full legal notices."; without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
revision 2019-07-02 { This version of this YANG module is part of RFC XXXX; see
description the RFC itself for full legal notices.";
"Initial version";
reference
"RFC XXX: Yang-Push Notification Capabilities";
}
container datastore-subscription-capabilities { revision 2019-08-13 {
config false; description
description "Initial version";
"YANG-Push related server capabilities"; reference
"RFC XXX: Yang-Push Notification Capabilities";
}
choice update-period { container datastore-subscription-capabilities {
description config false;
"Supported period values."; description
leaf minimum-update-period { "YANG-Push related server capabilities";
type uint32;
units "centiseconds";
description
"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 { grouping datastore-subscription-throughput-capabilities {
type uint32; description "Capability values that affect the amount of
units "centiseconds"; notifications the server can send out.";
description
"Specific supported update period values
for a periodic subscription.";
}
}
leaf max-objects-per-update { choice update-period {
type uint32 { description
range "1..max"; "Supported update-period values.";
} leaf minimum-update-period {
description type uint32;
"Maximum number of objects that can be sent units "centiseconds";
in an update. May be absent if the server is description
not capable of providing a specific value."; "Minimum update period supported for a
} periodic subscription.";
}
leaf minimum-dampening-period { leaf-list supported-update-period {
if-feature yp:on-change ; type uint32;
type uint32; units "centiseconds";
units "centiseconds"; description
description "Specific supported update period values
"The minimum dampening period supported for on-change for a periodic subscription.";
subscriptions. May be absent if the server is }
not capable of providing a specific value."; }
}
list on-change-capable-nodes { leaf max-objects-per-update {
if-feature yp:on-change ; type uint32 {
key datastore ; range "1..max";
description "Specifies per datastore the data nodes for which the }
server is capable of sending on-change notifications. description
If a datastore implemented by the server is not specified "Maximum number of objects that can be sent
in this list and there is no list element for 'all' datastores in an update.";
the datastore does not support any on-change notifications. }
On-change notification capability is marked as true or false. leaf minimum-dampening-period {
This marking is inherited from the parent down the data tree if-feature yp:on-change ;
unless explicitly marked otherwise. type uint32;
units "centiseconds";
description
"The minimum dampening period supported for on-change
subscriptions.";
}
}
On-change notifications SHALL be sent for a config=true uses datastore-subscription-throughput-capabilities {
data node if one of the following is true: description "Top level throughput capabilities.
- if it is a top level data-node and is not specified in the These values can be overridden by values provided per
on-change-notification-capability list and the datastore or for individual data nodes in a datastore.";
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.
On-change notifications SHALL be sent for a config=false list datastore-capabilities {
data node if one of the following is true: key datastore ;
- if it is a top level data-node (a config=false data node with description "Capabilities values per datastore.
a config=true parent SHALL be treated as a top level data node) For non-NMDA servers the config=false data is considered
and is not specified in the on-change-notification-capability as if it was part of the running datastore.
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 { Indicates per datastore throughput capabilities.
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 notification-sent-for-config-default { Indicates per datastore the data nodes for which the
type boolean; server is capable of sending on-change notifications.
default "true"; If a datastore implemented by the server is not specified
description in this list and there is no list element for 'all' datastores
"Specifies the default value for the datastore does not support any on-change notifications.
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 { On-change notifications SHALL be sent for a config=true
key "node-selector"; data node if one of the following is true:
description - if it is a top level data-node and is not specified in the
"A list of data nodes that have the per-node-capabilities list and on-change-supported-for-config
on-change-notification-capability specifically defined. is true; or
- notifications are sent for its parent data node and it is
not specified in the per-node-capabilities list; or
- it is specified in the per-node-capabilities list and has
an on-change-supported value true.
Should be used only when specific data nodes support On-change notifications SHALL be sent for a config=false
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 (a config=false data node with
do not support the notification in a module/subtree a config=true parent SHALL be treated as a top level data node)
that generally supports on-change notifications."; and is not specified in the per-node-capabilities list and
on-change-supported-for-state is true; or
- notifications are sent for its parent data node
which is also config=false and it is not specified in the
per-node-capabilities list; or
- it is specified in the per-node-capabilities list and has
an on-change-supported value true";
leaf node-selector { leaf datastore {
type nacm:node-instance-identifier; type union {
description type leafref {
"Selects the data nodes for which path /yanglib:yang-library/yanglib:datastore/yanglib:name ;
on-change capability is specified."; }
} 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 capabilities are defined.";
}
leaf on-change-supported { uses datastore-subscription-throughput-capabilities {
type boolean; description "Throughput capabilities for a datastore.
mandatory true; These values will override top level values and can be
description overridden by values provided for individual data nodes
"Specifies whether the server is capable of in a datastore.";
sending on-change notifications for the selected }
data nodes.";
} leaf on-change-supported-for-config {
} if-feature yp:on-change ;
} type boolean;
} default "true";
} description
"Specifies the default value for
top level config=true data nodes for the
on-change-supported capability.";
}
leaf on-change-supported-for-state {
if-feature yp:on-change ;
type boolean;
default "false";
description
"Specifies the default value for
top level config=false data nodes for the
on-change-supported capability.";
}
list per-node-capabilities {
key "node-selector";
description
"A list of data nodes that have either a throughput or
on-change-notification capability specifically defined.
Should be used only when specific data nodes support
capabilities that are different from capabilities
of their parent nodes or the default for the datastore.";
leaf node-selector {
type nacm:node-instance-identifier;
description
"Selects the data nodes for which
a capability is specified.";
}
uses datastore-subscription-throughput-capabilities {
description "Throughput capabilities for a specific data node.
These values will override top level or datastore
specific values.";
}
leaf on-change-supported {
if-feature yp:on-change ;
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 specified in this document defines a schema for data The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
is the secure transport layer, and the mandatory-to-implement secure is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
skipping to change at page 12, line 7 skipping to change at page 13, line 16
7.1. Normative References 7.1. Normative References
[I-D.ietf-netconf-yang-push] [I-D.ietf-netconf-yang-push]
Clemm, A. and E. Voit, "Subscription to YANG Datastores", Clemm, A. and E. Voit, "Subscription to YANG Datastores",
draft-ietf-netconf-yang-push-25 (work in progress), May draft-ietf-netconf-yang-push-25 (work in progress), May
2019. 2019.
[I-D.ietf-netmod-yang-instance-file-format] [I-D.ietf-netmod-yang-instance-file-format]
Lengyel, B. and B. Claise, "YANG Instance Data File Lengyel, B. and B. Claise, "YANG Instance Data File
Format", draft-ietf-netmod-yang-instance-file-format-02 Format", draft-ietf-netmod-yang-instance-file-format-04
(work in progress), February 2019. (work in progress), August 2019.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>. <https://www.rfc-editor.org/info/rfc6242>.
skipping to change at page 14, line 8 skipping to change at page 15, line 8
The following example is instance-data describing the notification The following example is instance-data describing the notification
capabilities of a hypothetical "acme-switch". The switch implements capabilities of a hypothetical "acme-switch". The switch implements
the running, candidate and operational datastores. Every change can the running, candidate and operational datastores. Every change can
be reported on-change from running, nothing from candidate and all be reported on-change from running, nothing from candidate and all
config=false data from operational. config=false data from operational.
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns= <instance-data-set xmlns=
"urn:ietf:params:xml:ns:yang:ietf-yang-instance-data"> "urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
<name>acme-switch-notification-capabilites</name> <name>acme-switch-notification-capabilities</name>
<!-- Content-schema specification, revision date, contact, etc. --> <module>ietf-notification-capabilities@2019-08-13.yang</module>
<!-- revision date, contact, etc. -->
<description>Notification capabilities of acme-switch. <description>Notification capabilities of acme-switch.
Acme-switch implements the running, candidate and operational Acme-switch implements the running, candidate and operational
datastores. Every change can be reported on-change from running, datastores. Every change can be reported on-change from running,
nothing from candidate and all config=false data from operational. nothing from candidate and all config=false data from operational.
</description> </description>
<content-data> <content-data>
<datastore-subscription-capabilities> <datastore-subscription-capabilities>
<minimum-update-period>500</minimum-update-period> <minimum-update-period>500</minimum-update-period>
<max-objects-per-update>2000</max-objects-per-update> <max-objects-per-update>2000</max-objects-per-update>
<minimum-dampening-period>100</minimum-dampening-period> <minimum-dampening-period>100</minimum-dampening-period>
<on-change-capable-nodes> <datastore-capabilities>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores"> <datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
running running
</datastore> </datastore>
<!-- Neither notification-sent-for-config-default or <!-- Neither on-change-supported-for-config nor
notification-sent-for-state-default are present as the on-change-supported-for-state are present as the
default values are in effect. --> default values are in effect. -->
</on-change-capable-nodes> </datastore-capabilities>
<!-- The candidate datastore is implemented, but not present <!-- The candidate datastore is implemented, but not present
here as it does not support any on-change notifications. --> here as it does not support any on-change notifications. -->
<on-change-capable-nodes> <datastore-capabilities>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores"> <datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
operational operational
</datastore> </datastore>
<notification-sent-for-config-default> <on-change-supported-for-config>
false false
</notification-sent-for-config-default> </on-change-supported-for-config>
<notification-sent-for-state-default> <on-change-supported-for-state>
true true
</notification-sent-for-state-default> </on-change-supported-for-state>
</on-change-capable-nodes> </datastore-capabilities>
</datastore-subscription-capabilities> </datastore-subscription-capabilities>
</content-data> </content-data>
</instance-data-set> </instance-data-set>
Figure 1: Notification Capabilities with default settings Figure 1: Notification Capabilities with default settings
The following is the instance-data describing the notification The following is the instance-data describing the notification
capabilities of a hypothetical "acme-router". The router implements capabilities of a hypothetical "acme-router". The router implements
the running, and operational datastores. Every change can be the running, and operational datastores. Every change can be
reported on-change from running, but only config=true nodes and some reported on-change from running, but only config=true nodes and some
config=false data from operational. Interface statistics are not config=false data from operational. Interface statistics are not
reported on-change only 2 important counters. reported on-change only 2 important counters.
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns= <instance-data-set xmlns=
"urn:ietf:params:xml:ns:yang:ietf-yang-instance-data"> "urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
<name>acme-router-notification-capabilites</name> <name>acme-router-notification-capabilities</name>
<!-- Content-schema specification, revision date, contact, etc. --> <module>ietf-notification-capabilities@2019-08-13.yang</module>
<!-- revision date, contact, etc. -->
<description>Defines the notification capabilities of an acme-router. <description>Defines the notification capabilities of an acme-router.
The router only has running, and operational datastores. The router only has running, and operational datastores.
Every change can be reported on-change from running, but Every change can be reported on-change from running, but
only config=true nodes and some config=false data from operational. only config=true nodes and some config=false data from operational.
Statistics are not reported on-change only 2 important counters. Statistics are not reported on-change only 2 important counters,
for these a smaller dampening period is possible.
</description> </description>
<content-data> <content-data>
<datastore-subscription-capabilities <datastore-subscription-capabilities
xmlns="urn:ietf:params:xml:ns:yang:ietf-notification-capabilities"> xmlns="urn:ietf:params:xml:ns:yang:ietf-notification-capabilities">
<minimum-update-period>500</minimum-update-period> <minimum-update-period>500</minimum-update-period>
<max-objects-per-update>2000</max-objects-per-update> <max-objects-per-update>2000</max-objects-per-update>
<minimum-dampening-period>100</minimum-dampening-period> <minimum-dampening-period>100</minimum-dampening-period>
<on-change-capable-nodes> <datastore-capabilities>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores"> <datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
running running
</datastore> </datastore>
</on-change-capable-nodes> </datastore-capabilities>
<on-change-capable-nodes> <datastore-capabilities>
<datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores"> <datastore xmlns="urn:ietf:params:xml:ns:yang:ietf-datastores">
operational operational
</datastore> </datastore>
<notification-sent-for-state-default> <on-change-supported-for-state>
true true
</notification-sent-for-state-default> </on-change-supported-for-state>
<on-change-notification-capability> <per-node-capabilities>
<node-selector> <node-selector>
/if:interfaces/if:interface/if:statistics</node-selector> /if:interfaces/if:interface/if:statistics</node-selector>
<on-change-supported>false</on-change-supported> <on-change-supported>false</on-change-supported>
</on-change-notification-capability> </per-node-capabilities>
<on-change-notification-capability> <per-node-capabilities>
<node-selector> <node-selector>
/if:interfaces/if:interface/if:statistics/if:in-octets /if:interfaces/if:interface/if:statistics/if:in-octets
</node-selector> </node-selector>
<minimum-dampening-period>10</minimum-dampening-period>
<on-change-supported>true</on-change-supported> <on-change-supported>true</on-change-supported>
</on-change-notification-capability> </per-node-capabilities>
<on-change-notification-capability> <per-node-capabilities>
<node-selector> <node-selector>
/if:interfaces/if:interface/if:statistics/if:out-octets /if:interfaces/if:interface/if:statistics/if:out-octets
</node-selector> </node-selector>
<on-change-supported>true</on-change-supported> <on-change-supported>true</on-change-supported>
</on-change-notification-capability> <minimum-dampening-period>10</minimum-dampening-period>
</on-change-capable-nodes> </per-node-capabilities>
</datastore-capabilities>
</datastore-subscription-capabilities> </datastore-subscription-capabilities>
</content-data> </content-data>
</instance-data-set> </instance-data-set>
Figure 2: Notification Capabilities with data node specific settings Figure 2: Notification Capabilities with data node specific settings
Appendix B. Changes between revisions Appendix B. Changes between revisions
v02 - v03
o Allow throughput related capabilities to be defined on top,
datastore or data node level. Described that specific capability
values always override generic ones.
o Indicate that non-NMDA servers can also use this model.
o Updated according to draft-ietf-netmod-yang-instance-file-
format-04
v01 - v02 v01 - v02
o Added instance data examples o Added instance data examples
o On-change capability can be defined per datastore o On-change capability can be defined per datastore
o Added "if-feature yp:on-change" where relevant o Added "if-feature yp:on-change" where relevant
o Unified units used o Unified units used
 End of changes. 60 change blocks. 
268 lines changed or deleted 342 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/