a4b4dc97ce
* Pagination is updated to new drafts: * [https://datatracker.ietf.org/doc/html/draft-wwlh-netconf-list-pagination-00>] * [https://datatracker.ietf.org/doc/html/draft-wwlh-netconf-list-pagination-nc-02] * [https://datatracker.ietf.org/doc/html/draft-wwlh-netconf-list-pagination-rc-02] * See also updated [https://clixon-docs.readthedocs.io/en/latest/pagination.html] * Added IETF RFC:s (included by pagination): * ietf-netconf-nmda@2019-01-07.yang * ietf-origin@2018-02-14.yang * ietf-netconf-with-defaults@2011-06-01.yang * Dropped pcvec parameter to many restconf api functions
101 lines
3.3 KiB
YANG
101 lines
3.3 KiB
YANG
module ietf-list-pagination-nc {
|
|
yang-version 1.1;
|
|
namespace "urn:ietf:params:xml:ns:yang:ietf-list-pagination-nc";
|
|
prefix lpgnc;
|
|
|
|
import ietf-netconf {
|
|
prefix nc;
|
|
reference
|
|
"RFC 6241: Network Configuration Protocol (NETCONF)";
|
|
}
|
|
|
|
import ietf-netconf-nmda {
|
|
prefix ncds;
|
|
reference
|
|
"RFC 8526: NETCONF Extensions to Support the
|
|
Network Management Datastore Architecture";
|
|
}
|
|
|
|
import ietf-list-pagination {
|
|
prefix lp;
|
|
reference
|
|
"RFC XXXX: List Pagination for YANG-driven Protocols";
|
|
}
|
|
|
|
organization
|
|
"IETF NETCONF (Network Configuration) Working Group";
|
|
|
|
contact
|
|
"WG Web: <http://tools.ietf.org/wg/netconf/>
|
|
WG List: <mailto:netconf@ietf.org>";
|
|
|
|
description
|
|
"This module augments the <get>, <get-config>, and <get-data>
|
|
'rpc' statements to support list pagination.
|
|
|
|
Copyright (c) 2021 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 Simplified
|
|
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 2021-10-25 {
|
|
description
|
|
"Initial revision.";
|
|
reference
|
|
"RFC XXXX: NETCONF Extensions to Support List Pagination";
|
|
}
|
|
|
|
grouping pagination-parameters {
|
|
description "A grouping for list pagination parameters.";
|
|
container list-pagination {
|
|
description "List pagination parameters.";
|
|
presence "Flag that request contains pagination parameters";
|
|
uses lp:where-param-grouping;
|
|
uses lp:sort-by-param-grouping;
|
|
uses lp:direction-param-grouping;
|
|
uses lp:offset-param-grouping;
|
|
uses lp:limit-param-grouping;
|
|
uses lp:sublist-limit-param-grouping;
|
|
}
|
|
}
|
|
|
|
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 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 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 pagination-parameters;
|
|
}
|
|
}
|