idnits 2.17.00 (12 Aug 2021) /tmp/idnits28567/draft-wwlh-netconf-list-pagination-nc-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: ---------------------------------------------------------------------------- == There is 1 instance of lines with non-ascii characters in the document. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The abstract seems to contain references ([I-D.wwlh-netconf-list-pagination], [RFC6241], [RFC8526]), 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 RFC6241, 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 (25 October 2021) is 201 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) -- No information found for draft-wwlh-netconf-list-pagination - is the name correct? -- Possible downref: Normative reference to a draft: ref. 'I-D.wwlh-netconf-list-pagination' Summary: 1 error (**), 0 flaws (~~), 2 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETCONF Working Group K. Watsen 3 Internet-Draft Watsen Networks 4 Intended status: Standards Track Q. Wu 5 Expires: 28 April 2022 Huawei 6 O. Hagsand 7 Netgate 8 H. Li 9 HPE 10 P. Andersson 11 Cisco Systems 12 25 October 2021 14 NETCONF Extensions to Support List Pagination 15 draft-wwlh-netconf-list-pagination-nc-02 17 Abstract 19 This document defines a mapping of the list pagination mechanism 20 defined in [I-D.wwlh-netconf-list-pagination] to NETCONF [RFC6241]. 22 This document updates [RFC6241], to augment the and "rpc" statements, and [RFC8526], to augment the 24 "rpc" statement, to define input parameters necessary for list 25 pagination. 27 Status of This Memo 29 This Internet-Draft is submitted in full conformance with the 30 provisions of BCP 78 and BCP 79. 32 Internet-Drafts are working documents of the Internet Engineering 33 Task Force (IETF). Note that other groups may also distribute 34 working documents as Internet-Drafts. The list of current Internet- 35 Drafts is at https://datatracker.ietf.org/drafts/current/. 37 Internet-Drafts are draft documents valid for a maximum of six months 38 and may be updated, replaced, or obsoleted by other documents at any 39 time. It is inappropriate to use Internet-Drafts as reference 40 material or to cite them other than as "work in progress." 42 This Internet-Draft will expire on 28 April 2022. 44 Copyright Notice 46 Copyright (c) 2021 IETF Trust and the persons identified as the 47 document authors. All rights reserved. 49 This document is subject to BCP 78 and the IETF Trust's Legal 50 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 51 license-info) in effect on the date of publication of this document. 52 Please review these documents carefully, as they describe your rights 53 and restrictions with respect to this document. Code Components 54 extracted from this document must include Simplified BSD License text 55 as described in Section 4.e of the Trust Legal Provisions and are 56 provided without warranty as described in the Simplified BSD License. 58 Table of Contents 60 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 61 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 62 1.2. Conventions . . . . . . . . . . . . . . . . . . . . . . . 3 63 2. Updates to NETCONF operations . . . . . . . . . . . . . . . . 3 64 2.1. Updates to RFC 6241 . . . . . . . . . . . . . . . . . . . 3 65 2.2. Updates to RFC 8526 . . . . . . . . . . . . . . . . . . . 3 66 3. List Pagination for NETCONF . . . . . . . . . . . . . . . . . 3 67 4. Error Reporting . . . . . . . . . . . . . . . . . . . . . . . 4 68 5. YANG Module for List Pagination in NETCONF . . . . . . . . . 5 69 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 70 6.1. The "IETF XML" Registry . . . . . . . . . . . . . . . . . 7 71 6.2. The "YANG Module Names" Registry . . . . . . . . . . . . 7 72 7. Security Considerations . . . . . . . . . . . . . . . . . . . 8 73 7.1. The "ietf-netconf-list-pagination" YANG Module . . . . . 8 74 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 75 8.1. Normative References . . . . . . . . . . . . . . . . . . 8 76 8.2. Informative References . . . . . . . . . . . . . . . . . 9 77 Appendix A. Open Issues . . . . . . . . . . . . . . . . . . . . 10 78 Appendix B. Example YANG Module . . . . . . . . . . . . . . . . 10 79 Appendix C. Example Data Set . . . . . . . . . . . . . . . . . . 10 80 Appendix D. Example Queries . . . . . . . . . . . . . . . . . . 10 81 D.1. List pagination with all query parameters . . . . . . . . 10 82 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 12 83 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 12 85 1. Introduction 87 This document defines a mapping of the list pagination mechanism 88 defined in [I-D.wwlh-netconf-list-pagination] to NETCONF [RFC6241]. 90 This document updates [RFC6241] and [RFC8526], as described in 91 Section 2. 93 While the pagination mechanism defined in this document is designed 94 for the NETCONF protocol [RFC6241], the augmented RPCs MAY be used by 95 the RESTCONF protocol [RFC8040] if the RESTCONF server implements the 96 "ietf-list-pagination-nc" module. 98 The YANG data model in this document conforms to the Network 99 Management Datastore Architecture defined in [RFC8342] 101 1.1. Terminology 103 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 104 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 105 "OPTIONAL" in this document are to be interpreted as described in BCP 106 14 [RFC2119] [RFC8174] when, and only when, they appear in all 107 capitals, as shown here. 109 1.2. Conventions 111 Various examples used in this document use a placeholder value for 112 binary data that has been base64 encoded (e.g., "BASE64VALUE="). 113 This placeholder value is used as real base64 encoded structures are 114 often many lines long and hence distracting to the example being 115 presented. 117 2. Updates to NETCONF operations 119 2.1. Updates to RFC 6241 121 The and rpc statements are augmented to accept 122 additional input parameters, as described in Section 3. 124 2.2. Updates to RFC 8526 126 The rpc statement is augmented to accept additional input 127 parameters, as described in in Section 3. 129 3. List Pagination for NETCONF 131 In order for NETCONF to support [I-D.wwlh-netconf-list-pagination], 132 this document extends the operations , and to include additional input parameters and output annotations. 135 The updated operations accept a content filter parameter, similar to 136 the "filter" parameter of , but includes nodes for "list" 137 and "leaf-list" filtering. 139 The content filter parameter is used to specify the YANG list or 140 leaf-list that is to be retrieved. This must be a path expression 141 used to represent a list or leaf-list data node. 143 The following tree diagram [RFC8340] illustrates the "ietf-netconf- 144 list-pagination" module: 146 module: ietf-list-pagination-nc 148 augment /nc:get/nc:input: 149 +---w list-pagination 150 +---w where? union 151 +---w sort-by? union 152 +---w direction? enumeration 153 +---w offset? uint32 154 +---w limit? union 155 +---w sublist-limit? union 156 augment /nc:get-config/nc:input: 157 +---w list-pagination 158 +---w where? union 159 +---w sort-by? union 160 +---w direction? enumeration 161 +---w offset? uint32 162 +---w limit? union 163 +---w sublist-limit? union 164 augment /ncds:get-data/ncds:input: 165 +---w list-pagination 166 +---w where? union 167 +---w sort-by? union 168 +---w direction? enumeration 169 +---w offset? uint32 170 +---w limit? union 171 +---w sublist-limit? union 173 Comments: 175 * This module augments three NETCONF "rpc" statements: get, get- 176 config, and get-data. 178 * The "get" and "get-config" augments are against the YANG module 179 defined in [RFC6241]. The "get-data" augment is against the YANG 180 module defined in [RFC8526]. 182 4. Error Reporting 184 When an input query parameter is supplied with an erroneous value, an 185 MUST be returned containing the error-type value 186 "application", the error-tag value "invalid-value", and MAY include 187 the error-severity value "error". Additionally the error-app-tag 188 SHOULD be set containing query parameter specific error value. 190 4.1. The "offset" Query Parameter 192 If the "offset" query parameter value supplied is larger then the 193 number of instances in the list or leaf-list target resource, the 194 MUST contain error-app-tag with value "offset-out-of- 195 range". 197 5. YANG Module for List Pagination in NETCONF 199 The "ietf-netconf-list-pagination-nc" module defines conceptual 200 definitions within groupings, which are not meant to be implemented 201 as datastore contents by a server. 203 This module has normative references to [RFC6241], [RFC6243], 204 [RFC6991], and [RFC8342]. 206 file "ietf-list-pagination-nc@2021-10-25.yang" 208 module ietf-list-pagination-nc { 209 yang-version 1.1; 210 namespace "urn:ietf:params:xml:ns:yang:ietf-list-pagination-nc"; 211 prefix lpgnc; 213 import ietf-netconf { 214 prefix nc; 215 reference 216 "RFC 6241: Network Configuration Protocol (NETCONF)"; 217 } 219 import ietf-netconf-nmda { 220 prefix ncds; 221 reference 222 "RFC 8526: NETCONF Extensions to Support the 223 Network Management Datastore Architecture"; 224 } 226 import ietf-list-pagination { 227 prefix lp; 228 reference 229 "RFC XXXX: List Pagination for YANG-driven Protocols"; 230 } 232 organization 233 "IETF NETCONF (Network Configuration) Working Group"; 235 contact 236 "WG Web: 237 WG List: "; 239 description 240 "This module augments the , , and 241 'rpc' statements to support list pagination. 243 Copyright (c) 2021 IETF Trust and the persons identified 244 as authors of the code. All rights reserved. 246 Redistribution and use in source and binary forms, with 247 or without modification, is permitted pursuant to, and 248 subject to the license terms contained in, the Simplified 249 BSD License set forth in Section 4.c of the IETF Trust's 250 Legal Provisions Relating to IETF Documents 251 (https://trustee.ietf.org/license-info). 253 This version of this YANG module is part of RFC XXXX 254 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC 255 itself for full legal notices. 257 The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 258 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 259 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document 260 are to be interpreted as described in BCP 14 (RFC 2119) 261 (RFC 8174) when, and only when, they appear in all 262 capitals, as shown here."; 264 revision 2021-10-25 { 265 description 266 "Initial revision."; 267 reference 268 "RFC XXXX: NETCONF Extensions to Support List Pagination"; 269 } 271 grouping pagination-parameters { 272 description "A grouping for list pagination parameters."; 273 container list-pagination { 274 description "List pagination parameters."; 275 uses lp:where-param-grouping; 276 uses lp:sort-by-param-grouping; 277 uses lp:direction-param-grouping; 278 uses lp:offset-param-grouping; 279 uses lp:limit-param-grouping; 280 uses lp:sublist-limit-param-grouping; 281 } 282 } 284 augment "/nc:get/nc:input" { 285 description 286 "Allow the 'get' operation to use content filter 287 parameter for specifying the YANG list or leaf-list 288 that is to be retrieved"; 289 uses pagination-parameters; 290 } 292 augment "/nc:get-config/nc:input" { 293 description 294 "Allow the 'get-config' operation to use content filter 295 parameter for specifying the YANG list or leaf-list 296 that is to be retrieved"; 297 uses pagination-parameters; 298 } 300 augment "/ncds:get-data/ncds:input" { 301 description 302 "Allow the 'get-data' operation to use content filter 303 parameter for specifying the YANG list or leaf-list 304 that is to be retrieved"; 305 uses pagination-parameters; 306 } 307 } 309 311 6. IANA Considerations 313 6.1. The "IETF XML" Registry 315 This document registers one URI in the "ns" subregistry of the IETF 316 XML Registry [RFC3688] maintained at 317 https://www.iana.org/assignments/xml-registry/xml-registry.xhtml#ns. 318 Following the format in [RFC3688], the following registration is 319 requested: 321 URI: urn:ietf:params:xml:ns:yang:ietf-list-pagination-nc 322 Registrant Contact: The IESG. 323 XML: N/A, the requested URI is an XML namespace. 325 6.2. The "YANG Module Names" Registry 327 This document registers one YANG module in the YANG Module Names 328 registry [RFC6020] maintained at https://www.iana.org/assignments/ 329 yang-parameters/yang-parameters.xhtml. Following the format defined 330 in [RFC6020], the below registration is requested: 332 name: ietf-list-pagination-nc 333 namespace: urn:ietf:params:xml:ns:yang:ietf-list-pagination-nc 334 prefix: pgnc 335 RFC: XXXX 337 7. Security Considerations 339 7.1. The "ietf-netconf-list-pagination" YANG Module 341 The YANG module defined in this document extends the base operations 342 for NETCONF [RFC6241] and RESTCONF [RFC8040]. The lowest NETCONF 343 layer is the secure transport layer, and the mandatory-to-implement 344 secure transport is Secure Shell (SSH) [RFC6242]. The lowest 345 RESTCONF layer is HTTPS, and the mandatory-to-implement secure 346 transport is TLS [RFC8446]. 348 The Network Configuration Access Control Model (NACM) [RFC8341] 349 provides the means to restrict access for particular NETCONF users to 350 a preconfigured subset of all available NETCONF protocol operations 351 and content. 353 The security considerations for the base NETCONF protocol operations 354 (see Section 9 of [RFC6241] apply to the new 355 RPC operations defined in this document. 357 8. References 359 8.1. Normative References 361 [I-D.wwlh-netconf-list-pagination] 362 "List Pagination...", . 364 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 365 Requirement Levels", BCP 14, RFC 2119, 366 DOI 10.17487/RFC2119, March 1997, 367 . 369 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 370 DOI 10.17487/RFC3688, January 2004, 371 . 373 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 374 the Network Configuration Protocol (NETCONF)", RFC 6020, 375 DOI 10.17487/RFC6020, October 2010, 376 . 378 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 379 and A. Bierman, Ed., "Network Configuration Protocol 380 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 381 . 383 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 384 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 385 . 387 [RFC6243] Bierman, A. and B. Lengyel, "With-defaults Capability for 388 NETCONF", RFC 6243, DOI 10.17487/RFC6243, June 2011, 389 . 391 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 392 RFC 6991, DOI 10.17487/RFC6991, July 2013, 393 . 395 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 396 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 397 May 2017, . 399 [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration 400 Access Control Model", STD 91, RFC 8341, 401 DOI 10.17487/RFC8341, March 2018, 402 . 404 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 405 and R. Wilton, "Network Management Datastore Architecture 406 (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, 407 . 409 [RFC8526] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 410 and R. Wilton, "NETCONF Extensions to Support the Network 411 Management Datastore Architecture", RFC 8526, 412 DOI 10.17487/RFC8526, March 2019, 413 . 415 8.2. Informative References 417 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 418 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 419 . 421 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", 422 BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, 423 . 425 [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol 426 Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, 427 . 429 Appendix A. Open Issues 431 Cursors (i.e.,stable result sets) are related to the topic of dynamic 432 changing lists between two queries. How cursors can be supported 433 using "feature"? 435 Appendix B. Example YANG Module 437 The examples within this document use the "example-social" YANG 438 module defined in Appendix A.1 of [I-D.wwlh-netconf-list-pagination]. 440 Appendix C. Example Data Set 442 The Example Data Set used by the examples is defined in Appendix A.2 443 of [I-D.wwlh-netconf-list-pagination]. 445 Appendix D. Example Queries 447 D.1. List pagination with all query parameters 449 This example mimics that Appendix A.3.7 of 450 [I-D.wwlh-netconf-list-pagination]. 452 =============== NOTE: '\' line wrapping per RFC 8792 ================ 454 455 456 457 458 459 461 true 464 //stats//joined[starts-with(@timestamp,'2020')] 465 timestamp 466 backwards 467 2 468 2 469 1 470 471 472 473 Response from the NETCONF server: 475 =============== NOTE: '\' line wrapping per RFC 8792 ================ 477 480 481 eric 482 eric@example.com 483 $0$1543 484 BASE64VALUE= 485 Go to bed with dreams; wake up with a purpose. 486 alice 487 488 489 2020-09-17T18:02:04Z 490 Son, brother, husband, father 491 What's your story? 492 493 494 495 two 496 497 498 2020-09-17T19:38:32Z 499 pro 500 2020-09-17T18:02:04Z 501 502 503 504 bob 505 bob@example.com 506 $0$1543 507 BASE64VALUE= 508 Here and now, like never before. 509 510 511 2020-08-14T03:32:25Z 512 Just got in. 513 514 515 516 3.14159 517 518 519 2020-08-14T03:30:00Z 520 standard 521 2020-08-14T03:34:30Z 522 523 524 526 Acknowledgements 528 This work has benefited from the discussions of RESTCONF resource 529 collection over the years, in particular, [I-D.ietf-netconf-restconf- 530 collection] which provides enhanced filtering features for the 531 retrieval of data nodes with the GET method and [I-D.zheng-netconf- 532 fragmentation] which document large size data handling challenge. 533 The authors would like to thank the following for lively discussions 534 on list: 536 Andy Bierman Martin Björklund Robert Varga 538 Authors' Addresses 540 Kent Watsen 541 Watsen Networks 543 Email: kent+ietf@watsen.net 545 Qin Wu 546 Huawei 547 101 Software Avenue, Yuhua District 548 Nanjing 549 Jiangsu, 210012 550 China 552 Email: bill.wu@huawei.com 554 Olof Hagsand 555 Netgate 557 Email: olof@hagsand.se 559 Hongwei Li 560 HPE 562 Email: flycoolman@gmail.com 563 Per Andersson 564 Cisco Systems 566 Email: perander@cisco.com