RESTCONF Extensions to Support the Network Management Datastore Architecture
RFC 8527
| Document | Type |
RFC - Proposed Standard
(March 2019; No errata)
Updates RFC 8040
|
|
|---|---|---|---|
| Last updated | 2019-03-06 | ||
| Replaces | draft-dsdt-netconf-restconf-nmda | ||
| Stream | IETF | ||
| Formats | plain text html pdf htmlized bibtex | ||
| Reviews | |||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Mahesh Jethanandani | ||
| Shepherd write-up | Show (last changed 2018-04-25) | ||
| IESG | IESG state | RFC 8527 (Proposed Standard) | |
| Consensus Boilerplate | Yes | ||
| Telechat date | |||
| Responsible AD | Ignas Bagdonas | ||
| Send notices to | Mahesh Jethanandani <mjethanandani@gmail.com> | ||
| IANA | IANA review state | IANA OK - Actions Needed | |
| IANA action state | RFC-Ed-Ack | ||
Internet Engineering Task Force (IETF) M. Bjorklund
Request for Comments: 8527 Tail-f Systems
Updates: 8040 J. Schoenwaelder
Category: Standards Track Jacobs University
ISSN: 2070-1721 P. Shafer
Juniper Networks
K. Watsen
Watsen Networks
R. Wilton
Cisco Systems
March 2019
RESTCONF Extensions to Support the
Network Management Datastore Architecture
Abstract
This document extends the RESTCONF protocol defined in RFC 8040 in
order to support the Network Management Datastore Architecture (NMDA)
defined in RFC 8342.
This document updates RFC 8040 by introducing new datastore
resources, adding a new query parameter, and requiring the usage of
the YANG library (described in RFC 8525) by RESTCONF servers
implementing the NMDA.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 7841.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
https://www.rfc-editor.org/info/rfc8527.
Bjorklund, et al. Standards Track [Page 1]
RFC 8527 RESTCONF Extensions for the NMDA March 2019
Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction ....................................................3
1.1. Terminology ................................................3
2. Datastore and YANG Library Requirements .........................3
3. RESTCONF Extensions .............................................4
3.1. New Datastore Resources ....................................4
3.2. Protocol Operations ........................................5
3.2.1. The "with-defaults" Query Parameter on the
Operational State Datastore .........................5
3.2.2. New "with-origin" Query Parameter ...................6
4. IANA Considerations .............................................7
5. Security Considerations .........................................7
6. Normative References ............................................7
Authors' Addresses .................................................9
Bjorklund, et al. Standards Track [Page 2]
RFC 8527 RESTCONF Extensions for the NMDA March 2019
1. Introduction
This document extends the RESTCONF protocol defined in [RFC8040] in
order to support the Network Management Datastore Architecture (NMDA)
defined in [RFC8342].
This document updates [RFC8040] in order to enable RESTCONF clients
to discover which datastores are supported by the RESTCONF server,
determine which modules are supported in each datastore, and interact
with all the datastores supported by the NMDA. Specifically, the
update introduces new datastore resources, adds a new query
parameter, and requires the usage of the YANG library [RFC8525] by
RESTCONF servers implementing the NMDA.
The solution presented in this document is backwards compatible with
[RFC8040]. This is achieved by only adding new resources and leaving
the semantics of the existing resources unchanged.
1.1. Terminology
This document uses the terminology defined by the NMDA [RFC8342].
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
Show full document text