< draft-ietf-netconf-netconf-event-notifications-20.txt   draft-ietf-netconf-netconf-event-notifications-21.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 9, 2019 Huawei Expires: November 16, 2019 Huawei
A. Gonzalez Prieto A. Gonzalez Prieto
Microsoft Microsoft
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
May 8, 2019 May 15, 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-20 draft-ietf-netconf-netconf-event-notifications-21
Abstract Abstract
This document provides a Network Configuration Protocol (NETCONF) This document provides a Network Configuration Protocol (NETCONF)
binding to the dynamic subscription capability of both subscribed binding to the dynamic subscription capability of both subscribed
notifications and YANG-Push. notifications and YANG-Push.
RFC Editor note: please replace the references to pre-RFC normative RFC Editor note: please replace the references to pre-RFC normative
drafts with the actual assigned RFC numbers. drafts with the actual assigned RFC numbers.
skipping to change at page 1, line 41 skipping to change at page 1, line 41
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 9, 2019. This Internet-Draft will expire on November 16, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 33 skipping to change at page 2, line 33
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 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 . . . . . . 4 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 . . . . . . . . 5 7. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 5
8. Security Considerations . . . . . . . . . . . . . . . . . . . 6 8. Security Considerations . . . . . . . . . . . . . . . . . . . 7
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 7 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 7
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 7
11.1. Normative References . . . . . . . . . . . . . . . . . . 7 11.1. Normative References . . . . . . . . . . . . . . . . . . 7
11.2. Informative References . . . . . . . . . . . . . . . . . 8 11.2. Informative References . . . . . . . . . . . . . . . . . 8
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 8 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 8
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 8 A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 8
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 9 A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 9
A.3. Subscription State Notifications . . . . . . . . . . . . 13 A.3. Subscription State Notifications . . . . . . . . . . . . 14
A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 15 A.4. Filter Examples . . . . . . . . . . . . . . . . . . . . . 15
Appendix B. Changes between revisions . . . . . . . . . . . . . 16 Appendix B. Changes between revisions . . . . . . . . . . . . . 17
B.1. v19 to v20 . . . . . . . . . . . . . . . . . . . . . . . 16 B.1. v20 to v21 . . . . . . . . . . . . . . . . . . . . . . . 17
B.2. v17 to v19 . . . . . . . . . . . . . . . . . . . . . . . 17 B.2. v19 to v20 . . . . . . . . . . . . . . . . . . . . . . . 17
B.3. v16 to v17 . . . . . . . . . . . . . . . . . . . . . . . 17 B.3. v17 to v19 . . . . . . . . . . . . . . . . . . . . . . . 17
B.4. v15 to v16 . . . . . . . . . . . . . . . . . . . . . . . 17 B.4. v16 to v17 . . . . . . . . . . . . . . . . . . . . . . . 17
B.5. v14 to v15 . . . . . . . . . . . . . . . . . . . . . . . 17 B.5. v15 to v16 . . . . . . . . . . . . . . . . . . . . . . . 17
B.6. v13 to v14 . . . . . . . . . . . . . . . . . . . . . . . 17 B.6. v14 to v15 . . . . . . . . . . . . . . . . . . . . . . . 18
B.7. v11 to v13 . . . . . . . . . . . . . . . . . . . . . . . 17 B.7. v13 to v14 . . . . . . . . . . . . . . . . . . . . . . . 18
B.8. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 17 B.8. v11 to v13 . . . . . . . . . . . . . . . . . . . . . . . 18
B.9. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 17 B.9. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 18
B.10. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 18 B.10. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 18
B.11. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 18 B.11. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 18
B.12. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 18 B.12. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 18
B.13. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 18 B.13. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 18
B.14. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 18 B.14. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 18
B.15. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 18 B.15. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 19
B.16. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 18 B.16. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 19
B.17. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 19
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 19 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 19
1. Introduction 1. Introduction
This document provides a binding for events streamed over the NETCONF This document specifies the binding of a stream of events which form
protocol [RFC6241] for dynamic subscriptions as defined in part of a dynamic subscription to the NETCONF protocol [RFC6241].
Dynamic subscriptions are defined in
[I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as [I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as
[I-D.draft-ietf-netconf-yang-push] is itself built upon [I-D.draft-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.
This document assumes that the reader is familiar with the
terminology and concepts defined in
[I-D.draft-ietf-netconf-subscribed-notifications].
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]: dynamic [I-D.draft-ietf-netconf-subscribed-notifications]: dynamic
skipping to change at page 5, line 15 skipping to change at page 5, line 18
7. Dynamic Subscriptions and RPC Error Responses 7. Dynamic Subscriptions and RPC Error Responses
When an RPC error occurs as defined in When an RPC error occurs as defined in
[I-D.draft-ietf-netconf-subscribed-notifications] Section 2.4.6 and [I-D.draft-ietf-netconf-subscribed-notifications] Section 2.4.6 and
[I-D.draft-ietf-netconf-yang-push] Appendix A, the NETCONF RPC reply [I-D.draft-ietf-netconf-yang-push] Appendix A, the NETCONF RPC reply
MUST include an "rpc-error" element per [RFC6241] with the error MUST include an "rpc-error" element per [RFC6241] with the error
information populated as follows: information populated as follows:
o An "error-type" node of "application". o An "error-type" node of "application".
o An "error-tag" node with the value being a string that corresponds o An "error-tag" node with the value being a string that corresponds
to an identity associated with the error. This "error-tag" will to an identity associated with the error. For the mechanisms
come from one of two places. Either it will correspond to the specified in this document, this "error-tag" will come from one of
error identities within two places. Either it will correspond to the error identities
[I-D.draft-ietf-netconf-subscribed-notifications] section 2.4.6 within [I-D.draft-ietf-netconf-subscribed-notifications] section
for general subscription errors: 2.4.6 for general subscription errors:
error identity uses error-tag error identity uses error-tag
---------------------- -------------- ---------------------- --------------
dscp-unavailable invalid-value dscp-unavailable invalid-value
encoding-unsupported invalid-value encoding-unsupported invalid-value
filter-unsupported invalid-value filter-unsupported invalid-value
insufficient-resources resource-denied insufficient-resources resource-denied
no-such-subscription invalid-value no-such-subscription invalid-value
replay-unsupported operation-not-supported replay-unsupported operation-not-supported
skipping to change at page 6, line 9 skipping to change at page 6, line 12
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.draft-ietf-netconf-yang-push] for general subscriptions, and [I-D.draft-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. Each to use depends on the RPC for which the error occurred. Each
error identity will be inserted as the "error-app-tag" following error identity will be inserted as the "error-app-tag" following
the form <modulename>:<identityname>. An example of such as valid the form <modulename>:<identityname>. An example of such as valid
encoding would be "ietf-subscribed-notifications:no-such- encoding would be "ietf-subscribed-notifications:no-such-
subscription". Viable errors for different RPCs are as follows: subscription". Viable errors for different RPCs are as follows:
RPC use base identity RPC have 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 delete-subscription-error kill-subscription delete-subscription-error
resync-subscription resync-subscription-error resync-subscription resync-subscription-error
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
skipping to change at page 6, line 36 skipping to change at page 6, line 39
---------------------- ------------------------------------ ---------------------- ------------------------------------
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 "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 "resync-subscription" request, no "error- "kill-subscription", or "resync-subscription" request, no "error-
info" needs to be included, as the "subscription-id" is the only RPC info" needs to be included, as the "subscription-id" is the only RPC
input parameter and no hints regarding this RPC input parameters need input parameter and no hints regarding this RPC input 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 This document does not introduce additional Security Considerations
establish-subscription requests, then these subscriptions accumulate for dynamic subscriptions beyond those discussed in
and may use up system resources. In such a situation, subscriptions [I-D.draft-ietf-netconf-subscribed-notifications]. But there is one
MAY be terminated by terminating the underlying NETCONF session. The consideration worthy of more refinement based on the connection
oriented nature of the NETCONF protocol. Specifically, if a buggy or
compromised NETCONF subscriber sends a number of "establish-
subscription" requests, then these subscriptions accumulate and may
use up system resources. In such a situation, subscriptions 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 in order to reclaim resources
and preserve normal operation for the other subscriptions.
9. IANA Considerations 9. IANA Considerations
This document has no actions for IANA. This document has no actions for IANA.
10. Acknowledgments 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,
skipping to change at page 8, line 23 skipping to change at page 8, line 37
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>.
Appendix A. Examples Appendix A. Examples
This section is non-normative. This section is non-normative. Additionally the subscription "id"
values of 22, 23, and 39 used below are just examples. In
production, the actual values of "id" may not be small integers.
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
against the top-level container "/streams" defined in against the top-level container "/streams" defined in
[I-D.draft-ietf-netconf-subscribed-notifications] Section 3.1. [I-D.draft-ietf-netconf-subscribed-notifications] Section 3.1.
skipping to change at page 16, line 47 skipping to change at page 17, 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. v19 to v20 B.1. v20 to v21
o Including Tom Petch's text to resolve the meaning of 'binding'.
o A few small wording tweaks.
B.2. v19 to v20
o Notes to RFC editor removed, consideration moved under Figure 10 o Notes to RFC editor removed, consideration moved under Figure 10
in SN. in SN.
B.2. v17 to v19 B.3. v17 to v19
o Per Benjamin Kaduk's discuss on SN, adjusted IPR to o Per Benjamin Kaduk's discuss on SN, adjusted IPR to
pre5378Trust200902 pre5378Trust200902
B.3. v16 to v17 B.4. v16 to v17
o During the SN YANG Doctor review, a suggestion was made to update o During the SN YANG Doctor review, a suggestion was made to update
the error-tags to make the mechanism work with embedded NETCONF the error-tags to make the mechanism work with embedded NETCONF
and RESTCONF error reporting. and RESTCONF error reporting.
o Minor text tweaks from review. o Minor text tweaks from review.
B.4. v15 to v16 B.5. v15 to v16
o During the shepherd review, two clarifications were requested o During the shepherd review, two clarifications were requested
which do not impact the technical details of this document. These which do not impact the technical details of this document. These
clarifications were: (a) further describing that dynamic clarifications were: (a) further describing that dynamic
subscriptions can have state change notifications, and (b) more subscriptions can have state change notifications, and (b) more
details about the recommended text refinement desired for RFC6241. details about the recommended text refinement desired for RFC6241.
B.5. v14 to v15 B.6. 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.6. v13 to v14 B.7. v13 to v14
o Title change. o Title change.
B.7. v11 to v13 B.8. 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.8. v10 to v11 B.9. v10 to v11
o Configured removed. o Configured removed.
B.9. v09 to v10 B.10. 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.10. v08 to v09 B.11. 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.11. v07 to v08 B.12. v07 to v08
o Tweaks and clarification on :interleave. o Tweaks and clarification on :interleave.
B.12. v06 to v07 B.13. 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.13. v05 to v06 B.14. 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.14. v03 to v04 B.15. 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.15. v01 to v03 B.16. v01 to v03
o Text simplifications throughout o Text simplifications throughout
o v02 had no meaningful changes o v02 had no meaningful changes
B.16. v00 to v01 B.17. 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. 31 change blocks. 
54 lines changed or deleted 73 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/