/
draft-ietf-netconf-netconf-event-notifications-11-configured-removed.txt
841 lines (567 loc) · 29.6 KB
/
draft-ietf-netconf-netconf-event-notifications-11-configured-removed.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
PRE-DRAFT 27-June-2018:
-------------------------------------------------------------
NETCONF E. Voit
Internet-Draft Cisco Systems
Intended status: Standards Track A. Clemm
Expires: January 28, 2019 Huawei
A. Gonzalez Prieto
Microsoft
E. Nilsen-Nygaard
A. Tripathy
Cisco Systems
July 27, 2018
NETCONF Support for Event Notifications
draft-ietf-netconf-netconf-event-notifications-11
Abstract
This document provides a NETCONF binding to the dynamic subscription
capability of both subscribed notifications and YANG push.
RFC Editor note: please replace the four references to pre-RFC
normative drafts with the actual assigned RFC numbers.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on January 28, 2019.
Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
Voit, et al. Expires January 28, 2019 [Page 1]
Internet-Draft NETCONF-notif July 2018
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Compatibility with RFC-5277's create-subscription . . . . . . 3
4. Mandatory XML, event stream and datastore support . . . . . . 3
5. NETCONF connectivity and the Dynamic Subscriptions . . . . . 4
6. Notification Messages . . . . . . . . . . . . . . . . . . . . 4
7. Dynamic Subscriptions and RPC Error Responses . . . . . . . . 4
8. Security Considerations . . . . . . . . . . . . . . . . . . . 5
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 5
10. Normative References . . . . . . . . . . . . . . . . . . . . 6
Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 6
A.1. Event Stream Discovery . . . . . . . . . . . . . . . . . 6
A.2. Dynamic Subscriptions . . . . . . . . . . . . . . . . . . 7
A.3. Subscription State Notifications . . . . . . . . . . . . 12
Appendix B. Changes between revisions . . . . . . . . . . . . . 13
B.1. v10 to v11 . . . . . . . . . . . . . . . . . . . . . . . 14
B.2. v09 to v10 . . . . . . . . . . . . . . . . . . . . . . . 14
B.3. v08 to v09 . . . . . . . . . . . . . . . . . . . . . . . 14
B.4. v07 to v08 . . . . . . . . . . . . . . . . . . . . . . . 14
B.5. v06 to v07 . . . . . . . . . . . . . . . . . . . . . . . 14
B.6. v05 to v06 . . . . . . . . . . . . . . . . . . . . . . . 14
B.7. v03 to v04 . . . . . . . . . . . . . . . . . . . . . . . 14
B.8. v01 to v03 . . . . . . . . . . . . . . . . . . . . . . . 15
B.9. v00 to v01 . . . . . . . . . . . . . . . . . . . . . . . 15
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15
1. Introduction
This document provides a binding for events streamed over the NETCONF
protocol [RFC6241] for dyanamic subscriptions as defined in
[I-D.draft-ietf-netconf-subscribed-notifications]. In addition, as
[I-D.ietf-netconf-yang-push] is itself built upon
[I-D.draft-ietf-netconf-subscribed-notifications], this document
enables a NETCONF client to request via a dynamic subscription and
receive updates from a YANG datastore located on a NETCONF server.
Voit, et al. Expires January 28, 2019 [Page 2]
Internet-Draft NETCONF-notif July 2018
2. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
The following terms are defined in
[I-D.draft-ietf-netconf-subscribed-notifications]: notification
message, event stream, publisher, receiver, subscriber, subscription.
3. Compatibility with RFC-5277's create-subscription
A publisher is allowed to concurrently support dynamic subscription
RPCs of [I-D.draft-ietf-netconf-subscribed-notifications] at the same
time as [RFC5277]'s "create-subscription" RPC. However a single
NETCONF transport session cannot support both this specification and
a subscription established by [RFC5277]'s "create-subscription" RPC.
To protect against any attempts to use a single NETCONF transport
session in this way:
o A solution must reply with the [RFC6241] error "operation-not-
supported" if a "create-subscription" RPC is received on a NETCONF
session where an [I-D.draft-ietf-netconf-subscribed-notifications]
established subscription exists.
o A solution must reply with the [RFC6241] error "operation-not-
supported" if an "establish-subscription" request is been received
on a NETCONF session where the "create-subscription" RPC has
successfully [RFC5277] created a subscription.
If a publisher supports this specification but not subscriptions via
[RFC5277], the publisher MUST NOT advertise
"urn:ietf:params:netconf:capability:notification:1.0".
4. Mandatory XML, event stream and datastore support
The "encode-xml" feature of
[I-D.draft-ietf-netconf-subscribed-notifications] is mandatory to
support. This indicates that XML is a valid encoding for RPCs, state
change notifications, and subscribed content.
A NETCONF publisher supporting event stream subscription via
[I-D.draft-ietf-netconf-subscribed-notifications] MUST support the
"NETCONF" event stream identified in that draft.
Voit, et al. Expires January 28, 2019 [Page 3]
Internet-Draft NETCONF-notif July 2018
5. NETCONF connectivity and the Dynamic Subscriptions
For a dynamic subscription, if the NETCONF session involved with the
"establish-subscription" terminates, the subscription MUST be
terminated.
For a dynamic subscription a "modify-subscription", "delete-
subscription", or "resynch-subscription" RPC MUST be sent using same
the NETCONF session upon which the referenced subscription was
established.
6. Notification Messages
Notification messages transported over the NETCONF protocol will use
the "notification" message defined within [RFC5277], section 4.
For dynamic subscriptions, all notification messages MUST use the
NETCONF transport session used by the "establish-subscription" RPC.
7. Dynamic Subscriptions and RPC Error Responses
Management of dynamic subscriptions occurs via RPCs as defined in
[I-D.ietf-netconf-yang-push] and
[I-D.draft-ietf-netconf-subscribed-notifications]. When an RPC error
occurs, the NETCONF RPC reply MUST include an "rpc-error" element per
[RFC6241] with the error information populated as follows:
o an "error-type" node of "application".
o an "error-tag" node of "operation-failed".
o an "error-severity" of "error" (this MAY but does not have to be
included).
o an "error-app-tag" node with the value being a string that
corresponds to an identity associated with the error, as defined
in [I-D.draft-ietf-netconf-subscribed-notifications] section 2.4.6
for general subscriptions, and [I-D.ietf-netconf-yang-push]
Appendix A.1, for datastore subscriptions. The identityname to
use depends on the RPC for which the error occurred. Viable
errors for different RPCs are as follows:
RPC use base identity
---------------------- ----------------------------
establish-subscription establish-subscription-error
modify-subscription modify-subscription-error
delete-subscription delete-subscription-error
kill-subscription kill-subscription-error
resynch-subscription resynch-subscription-error
Voit, et al. Expires January 28, 2019 [Page 4]
Internet-Draft NETCONF-notif July 2018
Each error identity will be inserted as the "error-app-tag" using
JSON encoding following the form <modulename>:<identityname>. An
example of such as valid encoding would be "ietf-subscribed-
notifications:no-such-subscription".
o In case of error responses to an "establish-subscription" or
"modify-subscription" request there is the option of including an
"error-info" node. This node may contain XML-encoded data with
hints for parameter settings that might lead to successful RPC
requests in the future. Following are the yang-data structures
which may be returned:
establish-subscription returns hints in yang-data structure
---------------------- ------------------------------------
target: event stream establish-subscription-stream-error-info
target: datastore establish-subscription-datastore-error-info
modify-subscription returns hints in yang-data structure
---------------------- ------------------------------------
target: event stream modify-subscription-stream-error-info
target: datastore modify-subscription-datastore-error-info
The yang-data included within "error-info" SHOULD NOT include the
optional leaf "error-reason", as such a leaf would be redundant
with information that is already placed within the
"error-app-tag".
In case of an rpc error as a result of a "delete-subscription", a
"kill-subscription", or a "resynch-subscription" request, no
"error-info" needs to be included, as the "subscription-id" is
the only RPC input parameter and no hints regarding this RPC input
parameters need to be provided.
8. Security Considerations
If a malicious or buggy 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
subscriptions on that NETCONF session.
9. Acknowledgments
We wish to acknowledge the helpful contributions, comments, and
suggestions that were received from: Andy Bierman, Yan Gang, Sharon
Chisholm, Hector Trevino, Peipei Guo, Susan Hares, Tim Jenkins,
Voit, et al. Expires January 28, 2019 [Page 5]
Internet-Draft NETCONF-notif July 2018
Balazs Lengyel, Martin Bjorklund, Mahesh Jethanandani, Kent Watsen,
and Guangying Zheng.
10. Normative References
[I-D.draft-ietf-netconf-subscribed-notifications]
Voit, E., Clemm, A., Gonzalez Prieto, A., Tripathy, A.,
and E. Nilsen-Nygaard, "Customized Subscriptions to a
Publisher's Event Streams", draft-ietf-netconf-subscribed-
notifications-14 (work in progress), July 2018.
[I-D.ietf-netconf-yang-push]
Clemm, Alexander., Voit, Eric., Gonzalez Prieto, Alberto.,
Tripathy, A., Nilsen-Nygaard, E., Bierman, A., and B.
Lengyel, "YANG Datastore Subscription", June 2018,
<https://datatracker.ietf.org/doc/
draft-ietf-netconf-yang-push/>.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event
Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008,
<https://www.rfc-editor.org/info/rfc5277>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
Appendix A. Examples
This section is non-normative.
A.1. Event Stream Discovery
As defined in [I-D.draft-ietf-netconf-subscribed-notifications] an
event stream exposes a continuous set of events available for
subscription. A NETCONF client can retrieve the list of available
event streams from a NETCONF publisher using the "get" operation
against the top-level container "/streams" defined in
[I-D.draft-ietf-netconf-subscribed-notifications] Section 3.1.
Voit, et al. Expires January 28, 2019 [Page 6]
Internet-Draft NETCONF-notif July 2018
The following example illustrates the retrieval of the list of
available event streams:
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<streams
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"/>
</filter>
</get>
</rpc>
Figure 1: Get streams request
After such a request, the NETCONF publisher returns a list of event
streams available, as well as additional information which might
exist in the container.
A.2. Dynamic Subscriptions
A.2.1. Establishing Dynamic Subscriptions
The following figure shows two successful "establish-subscription"
RPC requests as per
[I-D.draft-ietf-netconf-subscribed-notifications]. The first request
is given a subscription identifier of 22, the second, an identifier
of 23.
Voit, et al. Expires January 28, 2019 [Page 7]
Internet-Draft NETCONF-notif July 2018
+------------+ +-----------+
| Subscriber | | Publisher |
+------------+ +-----------+
| |
| Capability Exchange |
|<---------------------------->|
| |
| |
| establish-subscription |
|----------------------------->| (a)
| RPC Reply: OK, id = 22 |
|<-----------------------------| (b)
| |
| notification message (for 22)|
|<-----------------------------|
| |
| |
| establish-subscription |
|----------------------------->|
| notification message (for 22)|
|<-----------------------------|
| RPC Reply: OK, id = 23 |
|<-----------------------------|
| |
| |
| notification message (for 22)|
|<-----------------------------|
| notification message (for 23)|
|<-----------------------------|
| |
Figure 2: Multiple subscriptions over a NETCONF session
To provide examples of the information being transported, example
messages for interactions (a) and (b) in Figure 2 are detailed below:
<rpc message-id="102" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<establish-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<stream>NETCONF</stream>
<stream-xpath-filter xmlns:ex="http://example.com/events">
/ex:foo/
</stream-xpath-filter>
<dscp>10</dscp>
</establish-subscription>
</rpc>
Figure 3: establish-subscription request (a)
Voit, et al. Expires January 28, 2019 [Page 8]
Internet-Draft NETCONF-notif July 2018
As NETCONF publisher was able to fully satisfy the request (a), the
publisher sends the subscription identifier of the accepted
subscription within message (b):
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<identifier
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
22
</identifier>
</rpc-reply>
Figure 4: establish-subscription success (b)
If the NETCONF publisher had not been able to fully satisfy the
request, or subscriber has no authorization to establish the
subscription, the publisher would have sent an RPC error response.
For instance, if the "dscp" value of 10 asserted by the subscriber in
Figure 3 proved unacceptable, the publisher may have returned:
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<rpc-error>
<error-type>application</error-type>
<error-tag>operation-failed</error-tag>
<error-severity>error</error-severity>
<error-app-tag>
ietf-subscribed-notifications:dscp-unavailable
</error-app-tag>
</rpc-error>
</rpc-reply>
Figure 5: an unsuccessful establish subscription
The subscriber can use this information in future attempts to
establish a subscription.
A.2.2. Modifying Dynamic Subscriptions
An existing subscription may be modified. The following exchange
shows a negotiation of such a modification via several exchanges
between a subscriber and a publisher. This negotiation consists of a
failed RPC modification request/response, followed by a successful
one.
Voit, et al. Expires January 28, 2019 [Page 9]
Internet-Draft NETCONF-notif July 2018
+------------+ +-----------+
| Subscriber | | Publisher |
+------------+ +-----------+
| |
| notification message (for 23)|
|<-----------------------------|
| |
| modify-subscription (id = 23)|
|----------------------------->| (c)
| RPC error (with hint) |
|<-----------------------------| (d)
| |
| modify-subscription (id = 23)|
|----------------------------->|
| RPC Reply: OK |
|<-----------------------------|
| |
| notification message (for 23)|
|<-----------------------------|
| |
Figure 6: Interaction model for successful subscription modification
If the subscription being modified in Figure 6 is a datastore
subscription as per [I-D.ietf-netconf-yang-push], the modification
request made in (c) may look like that shown in Figure 7. As can be
seen, the modifications being attempted are the application of a new
xpath filter as well as the setting of a new periodic time interval.
<rpc message-id="303"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<modify-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<identifier>23</identifier>
<yp:datastore-xpath-filter xmlns="http://example.com/datastore">
/interfaces-state/interface/oper-status
</yp:datastore-xpath-filter>
<yp:periodic>
<yp:period>500</yp:period>
</yp:periodic>
</modify-subscription>
</rpc>
Figure 7: Subscription modification request (c)
If the NETCONF publisher can satisfy both changes, the publisher
sends a positive result for the RPC. If the NETCONF publisher cannot
Voit, et al. Expires January 28, 2019 [Page 10]
Internet-Draft NETCONF-notif July 2018
satisfy either of the proposed changes, the publisher sends an RPC
error response (d). The following is an example RPC error response
for (d) which includes a hint. This hint is an alternative time
period value which might have resulted in a successful modification:
<rpc-reply message-id="303"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<rpc-error>
<error-type>application</error-type>
<error-tag>operation-failed</error-tag>
<error-severity>error</error-severity>
<error-app-tag>
ietf-yang-push:period-unsupported
</error-app-tag>
<error-info
xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<modify-subscription-datastore-error-info>
<period-hint>
3000
</period-hint>
</modify-subscription-datastore-error-info>
</error-info>
</rpc-error>
</rpc-reply>
Figure 8: Modify subscription failure with Hint (d)
A.2.3. Deleting Dynamic Subscriptions
The following demonstrates deleting a subscription. This
subscription may have been to either a stream or a datastore.
<rpc message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<delete-subscription
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<identifier>22</identifier>
</delete-subscription>
</rpc>
Figure 9: Delete subscription
If the NETCONF publisher can satisfy the request, the publisher
replies with success to the RPC request.
If the NETCONF publisher cannot satisfy the request, the publisher
sends an error-rpc element indicating the modification didn't work.
Figure 10 shows a valid response for existing valid subscription
Voit, et al. Expires January 28, 2019 [Page 11]
Internet-Draft NETCONF-notif July 2018
identifier, but that subscription identifier was created on a
different NETCONF transport session:
<rpc-reply message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<rpc-error>
<error-type>application</error-type>
<error-tag>operation-failed</error-tag>
<error-severity>error</error-severity>
<error-app-tag>
ietf-subscribed-notifications:no-such-subscription
</error-app-tag>
</rpc-error>
</rpc-reply>
Figure 10: Unsuccessful delete subscription
A.3. Subscription State Notifications
A publisher will send subscription state notifications for dynamic
subscriptions according to the definitions within
[I-D.draft-ietf-netconf-subscribed-notifications]).
A.3.1. subscription-modified
As per Section 2.7.2 of
[I-D.draft-ietf-netconf-subscribed-notifications], a "subscription-
modified" might be sent if over NETCONF if the definition of a
configured filter changes. A subscription state notification encoded
in XML would look like:
<notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime>
<subscription-modified
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<identifier>39</identifier>
<transport xmlns:nsn=
"urn:ietf:params:xml:ns:yang:ietf-netconf-subscribed-notifications">
nsn:netconf
<transport>
<stream-xpath-filter xmlns:ex="http://example.com/events">
/ex:foo
</stream-xpath-filter>
<stream>NETCONF</stream>
</subscription-modified>
</notification>
Figure 11: subscription-modified subscription state notification
Voit, et al. Expires January 28, 2019 [Page 12]
Internet-Draft NETCONF-notif July 2018
A.3.2. subscription-resumed, and replay-complete
A "subscription-resumed" would look like:
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime>
<subscription-resumed
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<identifier>39</identifier>
</subscription-resumed>
</notification>
Figure 12: subscription-resumed notification in XML
The "replay-complete" is virtually identical, with "subscription-
resumed" simply being replaced by "replay-complete".
A.3.3. subscription-terminated and subscription-suspended
A "subscription-terminated" would look like:
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime>
<subscription-terminated
xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications">
<identifier>39</identifier>
<error-id>
suspension-timeout
</error-id>
</subscription-terminated>
</notification>
Figure 13: subscription-terminated subscription state notification
The "subscription-suspended" is virtually identical, with
"subscription-terminated" simply being replaced by "subscription-
suspended".
Appendix B. Changes between revisions
(To be removed by RFC editor prior to publication)
Voit, et al. Expires January 28, 2019 [Page 13]
Internet-Draft NETCONF-notif July 2018
B.1. v10 to v11
o Configured removed.
B.2. v09 to v10
o Tweaks to examples and text.
o Downshifted state names.
o Removed address from examples.
B.3. v08 to v09
o Tweaks based on Kent's comments.
o Updated examples in Appendix A. And updates to some object names
based on changes in the subscribed-notifications draft.
o Added a YANG model for the NETCONF identity.
B.4. v07 to v08
o Tweaks and clarification on :interleave.
B.5. v06 to v07
o XML encoding and operational datastore mandatory.
o Error mechanisms and examples updated.
B.6. v05 to v06
o Moved examples to appendices
o All examples rewritten based on namespace learnings
o Normative text consolidated in front
o Removed all mention of JSON
o Call home process detailed
o Note: this is a major revision attempting to cover those comments
received from two week review.
B.7. v03 to v04
o Added additional detail to "configured subscriptions"
o Added interleave capability
o Adjusted terminology to that in draft-ietf-netconf-subscribed-
notifications
o Corrected namespaces in examples
Voit, et al. Expires January 28, 2019 [Page 14]
Internet-Draft NETCONF-notif July 2018
B.8. v01 to v03
o Text simplifications throughout
o v02 had no meaningful changes
B.9. v00 to v01
o Added Call Home in solution for configured subscriptions.
o Clarified support for multiple subscription on a single session.
No need to support multiple create-subscription.
o Added mapping between terminology in yang-push and [RFC6241] (the
one followed in this document).
o Editorial improvements.
Authors' Addresses
Eric Voit
Cisco Systems
Email: evoit@cisco.com
Alexander Clemm
Huawei
Email: ludwig@clemm.org
Alberto Gonzalez Prieto
Microsoft
Email: alberto.gonzalez@microsoft.com
Einar Nilsen-Nygaard
Cisco Systems
Email: einarnn@cisco.com
Ambika Prasad Tripathy
Cisco Systems
Email: ambtripa@cisco.com
Voit, et al. Expires January 28, 2019 [Page 15]