draft-ietf-netconf-netconf-event-notifications-11.txt   draft-ietf-netconf-netconf-event-notifications-12.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: February 4, 2019 Huawei Expires: April 7, 2019 Huawei
A. Gonzalez Prieto A. Gonzalez Prieto
Microsoft Microsoft
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
August 3, 2018 October 4, 2018
NETCONF Support for Event Notifications NETCONF Support for Event Notifications
draft-ietf-netconf-netconf-event-notifications-11 draft-ietf-netconf-netconf-event-notifications-12
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 February 4, 2019. This Internet-Draft will expire on April 7, 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 21 skipping to change at page 2, line 21
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Compatibility with RFC-5277's create-subscription . . . . . . 3 3. Compatibility with RFC-5277's create-subscription . . . . . . 3
4. Mandatory XML, event stream and datastore support . . . . . . 3 4. Mandatory XML, event stream and datastore support . . . . . . 3
5. NETCONF connectivity and the Dynamic Subscriptions . . . . . 4 5. NETCONF connectivity and the Dynamic Subscriptions . . . . . 4
6. Notification Messages . . . . . . . . . . . . . . . . . . . . 4 6. Notification Messages . . . . . . . . . . . . . . . . . . . . 4
7. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 4 7. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 4
8. Security Considerations . . . . . . . . . . . . . . . . . . . 5 8. Security Considerations . . . . . . . . . . . . . . . . . . . 5
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 5 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6
10. Normative References . . . . . . . . . . . . . . . . . . . . 6 10. Notes to the RFC Editor . . . . . . . . . . . . . . . . . . . 6
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 6 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 6
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 6 11.1. Normative References . . . . . . . . . . . . . . . . . . 6
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 7 11.2. Informative References . . . . . . . . . . . . . . . . . 7
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 7
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 7
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 8
A.3. Subscription State Notifications . . . . . . . . . . . . 12 A.3. Subscription State Notifications . . . . . . . . . . . . 12
Appendix B. Changes between revisions . . . . . . . . . . . . . 13 A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 14
B.1. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 14 Appendix B. Changes between revisions . . . . . . . . . . . . . 15
B.2. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 14 B.1. v11 to v12 . . . . . . . . . . . . . . . . . . . . . . . 15
B.3. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 14 B.2. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 16
B.4. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 14 B.3. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 16
B.5. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 14 B.4. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 16
B.6. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 14 B.5. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 16
B.7. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 14 B.6. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 16
B.8. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 15 B.7. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 16
B.9. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 15 B.8. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 16
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15 B.9. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 17
B.10. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 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 dyanamic 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
receive updates from a YANG datastore located on a NETCONF server. receive updates from a YANG datastore located on a NETCONF server.
2. Terminology 2. 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 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]: dynamic
message, event stream, publisher, receiver, subscriber, subscription. subscription, event stream, notification message, publisher,
receiver, subscriber, subscription.
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:
skipping to change at page 4, line 18 skipping to change at page 4, line 22
"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 a "modify-subscription", "delete-
subscription", or "resynch-subscription" RPC MUST be sent using same subscription", or "resynch-subscription" RPC MUST be sent using same
the NETCONF session upon which the referenced subscription was the NETCONF session upon which the referenced subscription was
established. established.
6. Notification Messages 6. Notification Messages
Notification messages transported over the NETCONF protocol will use Notification messages transported over the NETCONF protocol MUST be
the "notification" message defined within [RFC5277], section 4. encoded in a <notification> message as defined within [RFC5277],
Section 4. And per [RFC5277]'s "eventTime" object definition, the
"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
NETCONF transport session used by the "establish-subscription" RPC. NETCONF transport session used by the "establish-subscription" RPC.
7. Dynamic Subscriptions and RPC Error Responses 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 identityname to Appendix A.1, for datastore subscriptions. The specific identity
use depends on the RPC for which the error occurred. Viable to use depends on the RPC for which the error occurred. Viable
errors for 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
skipping to change at page 5, line 32 skipping to change at page 5, line 40
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 as a result of a "delete-subscription", a In case of an rpc error resulting from a "delete-subscription",
"kill-subscription", or a "resynch-subscription" request, no "kill-subscription", or "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.
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
skipping to change at page 6, line 7 skipping to change at page 6, line 15
subscriptions on that NETCONF session. subscriptions on that NETCONF session.
9. Acknowledgments 9. 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.
10. Normative References 10. Notes to the RFC Editor
This section can be removed by the RFC editor after the requests have
been performed.
RFC 6241 need to be updated. RFC-6241 refers to RFC-5277 which says
that a notification message can only be sent after a successful
"create-subscription". This text must be modified to also allow
notification messages be sent after a successful "establish-
subscription".
11. 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", draft-ietf-netconf-subscribed-
notifications-15 (work in progress), August 2018. notifications-17 (work in progress), September 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", June 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,
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>.
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event
Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008,
skipping to change at page 6, line 40 skipping to change at page 7, line 14
[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>.
[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>.
11.2. Informative References
[RFC8347] Liu, X., Ed., Kyparlis, A., Parikh, R., Lindem, A., and M.
Zhang, "A YANG Data Model for the Virtual Router
Redundancy Protocol (VRRP)", RFC 8347,
DOI 10.17487/RFC8347, March 2018,
<https://www.rfc-editor.org/info/rfc8347>.
[XPATH] Clark, J. and S. DeRose, "XML Path Language (XPath)
Version 1.0", November 1999,
<http://www.w3.org/TR/1999/REC-xpath-19991116>.
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 7, line 31 skipping to change at page 8, line 16
streams available, as well as additional information which might streams available, as well as additional information which might
exist in the container. exist in the container.
A.2. Dynamic Subscriptions A.2. Dynamic Subscriptions
A.2.1. Establishing Dynamic Subscriptions A.2.1. Establishing Dynamic Subscriptions
The following figure shows two successful "establish-subscription" The following figure shows two successful "establish-subscription"
RPC requests as per RPC requests as per
[I-D.draft-ietf-netconf-subscribed-notifications]. The first request [I-D.draft-ietf-netconf-subscribed-notifications]. The first request
is given a subscription identifier of 22, the second, an identifier is given a subscription "id" of 22, the second, an "id" of 23.
of 23.
+------------+ +-----------+ +------------+ +-----------+
| Subscriber | | Publisher | | Subscriber | | Publisher |
+------------+ +-----------+ +------------+ +-----------+
| | | |
| Capability Exchange | | Capability Exchange |
|<---------------------------->| |<---------------------------->|
| | | |
| | | |
| establish-subscription | | establish-subscription |
skipping to change at page 9, line 6 skipping to change at page 9, line 19
<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>
<dscp>10</dscp> <dscp>10</dscp>
</establish-subscription> </establish-subscription>
</rpc> </rpc>
Figure 3: establish-subscription request (a) Figure 3: establish-subscription request (a)
As NETCONF publisher was able to fully satisfy the request (a), the As NETCONF publisher was able to fully satisfy the request (a), the
publisher sends the subscription identifier of the accepted publisher sends the subscription "id" of the accepted subscription
subscription within message (b): within message (b):
<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">
<identifier <id
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
22 22
</identifier> </id>
</rpc-reply> </rpc-reply>
Figure 4: establish-subscription success (b) Figure 4: establish-subscription success (b)
If the NETCONF publisher had not been able to fully satisfy the If the NETCONF publisher had not been able to fully satisfy the
request, or subscriber has no authorization to establish the request, or subscriber has no authorization to establish the
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:
skipping to change at page 10, line 39 skipping to change at page 11, line 10
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">
<identifier>23</identifier> <id>23</id>
<yp:datastore-xpath-filter xmlns="http://example.com/datastore"> <yp:datastore-xpath-filter xmlns="http://example.com/datastore">
/interfaces-state/interface/oper-status /interfaces-state/interface/oper-status
</yp:datastore-xpath-filter> </yp:datastore-xpath-filter>
<yp:periodic> <yp:periodic>
<yp:period>500</yp:period> <yp:period>500</yp:period>
</yp:periodic> </yp:periodic>
</modify-subscription> </modify-subscription>
</rpc> </rpc>
Figure 7: Subscription modification request (c) Figure 7: Subscription modification request (c)
skipping to change at page 11, line 40 skipping to change at page 12, line 14
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">
<identifier>22</identifier> <id>22</id>
</delete-subscription> </delete-subscription>
</rpc> </rpc>
Figure 9: Delete subscription Figure 9: Delete subscription
If the NETCONF publisher can satisfy the request, the publisher If the NETCONF publisher can satisfy the request, the publisher
replies with success to the RPC request. replies with success to the RPC request.
If the NETCONF publisher cannot satisfy the request, the publisher If the NETCONF publisher cannot satisfy the request, the publisher
sends an error-rpc element indicating the modification didn't work. sends an error-rpc element indicating the modification didn't work.
Figure 10 shows a valid response for existing valid subscription Figure 10 shows a valid response for existing valid subscription
identifier, but that subscription identifier was created on a "id", but that subscription "id" was created on a different NETCONF
different NETCONF transport session: 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>
ietf-subscribed-notifications:no-such-subscription ietf-subscribed-notifications:no-such-subscription
</error-app-tag> </error-app-tag>
skipping to change at page 12, line 39 skipping to change at page 13, line 17
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 if 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">
<identifier>39</identifier> <id>39</id>
<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-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>
skipping to change at page 13, line 14 skipping to change at page 13, line 40
A.3.2. subscription-resumed, and replay-complete A.3.2. subscription-resumed, and replay-complete
A "subscription-resumed" would look like: A "subscription-resumed" would look like:
<notification <notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> 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-resumed <subscription-resumed
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<identifier>39</identifier> <id>39</id>
</subscription-resumed> </subscription-resumed>
</notification> </notification>
Figure 12: subscription-resumed notification in XML Figure 12: subscription-resumed notification in XML
The "replay-complete" is virtually identical, with "subscription- The "replay-complete" is virtually identical, with "subscription-
resumed" simply being replaced by "replay-complete". resumed" simply being replaced by "replay-complete".
A.3.3. subscription-terminated and subscription-suspended A.3.3. subscription-terminated and subscription-suspended
A "subscription-terminated" would look like: A "subscription-terminated" would look like:
<notification <notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> 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-terminated <subscription-terminated
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"> xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<identifier>39</identifier> <id>39</id>
<error-id> <reason>
suspension-timeout suspension-timeout
</error-id> </reason>
</subscription-terminated> </subscription-terminated>
</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
This section provides examples which illustrate both xpath and
subtree methods of filtering event record contents. The examples are
based on the YANG notification "vrrp-protocol-error-event" as defined
per the ietf-vrrp.yang model within [RFC8347]. Event records based
on this specification which are generated by the publisher might
appear as:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-09-14T08:22:33.44Z</eventTime>
<vrrp-protocol-error-event
xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp">
<protocol-error-reason>checksum-error</protocol-error-reason>
</vrrp-protocol-error-event>
</notification>
Figure 14: RFC 8347 (VRRP) - Example Notification
Suppose a subscriber wanted to establish a subscription which only
passes instances of event records where there is a "checksum-error"
as part of a VRRP protocol event. Also assume the publisher places
such event records into the NETCONF stream. To get a continuous
series of matching event records, the subscriber might request the
application of an XPath filter against the NETCONF stream. An
"establish-subscription" RPC to meet this objective might be:
<rpc message-id="601" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<stream>NETCONF</stream>
<stream-xpath-filter xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp">
/vrrp-protocol-error-event[protocol-error-reason="checksum-error"]
</stream-xpath-filter>
</establish-subscription>
</rpc>
Figure 15: Establishing a subscription error reason via XPATH
For more examples of xpath filters, see [XPATH].
Suppose the "establish-subscription" in Figure 15 was accepted. And
suppose later a subscriber decided they wanted to broaden this
subscription cover to all VRRP protocol events (i.e., not just those
with a "checksum error"). The subscriber might attempt to modify the
subscription in a way which replaces the XPath filter with a subtree
filter which sends all VRRP protocol events to a subscriber. Such a
"modify-subscription" RPC might look like:
<rpc message-id="602" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<modify-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<id>99</id>
<stream-subtree-filter>
<vrrp-protocol-error-event
xmlns="urn:ietf:params:xml:ns:yang:ietf-vrrp"/>
</stream-subtree-filter>
</modify-subscription>
</rpc>
Figure 16
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. v10 to v11 B.1. v11 to v12
o Subscription identifier renamed to id.
o Appendix A.4 for filter examples
B.2. v10 to v11
o Configured removed. o Configured removed.
B.2. v09 to v10 B.3. 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.3. v08 to v09 B.4. 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.4. v07 to v08 B.5. v07 to v08
o Tweaks and clarification on :interleave. o Tweaks and clarification on :interleave.
B.5. v06 to v07 B.6. 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.6. v05 to v06 B.7. 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.7. v03 to v04 B.8. 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.8. v01 to v03 B.9. v01 to v03
o Text simplifications throughout o Text simplifications throughout
o v02 had no meaningful changes o v02 had no meaningful changes
B.9. v00 to v01 B.10. 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. 36 change blocks. 
56 lines changed or deleted 157 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/