]> NETCONF Extensions to Support List Pagination Watsen Networks
kent+ietf@watsen.net
Huawei
bill.wu@huawei.com
Ionio Systems
per.ietf@ionio.se
SUNET
olof@hagsand.se
HPE
flycoolman@gmail.com
OPS Area NETCONF Working Group This document defines a mapping of the list pagination mechanism defined in to NETCONF . This document updates , to augment the <get> and <get-config> "rpc" statements, and , to augment the <get-data> "rpc" statement, to define input parameters necessary for list pagination.
Introduction This document defines a mapping of the list pagination mechanism defined in to NETCONF . This document updates and , as described in . While the pagination mechanism defined in this document is designed for the NETCONF protocol , the augmented RPCs MAY be used by the RESTCONF protocol if the RESTCONF server implements the "ietf-list-pagination-nc" module. The YANG data model in this document conforms to the Network Management Datastore Architecture defined in
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 when, and only when, they appear in all capitals, as shown here.
Conventions Various examples in this document use "BASE64VALUE=" as a placeholder value for binary data that has been base64 encoded (per ). This placeholder value is used because real base64 encoded structures are often many lines long and hence distracting to the example being presented.
Updates to NETCONF operations
Updates to RFC 6241 The <get> and <get-config> rpc statements are augmented to accept additional input parameters, as described in .
Updates to RFC 8526 The <get-data> rpc statement is augmented to accept additional input parameters, as described in in .
List Pagination for NETCONF In order for NETCONF to support , this document extends the operations <get>, <get-config> and <get-data> to include additional input parameters and output annotations. The updated operations accept a content filter parameter "where", similar to the "filter" parameter of <get-config>, but includes nodes for "list" and "leaf-list" filtering. The "where" query parameter is used to specify the YANG list or leaf-list that is to be retrieved. This must be a path expression used to represent a list or leaf-list data node. Prefixes in the "where" query parameter XPath expression MUST be the YANG module prefix. If the specified XPath expression is invalid, then an <rpc-error> is returned with error type value "application" and "error-tag" value "invalid-value". The following tree diagram illustrates the "ietf-netconf-list-pagination" module: Comments:
  • This module augments three NETCONF "rpc" statements: get, get-config, and get-data.
  • The "get" and "get-config" augments are against the YANG module defined in . The "get-data" augment is against the YANG module defined in .
Error Reporting When an input query parameter is supplied with an erroneous value, an <rpc-error> MUST be returned containing the error-type value "application", the error-tag value "invalid-value", and MAY include the error-severity value "error". Additionally the error-app-tag SHOULD be set containing query parameter specific error value.
The "offset" Query Parameter If the "offset" query parameter value supplied is larger than the number of instances in the working result-set, the <rpc-error> MUST contain error-app-tag with value "offset-out-of-range".
YANG Module for List Pagination in NETCONF The "ietf-netconf-list-pagination-nc" module defines conceptual definitions within groupings, which are not meant to be implemented as datastore contents by a server. This module has normative references to , , , and . <CODE BEGINS> file "ietf-list-pagination-nc@2026-04-02.yang" WG List: Author: Kent Watsen Author: Qin Wu Author: Per Andersson Author: Olof Hagsand Author: Hongwei Li "; description "This module augments the , , and 'rpc' statements to support list pagination. Copyright (c) 2026 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices. 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 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2026-04-02 { description "Initial revision."; reference "RFC XXXX: NETCONF Extensions to Support List Pagination"; } augment "/nc:get/nc:input" { description "Allow the 'get' operation to use content filter parameter for specifying the YANG list or leaf-list that is to be retrieved"; uses lpg:pagination-parameters; } augment "/nc:get-config/nc:input" { description "Allow the 'get-config' operation to use content filter parameter for specifying the YANG list or leaf-list that is to be retrieved"; uses lpg:pagination-parameters; } augment "/ncds:get-data/ncds:input" { description "Allow the 'get-data' operation to use content filter parameter for specifying the YANG list or leaf-list that is to be retrieved"; uses lpg:pagination-parameters; } } ]]> <CODE ENDS>
IANA Considerations
The "IETF XML" Registry This document registers one URI in the "ns" subregistry of the IETF XML Registry maintained at . Following the format in , the following registration is requested:
The "YANG Module Names" Registry This document registers one YANG module in the YANG Module Names registry maintained at . Following the format defined in , the below registration is requested:
Security Considerations
The "ietf-netconf-list-pagination" YANG Module This section follows the template defined in . The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF or RESTCONF . The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) . The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS . The Network Configuration Access Control Model (NACM) provides the means to restrict access for particular NETCONF users to a preconfigured subset of all available NETCONF protocol operations and content. The security considerations for the base NETCONF protocol operations (see Section 9 of and Section 6 of ) apply to the extension of operations <get>, <get-config>, and <get-data> defined in this document.
References Normative References Informative References
Example YANG Module The examples within this document use the "example-social" YANG module defined in .
Example Data Set The Example Data Set used by the examples is defined in .
Example Queries
List pagination with all query parameters This example mimics that . In this XML example, The xmlns:es attribute binds the "es" prefix to the example-social module name. The urn:ietf:params:xml:ns:yang:ietf-list-pagination-nc namespace is used for the list-pagination query parameters. //stats[starts-with(joined,'2020')] joined backwards 2 2 1 sv_US ]]> Response from the NETCONF server: eric eric@example.com $0$1543 BASE64VALUE= Go to bed with dreams; wake up with purpose. alice 2020-09-17T18:02:04Z Son, brother, husband, father What's your story? two 2020-09-17T19:38:32Z pro 2020-09-17T18:02:04Z bob bob@example.com $0$1543 BASE64VALUE= Here and now, like never before. 2020-08-14T03:32:25Z Just got in. 3.14\ 159 2020-08-14T03:30:00Z standard 2020-08-14T03:34:30Z ]]>
Acknowledgements This work has benefited from the discussions of RESTCONF resource collection over the years, in particular, which provides enhanced filtering features for the retrieval of data nodes with the GET method and which document large size data handling challenge. The authors would like to thank the following for lively discussions on list (ordered by first name): Andy Bierman, Martin Björklund, Robert Varga, and Robert Wilton.