idnits 2.17.1 draft-tao-netconf-data-export-capabilities-00.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 are 3 instances of too long lines in the document, the longest one being 22 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 167 has weird spacing: '...-update uni...' == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (March 3, 2020) is 1487 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) == Unused Reference: 'RFC7950' is defined on line 502, but no explicit reference was found in the text == Unused Reference: 'RFC8126' is defined on line 510, but no explicit reference was found in the text == Unused Reference: 'RFC8342' is defined on line 524, but no explicit reference was found in the text == Unused Reference: 'RFC8407' is defined on line 529, but no explicit reference was found in the text Summary: 1 error (**), 0 flaws (~~), 7 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group R. Tao 3 Internet-Draft Q. Wu 4 Intended status: Standards Track Huawei 5 Expires: September 4, 2020 L. Geng 6 China Mobile 7 March 3, 2020 9 Telemetry Data Export capability 10 draft-tao-netconf-data-export-capabilities-00 12 Abstract 14 This document proposes a YANG module for telemetry data export 15 capability which augments system Capabilities model and provide 16 additional telemetry data export attributes associated with system 17 capability for transport dependent capability negotiation. 19 Status of This Memo 21 This Internet-Draft is submitted in full conformance with the 22 provisions of BCP 78 and BCP 79. 24 Internet-Drafts are working documents of the Internet Engineering 25 Task Force (IETF). Note that other groups may also distribute 26 working documents as Internet-Drafts. The list of current Internet- 27 Drafts is at https://datatracker.ietf.org/drafts/current/. 29 Internet-Drafts are draft documents valid for a maximum of six months 30 and may be updated, replaced, or obsoleted by other documents at any 31 time. It is inappropriate to use Internet-Drafts as reference 32 material or to cite them other than as "work in progress." 34 This Internet-Draft will expire on September 4, 2020. 36 Copyright Notice 38 Copyright (c) 2020 IETF Trust and the persons identified as the 39 document authors. All rights reserved. 41 This document is subject to BCP 78 and the IETF Trust's Legal 42 Provisions Relating to IETF Documents 43 (https://trustee.ietf.org/license-info) in effect on the date of 44 publication of this document. Please review these documents 45 carefully, as they describe your rights and restrictions with respect 46 to this document. Code Components extracted from this document must 47 include Simplified BSD License text as described in Section 4.e of 48 the Trust Legal Provisions and are provided without warranty as 49 described in the Simplified BSD License. 51 Table of Contents 53 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 54 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 2 55 2. Data Export capability . . . . . . . . . . . . . . . . . . . 3 56 2.1. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . 4 57 3. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 4 58 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 59 4.1. Updates to the IETF XML Registry . . . . . . . . . . . . 9 60 4.2. Updates to the YANG Module Names Registry . . . . . . . . 10 61 5. Security Considerations . . . . . . . . . . . . . . . . . . . 10 62 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 11 63 6.1. Normative References . . . . . . . . . . . . . . . . . . 11 64 6.2. Informative References . . . . . . . . . . . . . . . . . 12 65 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12 67 1. Introduction 69 Notification capability model defined in [I-D.netconf-notification- 70 capabilities] allows a client to discover a set of capabilities 71 supported by the server (e.g., basic system capability and YANG-Push 72 related capabilities) both at implementation-time and run- time. 73 These "capabilities" permit the client to adjust its behavior to take 74 advantage of the features exposed by the device. 76 However pre-configuration for some transport specific parameters 77 (e.g., transport protocol, encoding format, encryption by the client 78 is still inevitable, which may cause unexpected failure and 79 additional message exchange between client and server. 81 This document proposes a YANG module for telemetry data export 82 capability which augments System Capabilities model and provide 83 additional data export attributes for transport dependent capability 84 negotiation. 86 1.1. Terminology 88 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 89 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 90 "OPTIONAL" in this document are to be interpreted as described in BCP 91 14 [RFC2119] [RFC8174] when, and only when, they appear in all 92 capitals, as shown here. 94 2. Data Export capability 96 The YANG module ietf-notification-capabilities defined in [I- 97 D.netconf-notification-capabilities] specify the following server 98 capabilities related to YANG Push: 100 o A set of capabilities related to the amount of notifications the 101 server can send out 103 o Specification of which data nodes support on-change notifications. 105 o Capability values can be specified on server level, datastore 106 level or on specific data nodes (and their contained sub-tree) of 107 a specific datastore. Capability values on a smaller, more 108 specific part of the server's data always override more generic 109 values. 111 o On-change capability is not specified on a server level as 112 different datastores usually have different on-change 113 capabilities. On a datastore level on-change capability for 114 configuration and state data can be specified separately. 116 These server capabilities are transport independent and session level 117 capabilities and can be provided either at implementation time or 118 reported at run time. 120 This document augments system Capabilities model and provides 121 additional data export attributes associated with system 122 capabilities: 124 o Specification of transport protocol the client can use to 125 establish transport connection; 127 o Specification of encoding selection(e.g., XML or JSON, to binary) 128 of Data Modeled with YANG; 130 o Specification of secure transport mechanisms that are needed by 131 the client to communicate with the server; 133 o Specification of the type of data compression algorithm (e.g., 134 lossless data compression) the client can use for file compression 135 and decompression 137 o Specification of Maximum number of data nodes that can be sent in 138 a group of data node with the same characteristics; 140 o Specification of the number of sensors group. A sensor group 141 represents a resuable grouping of multiple paths and exclude 142 filters. 144 o Specification of the notification message encapsulation type, 145 either one notification per message or multiple notifications per 146 message. 148 o Specification of the type of subscription, e.g., periodic 149 subscrption, on-change subscription, bulk subscription, adaptive 150 subscription. 152 o Specification of the time length of sampling interval. 154 2.1. Tree Diagram 156 The following tree diagram [RFC8340] provides an overview of the data 157 model. 159 module: ietf-data-export-capabilities 160 augment /sysc:system-capabilities: 161 +--ro data-export-capabilities 162 +--ro transport-protocol transport-protocol 163 +--ro encoding-format encoding-format 164 +--ro secure-transport secure-transport 165 +--ro compression-mode compression-mode 166 +--ro max-nodes-per-sensor-group unint32 167 +--ro max-sensor-group-per-update unint32 168 augment /sysc:system-capabilities/inc:subscription-capabilities: 169 +--ro message-bundling-support boolean 170 +--ro subscription-mode subscription-mode 171 augment /sysc:system-capabilities/sysc:datastore-capabilities/ + 172 sysc:per-node-capabilities: 173 +--ro sampling-interval* centiseconds 174 +--ro threshold-support boolean 176 3. YANG Module 178 file "ietf-data-export-capabilities.yang" 179 module ietf-data-export-capabilities { 180 yang-version 1.1; 181 namespace urn:ietf:params:xml:ns:yang:ietf-notification-data-export-capabilities; 182 prefix dec; 183 import ietf-system-capabilities { prefix sysc ; } 184 import ietf-notification-capabilities { prefix inc; } 185 organization 186 "IETF NETCONF (Network Configuration) Working Group"; 187 contact 188 "WG Web: 189 WG List: 190 Editor: Ran Tao 191 192 Qin Wu 193 410 4. IANA Considerations 412 4.1. Updates to the IETF XML Registry 414 This document registers a URI in the "IETF XML Registry" [RFC3688]. 415 Following the format in [RFC3688], the following registration has 416 been made: 418 URI: 419 urn:ietf:params:xml:ns:yang:ietf-data-export-capabilities 420 Registrant Contact: 421 The IESG. 422 XML: 423 N/A; the requested URI is an XML namespace. 425 4.2. Updates to the YANG Module Names Registry 427 This document registers one YANG module in the "YANG Module Names" 428 registry [RFC6020]. Following the format in [RFC6020], the following 429 registration has been made: 431 name: 432 ietf-data-export-capabilities 433 namespace: 434 urn:ietf:params:xml:ns:yang:ietf-data-export-capabilities 435 prefix: 436 dec 437 reference: 438 RFC XXXX (RFC Ed.: replace XXX with actual RFC number and remove 439 this note.) 441 5. Security Considerations 443 The YANG module specified in this document defines a schema for data 444 that is designed to be accessed via network management protocols such 445 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 446 is the secure transport layer, and the mandatory-to-implement secure 447 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 448 is HTTPS, and the mandatory-to-implement secure transport is TLS 449 [RFC8446]. 451 The NETCONF Configuration Access Control Model (NACM) [RFC8341] 452 provides the means to restrict access for particular NETCONF or 453 RESTCONF users to a preconfigured subset of all available NETCONF or 454 RESTCONF protocol operations and content. 456 There are a number of data nodes defined in this YANG module that are 457 writable/creatable/deletable (i.e., config true, which is the 458 default). These data nodes may be considered sensitive in some 459 network environments. Write operations (e.g., edit-config) to these 460 data nodes without proper protection can have a negative effect on 461 network operations. These are the subtrees and data nodes and their 462 sensitivity/vulnerability: 464 o /sysc:system-capabilities/dec:transport-protocol 466 o /sysc:system-capabilities/dec:encoding-format 468 o /sysc:system-capabilities/dec:secure-transport 470 o /sysc:system-capabilities/dec:compression-mode 472 o /sysc:system-capabilities/dec:max-nodes-per-sensor-group 473 o /sysc:system-capabilities/dec:sensor-group-count 475 o /sysc:system-capabilities/inc:subscription-capabilities/ 476 dec:message-bundling-support 478 o /sysc:system-capabilities/inc:subscription-capabilities/ 479 dec:subscription-mode 481 o /sysc:system-capabilities/sysc:datastore-capabilities/sysc:per- 482 node-capabilities/dec:sampling-interval 484 6. References 486 6.1. Normative References 488 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 489 Requirement Levels", BCP 14, RFC 2119, 490 DOI 10.17487/RFC2119, March 1997, 491 . 493 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 494 and A. Bierman, Ed., "Network Configuration Protocol 495 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 496 . 498 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 499 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 500 . 502 [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", 503 RFC 7950, DOI 10.17487/RFC7950, August 2016, 504 . 506 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 507 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 508 . 510 [RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for 511 Writing an IANA Considerations Section in RFCs", BCP 26, 512 RFC 8126, DOI 10.17487/RFC8126, June 2017, 513 . 515 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 516 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 517 May 2017, . 519 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 520 Access Control Model", STD 91, RFC 8341, 521 DOI 10.17487/RFC8341, March 2018, 522 . 524 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 525 and R. Wilton, "Network Management Datastore Architecture 526 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 527 . 529 [RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of 530 Documents Containing YANG Data Models", BCP 216, RFC 8407, 531 DOI 10.17487/RFC8407, October 2018, 532 . 534 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 535 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 536 . 538 6.2. Informative References 540 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 541 DOI 10.17487/RFC3688, January 2004, 542 . 544 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 545 the Network Configuration Protocol (NETCONF)", RFC 6020, 546 DOI 10.17487/RFC6020, October 2010, 547 . 549 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 550 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 551 . 553 Authors' Addresses 555 Ran Tao 556 Huawei 557 101 Software Avenue, Yuhua District 558 Nanjing, Jiangsu 210012 559 China 561 Email: taoran20@huawei.com 562 Qin Wu 563 Huawei 564 101 Software Avenue, Yuhua District 565 Nanjing, Jiangsu 210012 566 China 568 Email: bill.wu@huawei.com 570 Liang Geng 571 China Mobile 572 32 Xuanwumen West St, Xicheng District 573 Beijing 10053 575 Email: gengliang@chinamobile.com