draft-ietf-netconf-netconf-event-notifications-13.txt   draft-ietf-netconf-netconf-event-notifications-14.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: April 7, 2019 Huawei Expires: April 26, 2019 Huawei
A. Gonzalez Prieto A. Gonzalez Prieto
Microsoft Microsoft
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
October 4, 2018 October 23, 2018
NETCONF Support for Event Notifications Dynamic subscription to YANG Events and Datastores over NETCONF
draft-ietf-netconf-netconf-event-notifications-13 draft-ietf-netconf-netconf-event-notifications-14
Abstract Abstract
This document provides a NETCONF binding to the dynamic subscription This document provides a NETCONF binding to the dynamic subscription
capability of both subscribed notifications and YANG push. capability of both subscribed notifications and 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 April 7, 2019. This Internet-Draft will expire on April 26, 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
skipping to change at page 2, line 32 skipping to change at page 2, line 32
10. Notes to the RFC Editor . . . . . . . . . . . . . . . . . . . 6 10. Notes to the RFC Editor . . . . . . . . . . . . . . . . . . . 6
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 6
11.1. Normative References . . . . . . . . . . . . . . . . . . 6 11.1. Normative References . . . . . . . . . . . . . . . . . . 6
11.2. Informative References . . . . . . . . . . . . . . . . . 7 11.2. Informative References . . . . . . . . . . . . . . . . . 7
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 7 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 7
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 7 A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 7
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 8 A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 8
A.3. Subscription State Notifications . . . . . . . . . . . . 12 A.3. Subscription State Notifications . . . . . . . . . . . . 12
A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 14 A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 14
Appendix B. Changes between revisions . . . . . . . . . . . . . 15 Appendix B. Changes between revisions . . . . . . . . . . . . . 15
B.1. v11 to v13 . . . . . . . . . . . . . . . . . . . . . . . 15 B.1. v13 to v14 . . . . . . . . . . . . . . . . . . . . . . . 15
B.2. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 16 B.2. v11 to v13 . . . . . . . . . . . . . . . . . . . . . . . 16
B.3. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 16 B.3. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 16
B.4. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 16 B.4. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 16
B.5. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 16 B.5. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 16
B.6. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 16 B.6. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 16
B.7. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 16 B.7. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 16
B.8. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 16 B.8. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 16
B.9. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 17 B.9. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 16
B.10. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 17 B.10. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 17
B.11. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 17
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17
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] for dynamic subscriptions as defined in protocol [RFC6241] for dynamic subscriptions as defined in
[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 via a dynamic subscription and enables a NETCONF client to request via a dynamic subscription and
skipping to change at page 3, line 18 skipping to change at page 3, line 18
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 following terms are defined in The following terms are defined in
[I-D.draft-ietf-netconf-subscribed-notifications]: dynamic [I-D.draft-ietf-netconf-subscribed-notifications]: dynamic
subscription, event stream, notification message, publisher, subscription, event stream, notification message, publisher,
receiver, subscriber, subscription. receiver, subscriber, subscription. No additional terms are defined.
3. Compatibility with RFC-5277's create-subscription 3. Compatibility with RFC-5277's create-subscription
A publisher is allowed to concurrently support dynamic subscription A publisher is allowed to concurrently support dynamic subscription
RPCs of [I-D.draft-ietf-netconf-subscribed-notifications] at the same RPCs of [I-D.draft-ietf-netconf-subscribed-notifications] at the same
time as [RFC5277]'s "create-subscription" RPC. However a single time as [RFC5277]'s "create-subscription" RPC. However a single
NETCONF transport session cannot support both this specification and NETCONF transport session cannot support both this specification and
a subscription established by [RFC5277]'s "create-subscription" RPC. a 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:
o A solution must reply with the [RFC6241] error "operation-not- o A solution must reply with the [RFC6241] error "operation-not-
supported" if a "create-subscription" RPC is received on a NETCONF supported" if a "create-subscription" RPC is received on a NETCONF
session where an [I-D.draft-ietf-netconf-subscribed-notifications] session where an [I-D.draft-ietf-netconf-subscribed-notifications]
established subscription exists. established subscription exists.
o A solution must reply with the [RFC6241] error "operation-not- o A solution must reply with the [RFC6241] error "operation-not-
supported" if an "establish-subscription" request is been received supported" if an "establish-subscription" request has been
on a NETCONF session where the "create-subscription" RPC has received on a NETCONF session where the "create-subscription" RPC
successfully [RFC5277] created a subscription. has successfully [RFC5277] created a subscription.
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".
4. 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] MUST be supported.
support. This indicates that XML is a valid encoding for RPCs, state This indicates that XML is a valid encoding for RPCs, state change
change notifications, and subscribed content. 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 document.
5. NETCONF connectivity and the Dynamic Subscriptions 5. NETCONF connectivity and the Dynamic Subscriptions
For a dynamic subscription, 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
terminated. terminated.
For a dynamic subscription a "modify-subscription", "delete- For a dynamic subscription, any "modify-subscription", "delete-
subscription", or "resynch-subscription" RPC MUST be sent using same subscription", or "resynch-subscription" RPCs MUST be sent using the
the NETCONF session upon which the referenced subscription was same NETCONF session upon which the referenced subscription was
established. established.
6. Notification Messages 6. Notification Messages
Notification messages transported over the NETCONF protocol MUST be Notification messages transported over the NETCONF protocol MUST be
encoded in a <notification> message as defined within [RFC5277], encoded in a <notification> message as defined within [RFC5277],
Section 4. And per [RFC5277]'s "eventTime" object definition, the Section 4. And per [RFC5277]'s "eventTime" object definition, the
"eventTime" MUST be populated with the event occurrence time. "eventTime" MUST be populated with the event occurrence time.
For dynamic subscriptions, all notification messages MUST use the For dynamic subscriptions, all notification messages MUST use the
skipping to change at page 4, line 47 skipping to change at page 4, line 47
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 specific identity Appendix A.1, for datastore subscriptions. The specific identity
to use depends on the RPC for which the error occurred. Viable to use depends on the RPC for which the error occurred. Each
errors for different RPCs are as follows: error identity will be inserted as the "error-app-tag" following
the form <modulename>:<identityname>. An example of such as valid
encoding would be "ietf-subscribed-notifications:no-such-
subscription". Viable 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: from [I-D.draft-ietf-netconf-subscribed-notifications] and
[I-D.ietf-netconf-yang-push] 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
target: datastore establish-subscription-datastore-error-info target: datastore establish-subscription-datastore-error-info
modify-subscription returns hints in yang-data structure modify-subscription returns hints in yang-data structure
---------------------- ------------------------------------ ---------------------- ------------------------------------
target: event stream modify-subscription-stream-error-info target: event stream modify-subscription-stream-error-info
target: datastore modify-subscription-datastore-error-info target: datastore modify-subscription-datastore-error-info
The yang-data included within "error-info" SHOULD NOT include the The yang-data included within "error-info" SHOULD NOT include the
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 resulting from a "delete-subscription", In case of an rpc error resulting from a "delete-subscription",
"kill-subscription", or "resynch-subscription" request, no "kill-subscription", or "resynch-subscription" request, no "error-
"error-info" needs to be included, as the "subscription-id" is info" needs to be included, as the "subscription-id" is the only RPC
the only RPC input parameter and no hints regarding this RPC input input parameter and no hints regarding this RPC input parameters need
parameters need to be provided. to be provided.
8. Security Considerations 8. Security Considerations
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.
skipping to change at page 6, line 33 skipping to change at page 6, line 31
notification messages be sent after a successful "establish- notification messages be sent after a successful "establish-
subscription". subscription".
11. References 11. References
11.1. Normative References 11.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", September 2018,
notifications-17 (work in progress), September 2018. <https://datatracker.ietf.org/doc/
draft-ietf-netconf-subscribed-notifications/>.
[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", September 2018, Lengyel, "YANG Datastore Subscription", September 2018,
<https://datatracker.ietf.org/doc/ <https://datatracker.ietf.org/doc/
draft-ietf-netconf-yang-push/>. draft-ietf-netconf-yang-push/>.
[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,
skipping to change at page 10, line 43 skipping to change at page 10, line 43
| notification message (for 23)| | notification message (for 23)|
|<-----------------------------| |<-----------------------------|
| | | |
Figure 6: Interaction model for successful subscription modification Figure 6: Interaction model for successful subscription modification
If the subscription being modified in Figure 6 is a datastore If the subscription being modified in Figure 6 is a datastore
subscription as per [I-D.ietf-netconf-yang-push], the modification subscription as per [I-D.ietf-netconf-yang-push], the modification
request made in (c) may look like that shown in Figure 7. As can be request made in (c) may look like that shown in Figure 7. As can be
seen, the modifications being attempted are the application of a new seen, the modifications being attempted are the application of a new
xpath filter as well as the setting of a new periodic time interval. XPath filter as well as the setting of a new periodic time interval.
<rpc message-id="303" <rpc message-id="303"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<modify-subscription <modify-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications" xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push"> xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<id>23</id> <id>23</id>
<yp:datastore-xpath-filter xmlns:ds="http://example.com/datastore"> <yp:datastore-xpath-filter xmlns:ds="http://example.com/datastore">
/ds:foo/ds:bar /ds:foo/ds:bar
</yp:datastore-xpath-filter> </yp:datastore-xpath-filter>
skipping to change at page 11, line 38 skipping to change at page 11, line 38
<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>
ietf-yang-push: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"> <modify-subscription-datastore-error-info
<modify-subscription-datastore-error-info> xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<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>
</rpc-reply> </rpc-reply>
Figure 8: Modify subscription failure with Hint (d) Figure 8: Modify subscription failure with hint (d)
A.2.3. Deleting Dynamic Subscriptions A.2.3. Deleting Dynamic Subscriptions
The following demonstrates deleting a subscription. This The following demonstrates deleting a subscription. This
subscription may have been to either a stream or a datastore. subscription may have been to either a stream or a datastore.
<rpc message-id="103" <rpc message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<delete-subscription <delete-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
skipping to change at page 12, line 47 skipping to change at page 12, line 47
</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. Subscription State Notifications A.3. Subscription State Notifications
A publisher will send subscription state notifications for dynamic A publisher will send subscription state notifications for dynamic
subscriptions according to the definitions within subscriptions according to the definitions within
[I-D.draft-ietf-netconf-subscribed-notifications]). [I-D.draft-ietf-netconf-subscribed-notifications].
A.3.1. subscription-modified A.3.1. subscription-modified
As per Section 2.7.2 of As per Section 2.7.2 of
[I-D.draft-ietf-netconf-subscribed-notifications], a "subscription- [I-D.draft-ietf-netconf-subscribed-notifications], a "subscription-
modified" might be sent if over NETCONF if the definition of a modified" might be sent over NETCONF if the definition of a
configured filter changes. A subscription state notification encoded configured filter changes. A subscription state notification encoded
in XML would look like: in XML would look like:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime> <eventTime>2007-09-01T10:00:00Z</eventTime>
<subscription-modified <subscription-modified
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<id>39</id> <id>39</id>
<transport xmlns:nsn=
"urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-notifications">
nsn:netconf
<transport>
<stream-xpath-filter xmlns:ex="http://example.com/events"> <stream-xpath-filter xmlns:ex="http://example.com/events">
/ex:foo /ex:foo
</stream-xpath-filter> </stream-xpath-filter>
<stream>NETCONF</stream> <stream>NETCONF</stream>
</subscription-modified> </subscription-modified>
</notification> </notification>
Figure 11: subscription-modified subscription state notification Figure 11: subscription-modified subscription state notification
A.3.2. subscription-resumed, and replay-complete A.3.2. subscription-resumed, and replay-complete
skipping to change at page 14, line 29 skipping to change at page 14, line 25
</notification> </notification>
Figure 13: subscription-terminated subscription state notification Figure 13: 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".
A.4. Filter Examples A.4. Filter Examples
This section provides examples which illustrate both xpath and This section provides examples which illustrate both XPath and
subtree methods of filtering event record contents. The examples are subtree methods of filtering event record contents. The examples are
based on the YANG notification "vrrp-protocol-error-event" as defined based on the YANG notification "vrrp-protocol-error-event" as defined
per the ietf-vrrp.yang model within [RFC8347]. Event records based per the ietf-vrrp.yang model within [RFC8347]. Event records based
on this specification which are generated by the publisher might on this specification which are generated by the publisher might
appear as: appear as:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-09-14T08:22:33.44Z</eventTime> <eventTime>2018-09-14T08:22:33.44Z</eventTime>
<vrrp-protocol-error-event <vrrp-protocol-error-event
xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp"> xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp">
skipping to change at page 15, line 5 skipping to change at page 15, line 5
Figure 14: RFC 8347 (VRRP) - Example Notification Figure 14: RFC 8347 (VRRP) - Example Notification
Suppose a subscriber wanted to establish a subscription which only Suppose a subscriber wanted to establish a subscription which only
passes instances of event records where there is a "checksum-error" passes instances of event records where there is a "checksum-error"
as part of a VRRP protocol event. Also assume the publisher places as part of a VRRP protocol event. Also assume the publisher places
such event records into the NETCONF stream. To get a continuous such event records into the NETCONF stream. To get a continuous
series of matching event records, the subscriber might request the series of matching event records, the subscriber might request the
application of an XPath filter against the NETCONF stream. An application of an XPath filter against the NETCONF stream. An
"establish-subscription" RPC to meet this objective might be: "establish-subscription" RPC to meet this objective might be:
<rpc message-id="601" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <rpc message-id="601" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription <establish-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<stream>NETCONF</stream> <stream>NETCONF</stream>
<stream-xpath-filter xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp"> <stream-xpath-filter xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp">
/vrrp-protocol-error-event[protocol-error-reason="checksum-error"] /vrrp-protocol-error-event[
</stream-xpath-filter> vrrp:protocol-error-reason="vrrp:checksum-error"]
</establish-subscription> </stream-xpath-filter>
</rpc> </establish-subscription>
</rpc>
Figure 15: Establishing a subscription error reason via XPATH Figure 15: Establishing a subscription error reason via XPath
For more examples of xpath filters, see [XPATH]. For more examples of XPath filters, see [XPATH].
Suppose the "establish-subscription" in Figure 15 was accepted. And Suppose the "establish-subscription" in Figure 15 was accepted. And
suppose later a subscriber decided they wanted to broaden this suppose later a subscriber decided they wanted to broaden this
subscription cover to all VRRP protocol events (i.e., not just those subscription cover to all VRRP protocol events (i.e., not just those
with a "checksum error"). The subscriber might attempt to modify the with a "checksum error"). The subscriber might attempt to modify the
subscription in a way which replaces the XPath filter with a subtree subscription in a way which replaces the XPath filter with a subtree
filter which sends all VRRP protocol events to a subscriber. Such a filter which sends all VRRP protocol events to a subscriber. Such a
"modify-subscription" RPC might look like: "modify-subscription" RPC might look like:
<rpc message-id="602" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <rpc message-id="602" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
skipping to change at page 15, line 46 skipping to change at page 15, line 47
</rpc> </rpc>
Figure 16 Figure 16
For more examples of subtree filters, see [RFC6241], section 6.4. For more examples of subtree filters, see [RFC6241], section 6.4.
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. v11 to v13 B.1. v13 to v14
o Title change.
B.2. v11 to v13
o Subscription identifier renamed to id. o Subscription identifier renamed to id.
o Appendix A.4 for filter examples o Appendix A.4 for filter examples
o for v13, Tweak of example to /foo/bar o for v13, Tweak of example to /foo/bar
B.2. v10 to v11 B.3. v10 to v11
o Configured removed. o Configured removed.
B.3. v09 to v10 B.4. v09 to v10
o Tweaks to examples and text. o Tweaks to examples and text.
o Downshifted state names. o Downshifted state names.
o Removed address from examples. o Removed address from examples.
B.4. v08 to v09 B.5. 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.5. v07 to v08 B.6. v07 to v08
o Tweaks and clarification on :interleave. o Tweaks and clarification on :interleave.
B.6. v06 to v07 B.7. 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.7. v05 to v06 B.8. 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.8. v03 to v04 B.9. 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.9. v01 to v03 B.10. v01 to v03
o Text simplifications throughout o Text simplifications throughout
o v02 had no meaningful changes o v02 had no meaningful changes
B.10. v00 to v01 B.11. 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. 37 change blocks. 
79 lines changed or deleted 82 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/