draft-ietf-netconf-netconf-event-notifications-00.txt   draft-ietf-netconf-netconf-event-notifications-01.txt 
NETCONF A. Gonzalez Prieto NETCONF A. Gonzalez Prieto
Internet-Draft Cisco Systems Internet-Draft Cisco Systems
Intended status: Standards Track A. Clemm Intended status: Standards Track A. Clemm
Expires: March 4, 2017 Expires: May 4, 2017 Sympotech
E. Voit E. Voit
E. Nilsen-Nygaard E. Nilsen-Nygaard
A. Tripathy A. Tripathy
Cisco Systems Cisco Systems
S. Chisholm S. Chisholm
Ciena Ciena
H. Trevino H. Trevino
Cisco Systems Cisco Systems
August 31, 2016 October 31, 2016
NETCONF Support for Event Notifications NETCONF Support for Event Notifications
draft-ietf-netconf-netconf-event-notifications-00 draft-ietf-netconf-netconf-event-notifications-01
Abstract Abstract
This document defines the support of [event-notifications] by the This document defines the support of [event-notifications] by the
Network Configuration protocol (NETCONF). [event-notifications] Network Configuration protocol (NETCONF). [event-notifications]
describes capabilities and operations for providing asynchronous describes capabilities and operations for providing asynchronous
message notification delivery. This document discusses how to message notification delivery. This document discusses how to
provide them on top of NETCONF. The capabilities and operations provide them on top of NETCONF. The capabilities and operations
defined between this document and [event-notifications] are intended defined between this document and [event-notifications] are intended
to obsolete RFC 5277. to obsolete RFC 5277.
skipping to change at page 1, line 45 skipping to change at page 1, line 45
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 http://datatracker.ietf.org/drafts/current/. Drafts is at http://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 March 4, 2017. This Internet-Draft will expire on May 4, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2016 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
(http://trustee.ietf.org/license-info) in effect on the date of (http://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 26 skipping to change at page 2, line 26
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 . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 4
1.2. Solution Overview . . . . . . . . . . . . . . . . . . . . 5 1.2. Solution Overview . . . . . . . . . . . . . . . . . . . . 5
2. Solution . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2. Solution . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1. Event Streams . . . . . . . . . . . . . . . . . . . . . . 5 2.1. Event Streams . . . . . . . . . . . . . . . . . . . . . . 6
2.2. Event Stream Discovery . . . . . . . . . . . . . . . . . 6 2.2. Event Stream Discovery . . . . . . . . . . . . . . . . . 6
2.3. Default Event Stream . . . . . . . . . . . . . . . . . . 9 2.3. Default Event Stream . . . . . . . . . . . . . . . . . . 9
2.4. Creating a Subscription . . . . . . . . . . . . . . . . . 9 2.4. Creating a Subscription . . . . . . . . . . . . . . . . . 9
2.5. Establishing a Subscription . . . . . . . . . . . . . . . 11 2.5. Establishing a Subscription . . . . . . . . . . . . . . . 11
2.6. Modifying a Subscription . . . . . . . . . . . . . . . . 16 2.6. Modifying a Subscription . . . . . . . . . . . . . . . . 16
2.7. Deleting a Subscription . . . . . . . . . . . . . . . . . 21 2.7. Deleting a Subscription . . . . . . . . . . . . . . . . . 21
2.8. Configured Subscriptions . . . . . . . . . . . . . . . . 24 2.8. Configured Subscriptions . . . . . . . . . . . . . . . . 24
2.9. Event (Data Plane) Notifications . . . . . . . . . . . . 32 2.9. Event (Data Plane) Notifications . . . . . . . . . . . . 33
2.10. Control Plane Notifications . . . . . . . . . . . . . . . 34 2.10. Control Plane Notifications . . . . . . . . . . . . . . . 35
3. Backwards Compatibility . . . . . . . . . . . . . . . . . . . 44 3. Backwards Compatibility . . . . . . . . . . . . . . . . . . . 44
3.1. Capabilities . . . . . . . . . . . . . . . . . . . . . . 44 3.1. Capabilities . . . . . . . . . . . . . . . . . . . . . . 44
3.2. Stream Discovery . . . . . . . . . . . . . . . . . . . . 45 3.2. Stream Discovery . . . . . . . . . . . . . . . . . . . . 45
4. Security Considerations . . . . . . . . . . . . . . . . . . . 45 4. Security Considerations . . . . . . . . . . . . . . . . . . . 45
5. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 46 5. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 46
6. References . . . . . . . . . . . . . . . . . . . . . . . . . 46 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 46
6.1. Normative References . . . . . . . . . . . . . . . . . . 46 6.1. Normative References . . . . . . . . . . . . . . . . . . 46
6.2. Informative References . . . . . . . . . . . . . . . . . 47 6.2. Informative References . . . . . . . . . . . . . . . . . 47
Appendix A. Issues being worked and resolved . . . . . . . . . . 47 Appendix A. Issues that are currently being worked . . . . . . . 47
A.1. Unresolved Issues . . . . . . . . . . . . . . . . . . . . 47 Appendix B. Changes between revisions . . . . . . . . . . . . . 47
A.2. Agreement in principal . . . . . . . . . . . . . . . . . 47 B.1. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 47
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 48 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 47
1. Introduction 1. Introduction
[RFC6241] can be conceptually partitioned into four layers: [RFC6241] can be conceptually partitioned into four layers:
Layer Example Layer Example
+-------------+ +-------------------------------------------+ +-------------+ +-------------------------------------------+
| Content | | Configuration data | | Content | | Configuration data |
+-------------+ +-------------------------------------------+ +-------------+ +-------------------------------------------+
| | | |
skipping to change at page 3, line 37 skipping to change at page 3, line 37
Figure 1: NETCONF layer architecture Figure 1: NETCONF layer architecture
This document defines mechanisms that provide an asynchronous message This document defines mechanisms that provide an asynchronous message
notification delivery service for the NETCONF protocol [RFC6241] notification delivery service for the NETCONF protocol [RFC6241]
based on [event-notifications]. This is an optional capability built based on [event-notifications]. This is an optional capability built
on top of the base NETCONF definition. on top of the base NETCONF definition.
[event-notifications] and this document enhance the capabilities of [event-notifications] and this document enhance the capabilities of
RFC 5277 while maintaining backwards capability with existing RFC 5277 while maintaining backwards capability with existing
implementations. It is intended that a final version of this implementations. It is intended that a final version of this
document might obsolete [RFC5277]. document might obsolete [RFC5277]. The enhancements include the
ability to terminate subscriptions without terminating the client
The enhancements over [RFC5277] include the ability to terminate session, to modify existing subscriptions, and to have multiple
subscriptions without terminating the client session, to modify subscriptions on a NETCONF session. [RFC5277] clients that do not
existing subscriptions, and to have multiple subscriptions on a require these enhancements are not affected by them.
NETCONF session.
These enhancements do not affect [RFC5277] clients that do not
support these particular subscription requirements.
[event-notifications] covers the following functionality: [event-notifications] covers the following functionality:
o Ability to subscribe to event notifications using two mechanisms: o Ability to subscribe to event notifications using two mechanisms:
dynamic and configuration subscriptions. dynamic and configuration subscriptions.
o Ability to subscribe to event notifications using two mechanisms: o Ability to subscribe to event notifications using two mechanisms:
dynamic and configuration subscriptions. dynamic and configuration subscriptions.
o Ability to negotiate acceptable subscription parameters. o Ability to negotiate acceptable subscription parameters.
skipping to change at page 4, line 35 skipping to change at page 4, line 30
o support a revised definition of the default NETCONF stream o support a revised definition of the default NETCONF stream
o be backwards compatible with RFC 5277 implementations. o be backwards compatible with RFC 5277 implementations.
1.1. Terminology 1.1. 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", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119]. document are to be interpreted as described in RFC 2119 [RFC2119].
1.1.1. Event Notifications 1.1.1. NETCONF
The following terms are defined in [RFC6241] :
o Client
o Server
o Operation
o RPC: remote procedure call
1.1.2. Event Notifications
The following terms are defined in [event-notifications]: The following terms are defined in [event-notifications]:
o Event o Event
o Event notification o Event notification
o Stream (also referred to as "event stream") o Stream (also referred to as "event stream")
o Subscriber o Subscriber
o Publisher
o Receiver o Receiver
o Subscription o Subscription
o Filter o Filter
o Dynamic subscription o Dynamic subscription
o Configured subscription o Configured subscription
1.1.2. NETCONF Note that a publisher in [event-notifications] corresponds to a
server in [RFC6241]. Similarly, a subscribers corresponds to a
The following terms are defined in [RFC6241] : client. A receiver is also a client. In the remainder of this
document, we will use the terminology in [RFC6241].
o Operation
o RPC: remote procedure call
1.1.3. NETCONF Access Control 1.1.3. NETCONF Access Control
The following terms are defined in [RFC6536] : The following terms are defined in [RFC6536] :
o NACM: NETCONF Access Control Model o NACM: NETCONF Access Control Model
1.2. Solution Overview 1.2. Solution Overview
[event-notifications] defines mechanisms that provide an asynchronous [event-notifications] defines mechanisms that provide an asynchronous
message notification delivery service. This document discusses its message notification delivery service. This document discusses its
realization on top of the NETCONF protocol [RFC6241]. realization on top of the NETCONF protocol [RFC6241].
The functionality to support is defined in [event-notifications]. It The functionality to support is defined in [event-notifications]. It
is formalized in a set of yang models. The mapping of yang is formalized in a set of yang models. The mapping of yang
constructs into NETCONF is described in [RFC6020]. constructs into NETCONF is described in [RFC6020].
Supporting [event-notifications] requires enhancements and Supporting [event-notifications] requires enhancements and
modifications in NETCONF. The key enhacement is suporting multiple modifications in NETCONF. The key enhacement is suporting multiple
subscriptions on a NETCONF session. A key modification is the subscriptions on a NETCONF session. A key modification is the
definition of the NETCONF stream definition of the NETCONF stream.
These enhancements do not affect [RFC5277] clients that do not These enhancements do not affect [RFC5277] clients that do not
support [event-notifications]. support [event-notifications].
2. Solution 2. Solution
In this section, we describe and exemplify how [event-notifications] In this section, we describe and exemplify how [event-notifications]
must be supported over NETCONF. must be supported over NETCONF.
2.1. Event Streams 2.1. Event Streams
skipping to change at page 9, line 18 skipping to change at page 9, line 18
capability MUST support the "NETCONF" notification event stream. capability MUST support the "NETCONF" notification event stream.
This stream contains all NETCONF XML event notifications supported by This stream contains all NETCONF XML event notifications supported by
the NETCONF server, except for those belonging only to streams that the NETCONF server, except for those belonging only to streams that
explicitly indicate that they must be excluded from the NETCONF explicitly indicate that they must be excluded from the NETCONF
stream. The exact string "NETCONF" is used during the advertisement stream. The exact string "NETCONF" is used during the advertisement
of stream support during the <get> operation on <streams> and during of stream support during the <get> operation on <streams> and during
the <create-subscription> and <establish-subscription> operations. the <create-subscription> and <establish-subscription> operations.
2.4. Creating a Subscription 2.4. Creating a Subscription
The following illustrates the creation of a simple subscription. This operation was fully defined in [RFC5277].
2.4.1. Usage Example 2.4.1. Usage Example
The following demonstrates dynamically creating a subscription. This The following demonstrates dynamically creating a subscription.
operation is fully defined in [RFC5277]
<netconf:rpc message-id="101" <netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<create-subscription <create-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
</create-subscription> </create-subscription>
</netconf:rpc> </netconf:rpc>
Figure 6: Create subscription Figure 6: Create subscription
skipping to change at page 11, line 13 skipping to change at page 11, line 13
does not support it, the following error is returned: does not support it, the following error is returned:
Tag: operation-failed Tag: operation-failed
Error-type: protocol Error-type: protocol
Severity: error Severity: error
Error-info: none Error-info: none
Description: Request could not be completed because the Description: Request could not be completed because the
requested operation failed for some reason requested operation failed for some reason
not covered by any other error condition. not covered by any other error condition.
Figure 9: Create subscription pperation failed Figure 9: Create subscription operation failed
If a stopTime is requested that is earlier than the specified If a stopTime is requested that is earlier than the specified
startTime, the following error is returned: startTime, the following error is returned:
Tag: bad-element Tag: bad-element
Error-type: protocol Error-type: protocol
Severity: error Severity: error
Error-info: <bad-element>: stopTime Error-info: <bad-element>: stopTime
Description: An element value is not correct; Description: An element value is not correct;
e.g., wrong type, out of range, pattern mismatch. e.g., wrong type, out of range, pattern mismatch.
skipping to change at page 11, line 41 skipping to change at page 11, line 41
Error-type: protocol Error-type: protocol
Severity: error Severity: error
Error-info: <bad-element>: startTime Error-info: <bad-element>: startTime
Description: An element value is not correct; Description: An element value is not correct;
e.g., wrong type, out of range, pattern mismatch. e.g., wrong type, out of range, pattern mismatch.
Figure 11: Create subscription incorrect startTime Figure 11: Create subscription incorrect startTime
2.5. Establishing a Subscription 2.5. Establishing a Subscription
This operation is defined in [event-notifications].
2.5.1. Usage Example 2.5.1. Usage Example
The following illustrates the establishment of a simple subscription. The following illustrates the establishment of a simple subscription.
<netconf:rpc message-id="101" <netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription <establish-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
</establish-subscription> </establish-subscription>
</netconf:rpc> </netconf:rpc>
skipping to change at page 12, line 35 skipping to change at page 12, line 44
<subscription-result <subscription-result
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
ok ok
</subscription-result> </subscription-result>
<subscription-id <subscription-id
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
52 52
</subscription-id> </subscription-id>
</rpc-reply> </rpc-reply>
Figure 13: Successful establish subscription Figure 13: Successful establish-subscription
2.5.3. Negative Response 2.5.3. Negative Response
If the NETCONF server cannot satisfy the request, the server sends a If the NETCONF server cannot satisfy the request, the server sends a
negative <subscription-result> element. negative <subscription-result> element.
If the client has no authorization to establish the subscription, the If the client has no authorization to establish the subscription, the
<subscription-result> indicates an authorization error. For <subscription-result> indicates an authorization error. For
instance: instance:
skipping to change at page 13, line 28 skipping to change at page 13, line 32
</subscription-result> </subscription-result>
</rpc-reply> </rpc-reply>
Figure 14: Unsuccessful establish subscription Figure 14: Unsuccessful establish subscription
If the request is rejected because the server is not able to serve If the request is rejected because the server is not able to serve
it, the server SHOULD include in the returned error what subscription it, the server SHOULD include in the returned error what subscription
parameters would have been accepted for the request when it was parameters would have been accepted for the request when it was
processed. However, they are no guarantee that subsequent requests processed. However, they are no guarantee that subsequent requests
with those parameters for this client or others will be accepted. with those parameters for this client or others will be accepted.
For instance, consider a subscription from [netconf-yang-push], which For instance, consider a subscription from [yang-push], which
augments the establish-subscription with some additional parameters, augments the establish-subscription with some additional parameters,
including "period". If the client requests a period the NETCONF including "period". If the client requests a period the NETCONF
server cannot serve, the exchange may be: server cannot serve, the exchange may be:
<netconf:rpc message-id="101" <netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription <establish-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
<stream>push-update</stream> <stream>push-update</stream>
<filter netconf:type="xpath" <filter netconf:type="xpath"
skipping to change at page 14, line 40 skipping to change at page 14, line 40
</rpc-reply> </rpc-reply>
Figure 15: Subscription establishment negotiation Figure 15: Subscription establishment negotiation
Subscription requests will fail if a filter with invalid syntax is Subscription requests will fail if a filter with invalid syntax is
provided or if the name of a non-existent stream is provided. provided or if the name of a non-existent stream is provided.
2.5.4. Multiple Subscriptions over a Single NETCONF Session 2.5.4. Multiple Subscriptions over a Single NETCONF Session
Note that [event-notifications] requires supporting multiple Note that [event-notifications] requires supporting multiple
subscriptions over a single NETCONF session. In contrast, [RFC5277] subscription establishments over a single NETCONF session. In
mandated server to return an error when a create-subscription was contrast, [RFC5277] mandated servers to return an error when a
sent while a subscription was active on that session. create-subscription was sent while a subscription was active on that
session. Note that servers are not required to support multiple
create-subscription over a single session, but they MUST support
multiple establish-suscription over one session.
2.5.5. Message Flow Examples 2.5.5. Message Flow Examples
+------------+ +-----------+ +------------+ +-----------+
| Client | | Server | | Client | | Server |
+------------+ +-----------+ +------------+ +-----------+
| | | |
| Capability Exchange | | Capability Exchange |
|<---------------------------->| |<---------------------------->|
| | | |
| | | |
skipping to change at page 16, line 43 skipping to change at page 16, line 43
| Notification (subs-id 23) | | Notification (subs-id 23) |
|<-----------------------------| |<-----------------------------|
| | | |
| | | |
Figure 17: Message Flow for multiple subscription establishments over Figure 17: Message Flow for multiple subscription establishments over
a single session a single session
2.6. Modifying a Subscription 2.6. Modifying a Subscription
This operation is defined in [event-notifications].
2.6.1. Usage Example 2.6.1. Usage Example
The following demonstrates modifying a subscription. Consider a The following demonstrates modifying a subscription. Consider a
subscription from [netconf-yang-push], which augments the establish- subscription from [yang-push], which augments the establish-
subscription with some additional parameters, including "period". A subscription with some additional parameters, including "period". A
subscription may be established as follows. subscription may be established as follows.
<netconf:rpc message-id="101" <netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription <establish-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
<stream>push-update</stream> <stream>push-update</stream>
<filter netconf:type="xpath" <filter netconf:type="xpath"
xmlns:ex="http://example.com/sample-data/1.0" xmlns:ex="http://example.com/sample-data/1.0"
skipping to change at page 18, line 32 skipping to change at page 18, line 32
1922 1922
</subscription-id> </subscription-id>
</rpc-reply> </rpc-reply>
Figure 19: Modify subscription Figure 19: Modify subscription
2.6.2. Positive Response 2.6.2. Positive Response
If the NETCONF server can satisfy the request, the server sends a If the NETCONF server can satisfy the request, the server sends a
positive <subscription-result> element. This response is like that positive <subscription-result> element. This response is like that
to an establish-subscription request. but without the subscription- to an establish-subscription request, but without the subscription-id
id, which would be redundant. (which would be redundant).
<netconf:rpc message-id="102" <netconf:rpc message-id="102"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<modify-subscription <modify-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
<subscription-id>1922</subscription-id> <subscription-id>1922</subscription-id>
<period <period
xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push:1.0"> xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push:1.0">
1000 1000
</period> </period>
skipping to change at page 19, line 31 skipping to change at page 19, line 31
ok ok
</subscription-result> </subscription-result>
</rpc-reply> </rpc-reply>
Figure 20: Successful modify subscription Figure 20: Successful modify subscription
2.6.3. Negative Response 2.6.3. Negative Response
If the NETCONF server cannot satisfy the request, the server sends a If the NETCONF server cannot satisfy the request, the server sends a
negative <subscription-result> element. Its contents and semantics negative <subscription-result> element. Its contents and semantics
are identical to those to an establish-subscription request. For are identical to those in an establish-subscription request. For
instance: instance:
<netconf:rpc message-id="102" <netconf:rpc message-id="102"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<modify-subscription <modify-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
<subscription-id>1922</subscription-id> <subscription-id>1922</subscription-id>
<period xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push:1.0"> <period xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push:1.0">
100 100
</period> </period>
skipping to change at page 21, line 38 skipping to change at page 21, line 38
|<-----------------------------| |<-----------------------------|
| Notification (subs-id 22) | | Notification (subs-id 22) |
|<-----------------------------| |<-----------------------------|
| | | |
| | | |
Figure 22: Message flow for subscription modification Figure 22: Message flow for subscription modification
2.7. Deleting a Subscription 2.7. Deleting a Subscription
This operation is defined in [event-notifications].
2.7.1. Usage Example 2.7.1. Usage Example
The following demonstrates deleting a subscription. The following demonstrates deleting a subscription.
<netconf:rpc message-id="101" <netconf:rpc message-id="101"
xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
<delete-subscription <delete-subscription
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1"> xmlns="urn:ietf:params:xml:ns:netconf:notification:1.1">
<subscription-id>1922</subscription-id> <subscription-id>1922</subscription-id>
</delete-subscription> </delete-subscription>
skipping to change at page 24, line 39 skipping to change at page 24, line 39
| | | |
| | | |
| | | |
| | | |
Figure 26: Message flow for subscription deletion Figure 26: Message flow for subscription deletion
2.8. Configured Subscriptions 2.8. Configured Subscriptions
A configured subscription is a subscription installed via a A configured subscription is a subscription installed via a
configuration interface, and do not support negotiation. configuration interface. Configured subscriptions do not support
negotiation.
Supporting configured subscriptions is optional and advertised during Supporting configured subscriptions is optional and advertised during
the capabilities exchange using the "configured-subscriptions" the capabilities exchange using the "configured-subscriptions"
feature. feature.
Configured susbscriptions are supported by NETCONF servers using
NETCONF Call Home [call-home]
In this section, we present examples of how to manage configuration In this section, we present examples of how to manage configuration
subscriptions using a NETCONF client. subscriptions using a NETCONF client.
2.8.1. Establishing a Configured Subscription 2.8.1. Call Home for Configured Subscriptions
Configured subscriptions are established, modified, and deleted using
configuration operations against the top-level subtree subscription-
config. Once the configuration is set, the server initiates a Call
Home to each of the receivers in the subscription on the address and
port specified. Once the NETCONF session between the server and the
receiver is established, the server will issue a "subscription-
started" notification. After that, the server will send
notifications to the receiver as per the subscription notification.
Note that the server assumes the receiver is aware that calls on the
configured port are intended only for pushing notifications. It also
assumes that the receiver is ready to accept notifications on the
session created as part of the Call Home as soon as the NETCONF
session is established. This may require coordination between the
client that configures the subscription and the clients for which the
notifications are intended. This coordination is out of the scope of
this document.
2.8.2. Establishing a Configured Subscription
Subscriptions are established using configuration operations against Subscriptions are established using configuration operations against
the top-level subtree subscription-config. the top-level subtree subscription-config.
For example at subscription establishment, a NETCONF client may send: For example at subscription establishment, a NETCONF client may send:
<rpc message-id="101" <rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
<edit-config> <edit-config>
skipping to change at page 26, line 21 skipping to change at page 27, line 19
<error-severity>error</error-severity> <error-severity>error</error-severity>
<error-message xml:lang="en"> <error-message xml:lang="en">
Temporarily the server cannot serve this Temporarily the server cannot serve this
subscription due to the current workload. subscription due to the current workload.
</error-message> </error-message>
</rpc-error> </rpc-error>
</rpc-reply> </rpc-reply>
Figure 29: Response to a failed static subscription establishment Figure 29: Response to a failed static subscription establishment
2.8.1.1. Message Flow Example 2.8.2.1. Message Flow Example
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| Client | | Server | | Rcver A | | Rcver B | | Client | | Server | | Rcver A | | Rcver B |
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| | | | | | | |
| Capability Exchange | | | | Capability Exchange | | |
|<-------------------------->| | | |<-------------------------->| | |
| | | | | | | |
| | | | | | | |
| Edit-config | | | | Edit-config | | |
|--------------------------->| | | |--------------------------->| | |
| RPC Reply: OK | | | | RPC Reply: OK | | |
|<---------------------------| | | |<---------------------------| | |
| | Call Home | |
| |<-------------->| |
| |<--------------------------->|
| | | |
| | Subscription | | | | Subscription | |
| | Started | | | | Started | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
| | | | | | | |
| | Notification | | | | Notification | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
skipping to change at page 27, line 45 skipping to change at page 29, line 5
| | | | | | | |
| | Notification | | | | Notification | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
| | | | | | | |
Figure 30: Message flow for subscription establishment (configured Figure 30: Message flow for subscription establishment (configured
subscription) subscription)
2.8.2. Modifying a Configured Subscription 2.8.3. Modifying a Configured Subscription
Configured subscriptions can be modified using configuration Configured subscriptions can be modified using configuration
operations against the top-level subtree subscription-config. operations against the top-level subtree subscription-config.
For example, the subscription established in the previous section For example, the subscription established in the previous section
could be modified as follows, choosing a different receiver: could be modified as follows, choosing a different receiver:
<rpc message-id="102" <rpc message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"
xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0"> xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0">
skipping to change at page 29, line 5 skipping to change at page 30, line 5
if the request is accepted, the server would reply: if the request is accepted, the server would reply:
<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">
<ok/> <ok/>
</rpc-reply> </rpc-reply>
Figure 32: Response to a successful configured subscription Figure 32: Response to a successful configured subscription
modification modification
2.8.2.1. Message Flow Example 2.8.3.1. Message Flow Example
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| Client | | Server | | Rcver A | | Rcver B | | Client | | Server | | Rcver A | | Rcver B |
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| | | | | | | |
| Capability Exchange | | | | Capability Exchange | | |
|<-------------------------->| | | |<-------------------------->| | |
| | | | | | | |
| | | | | | | |
| Edit-config | | | | Edit-config | | |
|--------------------------->| | | |--------------------------->| | |
| RPC Reply: OK | | | | RPC Reply: OK | | |
|<---------------------------| | | |<---------------------------| | |
| | Call Home | |
| |<-------------->| |
| |<--------------------------->|
| | | |
| | Subscription | | | | Subscription | |
| | Started | | | | Started | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
| | | | | | | |
| | Notification | | | | Notification | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
skipping to change at page 31, line 5 skipping to change at page 31, line 8
| | | | | | | |
| | Notification | | | | Notification | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
| | | | | | | |
Figure 33: Message flow for subscription modification (configured Figure 33: Message flow for subscription modification (configured
subscription) subscription)
2.8.3. Deleting a Configured Subscription 2.8.4. Deleting a Configured Subscription
Subscriptions can be deleted using configuration operations against Subscriptions can be deleted using configuration operations against
the top-level subtree subscription-config. For example: the top-level subtree subscription-config. For example:
<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">
<edit-config> <edit-config>
<target> <target>
<running/> <running/>
</target> </target>
skipping to change at page 31, line 34 skipping to change at page 31, line 37
</edit-config> </edit-config>
</rpc> </rpc>
<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">
<ok/> <ok/>
</rpc-reply> </rpc-reply>
Figure 34: Deleting a configured subscription Figure 34: Deleting a configured subscription
2.8.3.1. Message Flow Example 2.8.4.1. Message Flow Example
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| Client | | Server | | Rcver A | | Rcver B | | Client | | Server | | Rcver A | | Rcver B |
+----------+ +-----------+ +---------+ +---------+ +----------+ +-----------+ +---------+ +---------+
| | | | | | | |
| Capability Exchange | | | | Capability Exchange | | |
|<-------------------------->| | | |<-------------------------->| | |
| | | | | | | |
| | | | | | | |
| Edit-config | | | | Edit-config | | |
|--------------------------->| | | |--------------------------->| | |
| RPC Reply: OK | | | | RPC Reply: OK | | |
|<---------------------------| | | |<---------------------------| | |
| | Call Home | |
| |<-------------->| |
| |<--------------------------->|
| | | |
| | Subscription | | | | Subscription | |
| | Started | | | | Started | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
| | | | | | | |
| | Notification | | | | Notification | |
| | (subs-id 22) | | | | (subs-id 22) | |
| |--------------->| | | |--------------->| |
| |---------------------------->| | |---------------------------->|
skipping to change at page 33, line 22 skipping to change at page 33, line 32
The event notification always includes an <eventTime> element. It is The event notification always includes an <eventTime> element. It is
the time the event was generated by the event source. This parameter the time the event was generated by the event source. This parameter
is of type dateTime and compliant to [RFC3339]. Implementations must is of type dateTime and compliant to [RFC3339]. Implementations must
support time zones. support time zones.
The event notification also contains notification-specific tagged The event notification also contains notification-specific tagged
content, if any. With the exception of <eventTime>, the content of content, if any. With the exception of <eventTime>, the content of
the notification is beyond the scope of this document. the notification is beyond the scope of this document.
For the encodings other than XML, notifications include an additional For encodings other than XML, notifications include an additional XML
XML element so that the notification is a well-formed XML. The element so that the notification is a well-formed XML. The element
element is <notification-contents-{encoding}>, E.g., <notification- is <notification-contents-{encoding}>, E.g., <notification-contents-
contents-json>. That element contains the notification contents in json>. That element contains the notification contents in the
the desired encoding desired encoding
The following is an example of an event notification from [RFC6020]: The following is an example of an event notification from [RFC6020]:
notification link-failure { notification link-failure {
description "A link failure has been detected"; description "A link failure has been detected";
leaf if-name { leaf if-name {
type leafref { type leafref {
path "/interface/name"; path "/interface/name";
} }
} }
skipping to change at page 34, line 27 skipping to change at page 34, line 44
The equivalent using JSON encoding would be The equivalent using JSON encoding would be
<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>
<notification-contents-json> <notification-contents-json>
{ {
"acme-system:link-failure": { "acme-system:link-failure": {
"if-name": "so-1/2/3.0", "if-name": "so-1/2/3.0",
"if-admin-status": "up", "if-admin-status": "up",
"if-oper-status": "down " "if-oper-status": "down"
} }
} }
</notification-contents-json> </notification-contents-json>
</notification> </notification>
Figure 38: Data plane notification using JSON encoding Figure 38: Data plane notification using JSON encoding
2.10. Control Plane Notifications 2.10. Control Plane Notifications
In addition to data plane notifications, a server may send control In addition to data plane notifications, a server may send control
plane notifications (defined in [event-notifications]) to indicate to plane notifications (defined in [event-notifications]) to indicate to
receivers that an event related to the subscription management has receivers that an event related to the subscription management has
occurred. Control plane notifications cannot be filtered out. Next occurred. Control plane notifications cannot be filtered out. Next
we exemplify them using both XML, and JSON encondings for the data: we exemplify them using both XML, and JSON encondings for the
notification-specific content:
2.10.1. replayComplete 2.10.1. replayComplete
<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>
<replayComplete xmlns="urn:ietf:params:xml:ns:netmod:notification"/> <replayComplete xmlns="urn:ietf:params:xml:ns:netmod:notification"/>
</notification> </notification>
Figure 39: replayComplete control plane notification Figure 39: replayComplete control plane notification
skipping to change at page 46, line 8 skipping to change at page 46, line 8
publishers could be used to overwhelm a receiver, which doesn't even publishers could be used to overwhelm a receiver, which doesn't even
support subscriptions. Clients that do not want pushed data need support subscriptions. Clients that do not want pushed data need
only terminate or refuse any transport sessions from the publisher. only terminate or refuse any transport sessions from the publisher.
In addition, the NETCONF Authorization Control Model [RFC6536] SHOULD In addition, the NETCONF Authorization Control Model [RFC6536] SHOULD
be used to control and restrict authorization of subscription be used to control and restrict authorization of subscription
configuration. This control models permits specifying per-user configuration. This control models permits specifying per-user
permissions to receive specific event notification types. The permissions to receive specific event notification types. The
permissions are specified as a set of access control rules. permissions are specified as a set of access control rules.
Note that streams can define additional authorization requirements. Note that streams can define additional authorization requirements.
For instance, in [netconf-yang-push] each of the elements in its data For instance, in [yang-push] each of the elements in its data plane
plane notifications must also go through access control. notifications must also go through access control.
5. Acknowledgments 5. 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, Peipei suggestions that were received from: Andy Bierman, Yan Gang, Peipei
Guo, Susan Hares, Tim Jenkins, Balazs Lengyel, Kent Watsen, and Guo, Susan Hares, Tim Jenkins, Balazs Lengyel, Kent Watsen, and
Guangying Zheng. Guangying Zheng.
6. References 6. References
skipping to change at page 47, line 7 skipping to change at page 47, line 7
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>. <http://www.rfc-editor.org/info/rfc6241>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012, DOI 10.17487/RFC6536, March 2012,
<http://www.rfc-editor.org/info/rfc6536>. <http://www.rfc-editor.org/info/rfc6536>.
6.2. Informative References 6.2. Informative References
[call-home]
Watsen, K., "NETCONF Call Home and RESTCONF Call Home",
December 2015, <https://datatracker.ietf.org/doc/draft-
ietf-netconf-call-home/>.
[event-notifications] [event-notifications]
Gonzalez Prieto, A., Clemm, A., Voit, Eric., Nilsen- Clemm, A., Gonzalez Prieto, A., Voit, Eric., Nilsen-
Nygaard, E., Tripathy, A., Chisholm, S., and H. Trevino, Nygaard, E., Tripathy, A., Chisholm, S., and H. Trevino,
"Subscribing to YANG-Defined Event Notifications", June "Subscribing to Event Notifications", June 2016,
2016, <https://datatracker.ietf.org/doc/draft-gonzalez- <https://datatracker.ietf.org/doc/draft-ietf-netconf-
netconf-5277bis/>. rfc5277bis/>.
[netconf-yang-push] [yang-push]
Clemm, A., Gonzalez Prieto, A., Voit, Eric., Tripathy, A., Clemm, A., Gonzalez Prieto, A., Voit, Eric., Tripathy, A.,
and E. Nilsen-Nygaard, "Subscribing to YANG datastore push and E. Nilsen-Nygaard, "Subscribing to YANG datastore push
updates", February 2016, updates", February 2016,
<https://datatracker.ietf.org/doc/draft-ietf-netconf-yang- <https://datatracker.ietf.org/doc/draft-ietf-netconf-yang-
push/>. push/>.
Appendix A. Issues being worked and resolved Appendix A. Issues that are currently being worked
(To be removed by RFC editor prior to publication) (To be removed by RFC editor prior to publication)
A.1. Unresolved Issues o NT1 - Express filter in JSON should be documented.
NT1 - Support multiple create-subscriptions over a single NETCONF Appendix B. Changes between revisions
session? or only multiple establish-subscription? Recommend only
establish-subscription anytime there may be more than one
subscription, otherwise variations of supported RFCs and error states
proliferate.
NT2 - Configured subscription need to be refined in (To be removed by RFC editor prior to publication)
[event-notifications] and then adjust this document based on it.
NT3 - Express filter in JSON should be documented. B.1. v00 to v01
A.2. Agreement in principal o D1 - Added Call Home in solution for configured subscriptions.
NT1 - When a list of requirements for secure transport is provided o D2 - Clarified support for multiple subscription on a single
via a Configured Subscription, this list must be met via Netconf session. No need to support multiple create-subscription.
transport. Specifics still are needed for draft on the "how".
NT2 - Along with rfc5277bis, this draft to obsolete 5277 o D3 - Added mapping between terminology in [yang-push] and
[RFC6241] (the one followed in this document).
NT3 - Stream discovery. Adopted mechanism in 5277-bis and include o D4 - Editorial improvements.
backwards comptability support.
Authors' Addresses Authors' Addresses
Alberto Gonzalez Prieto Alberto Gonzalez Prieto
Cisco Systems Cisco Systems
Email: albertgo@cisco.com Email: albertgo@cisco.com
Alexander Clemm Alexander Clemm
Sympotech
Email: ludwig@clemm.org Email: alex@sympotech.com
Eric Voit Eric Voit
Cisco Systems Cisco Systems
Email: evoit@cisco.com Email: evoit@cisco.com
Einar Nilsen-Nygaard Einar Nilsen-Nygaard
Cisco Systems Cisco Systems
Email: einarnn@cisco.com Email: einarnn@cisco.com
 End of changes. 56 change blocks. 
82 lines changed or deleted 134 lines changed or added

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