draft-ietf-netconf-netconf-event-notifications-07.txt   draft-ietf-netconf-netconf-event-notifications-08.txt 
NETCONF A. Gonzalez Prieto NETCONF A. Gonzalez Prieto
Internet-Draft VMware Internet-Draft VMware
Intended status: Standards Track E. Voit Intended status: Standards Track E. Voit
Expires: August 12, 2018 Cisco Systems Expires: August 26, 2018 Cisco Systems
A. Clemm A. Clemm
Huawei Huawei
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
February 8, 2018 February 22, 2018
NETCONF Support for Event Notifications NETCONF Support for Event Notifications
draft-ietf-netconf-netconf-event-notifications-07 draft-ietf-netconf-netconf-event-notifications-08
Abstract Abstract
This document provides a NETCONF binding for This document provides a NETCONF binding to subscribed notifications
[I-D.draft-ietf-netconf-subscribed-notifications] and and to YANG push.
[I-D.ietf-netconf-yang-push]. Included are:
o transport mappings for subscription RPCs, state change RFC Editor note: please replace the four references to pre-RFC
notifications, and notification messages, normative drafts with the actual assigned RFC numbers.
o functional requirements, and
o examples
Status of This Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
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 August 12, 2018. This Internet-Draft will expire on August 26, 2018.
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 20 skipping to change at page 2, line 16
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Interleave Capability . . . . . . . . . . . . . . . . . . . . 3 3. Interleave Capability . . . . . . . . . . . . . . . . . . . . 3
4. Mandatory XML, stream and datastore support . . . . . . . . . 3 4. Compatibility with RFC-5277's create-subscription . . . . . . 3
5. Transport connectivity . . . . . . . . . . . . . . . . . . . 3 5. Mandatory XML, stream and datastore support . . . . . . . . . 3
5.1. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 3 6. Transport connectivity . . . . . . . . . . . . . . . . . . . 4
5.2. Configured Subscriptions . . . . . . . . . . . . . . . . 4 6.1. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 4
6. Notification Messages . . . . . . . . . . . . . . . . . . . . 4 6.2. Configured Subscriptions . . . . . . . . . . . . . . . . 4
7. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 4 7. Notification Messages . . . . . . . . . . . . . . . . . . . . 5
8. Security Considerations . . . . . . . . . . . . . . . . . . . 5 8. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 5
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6 9. Security Considerations . . . . . . . . . . . . . . . . . . . 6
10. Normative References . . . . . . . . . . . . . . . . . . . . 6 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6
11. Normative References . . . . . . . . . . . . . . . . . . . . 6
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 7 Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 7
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 7 A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 7
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 7 A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 8
A.3. Configured Subscriptions . . . . . . . . . . . . . . . . 14 A.3. Configured Subscriptions . . . . . . . . . . . . . . . . 15
A.4. Subscription State Notifications . . . . . . . . . . . . 19 A.4. Subscription State Notifications . . . . . . . . . . . . 20
Appendix B. Changes between revisions . . . . . . . . . . . . . 21 Appendix B. Changes between revisions . . . . . . . . . . . . . 22
B.1. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 21 B.1. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 22
B.2. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 21 B.2. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 22
B.3. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 21 B.3. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 22
B.4. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 22 B.4. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 22
B.5. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 22 B.5. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 23
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 22 B.6. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 23
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23
1. Introduction 1. Introduction
This document defines a binding for events streamed over the NETCONF This document provides a binding for events streamed over the NETCONF
protocol [RFC6241] as per protocol [RFC6241] as per
[I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as [I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as
[I-D.ietf-netconf-yang-push] is itself built upon [I-D.ietf-netconf-yang-push] is itself built upon
[I-D.draft-ietf-netconf-subscribed-notifications], this document [I-D.draft-ietf-netconf-subscribed-notifications], this document
enables a NETCONF client to request and receive updates from a YANG enables a NETCONF client to request and receive updates from a YANG
datastore located on a NETCONF server. datastore located on a NETCONF server.
2. Terminology 2. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
skipping to change at page 3, line 22 skipping to change at page 3, line 22
[I-D.draft-ietf-netconf-subscribed-notifications]: notification [I-D.draft-ietf-netconf-subscribed-notifications]: notification
message, stream, publisher, receiver, subscriber, subscription, message, stream, publisher, receiver, subscriber, subscription,
configured subscription. configured subscription.
3. Interleave Capability 3. Interleave Capability
To support multiple subscriptions on a single session, a NETCONF To support multiple subscriptions on a single session, a NETCONF
publisher MUST support the :interleave capability as defined in publisher MUST support the :interleave capability as defined in
[RFC5277]. Such support MUST be indicated by the following [RFC5277]. Such support MUST be indicated by the following
capability: "urn:ietf:params:netconf:capability:interleave:1.0". capability: "urn:ietf:params:netconf:capability:interleave:1.0".
Advertisement of this capability along with support Advertisement of both the :interleave capability and
[I-D.draft-ietf-netconf-subscribed-notifications] will indicate that "urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications" within a
a NETCONF publisher is able to receive, process, and respond to NETCONF capability exchange MUST indicate that a NETCONF publisher is
NETCONF requests and able to receive, process, and respond to NETCONF requests and
[I-D.draft-ietf-netconf-subscribed-notifications] subscription [I-D.draft-ietf-netconf-subscribed-notifications] subscription
operations on a session with active subscriptions. operations.
4. Mandatory XML, stream and datastore support 4. Compatibility with RFC-5277's create-subscription
A publisher is allowed to concurrently support both
[I-D.draft-ietf-netconf-subscribed-notifications] and [RFC5277]'s
"create-subscription" RPC, however this support MUST NOT happen on a
single transport NETCONF session. To accomplish this:
o A solution must reply with the [RFC6241] error "operation-not-
supported" if a "create-subscription" RPC is received on a NETCONF
session where at least one subscription is currently active.
o It is a prohibited to send updates or state change notifications
for a configured subscription on a NETCONF session where the
create-subscription RPC has successfully created a subscription.
o A "create-subscription" RPC MUST be rejected if a subscription is
already active across that NETCONF transport session.
5. Mandatory XML, stream and datastore support
A NETCONF publisher MUST support XML encoding of RPCs and A NETCONF publisher MUST support XML encoding of RPCs and
Notifications. Notifications.
A NETCONF publisher supporting A NETCONF publisher supporting
[I-D.draft-ietf-netconf-subscribed-notifications] MUST support the [I-D.draft-ietf-netconf-subscribed-notifications] MUST support the
"NETCONF" event stream identified in that draft. "NETCONF" event stream identified in that draft.
A NETCONF publisher supporting [I-D.ietf-netconf-yang-push] MUST A NETCONF publisher supporting [I-D.ietf-netconf-yang-push] MUST
support the operational state datastore as defined by support the operational state datastore as defined by
[I.D.draft-ietf-netmod-revised-datastores]. [I.D.draft-ietf-netmod-revised-datastores].
5. Transport connectivity 6. Transport connectivity
5.1. Dynamic Subscriptions 6.1. Dynamic Subscriptions
For dynamic subscriptions, if the NETCONF session involved with the For dynamic subscriptions, if the NETCONF session involved with the
"establish-subscription" terminates, the subscription MUST be "establish-subscription" terminates, the subscription MUST be
deleted. deleted.
5.2. Configured Subscriptions 6.2. Configured Subscriptions
For a configured subscription, there is no guarantee a transport For a configured subscription, there is no guarantee a transport
session is currently in place with each associated receiver. In session is currently in place with each associated receiver. In
cases where a configured subscription has a receiver in the cases where a configured subscription has a receiver in the
connecting state and the protocol configured as NETCONF, but no connecting state and the protocol configured as NETCONF, but no
NETCONF transport session exists to that receiver, the publisher MUST NETCONF transport session exists to that receiver, the publisher MUST
initiate a transport session via NETCONF call home [RFC8071], section initiate a transport session via NETCONF call home [RFC8071], section
4.1 to that receiver. Until NETCONF connectivity is established and 4.1 to that receiver. Until NETCONF connectivity is established and
a subscription-started state change notification is successfully a subscription-started state change notification is successfully
sent, that receiver MUST remain in a status of either "connecting" or sent, that receiver MUST remain in a status of either "connecting" or
skipping to change at page 4, line 37 skipping to change at page 5, line 5
home attempts or NETCONF sessions remotely terminated by the home attempts or NETCONF sessions remotely terminated by the
receiver. receiver.
NETCONF Transport session connectivity SHOULD be verified via NETCONF Transport session connectivity SHOULD be verified via
Section 4.1, step S7. Section 4.1, step S7.
If an active NETCONF session is disconnected but the stop-time of a If an active NETCONF session is disconnected but the stop-time of a
subscription has not been reached, the publisher MUST restart the subscription has not been reached, the publisher MUST restart the
call home process and return the receiver to the "connecting" state. call home process and return the receiver to the "connecting" state.
6. Notification Messages 7. Notification Messages
Notification messages transported over NETCONF will be identical in Notification messages transported over NETCONF will be identical in
format and content to those encoded using one-way operations defined format and content to those encoded using one-way operations defined
within [RFC5277], section 4. within [RFC5277], section 4.
7. Dynamic Subscriptions and RPC Error Responses 8. 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 "error-type" of "application". o "error-type" of "application".
o "error-tag" of "operation-failed". o "error-tag" of "operation-failed".
o Optionally, an "error-severity" of "error" (this MAY but does not o Optionally, an "error-severity" of "error" (this MAY but does not
have to be included). have to be included).
o "error-app-tag" with the value being a string that corresponds to o "error-app-tag" with the value being a string that corresponds to
an identity associated with the error, as defined in an identity associated with the error, as defined in
[I-D.draft-ietf-netconf-subscribed-notifications] section 2.4.6 [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 (YANG-Push) subscriptions. The tag to Appendix A.1, for datastore (YANG-Push) subscriptions. The tag to
use depends on the RPC for which the error occurred. Applicable use depends on the RPC for which the error occurred. Applicable
are identities with a base identity of "establish-subscription- are identities with a base identity of "establish-subscription-
error" (for error responses to an establish-subscription request), error" (for error responses to an establish-subscription request),
skipping to change at page 5, line 46 skipping to change at page 6, line 13
kill-subscription, or a resynch-subscription request, no error- kill-subscription, or a resynch-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 RPC input parameters need input parameter and no hints regarding RPC input parameters need
to be provided. to be provided.
Note that "error-path" does not need to be included with the "rpc- Note that "error-path" does not need to be included with the "rpc-
error" element, as subscription errors are generally not associated error" element, as subscription errors are generally not associated
with nodes in the datastore but with the choice of RPC input with nodes in the datastore but with the choice of RPC input
parameters. parameters.
8. Security Considerations 9. Security Considerations
Notification messages (including state change notifications) are Notification messages (including state change notifications) are
never sent before the NETCONF capabilities exchange has completed. never sent before the NETCONF capabilities exchange has completed.
If a malicious or buggy NETCONF subscriber sends a number of If a malicious or buggy NETCONF subscriber sends a number of
"establish-subscription" requests, then these subscriptions "establish-subscription" requests, then these subscriptions
accumulate and may use up system resources. In such a situation, accumulate and may use up system resources. In such a situation,
subscriptions MAY be terminated by terminating the underlying NETCONF subscriptions MAY be terminated by terminating the underlying NETCONF
session. The publisher MAY also suspend or terminate a subset of the session. The publisher MAY also suspend or terminate a subset of the
active subscriptions on that NETCONF session. active subscriptions on that NETCONF session.
The NETCONF Authorization Control Model [RFC6536] SHOULD be used to The NETCONF Authorization Control Model [rfc6536bis] SHOULD be used
control and restrict authorization of subscription configuration. to control and restrict authorization of subscription configuration.
9. 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,
Balazs Lengyel, Kent Watsen, and Guangying Zheng. Balazs Lengyel, Martin Bjorklund, Mahesh Jethanandani, Kent Watsen,
and Guangying Zheng.
10. Normative References 11. 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, "Custom Subscription to Event and E. Nilsen-Nygaard, "Custom Subscription to Event
Streams", draft-ietf-netconf-subscribed-notifications-10 Streams", draft-ietf-netconf-subscribed-notifications-10
(work in progress), January 2018. (work in progress), January 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.
skipping to change at page 7, line 10 skipping to change at page 7, line 25
[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,
<https://www.rfc-editor.org/info/rfc5277>. <https://www.rfc-editor.org/info/rfc5277>.
[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>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [rfc6536bis]
Protocol (NETCONF) Access Control Model", RFC 6536, Bierman, A. and M. Bjorklund, "Network Configuration
DOI 10.17487/RFC6536, March 2012, Access Control Module", December 2017,
<https://www.rfc-editor.org/info/rfc6536>. <https://datatracker.ietf.org/doc/
draft-ietf-netconf-rfc6536bis/>.
[RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home", [RFC8071] Watsen, K., "NETCONF Call Home and RESTCONF Call Home",
RFC 8071, DOI 10.17487/RFC8071, February 2017, RFC 8071, DOI 10.17487/RFC8071, February 2017,
<https://www.rfc-editor.org/info/rfc8071>. <https://www.rfc-editor.org/info/rfc8071>.
Appendix A. Examples Appendix A. Examples
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
skipping to change at page 21, line 27 skipping to change at page 22, line 27
Figure 19: subscription-terminated subscription state notification Figure 19: subscription-terminated subscription state notification
The "subscription-suspended" is virtually identical, with The "subscription-suspended" is virtually identical, with
"subscription-terminated" simply being replaced by "subscription- "subscription-terminated" simply being replaced by "subscription-
suspended". suspended".
Appendix B. Changes between revisions Appendix B. Changes between revisions
(To be removed by RFC editor prior to publication) (To be removed by RFC editor prior to publication)
B.1. v06 to v07 B.1. v07 to v08
o Tweaks and clarification on :interleave.
B.2. 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.2. v05 to v06 B.3. 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.3. v03 to v04 B.4. 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.4. v01 to v03 B.5. v01 to v03
o Text simplifications throughout o Text simplifications throughout
o v02 had no meaningful changes o v02 had no meaningful changes
B.5. v00 to v01 B.6. 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. 29 change blocks. 
58 lines changed or deleted 78 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/