draft-ietf-netconf-netconf-event-notifications-15.txt   draft-ietf-netconf-netconf-event-notifications-16.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: June 21, 2019 Huawei Expires: July 12, 2019 Huawei
A. Gonzalez Prieto A. Gonzalez Prieto
Microsoft Microsoft
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
December 18, 2018 January 8, 2019
Dynamic subscription to YANG Events and Datastores over NETCONF Dynamic subscription to YANG Events and Datastores over NETCONF
draft-ietf-netconf-netconf-event-notifications-15 draft-ietf-netconf-netconf-event-notifications-16
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 June 21, 2019. This Internet-Draft will expire on July 12, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
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 . . . . . . 4
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 . . . . . . . . . . . . . . . . . . . 6
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 6
10. Notes to the RFC Editor . . . . . . . . . . . . . . . . . . . 6 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 11. Notes to the RFC Editor . . . . . . . . . . . . . . . . . . . 6
11.1. Normative References . . . . . . . . . . . . . . . . . . 6 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 7
11.2. Informative References . . . . . . . . . . . . . . . . . 7 12.1. Normative References . . . . . . . . . . . . . . . . . . 7
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 7 12.2. Informative References . . . . . . . . . . . . . . . . . 7
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 7 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 8
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 8
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 8 A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 8
A.3. Subscription State Notifications . . . . . . . . . . . . 12 A.3. Subscription State Notifications . . . . . . . . . . . . 13
A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 14 A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 14
Appendix B. Changes between revisions . . . . . . . . . . . . . 15 Appendix B. Changes between revisions . . . . . . . . . . . . . 16
B.1. v14 to v15 . . . . . . . . . . . . . . . . . . . . . . . 15 B.1. v15 to v16 . . . . . . . . . . . . . . . . . . . . . . . 16
B.2. v13 to v14 . . . . . . . . . . . . . . . . . . . . . . . 16 B.2. v14 to v15 . . . . . . . . . . . . . . . . . . . . . . . 16
B.3. v11 to v13 . . . . . . . . . . . . . . . . . . . . . . . 16 B.3. v13 to v14 . . . . . . . . . . . . . . . . . . . . . . . 16
B.4. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 16 B.4. v11 to v13 . . . . . . . . . . . . . . . . . . . . . . . 16
B.5. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 16 B.5. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 16
B.6. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 16 B.6. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 17
B.7. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 16 B.7. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 17
B.8. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 16 B.8. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 17
B.9. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 16 B.9. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 17
B.10. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 17 B.10. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 17
B.11. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 17 B.11. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 17
B.12. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 17 B.12. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 17
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17 B.13. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18
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
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
skipping to change at page 6, line 5 skipping to change at page 6, line 14
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.
9. Acknowledgments 9. IANA Considerations
This document has no actions for IANA.
10. 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. Qin Wu, and Guangying Zheng.
10. Notes to the RFC Editor 11. Notes to the RFC Editor
This section can be removed by the RFC editor after the requests have This section can be removed by the RFC editor after the requests have
been performed. been performed.
RFC 6241 need to be updated. RFC-6241 refers to RFC-5277 which says RFC 6241 needs to be updated based on the needs of this draft.
that a notification message can only be sent after a successful RFC-6241 section 1.2 bullet "(2)" targets RFC-5277 (actually it
"create-subscription". This text must be modified to also allow identifies RFC 5717, but that was an error fixed after RFC
notification messages be sent after a successful "establish- publication). Anyway the current phrasing in RFC-5277 says that a
subscription". notification message can only be sent after a successful "create-
subscription". Therefore the reference text must be modified to also
allow notification messages be sent after a successful "establish-
subscription". Proposed text for bullet (2) of RFC-6241 would be:
11. References (2) The Messages layer provides a simple, transport-independent
framing mechanism for encoding RPCs and notifications.
Section 4 documents the RPC messages, [RFC5277] documents
Notifications sent as a result of a <create-subscription> RPC,
and [RFC xxxx] documents Notifications sent as a result of
an <establish-subscription> RPC.
11.1. Normative References (where xxxx is replaced with this RFC number)
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", September 2018, Publisher's Event Streams", September 2018,
<https://datatracker.ietf.org/doc/ <https://datatracker.ietf.org/doc/
draft-ietf-netconf-subscribed-notifications/>. 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.,
skipping to change at page 7, line 14 skipping to change at page 7, line 41
[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 12.2. Informative References
[RFC8347] Liu, X., Ed., Kyparlis, A., Parikh, R., Lindem, A., and M. [RFC8347] Liu, X., Ed., Kyparlis, A., Parikh, R., Lindem, A., and M.
Zhang, "A YANG Data Model for the Virtual Router Zhang, "A YANG Data Model for the Virtual Router
Redundancy Protocol (VRRP)", RFC 8347, Redundancy Protocol (VRRP)", RFC 8347,
DOI 10.17487/RFC8347, March 2018, DOI 10.17487/RFC8347, March 2018,
<https://www.rfc-editor.org/info/rfc8347>. <https://www.rfc-editor.org/info/rfc8347>.
[XPATH] Clark, J. and S. DeRose, "XML Path Language (XPath) [XPATH] Clark, J. and S. DeRose, "XML Path Language (XPath)
Version 1.0", November 1999, Version 1.0", November 1999,
<http://www.w3.org/TR/1999/REC-xpath-19991116>. <http://www.w3.org/TR/1999/REC-xpath-19991116>.
skipping to change at page 15, line 47 skipping to change at page 16, line 24
</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. v14 to v15 B.1. v15 to v16
o During the shepherd review, two clarifications were requested
which do not impact the technical details of this document. These
clarifications were: (a) further describing that dynamic
subscriptions can have state change notifications, and (b) more
details about the recommended text refinement desired for RFC6241.
B.2. v14 to v15
o Per Kent's request, added name attribute to artwork. This would o Per Kent's request, added name attribute to artwork. This would
be needed for an automated extraction. be needed for an automated extraction.
B.2. v13 to v14 B.3. v13 to v14
o Title change. o Title change.
B.3. v11 to v13 B.4. 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.4. v10 to v11 B.5. v10 to v11
o Configured removed. o Configured removed.
B.5. v09 to v10 B.6. 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.6. v08 to v09 B.7. 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.7. v07 to v08 B.8. v07 to v08
o Tweaks and clarification on :interleave. o Tweaks and clarification on :interleave.
B.8. v06 to v07 B.9. 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.9. v05 to v06 B.10. 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.10. v03 to v04 B.11. 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.11. v01 to v03 B.12. v01 to v03
o Text simplifications throughout o Text simplifications throughout
o v02 had no meaningful changes o v02 had no meaningful changes
B.12. v00 to v01 B.13. 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. 30 change blocks. 
54 lines changed or deleted 79 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/