idnits 2.17.1 draft-wu-netconf-base-notification-nmda-01.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 : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 9 characters in excess of 72. ** The abstract seems to contain references ([RFC8342], [RFC6470]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. -- The abstract seems to indicate that this document updates RFC6470, but the header doesn't have an 'Updates:' line to match this. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (June 19, 2018) is 2131 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) == Missing Reference: 'RFC8174' is mentioned on line 103, but not defined == Missing Reference: 'RFC7950' is mentioned on line 376, but not defined == Unused Reference: 'I-D.ietf-netconf-netconf-event-notifications' is defined on line 403, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-netconf-yang-push' is defined on line 409, but no explicit reference was found in the text == Unused Reference: 'RFC6020' is defined on line 428, but no explicit reference was found in the text == Outdated reference: A later version (-22) exists of draft-ietf-netconf-netconf-event-notifications-09 == Outdated reference: A later version (-25) exists of draft-ietf-netconf-yang-push-16 ** Obsolete normative reference: RFC 6021 (Obsoleted by RFC 6991) Summary: 3 errors (**), 0 flaws (~~), 8 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group Q. Wu 3 Internet-Draft R. Ranade 4 Intended status: Standards Track Huawei 5 Expires: December 21, 2018 June 19, 2018 7 Base Notifications for NMDA 8 draft-wu-netconf-base-notification-nmda-01 10 Abstract 12 The Network Configuration Protocol (NETCONF) provides mechanisms to 13 manipulate configuration datastores. NMDA introduces additional 14 datastores for systems that support more advanced processing chains 15 converting configuration to operational state. However, client 16 applications are not able to be aware of common events pertaining to 17 additional datstores, such as a data validation state change in 18 NETCONF server, that may impact management applications. This 19 document updates [RFC6470] to allow a NETCONF client to receive 20 additional notifications for some common system events pertaining to 21 the Network Management Datastore Architecture (NMDA) defined in 22 [RFC8342]. 24 Status of This Memo 26 This Internet-Draft is submitted in full conformance with the 27 provisions of BCP 78 and BCP 79. 29 Internet-Drafts are working documents of the Internet Engineering 30 Task Force (IETF). Note that other groups may also distribute 31 working documents as Internet-Drafts. The list of current Internet- 32 Drafts is at https://datatracker.ietf.org/drafts/current/. 34 Internet-Drafts are draft documents valid for a maximum of six months 35 and may be updated, replaced, or obsoleted by other documents at any 36 time. It is inappropriate to use Internet-Drafts as reference 37 material or to cite them other than as "work in progress." 39 This Internet-Draft will expire on December 21, 2018. 41 Copyright Notice 43 Copyright (c) 2018 IETF Trust and the persons identified as the 44 document authors. All rights reserved. 46 This document is subject to BCP 78 and the IETF Trust's Legal 47 Provisions Relating to IETF Documents 48 (https://trustee.ietf.org/license-info) in effect on the date of 49 publication of this document. Please review these documents 50 carefully, as they describe your rights and restrictions with respect 51 to this document. Code Components extracted from this document must 52 include Simplified BSD License text as described in Section 4.e of 53 the Trust Legal Provisions and are provided without warranty as 54 described in the Simplified BSD License. 56 Table of Contents 58 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 59 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 60 2. Summary of Updates to RFC 6470 . . . . . . . . . . . . . . . 3 61 3. NETCONF Base Notifications YANG Model extension for NMDA . . 3 62 3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . 3 63 3.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 5 64 4. Security Considerations . . . . . . . . . . . . . . . . . . . 8 65 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 66 6. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 9 67 7. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 9 68 8. Normative References . . . . . . . . . . . . . . . . . . . . 9 69 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 71 1. Introduction 73 The Network Configuration Protocol (NETCONF) [RFC6470] provides 74 mechanisms to manipulate configuration datastores. NMDA introduces 75 additional datastores (e.g., , ) for systems 76 that support more advanced processing chains converting configuration 77 to operational state. However, client applications are not able to 78 be aware of common events pertaining to additional datastores, e.g., 79 there are many background activities that happen during the time that 80 configuration is committed to to the time that the 81 configuration is actually applied to . It is possible 82 that some configuration could not be applied to due to 83 either validation issues, or missing resource etc. There is a need 84 for user to know the validation result of data-store and 85 the reason why the configuration were not applied. 87 This document updates [RFC6470] to allows a NETCONF client to receive 88 additional notifications for some common system events pertaining to 89 the Network Management Datastore Architecture (NMDA) defined in 90 [RFC8342]. These notification are not specific to any network 91 management protocols such as NETCONF and RESTCONF. 93 The solution presented in this document is backwards compatible with 94 [RFC6470]. 96 1.1. Terminology 98 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 99 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 100 "OPTIONAL" in this document are to be interpreted as described in BCP 101 14 [RFC2119] [RFC8174] when, and only when, they appear in all 102 capitals, as shown here. 104 The following terms are defined in [RFC8342] and are not redefined 105 here: 107 o operational state datastore 109 o running configuration datastore 111 o intended configuration datastore 113 2. Summary of Updates to RFC 6470 115 This document is intended to provide an extension of notifications 116 initially defined within [RFC6470], with the development of NMDA 117 architcture and data model. Key relationships between these two 118 documents include: 120 o The existing notifications defined in [RFC6470] are remain 121 unchanged, no additional information is added. 123 o A new event notification is defined in this document to overcome 124 the shortcoming of [RFC6470] for supporting NMDA. 126 3. NETCONF Base Notifications YANG Model extension for NMDA 128 3.1. Overview 130 The YANG module in NETCONF Base Notifications [RFC6470] specifies the 131 following 5 event notifications for the 'NETCONF' stream to notify a 132 client application that the NETCONF server state has changed: 134 o netconf-config-change 136 o netconf-capability-change 138 o netconf-session-start 140 o netconf-session-end 142 o netconf-confirmed-commit 143 These event notifications used within the 'NETCONF' stream are 144 accessible to clients via the subscription mechanism described in 145 [RFC5277]. 147 This document extends the YANG module defined in [RFC6470] to include 148 NMDA specific extension which allows a NETCONF client to receive 149 notifications for additional common system event as follows: 151 nmda-data-validate: Generated when a server with network management 152 protocol support detects that a data validation event has occurred 153 from the time that configuration is committed to to the 154 time that the configuration is actually applied to 155 during management session. Indicates the event and the current 156 state of the data validation. A server MAY report events for non- 157 NETCONF management sessions (such as RESTCONF,gPRC), using the 158 'session-id' value of zero. 160 These notification messages are accessible to clients via either the 161 subscription mechanism described in [RFC5277] or dynamic subscription 162 mechanism and configured subscription mechanism described in [I- 163 D.ietf-netconf-netconf-event-notifications]. 165 The following are examples of a nmda-data-validation notification 166 message: 168 169 2017-06-16T16:30:59.137045+09:00 170 171 admin 172 0 173 10.251.93.83 174 start 175 partial-fail 176 177 intended 178 /ietf-interfaces:interfaces-state 179 180 181 intended 182 /ietf-system:system 183 184 185 186 3.2. Definitions 188 This section presents the YANG module defined in this document. This 189 module imports data types from the 'ietf-netconf' module defined in 190 [RFC6241] and 'ietf-inet-types' module defined in [RFC6021]. 192 file "ietf-nmda-notifications@2018-04-01.yang" 193 module ietf-nmda-notifications { 194 namespace "urn:ietf:params:xml:ns:yang:ietf-nmda-notifications"; 195 prefix nmdan; 197 import ietf-datastores { 198 prefix ds; 199 } 200 import ietf-inet-types { prefix inet; } 201 organization 202 "IETF NETCONF (Network Configuration Protocol) Working Group"; 203 contact 204 "WG Web: 205 WG List: 206 WG Chair: Kent Watsen 207 208 WG Chair: Mahesh Jethanandani 209 210 Editor: Qin Wu 211 212 Editor: Rohit R Ranade 213 "; 214 description 215 "This module defines a YANG data model for use with the 216 NETCONF protocol that allows the NETCONF client to 217 receive additional common NETCONF base event notifications 218 related to NMDA. 219 Copyright (c) 2012 IETF Trust and the persons identified as 220 the document authors. All rights reserved. 221 Redistribution and use in source and binary forms, with or 222 without modification, is permitted pursuant to, and subject 223 to the license terms contained in, the Simplified BSD License 224 set forth in Section 4.c of the IETF Trust's Legal Provisions 225 Relating to IETF Documents 226 (http://trustee.ietf.org/license-info). 227 This version of this YANG module is part of RFC xxxx; see 228 the RFC itself for full legal notices."; 230 revision 2018-04-01 { 231 description 232 "Initial version."; 233 reference "RFC xxx: NETCONF Base Notifications for NMDA"; 235 } 236 typedef session-id-or-zero-type { 237 type uint32; 238 description 239 "NETCONF Session Id or Zero to indicate none"; 240 } 242 grouping common-session-parms { 243 description 244 "Common session parameters to identify a 245 management session."; 247 leaf username { 248 type string; 249 mandatory true; 250 description 251 "Name of the user for the session."; 252 } 254 leaf session-id { 255 type session-id-or-zero-type; 256 mandatory true; 257 description 258 "Identifier of the session. 259 A NETCONF session MUST be identified by a non-zero value. 260 A non-NETCONF session MAY be identified by the value zero."; 261 } 263 leaf source-host { 264 type inet:ip-address; 265 description 266 "Address of the remote host for the session."; 267 } 268 } 269 notification nmda-data-validate { 270 description 271 "Generated when a NETCONF server detects that a 272 Data validation event has occurred. Indicates the event 273 and the current state of the data validation procedure 274 in progress."; 275 reference "RFC 8342, Section 5"; 276 uses common-session-parms; 277 leaf validate-event { 278 type enumeration { 279 enum "start" { 280 description 281 "The data validate procedure has started."; 282 } 283 enum "complete" { 284 description 285 "The data validation procedure has been completed."; 286 } 287 } 288 mandatory true; 289 description 290 "Indicates the event that caused the notification."; 291 } 292 leaf validate-result { 293 when "../validate-event = 'complete'"; 294 type enumeration { 295 enum "fail" { 296 description 297 "The configuration fails to be validated 298 before being applied to , e.g., resources 299 are not available or otherwise not physically present 300 leads to the whole set of are not applied."; 301 } 302 enum "partial-fail" { 303 description 304 "The configuration partially fails to be 305 validated before being applied to ,e.g., 306 resources are not available or otherwise not physically 307 present leads to parts of are not applied"; 308 } 309 enum "success" { 310 description 311 "The configuration is successfully validated 312 before being applied to ."; 313 } 314 } 315 description 316 "Result of validate"; 317 } 318 list fail-validate-target { 319 leaf datastore { 320 type identityref { 321 base ds:datastore; 322 } 323 default "ds:operational"; 324 description 325 "Indicates which datastore has changed or which datastore is 326 target of edit-data operation."; 327 } 328 leaf target { 329 type instance-identifier; 330 description 331 "Topmost node associated with the configuration change. 332 A server SHOULD set this object to the node within 333 the datastore that is being altered. A server MAY 334 set this object to one of the ancestors of the actual 335 node that was changed, or omit this object, if the 336 exact node is not known."; 337 } 338 description 339 "List for fail validate targets"; 340 } 341 } 342 } 343 345 4. Security Considerations 347 The YANG module defined in this memo is designed to be accessed via 348 the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the 349 secure transport layer and the mandatory-to-implement secure 350 transport is SSH, defined in [RFC6242]. 352 Some of the readable data nodes in this YANG module may be considered 353 sensitive or vulnerable in some network environments. It is thus 354 important to control read access (e.g., via get, get-config, or 355 notification) to these data nodes. These are the subtrees and data 356 nodes and their sensitivity/vulnerability: 358 /nmda-data-validate/validate-event: 360 Indicates the specific validate-event state change that occurred. 361 A value of 'complete' probably indicates that data validation 362 procedure has completed. 364 5. IANA Considerations 366 This document registers one XML namespace URN in the 'IETF XML 367 registry', following the format defined in [RFC3688]: 369 URI: urn:ietf:params:xml:ns:yang:ietf-nmda-notifications 371 Registrant Contact: The IESG. 373 XML: N/A, the requested URI is an XML namespace. 375 This document registers one module name in the 'YANG Module Names' 376 registry, defined in [RFC7950]: 378 name: ietf-nmda-notifications 379 prefix: ncdn 381 namespace: urn:ietf:params:xml:ns:yang:ietf-nmda-notifications 383 RFC: xxxx 385 6. Acknowledgements 387 Thanks to Juergen Schoenwaelder, Alex Clemm,Carey Timothy and Andy 388 Berman to review this draft and provide important input to this 389 document. 391 7. Contributors 393 Xiaojian Ding 394 Huawei 395 101 Software Avenue, Yuhua District 396 Nanjing, Jiangsu 210012 397 China 399 Email: dingxiaojian1@huawei.com 401 8. Normative References 403 [I-D.ietf-netconf-netconf-event-notifications] 404 Voit, E., Clemm, A., Prieto, A., Nilsen-Nygaard, E., and 405 A. Tripathy, "NETCONF Support for Event Notifications", 406 draft-ietf-netconf-netconf-event-notifications-09 (work in 407 progress), May 2018. 409 [I-D.ietf-netconf-yang-push] 410 Clemm, A., Voit, E., Prieto, A., Tripathy, A., Nilsen- 411 Nygaard, E., Bierman, A., and B. Lengyel, "YANG Datastore 412 Subscription", draft-ietf-netconf-yang-push-16 (work in 413 progress), May 2018. 415 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 416 Requirement Levels", BCP 14, RFC 2119, 417 DOI 10.17487/RFC2119, March 1997, 418 . 420 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 421 DOI 10.17487/RFC3688, January 2004, 422 . 424 [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event 425 Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, 426 . 428 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 429 the Network Configuration Protocol (NETCONF)", RFC 6020, 430 DOI 10.17487/RFC6020, October 2010, 431 . 433 [RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types", 434 RFC 6021, DOI 10.17487/RFC6021, October 2010, 435 . 437 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 438 and A. Bierman, Ed., "Network Configuration Protocol 439 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 440 . 442 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 443 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 444 . 446 [RFC6470] Bierman, A., "Network Configuration Protocol (NETCONF) 447 Base Notifications", RFC 6470, DOI 10.17487/RFC6470, 448 February 2012, . 450 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 451 and R. Wilton, "Network Management Datastore Architecture 452 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 453 . 455 Authors' Addresses 457 Qin Wu 458 Huawei 459 101 Software Avenue, Yuhua District 460 Nanjing, Jiangsu 210012 461 China 463 Email: bill.wu@huawei.com 465 Rohit R Ranade 466 Huawei 468 Email: rohitrranade@huawei.com