draft-ietf-netconf-netconf-event-notifications-09.txt   draft-ietf-netconf-netconf-event-notifications-10.txt 
NETCONF E. Voit NETCONF E. Voit
Internet-Draft Cisco Systems Internet-Draft Cisco Systems
Intended status: Standards Track A. Clemm Intended status: Standards Track A. Clemm
Expires: November 5, 2018 Huawei Expires: January 3, 2019 Huawei
A. Gonzalez Prieto A. Gonzalez Prieto
VMware VMware
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
May 4, 2018 July 2, 2018
NETCONF Support for Event Notifications NETCONF Support for Event Notifications
draft-ietf-netconf-netconf-event-notifications-09 draft-ietf-netconf-netconf-event-notifications-10
Abstract Abstract
This document provides a NETCONF binding to subscribed notifications This document provides a NETCONF binding to subscribed notifications
and to YANG push. and to YANG push.
RFC Editor note: please replace the four references to pre-RFC RFC Editor note: please replace the four references to pre-RFC
normative drafts with the actual assigned RFC numbers. normative drafts with the actual assigned RFC numbers.
Status of This Memo Status of This Memo
skipping to change at page 1, line 40 skipping to change at page 1, line 40
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 November 5, 2018. This Internet-Draft will expire on January 3, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 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. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Interleave Capability . . . . . . . . . . . . . . . . . . . . 3 3. Compatibility with RFC-5277's create-subscription . . . . . . 3
4. Compatibility with RFC-5277's create-subscription . . . . . . 3 4. Mandatory XML, event stream and datastore support . . . . . . 4
5. Mandatory XML, event stream and datastore support . . . . . . 4 5. NETCONF connectivity and the subscription lifecycle . . . . . 4
6. NETCONF connectivity and the subscription lifecycle . . . . . 4 5.1. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 4
6.1. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 4 5.2. Configured Subscriptions . . . . . . . . . . . . . . . . 4
6.2. Configured Subscriptions . . . . . . . . . . . . . . . . 4 6. Notification Messages . . . . . . . . . . . . . . . . . . . . 5
7. Notification Messages . . . . . . . . . . . . . . . . . . . . 5 7. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 5
8. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 5 8. YANG module . . . . . . . . . . . . . . . . . . . . . . . . . 7
9. YANG module . . . . . . . . . . . . . . . . . . . . . . . . . 6 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 10. Security Considerations . . . . . . . . . . . . . . . . . . . 9
11. Security Considerations . . . . . . . . . . . . . . . . . . . 8 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 9
12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 9 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
13. Normative References . . . . . . . . . . . . . . . . . . . . 9 12.1. Normative References . . . . . . . . . . . . . . . . . . 10
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 10 12.2. Informative References . . . . . . . . . . . . . . . . . 11
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 10 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 11
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 11 A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 11
A.3. Configured Subscriptions . . . . . . . . . . . . . . . . 15 A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 12
A.4. Subscription State Notifications . . . . . . . . . . . . 20 A.3. Configured Subscriptions . . . . . . . . . . . . . . . . 16
Appendix B. Changes between revisions . . . . . . . . . . . . . 22 A.4. Subscription State Notifications . . . . . . . . . . . . 22
B.1. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 22 Appendix B. Changes between revisions . . . . . . . . . . . . . 24
B.2. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 22 B.1. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 24
B.3. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 22 B.2. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 24
B.4. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 22 B.3. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 24
B.5. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 23 B.4. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 24
B.6. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 23 B.5. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 25
B.7. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 23 B.6. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 25
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23 B.7. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 25
B.8. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 25
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 25
1. Introduction 1. Introduction
This document provides a binding for events streamed over the NETCONF This document provides a binding for events streamed over the NETCONF
protocol [RFC6241] as per protocol [RFC6241] as per
[I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as [I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as
[I-D.ietf-netconf-yang-push] is itself built upon [I-D.ietf-netconf-yang-push] is itself built upon
[I-D.draft-ietf-netconf-subscribed-notifications], this document [I-D.draft-ietf-netconf-subscribed-notifications], this document
enables a NETCONF client to request and receive updates from a YANG enables a NETCONF client to request and receive updates from a YANG
datastore located on a NETCONF server. datastore located on a NETCONF server.
skipping to change at page 3, line 18 skipping to change at page 3, line 20
"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 following terms are defined in The following terms are defined in
[I-D.draft-ietf-netconf-subscribed-notifications]: notification [I-D.draft-ietf-netconf-subscribed-notifications]: notification
message, event stream, publisher, receiver, subscriber, subscription, message, event stream, publisher, receiver, subscriber, subscription,
configured subscription. configured subscription.
3. Interleave Capability 3. Compatibility with RFC-5277's create-subscription
To support multiple subscriptions on a single session, a NETCONF
publisher MUST support the :interleave capability as defined in
[RFC5277]. Advertisement of both the :interleave capability and
"urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications" within a
NETCONF capability exchange MUST indicate that a NETCONF publisher is
able to receive, process, and respond to NETCONF requests and
[I-D.draft-ietf-netconf-subscribed-notifications] subscription
operations.
4. Compatibility with RFC-5277's create-subscription
A publisher is allowed to concurrently support configured A publisher is allowed to concurrently support configured
subscriptions and dynamic subscription RPCs of subscriptions and dynamic subscription RPCs of
[I-D.draft-ietf-netconf-subscribed-notifications] at the same time as [I-D.draft-ietf-netconf-subscribed-notifications] at the same time as
[RFC5277]'s "create-subscription" RPC. However a single NETCONF [RFC5277]'s "create-subscription" RPC. However a single NETCONF
transport session cannot support both this specification and a transport session cannot support both this specification and a
subscription established by [RFC5277]'s "create-subscription" RPC. subscription established by [RFC5277]'s "create-subscription" RPC.
To protect against any attempts to use a single NETCONF transport To protect against any attempts to use a single NETCONF transport
session in this way: session in this way:
skipping to change at page 4, line 9 skipping to change at page 4, line 5
subscription. subscription.
o A "create-subscription" RPC MUST be rejected if any o A "create-subscription" RPC MUST be rejected if any
[I-D.draft-ietf-netconf-subscribed-notifications] or [I-D.draft-ietf-netconf-subscribed-notifications] or
[RFC5277]subscription is active across that NETCONF transport [RFC5277]subscription is active across that NETCONF transport
session. session.
If a publisher supports this specification but not subscriptions via If a publisher supports this specification but not subscriptions via
[RFC5277], the publisher MUST NOT advertise [RFC5277], the publisher MUST NOT advertise
"urn:ietf:params:netconf:capability:notification:1.0". "urn:ietf:params:netconf:capability:notification:1.0".
5. Mandatory XML, event stream and datastore support 4. Mandatory XML, event stream and datastore support
The "encode-xml" feature of The "encode-xml" feature of
[I-D.draft-ietf-netconf-subscribed-notifications] is mandatory to [I-D.draft-ietf-netconf-subscribed-notifications] is mandatory to
support. This indicates that XML is a valid encoding for RPCs, state support. This indicates that XML is a valid encoding for RPCs, state
change notifications, and subscribed content. change notifications, and subscribed content.
A NETCONF publisher supporting event stream subscription via A NETCONF publisher supporting event stream subscription via
[I-D.draft-ietf-netconf-subscribed-notifications] MUST support the [I-D.draft-ietf-netconf-subscribed-notifications] MUST support the
"NETCONF" event stream identified in that draft. "NETCONF" event stream identified in that draft.
A NETCONF publisher supporting [I-D.ietf-netconf-yang-push] MUST A NETCONF publisher supporting [I-D.ietf-netconf-yang-push] MUST
support the operational state datastore as defined by support the operational state datastore as defined by [RFC8342].
[I.D.draft-ietf-netmod-revised-datastores].
6. NETCONF connectivity and the subscription lifecycle 5. NETCONF connectivity and the subscription lifecycle
This section describes how the availability of NETCONF transport This section describes how the availability of NETCONF transport
impacts the establishment and lifecycle of different types of impacts the establishment and lifecycle of different types of
[I-D.draft-ietf-netconf-subscribed-notifications] subscriptions. [I-D.draft-ietf-netconf-subscribed-notifications] subscriptions.
6.1. Dynamic Subscriptions 5.1. Dynamic Subscriptions
For dynamic subscriptions, if the NETCONF session involved with the For a dynamic subscription, if the NETCONF session involved with the
"establish-subscription" terminates, the subscription MUST be "establish-subscription" terminates, the subscription MUST be
deleted. deleted.
6.2. Configured Subscriptions For a dynamic subscription a "modify-subscription", "delete-
subscription", or "resynch-subscription" RPC MUST be sent using same
the NETCONF session upon which the referenced subscription was
established.".
For a configured subscription, there is no guarantee a transport 5.2. Configured Subscriptions
session is currently in place with each associated receiver. In
cases where a configured subscription has a receiver in the When a configured subscription enters the "valid" state, there is no
CONNECTING state as described in guarantee a usable NETCONF transport session is currently in place
[I-D.draft-ietf-netconf-subscribed-notifications], section 2.5.1, and with each associated receiver. As a result, the first configured
the "transport" for that subscription is "NETCONF", but no NETCONF subscription to a specific receiver MUST establish a NETCONF
transport session exists to that receiver (or all existing NETCONF transport session via NETCONF call home [RFC8071], section 4.1. This
transport sessions are currently supporting [RFC5277] subscriptions), transport session MUST then be used by additional configured
then the publisher MUST initiate a transport session via NETCONF call subscriptions targeting that the same receiver. This same receiver
home [RFC8071], section 4.1 to that receiver. Until NETCONF is identifiable on the publisher as one which targets the same IP
connectivity is established and a "subscription-started" state change address and port used to establish the existing NETCONF call home
notification is successfully sent, that receiver MUST remain in connection. This transport session MAY also be used by dynamic
either the CONNECTING or the TIMEOUT state. subscriptions and/or non-subscription related NETCONF operations
originated by the NETCONF client.
The method of identifying the targeted recevier IP address, port, and
security credentials are left up to implementers of this
specification. For implementation guidance and a YANG model for this
function, please look to
[I-D.draft-ietf-netconf-netconf-client-server].
If the call home fails because the publisher receives receiver If the call home fails because the publisher receives receiver
credentials which are subsequently declined per [RFC8071], credentials which are subsequently declined per [RFC8071],
Section 4.1, step S5 authentication, then that receiver MUST be Section 4.1, step S5 authentication, then that receiver MUST be
placed into the TIMEOUT state. placed into the "timeout" state.
If the call home fails to establish for any other reason, the If the call home fails to establish for any other reason, the
publisher MUST NOT progress the receiver to the ACTIVE state. publisher MUST NOT progress the receiver to the "active" state.
Additionally, the publisher SHOULD place the receiver into the Additionally, the publisher SHOULD place the receiver into the
TIMEOUT state after a predetermined number of either failed call home "timeout" state after a predetermined number of either failed call
attempts or NETCONF sessions remotely terminated by the receiver. home attempts or NETCONF sessions remotely terminated by the
receiver.
NETCONF transport session connectivity SHOULD be verified via NETCONF transport session connectivity SHOULD be verified as
Section 4.1, step S7. described in [RFC8071], Section 4.1, step S7.
Until NETCONF transport with a receiver has been established, and a
"subscription-started" state change notification has been
successfully sent for a configured subscription, that subscription's
receiver MUST remain in either the "connecting" or the "timeout"
state.
If a NETCONF session is disconnected but the "stop-time" of a If a NETCONF session is disconnected but the "stop-time" of a
subscription being transported over that session has not been subscription being transported over that session has not been
reached, the publisher restarts the call home process and return the reached, the publisher restarts the call home process and return the
receiver to the CONNECTING state. receiver to the "connecting" state.
7. Notification Messages 6. Notification Messages
Notification messages transported over the NETCONF protocol will be Notification messages transported over the NETCONF protocol will use
identical in format and content to those encoded using one-way the "notification" message defined within [RFC5277], section 4.
operations defined within [RFC5277], section 4.
8. Dynamic Subscriptions and RPC Error Responses All notification messages MUST use the NETCONF transport session used
by the "establish-subscription" RPC.
7. Dynamic Subscriptions and RPC Error Responses
Management of dynamic subscriptions occurs via RPCs as defined in Management of dynamic subscriptions occurs via RPCs as defined in
[I-D.ietf-netconf-yang-push] and [I-D.ietf-netconf-yang-push] and
[I-D.draft-ietf-netconf-subscribed-notifications]. When an RPC error [I-D.draft-ietf-netconf-subscribed-notifications]. When an RPC error
occurs, the NETCONF RPC reply MUST include an "rpc-error" element per occurs, the NETCONF RPC reply MUST include an "rpc-error" element per
[RFC6241] with the error information populated as follows: [RFC6241] with the error information populated as follows:
o an "error-type" node of "application". o an "error-type" node of "application".
o an "error-tag" node of "operation-failed". o an "error-tag" node of "operation-failed".
o an "error-severity" of "error" (this MAY but does not have to be o an "error-severity" of "error" (this MAY but does not have to be
included). included).
o an "error-app-tag" node with the value being a string that o an "error-app-tag" node with the value being a string that
corresponds to an identity associated with the error, as defined corresponds to an identity associated with the error, as defined
in [I-D.draft-ietf-netconf-subscribed-notifications] section 2.4.6 in [I-D.draft-ietf-netconf-subscribed-notifications] section 2.4.6
for general subscriptions, and [I-D.ietf-netconf-yang-push] for general subscriptions, and [I-D.ietf-netconf-yang-push]
Appendix A.1, for datastore subscriptions. The tag to use depends Appendix A.1, for datastore subscriptions. The identityname to
on the RPC for which the error occurred. Viable errors for use depends on the RPC for which the error occurred. Viable
different RPCs are as follows: errors for different RPCs are as follows:
RPC use base identity RPC use base identity
---------------------- ---------------------------- ---------------------- ----------------------------
establish-subscription establish-subscription-error establish-subscription establish-subscription-error
modify-subscription modify-subscription-error modify-subscription modify-subscription-error
delete-subscription delete-subscription-error delete-subscription delete-subscription-error
kill-subscription kill-subscription-error kill-subscription kill-subscription-error
resynch-subscription resynch-subscription-error resynch-subscription resynch-subscription-error
Each error identity will be inserted as the "error-app-tag" using
JSON encoding following the form <modulename>:<identityname>. An
example of such as valid encoding would be "ietf-subscribed-
notifications:no-such-subscription".
o In case of error responses to an "establish-subscription" or o In case of error responses to an "establish-subscription" or
"modify-subscription" request there is the option of including an "modify-subscription" request there is the option of including an
"error-info" node. This node may contain XML-encoded data with "error-info" node. This node may contain XML-encoded data with
hints for parameter settings that might lead to successful RPC hints for parameter settings that might lead to successful RPC
requests in the future. Following are the yang-data structures requests in the future. Following are the yang-data structures
which may be returned: which may be returned:
establish-subscription returns hints in yang-data structure establish-subscription returns hints in yang-data structure
---------------------- ------------------------------------ ---------------------- ------------------------------------
target: event stream establish-subscription-stream-error-info target: event stream establish-subscription-stream-error-info
skipping to change at page 6, line 41 skipping to change at page 7, line 26
optional leaf "error-reason", as such a leaf would be redundant optional leaf "error-reason", as such a leaf would be redundant
with information that is already placed within the with information that is already placed within the
"error-app-tag". "error-app-tag".
In case of an rpc error as a result of a "delete-subscription", a In case of an rpc error as a result of a "delete-subscription", a
"kill-subscription", or a "resynch-subscription" request, no "kill-subscription", or a "resynch-subscription" request, no
"error-info" needs to be included, as the "subscription-id" is "error-info" needs to be included, as the "subscription-id" is
the only RPC input parameter and no hints regarding this RPC input the only RPC input parameter and no hints regarding this RPC input
parameters need to be provided. parameters need to be provided.
Note that "error-path" does not need to be included with the "rpc- 8. YANG module
error" element, as subscription errors are generally not associated
with nodes in the datastore but with the choice of RPC input
parameters.
9. YANG module
This module references This module references
[I-D.draft-ietf-netconf-subscribed-notifications]. [I-D.draft-ietf-netconf-subscribed-notifications].
[ note to the RFC Editor - please replace XXXX within this YANG model [ note to the RFC Editor - please replace XXXX within this YANG model
with the number of this document ] with the number of this document ]
<CODE BEGINS>file
"ietf-netconf-subscribed-notifications@2018-04-20.yang"
module ietf-netconf-subscribed-notifications { module ietf-netconf-subscribed-notifications {
yang-version 1.1; yang-version 1.1;
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-notifications"; "urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-notifications";
prefix nsn; prefix nsn;
import ietf-subscribed-notifications { import ietf-subscribed-notifications {
prefix sn; prefix sn;
} }
skipping to change at page 8, line 19 skipping to change at page 8, line 48
"RFC XXXX: NETCONF Support for Event Notifications"; "RFC XXXX: NETCONF Support for Event Notifications";
} }
identity netconf { identity netconf {
base sn:transport; base sn:transport;
base sn:inline-address; base sn:inline-address;
description description
"NETCONF is used as a transport for notification messages and "NETCONF is used as a transport for notification messages and
state change notifications."; state change notifications.";
} }
} }
<CODE ENDS>
10. IANA Considerations 9. IANA Considerations
This document registers the following namespace URI in the "IETF XML This document registers the following namespace URI in the "IETF XML
Registry" [RFC3688]: Registry" [RFC3688]:
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed- URI: urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-
notifications notifications
Registrant Contact: The IESG. Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace. XML: N/A; the requested URI is an XML namespace.
This document registers the following YANG module in the "YANG Module This document registers the following YANG module in the "YANG Module
Names" registry [RFC6020]: Names" registry [RFC6020]:
Name: ietf-netconf-subscribed-notifications Name: ietf-netconf-subscribed-notifications
Namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed- Namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-
notifications notifications
Prefix: nsn Prefix: nsn
Reference: RFC XXXX: NETCONF Support for Event Notifications Reference: RFC XXXX: NETCONF Support for Event Notifications
11. Security Considerations 10. Security Considerations
Notification messages (including state change notifications) are Notification messages (including state change notifications) are
never sent before the NETCONF capabilities exchange has completed. never sent before the NETCONF capabilities exchange has completed.
If a malicious or buggy NETCONF subscriber sends a number of If a malicious or buggy NETCONF subscriber sends a number of
establish-subscription requests, then these subscriptions accumulate establish-subscription requests, then these subscriptions accumulate
and may use up system resources. In such a situation, subscriptions and may use up system resources. In such a situation, subscriptions
MAY be terminated by terminating the underlying NETCONF session. The MAY be terminated by terminating the underlying NETCONF session. The
publisher MAY also suspend or terminate a subset of the active publisher MAY also suspend or terminate a subset of the active
subscriptions on that NETCONF session. subscriptions on that NETCONF session.
This draft does not define a YANG module and therefore doesn't have This draft has a YANG module which consists of a single identity. As
any YANG-related Security Considerations. a result additional security concerns beyond those of the imported
modules are not introduced.
12. Acknowledgments 11. Acknowledgments
We wish to acknowledge the helpful contributions, comments, and We wish to acknowledge the helpful contributions, comments, and
suggestions that were received from: Andy Bierman, Yan Gang, Sharon suggestions that were received from: Andy Bierman, Yan Gang, Sharon
Chisholm, Hector Trevino, Peipei Guo, Susan Hares, Tim Jenkins, Chisholm, Hector Trevino, Peipei Guo, Susan Hares, Tim Jenkins,
Balazs Lengyel, Martin Bjorklund, Mahesh Jethanandani, Kent Watsen, Balazs Lengyel, Martin Bjorklund, Mahesh Jethanandani, Kent Watsen,
and Guangying Zheng. and Guangying Zheng.
13. Normative References 12. References
12.1. Normative References
[I-D.draft-ietf-netconf-subscribed-notifications] [I-D.draft-ietf-netconf-subscribed-notifications]
Voit, E., Clemm, A., Gonzalez Prieto, A., Tripathy, A., Voit, E., Clemm, A., Gonzalez Prieto, A., Tripathy, A.,
and E. Nilsen-Nygaard, "Customized Subscriptions to a and E. Nilsen-Nygaard, "Customized Subscriptions to a
Publisher's Event Streams", draft-ietf-netconf-subscribed- Publisher's Event Streams", draft-ietf-netconf-subscribed-
notifications-11 (work in progress), April 2018. notifications-14 (work in progress), July 2018.
[I-D.ietf-netconf-yang-push] [I-D.ietf-netconf-yang-push]
Clemm, Alexander., Voit, Eric., Gonzalez Prieto, Alberto., Clemm, Alexander., Voit, Eric., Gonzalez Prieto, Alberto.,
Tripathy, A., Nilsen-Nygaard, E., Bierman, A., and B. Tripathy, A., Nilsen-Nygaard, E., Bierman, A., and B.
Lengyel, "YANG Datastore Subscription", February 2018, Lengyel, "YANG Datastore Subscription", June 2018,
<https://datatracker.ietf.org/doc/ <https://datatracker.ietf.org/doc/
draft-ietf-netconf-yang-push/>. draft-ietf-netconf-yang-push/>.
[I.D.draft-ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-10
(work in progress), January 2018.
[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>.
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event
skipping to change at page 10, line 23 skipping to change at page 11, line 5
<https://www.rfc-editor.org/info/rfc6241>. <https://www.rfc-editor.org/info/rfc6241>.
[RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home",
RFC 8071, DOI 10.17487/RFC8071, February 2017, RFC 8071, DOI 10.17487/RFC8071, February 2017,
<https://www.rfc-editor.org/info/rfc8071>. <https://www.rfc-editor.org/info/rfc8071>.
[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>.
[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>.
12.2. Informative References
[I-D.draft-ietf-netconf-netconf-client-server]
Watsen, K. and G. Wu, "NETCONF Client and Server Models",
draft-ietf-netconf-netconf-client-server-06 (work in
progress), June 2018.
Appendix A. Examples Appendix A. Examples
This section is non-normative. This section is non-normative.
A.1. Event Stream Discovery A.1. Event Stream Discovery
As defined in [I-D.draft-ietf-netconf-subscribed-notifications] an As defined in [I-D.draft-ietf-netconf-subscribed-notifications] an
event stream exposes a continuous set of events available for event stream exposes a continuous set of events available for
subscription. A NETCONF client can retrieve the list of available subscription. A NETCONF client can retrieve the list of available
event streams from a NETCONF publisher using the "get" operation event streams from a NETCONF publisher using the "get" operation
skipping to change at page 11, line 38 skipping to change at page 12, line 34
|----------------------------->| (a) |----------------------------->| (a)
| RPC Reply: OK, id = 22 | | RPC Reply: OK, id = 22 |
|<-----------------------------| (b) |<-----------------------------| (b)
| | | |
| notification message (for 22)| | notification message (for 22)|
|<-----------------------------| |<-----------------------------|
| | | |
| | | |
| establish-subscription | | establish-subscription |
|----------------------------->| |----------------------------->|
| notification message (for 22)|
|<-----------------------------|
| RPC Reply: OK, id = 23 | | RPC Reply: OK, id = 23 |
|<-----------------------------| |<-----------------------------|
| | | |
| | | |
| notification message (for 22)| | notification message (for 22)|
|<-----------------------------| |<-----------------------------|
| notification message (for 23)| | notification message (for 23)|
|<-----------------------------| |<-----------------------------|
| | | |
skipping to change at page 12, line 44 skipping to change at page 13, line 44
subscription, the publisher would have sent an RPC error response. subscription, the publisher would have sent an RPC error response.
For instance, if the "dscp" value of 10 asserted by the subscriber in For instance, if the "dscp" value of 10 asserted by the subscriber in
Figure 3 proved unacceptable, the publisher may have returned: Figure 3 proved unacceptable, the publisher may have returned:
<rpc-reply message-id="102" <rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<rpc-error> <rpc-error>
<error-type>application</error-type> <error-type>application</error-type>
<error-tag>operation-failed</error-tag> <error-tag>operation-failed</error-tag>
<error-severity>error</error-severity> <error-severity>error</error-severity>
<error-app-tag>dscp-unavailable</error-app-tag> <error-app-tag>
ietf-subscribed-notifications:dscp-unavailable
</error-app-tag>
</rpc-error> </rpc-error>
</rpc-reply> </rpc-reply>
Figure 5: an unsuccessful establish subscription Figure 5: an unsuccessful establish subscription
The subscriber can use this information in future attempts to The subscriber can use this information in future attempts to
establish a subscription. establish a subscription.
A.2.2. Modifying Dynamic Subscriptions A.2.2. Modifying Dynamic Subscriptions
skipping to change at page 14, line 36 skipping to change at page 15, line 36
for (d) which includes a hint. This hint is an alternative time for (d) which includes a hint. This hint is an alternative time
period value which might have resulted in a successful modification: period value which might have resulted in a successful modification:
<rpc-reply message-id="303" <rpc-reply message-id="303"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<rpc-error> <rpc-error>
<error-type>application</error-type> <error-type>application</error-type>
<error-tag>operation-failed</error-tag> <error-tag>operation-failed</error-tag>
<error-severity>error</error-severity> <error-severity>error</error-severity>
<error-app-tag> <error-app-tag>
period-unsupported ietf-yang-push:period-unsupported
</error-app-tag> </error-app-tag>
<error-info <error-info
xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push"> xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<modify-subscription-datastore-error-info> <modify-subscription-datastore-error-info>
<period-hint> <period-hint>
3000 3000
</period-hint> </period-hint>
</modify-subscription-datastore-error-info> </modify-subscription-datastore-error-info>
</error-info> </error-info>
</rpc-error> </rpc-error>
skipping to change at page 15, line 36 skipping to change at page 16, line 36
identifier, but that subscription identifier was created on a identifier, but that subscription identifier was created on a
different NETCONF transport session: different NETCONF transport session:
<rpc-reply message-id="103" <rpc-reply message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<rpc-error> <rpc-error>
<error-type>application</error-type> <error-type>application</error-type>
<error-tag>operation-failed</error-tag> <error-tag>operation-failed</error-tag>
<error-severity>error</error-severity> <error-severity>error</error-severity>
<error-app-tag> <error-app-tag>
no-such-subscription ietf-subscribed-notifications:no-such-subscription
</error-app-tag> </error-app-tag>
</rpc-error> </rpc-error>
</rpc-reply> </rpc-reply>
Figure 10: Unsuccessful delete subscription Figure 10: Unsuccessful delete subscription
A.3. Configured Subscriptions A.3. Configured Subscriptions
Configured subscriptions may be established, modified, and deleted Configured subscriptions may be established, modified, and deleted
using configuration operations against the top-level subtree of using configuration operations against the top-level subtree of
skipping to change at page 16, line 27 skipping to change at page 17, line 27
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<subscription> <subscription>
<identifier>1922</identifier> <identifier>1922</identifier>
<transport xmlns:nsn= <transport xmlns:nsn=
"urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-notifications"> "urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-notifications">
nsn:netconf nsn:netconf
<transport> <transport>
<stream>NETCONF</stream> <stream>NETCONF</stream>
<receivers> <receivers>
<receiver> <receiver>
<name>receiver1</name> <name>receiver1</name>
<address>1.2.3.4</address>
</receiver> </receiver>
</receivers> </receivers>
</subscription> </subscription>
</subscriptions> </subscriptions>
</config> </config>
</edit-config> </edit-config>
</rpc> </rpc>
Figure 11: Create a configured subscription Figure 11: Create a configured subscription
skipping to change at page 17, line 22 skipping to change at page 18, line 22
Temporarily the publisher cannot serve this Temporarily the publisher cannot serve this
subscription due to the current workload. subscription due to the current workload.
</error-message> </error-message>
</rpc-error> </rpc-error>
</rpc-reply> </rpc-reply>
Figure 12: Response to a failed configured subscription establishment Figure 12: Response to a failed configured subscription establishment
After a subscription has been created, NETCONF connectivity to each After a subscription has been created, NETCONF connectivity to each
receiver will be established if it does not already exist. This will receiver will be established if it does not already exist. This will
be accomplished via [RFC8071]. be accomplished through the association on the publisher with the
networking parameters needed to establish connectivity with each
configured receiver. These parameters will be used as needed by
NETCONF call home [RFC8071].
The following figure shows the interaction model for the successful The following figure shows the interaction model for the successful
creation of a configured subscription. creation of a configured subscription.
+----------+ +-----------+ +---------+ +----------+ +-----------+ +---------+
|Config Ops| | Publisher | | 1.2.3.4 | |Config Ops| | Publisher | |Receiver1|
+----------+ +-----------+ +---------+ +----------+ +-----------+ +---------+
| | | | | |
| Capability Exchange | | | Capability Exchange | |
|<-------------------------->| | |<-------------------------->| |
| | | | | |
| | | | | |
| Edit-config | | | Edit-config | |
|--------------------------->| | |--------------------------->| |
| RPC Reply: OK | | | RPC Reply: OK | |
|<---------------------------| | |<---------------------------| |
skipping to change at page 18, line 28 skipping to change at page 20, line 20
<config> <config>
<subscriptions <subscriptions
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<subscription> <subscription>
<identifier> <identifier>
1922 1922
</identifier> </identifier>
<receivers> <receivers>
<receiver> <receiver>
<name>receiver2</name> <name>receiver2</name>
<address>1.2.3.5</address>
</receiver> </receiver>
</receivers> </receivers>
</subscription> </subscription>
</subscriptions> </subscriptions>
</config> </config>
</edit-config> </edit-config>
</rpc> </rpc>
Figure 14: Modify configured subscription Figure 14: Modify configured subscription
If the request is accepted, the publisher will indicate success. The If the request is accepted, the publisher will indicate success. The
result is that the interaction model described in Figure 13 may be result is that the interaction model described in Figure 13 may be
extended as follows. extended as follows.
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
|Config Ops| | Publisher | | 1.2.3.4 | | 1.2.3.5 | |Config Ops| | Publisher | |Receiver1| |Receiver2|
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| | notification | | | | notification | |
| | message | | | | message | |
| |--------------->| | | |--------------->| |
| Edit-config | | | | Edit-config | | |
|--------------------------->| | | |--------------------------->| | |
| RPC Reply: OK | | | | RPC Reply: OK | | |
|<---------------------------| | | |<---------------------------| | |
| | subscription- | | | | subscription- | |
| | started | | | | started | |
skipping to change at page 20, line 6 skipping to change at page 22, line 6
would have been required for the original receiver. would have been required for the original receiver.
A.3.3. Deleting Configured Subscriptions A.3.3. Deleting Configured Subscriptions
Configured subscriptions can be deleted using configuration Configured subscriptions can be deleted using configuration
operations against the top-level container "/subscriptions". operations against the top-level container "/subscriptions".
Deleting the subscription above would result in the following flow Deleting the subscription above would result in the following flow
impacting all active receivers. impacting all active receivers.
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
|Config Ops| | Publisher | | 1.2.3.4 | | 1.2.3.5 | |Config Ops| | Publisher | |Receiver1| |Receiver2|
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| | | | | | | |
| | notification | | | | notification | |
| | message | | | | message | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
| | | | | | | |
| Edit-config | | | | Edit-config | | |
|--------------------------->| | | |--------------------------->| | |
| RPC Reply: OK | | | | RPC Reply: OK | | |
skipping to change at page 22, line 27 skipping to change at page 24, line 27
Figure 19: subscription-terminated subscription state notification Figure 19: subscription-terminated subscription state notification
The "subscription-suspended" is virtually identical, with The "subscription-suspended" is virtually identical, with
"subscription-terminated" simply being replaced by "subscription- "subscription-terminated" simply being replaced by "subscription-
suspended". suspended".
Appendix B. Changes between revisions Appendix B. Changes between revisions
(To be removed by RFC editor prior to publication) (To be removed by RFC editor prior to publication)
B.1. v08 to v09 B.1. v09 to v10
o Tweaks to examples and text.
o Downshifted state names.
o Removed address from examples.
B.2. v08 to v09
o Tweaks based on Kent's comments. o Tweaks based on Kent's comments.
o Updated examples in Appendix A. And updates to some object names o Updated examples in Appendix A. And updates to some object names
based on changes in the subscribed-notifications draft. based on changes in the subscribed-notifications draft.
o Added a YANG model for the NETCONF identity. o Added a YANG model for the NETCONF identity.
B.2. v07 to v08 B.3. v07 to v08
o Tweaks and clarification on :interleave. o Tweaks and clarification on :interleave.
B.3. v06 to v07 B.4. v06 to v07
o XML encoding and operational datastore mandatory. o XML encoding and operational datastore mandatory.
o Error mechanisms and examples updated. o Error mechanisms and examples updated.
B.4. v05 to v06 B.5. v05 to v06
o Moved examples to appendices o Moved examples to appendices
o All examples rewritten based on namespace learnings o All examples rewritten based on namespace learnings
o Normative text consolidated in front o Normative text consolidated in front
o Removed all mention of JSON o Removed all mention of JSON
o Call home process detailed o Call home process detailed
o Note: this is a major revision attempting to cover those comments o Note: this is a major revision attempting to cover those comments
received from two week review. received from two week review.
B.5. v03 to v04 B.6. v03 to v04
o Added additional detail to "configured subscriptions" o Added additional detail to "configured subscriptions"
o Added interleave capability o Added interleave capability
o Adjusted terminology to that in draft-ietf-netconf-subscribed- o Adjusted terminology to that in draft-ietf-netconf-subscribed-
notifications notifications
o Corrected namespaces in examples o Corrected namespaces in examples
B.6. v01 to v03 B.7. v01 to v03
o Text simplifications throughout o Text simplifications throughout
o v02 had no meaningful changes o v02 had no meaningful changes
B.7. v00 to v01 B.8. v00 to v01
o Added Call Home in solution for configured subscriptions. o Added Call Home in solution for configured subscriptions.
o Clarified support for multiple subscription on a single session. o Clarified support for multiple subscription on a single session.
No need to support multiple create-subscription. No need to support multiple create-subscription.
o Added mapping between terminology in yang-push and [RFC6241] (the o Added mapping between terminology in yang-push and [RFC6241] (the
one followed in this document). one followed in this document).
o Editorial improvements. o Editorial improvements.
Authors' Addresses Authors' Addresses
 End of changes. 53 change blocks. 
117 lines changed or deleted 147 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/