One document matched: draft-ietf-netconf-restconf-collection-00.xml
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt"?>
<!DOCTYPE rfc SYSTEM 'rfc2629.dtd'>
<?rfc toc="yes"?>
<?rfc compact="no"?>
<?rfc subcompact="no"?>
<?rfc symrefs="yes" ?>
<?rfc sortrefs="yes"?>
<?rfc iprnotified="no"?>
<?rfc strict="yes"?>
<rfc ipr="trust200902" category="std"
docName="draft-ietf-netconf-restconf-collection-00" >
<front>
<title abbrev="RESTCONF Collection">RESTCONF Collection Resource</title>
<author initials="A" surname="Bierman" fullname='Andy Bierman' >
<organization>YumaWorks</organization>
<address>
<email>andy@yumaworks.com</email>
</address>
</author>
<author initials="M" surname="Bjorklund" fullname='Martin Bjorklund' >
<organization>Tail-f Systems</organization>
<address>
<email>mbj@tail-f.com</email>
</address>
</author>
<author initials="K" surname="Watsen" fullname='Kent Watsen' >
<organization>Juniper Networks</organization>
<address>
<email>kwatsen@juniper.net</email>
</address>
</author>
<date/>
<abstract>
<t>
This document describes a collection resource for the RESTCONF
protocol to provide enhanced filtering features for
the retrieval of data nodes with the GET method.
</t>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>
There is a need for standard mechanisms to control the
filtering, sorting, and retrieval of data from RESTCONF devices.
A server may contain many instances of a particular YANG list.
Retrieval of the entire list at once can be extremely inefficient.
</t>
<t>
Pagination mechanisms are needed to allow a client to iterate
through a large list, in a manner that is most efficient
for the application.
</t>
<t>
This document describes a "collection" resource
that can be used to control retrieval of data nodes
from a RESTCONF server.
</t>
<figure>
<artwork><![CDATA[
[FIXME: describe basic needs
- target resource picks the list
- 'fields' is a node-set XPath expression to pick
the subtrees within the target resource
to return
- 'where' is a boolean XPath expression to pick which list
instances are selected for return
- 'sort' is ??? parameter to sort the selected list instances
- 'limit' is the max number of list instances returned
- 'offset' is the XPath position() of the list instance
??? pre or post access control ???
??? if post, then what if NACM changes while client
retrieving
]
]]></artwork>
</figure>
<t>
Collection resources represent search results through the
server data. Data that the client is not authorized
to receive according to the access control parameters
configured in <xref target="RFC6536"/> MUST NOT be returned in
RESTCONF response messages.
</t>
<section title="Terminology">
<t>
The keywords "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, <xref target="RFC2119"/>.
</t>
<t>
[FIXME: remove terms that are not used]
</t>
<section title="NETCONF">
<t>
The following terms are defined in <xref target="RFC6241"/>:
</t>
<t>
<list style="symbols">
<t>
candidate configuration datastore
</t>
<t>
client
</t>
<t>
configuration data
</t>
<t>
datastore
</t>
<t>
configuration datastore
</t>
<t>
protocol operation
</t>
<t>
running configuration datastore
</t>
<t>
server
</t>
<t>
startup configuration datastore
</t>
<t>
state data
</t>
<t>
user
</t>
</list>
</t>
</section>
<section title="HTTP">
<t>
The following terms are defined in <xref target="RFC3986"/>:
</t>
<t>
<list style="symbols">
<t>
fragment
</t>
<t>
path
</t>
<t>
query
</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC7230"/>:
</t>
<t>
<list style="symbols">
<t>
header
</t>
<t>
message-body
</t>
<t>
Request-Line
</t>
<t>
request URI
</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC7231"/>:
</t>
<t>
<list style="symbols">
<t>
method
</t>
<t>
request
</t>
<t>
resource
</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC7232"/>:
</t>
<t>
<list style="symbols">
<t>
entity tag
</t>
</list>
</t>
</section>
<section title="YANG">
<t>
The following terms are defined in <xref target="RFC6020"/>:
</t>
<t>
<list style="symbols">
<t>
container
</t>
<t>
data node
</t>
<t>
key leaf
</t>
<t>
leaf
</t>
<t>
leaf-list
</t>
<t>
list
</t>
<t>
presence container (or P-container)
</t>
<t>
RPC operation (now called protocol operation)
</t>
<t>
non-presence container (or NP-container)
</t>
<t>
ordered-by system
</t>
<t>
ordered-by user
</t>
</list>
</t>
</section>
<section title="RESTCONF">
<t>
The following terms are defined in <xref target="I-D.ietf-netconf-restconf"/>:
</t>
<t>
<list style="symbols">
<t>
data resource
</t>
<t>
target resource
</t>
<t>
retrieval request
</t>
</list>
</t>
</section>
<section title="Terms">
<t>
The following terms are used within this document:
</t>
<t>
<list style="symbols">
<t>
collection resource: a resource with the media type
"application/yang.collection+xml" or
"application/yang.collection+json". Contains a set of
data resources.
</t>
</list>
</t>
</section>
<section title="URI Template">
<t>
Throughout this document, the URI template <xref target="RFC6570"/> syntax
"{+restconf}" is used to refer to the RESTCONF API entry point outside
of an example. See the root resource discovery serction defined
in <xref target="I-D.ietf-netconf-restconf"/> for details.
</t>
<t>
All of the examples in this document assume "/restconf" as the
discovered RESTCONF API root path.
</t>
</section>
<section title="Tree Diagrams">
<t>
A simplified graphical representation of the data model is used in
this document. The meaning of the symbols in these
diagrams is as follows:
</t>
<t>
<list style="symbols">
<t>
Brackets "[" and "]" enclose list keys.
</t>
<t>
Abbreviations before data node names: "rw" means configuration
data (read-write) and "ro" state data (read-only).
</t>
<t>
Symbols after data node names: "?" means an optional node, "!" means
a presence container, and "*" denotes a list and leaf-list.
</t>
<t>
Parentheses enclose choice and case nodes, and case nodes are also
marked with a colon (":").
</t>
<t>
Ellipsis ("...") stands for contents of subtrees that are not shown.
</t>
</list>
</t>
</section>
</section>
<section title="Collection Resource Type">
<t>
The following resource type are defined in this document:
</t>
<?rfc compact="yes"?><texttable title="RESTCONF Media Types">
<ttcol align='left'> Resource</ttcol>
<ttcol align='left'>Media Type</ttcol>
<c>Collection</c>
<c>application/yang.collection</c>
</texttable>
<?rfc compact="no"?></section>
<section title="Collection Resource" anchor="collection-resource">
<t>
A collection resource contains a set of data resources. It is used to
represent a all instances or a subset of all instances in a YANG list
or leaf-list.
</t>
<t>
A collection resource can be retrieved with the GET method, optionally
with the query parameters "limit" (<xref target="limit"/>) and "offset" (<xref target="offset"/>).
</t>
<t>
The "ietf‑restconf‑collection" YANG module contains the
"application/yang.collection" restconf-media-type extension
which specifies the syntax and semantics of a "collection" media type.
</t>
</section>
<section title="Query Parameters" anchor="query-parameters">
<t>
Each RESTCONF operation allows zero or more query
parameters to be present in the request URI.
The following query parameters are defined for RESTCONF collection
resources.
</t>
<?rfc compact="yes"?><texttable title="RESTCONF Query Parameters">
<ttcol align='left'> Name</ttcol>
<ttcol align='left'>Methods</ttcol>
<ttcol align='left'>Description</ttcol>
<c>limit</c>
<c>GET</c>
<c>Number of entries to return for collection resources</c>
<c>offset</c>
<c>GET</c>
<c>Starting point for collection resources</c>
<c>sort</c>
<c>GET</c>
<c>Sorting criteria for collection resources</c>
<c>where</c>
<c>GET</c>
<c>Boolean filter to select data instances for a collection resource</c>
</texttable>
<?rfc compact="no"?> <t>
Query parameters can be given in any order.
Each parameter can appear at most once in a request URI.
A default value may apply if the parameter is missing.
</t>
<t>
Refer to <xref target="main-examples"/> for examples of query parameter usage.
</t>
<t>
If vendors define additional query parameters, they SHOULD use a
prefix (such as the enterprise or organization name) for query
parameter names in order to avoid collisions with other parameters.
</t>
<section title="Query Parameter URIs">
<t>
A new set of RESTCONF Capability URNs are defined to identify the specific
query parameters supported by the server.
</t>
<?rfc compact="yes"?><texttable title="RESTCONF Query Parameter URIs">
<ttcol align='left'> Name</ttcol>
<ttcol align='left'>URI</ttcol>
<c>page</c>
<c>urn:ietf:params:restconf:capability:page:1.0</c>
<c>page</c>
<c>urn:ietf:params:restconf:capability:page-xpath:1.0</c>
</texttable>
<?rfc compact="no"?></section>
<section title="The "limit" Query Parameter" anchor="limit">
<t>
The "limit" parameter is used to restrict the number of data resources
to return in response to GET requests on collection resources.
</t>
<t>
The value of the "limit" parameter is either an integer greater than
or equal to 1, or the string "unbounded". The string "unbounded" is the
default value.
</t>
<t>
If the server includes the "page" query parameter URI in
the "capability" leaf-list in the "ietf‑restconf‑monitoring"
module defined in <xref target="I-D.ietf-netconf-restconf"/>, then the "limit"
query parameter MUST be supported.
</t>
</section>
<section title="The "offset" Query Parameter" anchor="offset">
<t>
The "offset" parameter is used to specify the first data resource to
return in response to GET requests on collection resources.
Resources instances are numbered with consecutive integers
from 1 to the number of resource instances.
</t>
<t>
The value of the "offset" parameter is an integer greater than
or equal to 1. The default value is 1.
</t>
<t>
If the server includes the "page" query parameter URI in
the "capability" leaf-list in "ietf‑restconf‑monitoring" module
defined in <xref target="I-D.ietf-netconf-restconf"/>, then the "offset"
query parameter MUST be supported.
</t>
</section>
<section title="The "sort" Query Parameter" anchor="sort">
<figure>
<artwork><![CDATA[
[FIXME]
]]></artwork>
</figure>
</section>
<section title="The "where" Query Parameter" anchor="where">
<figure>
<artwork><![CDATA[
[FIXME]
]]></artwork>
</figure>
</section>
</section>
</section>
<section title="RESTCONF Collection module" anchor="module">
<t>
The "ietf‑restconf‑collection" module defines conceptual definitions
within groupings, which are not meant to be implemented
as datastore contents by a server.
</t>
<t>
The "ietf‑restconf" module from <xref target="I-D.ietf-netconf-restconf"/>
is used by this module for the 'restconf‑media‑type'
extension definition.
</t>
<t>
RFC Ed.: update the date below with the date of RFC publication and
remove this note.
</t>
<t><CODE BEGINS> file "ietf-restconf-collection@2015-01-30.yang"</t>
<figure>
<artwork><![CDATA[
module ietf-restconf-collection {
namespace "urn:ietf:params:xml:ns:yang:ietf-restconf-collection";
prefix "rcoll";
import ietf-restconf {
prefix rc;
revision-date 2015-01-30;
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com>
WG Chair: Mahesh Jethanandani
<mailto:mjethanandani@gmail.com>
Editor: Andy Bierman
<mailto:andy@yumaworks.com>
Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>
Editor: Kent Watsen
<mailto:kwatsen@juniper.net>";
description
"This module contains conceptual YANG specifications
for the RESTCONF Collection resource type.
Note that the YANG definitions within this module do not
represent configuration data of any kind.
The YANG grouping statements provide a normative syntax
for XML and JSON message encoding purposes.
Copyright (c) 2015 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
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this
// note.
// RFC Ed.: remove this note
// Note: extracted from
// draft-ietf-netconf-restconf-collection-00.txt
// RFC Ed.: update the date below with the date of RFC publication
// and remove this note.
revision 2015-01-30 {
description
"Initial revision.";
reference
"RFC XXXX: RESTCONF Collection Resource.";
}
rc:restconf-media-type "application/yang.collection" {
uses collection;
}
grouping collection {
description
"Conceptual container representing the
application/yang.collection resource type.";
container collection {
description
"Container representing the application/yang.collection
resource type.";
}
} // grouping collection
}
]]></artwork>
</figure>
<t><CODE ENDS></t>
</section>
<section title="IANA Considerations" anchor="iana">
<section title="YANG Module Registry">
<t>
This document registers three URIs in the IETF XML registry
<xref target="RFC3688"/>. Following the format in RFC 3688, the following
registration is requested to be made.
</t>
<figure>
<artwork><![CDATA[
URI: urn:ietf:params:xml:ns:yang:ietf-restconf-collection
Registrant Contact: The NETMOD WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
]]></artwork>
</figure>
<t>
This document registers three YANG modules in the YANG Module Names
registry <xref target="RFC6020"/>.
</t>
<figure>
<artwork><![CDATA[
name: ietf-restconf-collection
namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-collection
prefix: rcoll
// RFC Ed.: replace XXXX with RFC number and remove this note
reference: RFC XXXX
]]></artwork>
</figure>
</section>
<section title="application/yang Media Sub Types">
<t>
The parent MIME media type for RESTCONF resources is application/yang,
which is defined in <xref target="RFC6020"/>. This document defines the following
sub-types for this media type.
</t>
<figure>
<artwork><![CDATA[
- collection
Type name: application
Subtype name: yang.xxx
Required parameters: TBD
Optional parameters: TBD
Encoding considerations: TBD
Security considerations: TBD
Interoperability considerations: TBD
// RFC Ed.: replace XXXX with RFC number and remove this note
Published specification: RFC XXXX
]]></artwork>
</figure>
</section>
<section title="NETCONF Capability URNs">
<t>
This document registers two capability identifiers in
"RESTCONF Protocol Capability URNs" registry
</t>
<figure>
<artwork><![CDATA[
Index
Capability Identifier
------------------------
:page
urn:ietf:params:restconf:capability:page:1.0
:page-xpath
urn:ietf:params:restconf:capability:page-xpath:1.0
]]></artwork>
</figure>
</section>
</section>
<section title="Security Considerations">
<t>
This section provides security considerations for the resources
defined by the RESTCONF protocol. Security considerations for
HTTPS are defined in <xref target="RFC2818"/>. Security considerations for the
content manipulated by RESTCONF can be found in the documents
defining data models.
</t>
<t>
All security considerations that apply to resources
defined in <xref target="I-D.ietf-netconf-restconf"/> also apply
to the collection resource.
</t>
</section>
<section title="Acknowledgements">
<t>
The authors would like to thank for following for lively discussions
on list and in the halls (ordered by last name): Rex Fernando
</t>
</section>
</middle>
<back>
<references title="Normative References">
<reference anchor="RFC2119">
<front>
<title>Key words for use in RFCs to Indicate Requirement Levels</title>
<author initials="S." surname="Bradner" fullname="S. Bradner">
<organization>Harvard University</organization>
</author>
<date month="March" year="1997"/>
<abstract>
<t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents.</t>
</abstract>
</front>
<seriesInfo name="BCP" value="14"/>
<seriesInfo name="RFC" value="2119"/>
<format type="TXT" octets="4723" target="ftp://ftp.isi.edu/in-notes/rfc2119.txt"/>
</reference>
<reference anchor='RFC7230'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. This document provides an overview of HTTP architecture and its associated terminology, defines the "http" and "https" Uniform Resource Identifier (URI) schemes, defines the HTTP/1.1 message syntax and parsing requirements, and describes related security concerns for implementations.</t></abstract></front>
<seriesInfo name='RFC' value='7230' />
<format type='TXT' octets='205947' target='http://www.rfc-editor.org/rfc/rfc7230.txt' />
</reference>
<reference anchor='RFC7231'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless \%application- level protocol for distributed, collaborative, hypertext information systems. This document defines the semantics of HTTP/1.1 messages, as expressed by request methods, request header fields, response status codes, and response header fields, along with the payload of messages (metadata and body content) and mechanisms for content negotiation.</t></abstract></front>
<seriesInfo name='RFC' value='7231' />
<format type='TXT' octets='235053' target='http://www.rfc-editor.org/rfc/rfc7231.txt' />
</reference>
<reference anchor='RFC2818'>
<front>
<title>The IETF XML Registry</title>
<author initials='E.R.' surname='Rescorla' fullname='Erir Rescorla'>
<organization>RTFM, Inc.</organization></author>
<date year='2000' month='May' />
<abstract>
<t>This memo describes how to use TLS to secure HTTP connections over
the Internet. Current practice is to layer HTTP over SSL (the
predecessor to TLS), distinguishing secured traffic from insecure
traffic by the use of a different server port. This document
documents that practice using TLS. A companion document describes a
method for using HTTP/TLS over the same port as normal HTTP
[RFC2817].</t>
</abstract>
</front>
<seriesInfo name='RFC' value='2818' />
<format type='HTTP' octets='26507' target='http://tools.ietf.org/html/rfc2818' />
</reference>
<reference anchor='RFC7232'>
<front>
<title>Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests</title>
<author initials='R.' surname='Fielding' fullname='R. Fielding'>
<organization /></author>
<author initials='J.' surname='Reschke' fullname='J. Reschke'>
<organization /></author>
<date year='2014' month='June' />
<abstract>
<t>The Hypertext Transfer Protocol (HTTP) is a stateless application- level protocol for distributed, collaborative, hypertext information systems. This document defines HTTP/1.1 conditional requests, including metadata header fields for indicating state changes, request header fields for making preconditions on such state, and rules for constructing the responses to a conditional request when one or more preconditions evaluate to false.</t></abstract></front>
<seriesInfo name='RFC' value='7232' />
<format type='TXT' octets='56696' target='http://www.rfc-editor.org/rfc/rfc7232.txt' />
</reference>
<reference anchor='RFC3688'>
<front>
<title>The IETF XML Registry</title>
<author initials='M.' surname='Mealling' fullname='M. Mealling'>
<organization /></author>
<date year='2004' month='January' />
<abstract>
<t>This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas.</t></abstract></front>
<seriesInfo name='BCP' value='81' />
<seriesInfo name='RFC' value='3688' />
<format type='TXT' octets='17325' target='http://www.rfc-editor.org/rfc/rfc3688.txt' />
</reference>
<reference anchor="RFC3986">
<front>
<title abbrev="URI Generic Syntax">Uniform Resource Identifier (URI): Generic Syntax</title>
<author initials="T." surname="Berners-Lee" fullname="Tim Berners-Lee">
<organization abbrev="W3C/MIT">World Wide Web Consortium</organization>
<address>
<postal>
<street>Massachusetts Institute of Technology</street>
<street>77 Massachusetts Avenue</street>
<city>Cambridge</city>
<region>MA</region>
<code>02139</code>
<country>USA</country></postal>
<phone>+1-617-253-5702</phone>
<facsimile>+1-617-258-5999</facsimile>
<email>timbl@w3.org</email>
<uri>http://www.w3.org/People/Berners-Lee/</uri></address></author>
<author initials="R." surname="Fielding" fullname="Roy T. Fielding">
<organization abbrev="Day Software">Day Software</organization>
<address>
<postal>
<street>5251 California Ave., Suite 110</street>
<city>Irvine</city>
<region>CA</region>
<code>92617</code>
<country>USA</country></postal>
<phone>+1-949-679-2960</phone>
<facsimile>+1-949-679-2972</facsimile>
<email>fielding@gbiv.com</email>
<uri>http://roy.gbiv.com/</uri></address></author>
<author initials="L." surname="Masinter" fullname="Larry Masinter">
<organization abbrev="Adobe Systems">Adobe Systems Incorporated</organization>
<address>
<postal>
<street>345 Park Ave</street>
<city>San Jose</city>
<region>CA</region>
<code>95110</code>
<country>USA</country></postal>
<phone>+1-408-536-3024</phone>
<email>LMM@acm.org</email>
<uri>http://larry.masinter.net/</uri></address></author>
<date year="2005" month="January"/>
<area>Applications</area>
<keyword>uniform resource identifier</keyword>
<keyword>URI</keyword>
<keyword>URL</keyword>
<keyword>URN</keyword>
<keyword>WWW</keyword>
<keyword>resource</keyword>
<abstract>
<t>
A Uniform Resource Identifier (URI) is a compact sequence of characters
that identifies an abstract or physical resource. This specification
defines the generic URI syntax and a process for resolving URI references
that might be in relative form, along with guidelines and security
considerations for the use of URIs on the Internet.
The URI syntax defines a grammar that is a superset of all valid URIs,
allowing an implementation to parse the common components of a URI
reference without knowing the scheme-specific requirements of every
possible identifier. This specification does not define a generative
grammar for URIs; that task is performed by the individual
specifications of each URI scheme.
</t></abstract></front>
<seriesInfo name="STD" value="66"/>
<seriesInfo name="RFC" value="3986"/>
<format type="TXT" octets="141811" target="http://www.rfc-editor.org/rfc/rfc3986.txt"/>
<format type="HTML" octets="213584" target="http://xml.resource.org/public/rfc/html/rfc3986.html"/>
<format type="XML" octets="163534" target="http://xml.resource.org/public/rfc/xml/rfc3986.xml"/>
</reference>
<reference anchor='RFC6241'>
<front>
<title>Network Configuration Protocol (NETCONF)</title>
<author initials='R.' surname='Enns' fullname='R. Enns' role="editor">
<organization/>
</author>
<author initials='M.' surname='Bjorklund' fullname='M. Bjorklund' role="editor">
<organization/>
</author>
<author initials='J.' surname='Schoenwaelder' fullname='J. Schoenwaelder' role="editor">
<organization/>
</author>
<author initials='A.' surname='Bierman' fullname='A. Bierman' role="editor">
<organization/>
</author>
<date year='2011' month='June'/>
</front>
<seriesInfo name='RFC' value='6241'/>
</reference>
<reference anchor="RFC6536">
<front>
<title>Network Configuration Protocol (NETCONF) Access Control Model</title>
<author initials="A." surname="Bierman" fullname="A. Bierman">
<organization/></author>
<author initials="M." surname="Bjorklund" fullname="M. Bjorklund">
<organization/></author>
<date year="2012" month="March"/>
<abstract>
<t>The standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF protocol access for particular users to a pre-configured subset of all available NETCONF protocol operations and content. This document defines such an access control model. [STANDARDS-TRACK]</t></abstract></front>
<seriesInfo name="RFC" value="6536"/>
<format type="TXT" octets="90803" target="http://www.rfc-editor.org/rfc/rfc6536.txt"/>
</reference>
<reference anchor='RFC6570'>
<front>
<title>URI Template</title>
<author initials='J.G.' surname='Gregorio' fullname='Joe Gregorio'>
<organization>Google</organization>
</author>
<author initials='R.F.' surname='Fielding' fullname='Roy Fielding'>
<organization>Adobe</organization>
</author>
<author initials='M.H.' surname='Hadley' fullname='Marc Hadley'>
<organization>MITRE</organization>
</author>
<author initials='M.N.' surname='Nottingham' fullname='Mark Nottingham'>
<organization>Rackspace</organization>
</author>
<author initials='D.O.' surname='Orchard' fullname='David Orchard'>
<organization>Salesforce.com</organization>
</author>
<date year='2012' month='March'/>
</front>
<seriesInfo name='RFC' value='6570'/>
</reference>
<reference anchor="RFC6020">
<front>
<title>YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)</title>
<author initials="M." surname="Bjorklund" fullname="M. Bjorklund">
<organization/>
</author>
<date year="2010" month="October"/>
<abstract>
<t>YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS TRACK]</t>
</abstract>
</front>
<seriesInfo name="RFC" value="6020"/>
<format type="TXT" octets="324178" target="http://www.rfc-editor.org/rfc/rfc6020.txt"/>
</reference>
<!--
<reference anchor="I-D.ietf-netmod-json">
<front>
<title>Modeling JSON Text with YANG</title>
<author initials="L." surname="Lhotka" fullname="L. Lhotka">
<organization>CZ.NIC</organization>
</author>
<date year="2014" month="October"/>
</front>
<seriesInfo name="Internet-Draft"
value="draft-ietf-netmod-yang-json-01"/>
<format type='TXT'
target='http://www.ietf.org/id/draft-ietf-netmod-yang-json-01.txt'/>
</reference>
-->
<!--
<reference anchor="I-D.lhotka-netmod-yang-metadata">
<front>
<title>Defining and Using Metadata with YANG</title>
<author initials="L." surname="Lhotka" fullname="L. Lhotka">
<organization>CZ.NIC</organization>
</author>
<date year="2014" month="September"/>
</front>
<seriesInfo name="Internet-Draft"
value="draft-lhotka-netmod-yang-metadata-00"/>
<format type='TXT'
target='http://www.ietf.org/id/draft-lhotka-netmod-yang-metadata-00.txt'/>
</reference>
-->
<!--
<reference anchor='RFC6991'>
<front>
<title>Common YANG Data Types</title>
<author initials='J.' surname='Schoenwaelder' fullname='J. Schoenwaelder'>
<organization /></author>
<date year='2013' month='July' />
<abstract>
<t>This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021.</t></abstract></front>
<seriesInfo name='RFC' value='6991' />
<format type='TXT' octets='60242' target='http://www.rfc-editor.org/rfc/rfc6991.txt' />
</reference>
-->
<!--
<reference anchor='W3C.REC-xml-20081126'
target='http://www.w3.org/TR/2008/REC-xml-20081126'>
<front>
<title>Extensible Markup Language (XML) 1.0 (Fifth Edition)</title>
<author initials='F.' surname='Yergeau' fullname='François Yergeau'>
<organization />
</author>
<author initials='E.' surname='Maler' fullname='Eve Maler'>
<organization />
</author>
<author initials='J.' surname='Paoli' fullname='Jean Paoli'>
<organization />
</author>
<author initials='C.' surname='Sperberg-McQueen' fullname='C. M. Sperberg-McQueen'>
<organization />
</author>
<author initials='T.' surname='Bray' fullname='Tim Bray'>
<organization />
</author>
<date month='November' day='26' year='2008' />
</front>
<seriesInfo name='World Wide Web Consortium Recommendation' value='REC-xml-20081126' />
<format type='HTML' target='http://www.w3.org/TR/2008/REC-xml-20081126' />
</reference>
-->
<!--
<reference anchor="RFC7158">
<front>
<title>The JSON Data Interchange Format</title>
<author initials="T." surname="Bray"
fullname="T. Bray" role="editor">
<organization />
</author>
<date month="March" year="2013" />
</front>
<seriesInfo name='RFC' value='7158' />
<format type='TXT' target='http://www.rfc-editor.org/rfc/rfc7158.txt' />
</reference>
-->
<reference anchor='I-D.ietf-netconf-restconf'>
<front>
<title>RESTCONF Protocol</title>
<author initials='A' surname='Bierman' fullname='Andy Bierman'>
<organization />
</author>
<author initials='M' surname='Bjorklund' fullname='Martin Bjorklund'>
<organization />
</author>
<author initials='K' surname='Watsen' fullname='Kent Watsen'>
<organization />
</author>
<date month='January' year='2015' />
<abstract><t>This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastores defined in NETCONF.</t></abstract>
</front>
<seriesInfo name='Internet-Draft' value='draft-ietf-netconf-restconf-04' />
<format type='TXT'
target='http://www.ietf.org/internet-drafts/draft-ietf-netconf-restconf-04.txt' />
</reference>
</references>
<!--
<references title="Informative References">
<reference anchor="XPath" target="http://www.w3.org/TR/1999/REC-xpath-19991116">
<front>
<title>XML Path Language (XPath) Version 1.0</title>
<author initials="J." surname="Clark" fullname="James Clark">
<organization/>
</author>
<author initials="S." surname="DeRose" fullname="Steven DeRose">
<organization/>
</author>
<date month="November" day="16" year="1999"/>
</front>
<seriesInfo name="World Wide Web Consortium Recommendation" value="REC-xpath-19991116"/>
<format type="HTML" target="http://www.w3.org/TR/1999/REC-xpath-19991116"/>
</reference>
</references>
-->
<section title="Change Log">
<figure>
<artwork><![CDATA[
-- RFC Ed.: remove this section before publication.
]]></artwork>
</figure>
<t>
The RESTCONF issue tracker can be found here:
https://github.com/netconf-wg/restconf/issues
</t>
<section title="restconf-03 to restconf-collection-00">
<t>
<list style="symbols">
<t>
Moved collection resource from RESTCONF to a new document
</t>
</list>
</t>
</section>
</section>
<section title="Open Issues">
<figure>
<artwork><![CDATA[
-- RFC Ed.: remove this section before publication.
]]></artwork>
</figure>
<t>
The RESTCONF Collection issues are tracked on github.com:
</t>
<figure>
<artwork><![CDATA[
https://github.com/netconf-wg/restconf/issues
]]></artwork>
</figure>
</section>
<section title="RESTCONF Collection Examples" anchor="main-examples">
<t>
The examples within this document use the
"example‑jukebox" YANG module defined in <xref target="I-D.ietf-netconf-restconf"/>.
</t>
<section title=""limit" Parameter">
<t>
In this example, the client requests the first two "album" resources
for a given artist:
</t>
<t>
Request from client:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album/?limit=2 HTTP/1.1
Host: example.com
Content-Type: application/yang.collection+xml
]]></artwork>
</figure>
<t>
Response from server:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:01:00 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.collection+xml
]]></artwork>
</figure>
<figure>
<artwork><![CDATA[
<collection xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf"
<album xmlns="http://example.com/ns/example-jukebox">
<name>Foo Fighters</name>
<year>1995</year>
...
</album>
<album xmlns="http://example.com/ns/example-jukebox">
<name>The Color and the Shape</name>
<year>1997</year>
...
</album>
</collection>
]]></artwork>
</figure>
</section>
<section title=""offset" Parameter">
<t>
In this example, the client requests the next two albums, i.e., two
albums starting from two.
</t>
<t>
Request from client:
</t>
<figure>
<artwork><![CDATA[
GET /restconf/data/example-jukebox:jukebox/
library/artist=Foo%20Fighters/album/?limit=2&offset=2 HTTP/1.1
Host: example.com
Content-Type: application/yang.collection+json
]]></artwork>
</figure>
<t>
Response from server:
</t>
<figure>
<artwork><![CDATA[
HTTP/1.1 200 OK
Date: Mon, 23 Apr 2012 17:02:00 GMT
Server: example-server
Cache-Control: no-cache
Pragma: no-cache
Content-Type: application/yang.collection+json
{
"collection": {
"example-jukebox:album" : [
{
"year" : 1999,
"name" : "There is Nothing Left to Loose",
...
},
{
"year" : 2002,
"name" : "One by One",
...
}
]
}
}
]]></artwork>
</figure>
</section>
<section title=""sort" Parameter">
<figure>
<artwork><![CDATA[
[FIXME]
]]></artwork>
</figure>
</section>
<section title=""where" Parameter">
<figure>
<artwork><![CDATA[
[FIXME]
]]></artwork>
</figure>
</section>
<section title=""TopN" Use Case">
<figure>
<artwork><![CDATA[
[FIXME: use-case using all parameters for topN for some list]
]]></artwork>
</figure>
</section>
</section>
</back></rfc>
| PAFTECH AB 2003-2026 | 2026-04-23 05:13:39 |