idnits 2.17.1
draft-ranade-netmod-yang-push-extension-02.txt:
Checking boilerplate required by RFC 5378 and the IETF Trust (see
https://trustee.ietf.org/license-info):
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/checklist :
----------------------------------------------------------------------------
No issues found here.
Miscellaneous warnings:
----------------------------------------------------------------------------
== The copyright year in the IETF Trust and authors Copyright Line does not
match the current year
== The document doesn't use any RFC 2119 keywords, yet seems to have RFC
2119 boilerplate text.
-- The document date (Feb 05, 2019) is 1907 days in the past. Is this
intentional?
Checking references for intended status: Proposed Standard
----------------------------------------------------------------------------
(See RFCs 3967 and 4897 for information about using normative references
to lower-maturity documents in RFCs)
-- Looks like a reference, but probably isn't: '1' on line 424
== Missing Reference: 'RFC6020' is mentioned on line 338, but not defined
== Outdated reference: A later version (-25) exists of
draft-ietf-netconf-yang-push-21
Summary: 0 errors (**), 0 flaws (~~), 4 warnings (==), 2 comments (--).
Run idnits with the --verbose option for more detailed information about
the items above.
--------------------------------------------------------------------------------
2 NETMOD Working Group R. Ranade
3 Internet-Draft Huawei
4 Intended status: Standards Track Feb 05, 2019
5 Expires: August 9, 2019
7 Extensions to Yang Push
8 draft-ranade-netmod-yang-push-extension-02
10 Abstract
12 This document defines extensions to the yang push subscription
13 mechanism, which can provide more granularity in tracking
14 configuration changes in datastores.
16 Status of This Memo
18 This Internet-Draft is submitted in full conformance with the
19 provisions of BCP 78 and BCP 79.
21 Internet-Drafts are working documents of the Internet Engineering
22 Task Force (IETF). Note that other groups may also distribute
23 working documents as Internet-Drafts. The list of current Internet-
24 Drafts is at https://datatracker.ietf.org/drafts/current/.
26 Internet-Drafts are draft documents valid for a maximum of six months
27 and may be updated, replaced, or obsoleted by other documents at any
28 time. It is inappropriate to use Internet-Drafts as reference
29 material or to cite them other than as "work in progress."
31 This Internet-Draft will expire on August 9, 2019.
33 Copyright Notice
35 Copyright (c) 2019 IETF Trust and the persons identified as the
36 document authors. All rights reserved.
38 This document is subject to BCP 78 and the IETF Trust's Legal
39 Provisions Relating to IETF Documents
40 (https://trustee.ietf.org/license-info) in effect on the date of
41 publication of this document. Please review these documents
42 carefully, as they describe your rights and restrictions with respect
43 to this document. Code Components extracted from this document must
44 include Simplified BSD License text as described in Section 4.e of
45 the Trust Legal Provisions and are provided without warranty as
46 described in the Simplified BSD License.
48 Table of Contents
50 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
51 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 2
52 2. Yang Push Subscription Extensions . . . . . . . . . . . . . . 3
53 2.1. Config Filter . . . . . . . . . . . . . . . . . . . . . . 3
54 2.2. Origin Metadata Attribute . . . . . . . . . . . . . . . . 3
55 3. Examples of usage . . . . . . . . . . . . . . . . . . . . . . 3
56 4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 5
57 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8
58 6. Security Considerations . . . . . . . . . . . . . . . . . . . 8
59 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 9
60 7.1. Normative References . . . . . . . . . . . . . . . . . . 9
61 7.2. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 10
62 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 10
64 1. Introduction
66 The subscription mechanism defined in yang-push draft
67 [I-D.ietf-netconf-yang-push] supports a subscription mechanism where
68 datastore and its datanodes can be provided as targets. However
69 there are a few scenarios where a subscription to datanodes may not
70 be sufficient.
72 o An application on the client, may want to track the configuration
73 changes in a particular module. If a module contains "config
74 true" mixed with "config false" nodes, setting up a filter which
75 targets only "config true" nodes at multiple levels will be
76 cumbersome.
78 o An application on the client, may want to track the origin of the
79 recently applied configuration. Yang-push subscription currently
80 does not provide such control.
82 1.1. Terminology
84 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
85 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
86 "OPTIONAL" in this document are to be interpreted as described in BCP
87 14 [RFC2119] [RFC8174] when, and only when, they appear in all
88 capitals, as shown here.
90 The following terms are defined in [RFC8342] and are not redefined
91 here:
93 o operational state datastore
95 o intended configuration datastore
97 2. Yang Push Subscription Extensions
99 There are two new filter nodes added to the Yang push subscription
100 mechanism. They are listed below.
102 o config-filter
104 o with-origin
106 2.1. Config Filter
108 This is a filter for nodes with the given value for their 'config'
109 property. When this leaf is set to 'true', only 'config true' nodes
110 are selected and, when set to 'false', only 'config false' nodes are
111 selected. If this leaf is not present, this filter is not applied.
113 2.2. Origin Metadata Attribute
115 This document defines the "with-origin" parameter, which if present,
116 requests that the server includes "origin" metadata annotations as
117 defined in [RFC8342] in notifications which are part of this
118 subscription. This parameter is only valid for the operational state
119 datastore and any datastores with identities derived from the
120 "operational" identity. Otherwise, if an invalid datastore is
121 specified then a suitable error is returned.
123 Data in the operational state datastore can come from multiple
124 sources. The server should return the most accurate value for the
125 "origin" metadata annotation as possible, indicating the source of
126 the operational value, as specified in Section 5.3.4 of RFC8342 [1]
128 When encoding the origin metadata annotation for a hierarchy of
129 returned nodes, the annotation may be omitted for a child node when
130 the value matches that of the parent node, as described in the "ietf-
131 origin" YANG module [RFC8342].
133 The "with-origin" parameter is optional to support. It is identified
134 with the feature "origin".
136 3. Examples of usage
138 In this example, the following fictional module is used:
140 module example-interface {
141 yang-version 1.1;
142 namespace urn:example:interface;
143 prefix int;
145 import ietf-inet-types {
146 prefix inet;
147 }
149 container interface {
150 leaf name{
151 type string;
152 }
154 leaf speed{
155 type string;
156 config false;
157 }
158 }
159 }
161 A subscription on the "config true" nodes of the operational state
162 datastore. This subscription also requests to get the origin of the
163 datanodes as part of Yang-push notifications. This is considering
164 that the NETCONF protocol was used for this subscription.
166
167
171 operational
172 true
173
174
175
177 The operator has configured an interface ("eth1"), the system has
178 recognised an interface ("eth0") which was plugged in recently. The
179 below NETCONF notification is an example for a yang-push notification
180 when the device applies the "eth0" configuration.
182
184 2019-01-25T08:00:11.22Z
185
188 10
189
190
191 1
192
193 edit1
194 create
195 /example-interface:interface
196
197
199 eth0
200
201
202
203
204
205
207 4. YANG Module
209 file "ietf-yang-push-ext@2019-02-01.yang"
210 module ietf-yang-push-ext {
211 yang-version 1.1;
212 namespace "urn:ietf:params:xml:ns:yang:ietf-yang-push-ext";
213 prefix ypext;
215 import ietf-subscribed-notifications {
216 prefix sn;
217 }
219 import ietf-yang-push {
220 prefix yp;
221 }
223 import ietf-datastores {
224 prefix ds;
225 reference "RFC 8342: Network Management Datastore Architecture.";
226 }
228 organization
229 "IETF NETMOD (Network Modeling) Working Group";
231 contact
232 "WG Web:
233 WG List:
234 WG Chair: Kent Watsen
235
237 Editor: Rohit Ranade
238 ";
240 description
241 "This module defines extensions to subscription mechanism
242 to yang-push on operational state datastore.
244 Copyright (c) 2019 IETF Trust and the persons identified as
245 authors of the code. All rights reserved.
247 Redistribution and use in source and binary forms, with or
248 without modification, is permitted pursuant to, and subject to
249 the license terms contained in, the Simplified BSD License set
250 forth in Section 4.c of the IETF Trust's Legal Provisions
251 Relating to IETF Documents
252 (https://trustee.ietf.org/license-info).
254 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
255 NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and
256 'OPTIONAL' in the module text are to be interpreted as described
257 in RFC 2119 (https://tools.ietf.org/html/rfc2119).
259 This version of this YANG module is part of RFC XXXX
260 (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for
261 full legal notices.";
263 revision 2019-02-01 {
264 description
265 "Initial revision.";
266 reference "RFCXXXX";
267 }
269 feature origin {
270 description
271 "Indicates that the server supports the 'origin' annotation.";
272 reference
273 "RFC 8342: Network Management Datastore Architecture";
274 }
276 grouping subscription-filter-extension{
277 description
278 "This grouping describes the extensions to subscription
279 conditions.";
280 leaf config-filter {
281 type boolean;
282 description
283 "Filter for nodes with the given value for their 'config'
284 property. When this leaf is set to 'true', only 'config
285 true' nodes are selected and, when set to 'false', only
286 'config false' nodes are selected. If this leaf is not
287 present, this filter is not applied.";
288 }
290 leaf with-origin {
291 when 'derived-from-or-self(../yp:datastore, "ds:operational")';
292 if-feature origin;
293 type empty;
294 description
295 "If this parameter is present, the server will return
296 the 'origin' annotation for the nodes that has one.";
297 }
298 }
300 augment "/sn:establish-subscription/sn:input/sn:target"
301 + "/yp:datastore" {
302 description
303 "This augmentation adds the filter extensions for the
304 subscription to RPC input.";
305 uses subscription-filter-extension;
306 }
308 augment "/sn:modify-subscription/sn:input/sn:target"
309 + "/yp:datastore" {
310 description
311 "This augmentation adds the filter extensions for the
312 subscription to RPC input.";
313 uses subscription-filter-extension;
314 }
316 augment "/sn:subscriptions/sn:subscription/sn:target"
317 + "/yp:datastore" {
318 description
319 "This augmentation adds the filter extensions to
320 selection filtering criteria.";
321 uses subscription-filter-extension;
322 }
323 }
324
326 5. IANA Considerations
328 This document registers one URI in the IETF XML Registry [RFC3688].
329 The following registration has been made:
331 URI: urn:ietf:params:xml:ns:yang:ietf-yang-push-ext
333 Registrant Contact: The IESG.
335 XML: N/A, the requested URI is an XML namespace.
337 This document registers one YANG module in the YANG Module Names
338 Registry [RFC6020]. The following registration has been made:
340 name: ietf-yang-push-ext
342 namespace: urn:ietf:params:xml:ns:yang:ietf-yang-push-ext
344 prefix: ypext
346 RFC: xxxx
348 6. Security Considerations
350 The YANG module specified in this document defines a schema for data
351 that is designed to be accessed via network management protocols such
352 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
353 is the secure transport layer, and the mandatory-to-implement secure
354 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
355 is HTTPS, and the mandatory-to-implement secure transport is TLS
356 [RFC8446].
358 The Network Configuration Access Control Model (NACM) [RFC8341]
359 provides the means to restrict access for particular NETCONF or
360 RESTCONF users to a preconfigured subset of all available NETCONF or
361 RESTCONF protocol operations and content.
363 The origin metadata annotation exposes the origin of values in the
364 applied configuration. Origin information may provide hints that
365 certain control-plane protocols are active on a device. Since origin
366 information is tied to applied configuration values, it is only
367 accessible to clients that have the permissions to read the applied
368 configuration values. Security administrators should consider the
369 sensitivity of origin information while defining access control
370 rules.
372 7. References
374 7.1. Normative References
376 [I-D.ietf-netconf-yang-push]
377 Clemm, A., Voit, E., Prieto, A., Tripathy, A., Nilsen-
378 Nygaard, E., Bierman, A., and B. Lengyel, "Subscription to
379 YANG Datastores", draft-ietf-netconf-yang-push-21 (work in
380 progress), January 2019.
382 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
383 Requirement Levels", BCP 14, RFC 2119,
384 DOI 10.17487/RFC2119, March 1997,
385 .
387 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
388 DOI 10.17487/RFC3688, January 2004,
389 .
391 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
392 and A. Bierman, Ed., "Network Configuration Protocol
393 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
394 .
396 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
397 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
398 .
400 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
401 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
402 .
404 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
405 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
406 May 2017, .
408 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
409 Access Control Model", STD 91, RFC 8341,
410 DOI 10.17487/RFC8341, March 2018,
411 .
413 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
414 and R. Wilton, "Network Management Datastore Architecture
415 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
416 .
418 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
419 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
420 .
422 7.2. URIs
424 [1] https://tools.ietf.org/html/rfc8342#section-5.3.4
426 Author's Address
428 Rohit R Ranade
429 Huawei
430 Divyashree Techno Park, Whitefield
431 Bangalore, Karnataka 560066
432 India
434 Email: rohitrranade@huawei.com