Dynamic subscription to YANG Events and Datastores over RESTCONF
draft-ietf-netconf-restconf-notif-10

Document Type Active Internet-Draft (netconf WG)
Last updated 2018-11-05
Replaces draft-voit-netconf-restconf-notif
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Yang Validation 7 errors, 0 warnings.
Additional URLs
- Yang catalog entry for ietf-restconf-subscribed-notifications@2018-10-19.yang
- Yang impact analysis for draft-ietf-netconf-restconf-notif
- Mailing list discussion
Stream WG state Waiting for WG Chair Go-Ahead (wg milestone: Sep 2018 - WGLC for RESTCONF an... )
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
NETCONF                                                          E. Voit
Internet-Draft                                                 R. Rahman
Intended status: Standards Track                       E. Nilsen-Nygaard
Expires: May 8, 2019                                       Cisco Systems
                                                                A. Clemm
                                                                  Huawei
                                                              A. Bierman
                                                               YumaWorks
                                                        November 4, 2018

    Dynamic subscription to YANG Events and Datastores over RESTCONF
                  draft-ietf-netconf-restconf-notif-10

Abstract

   This document provides a RESTCONF binding to the dynamic subscription
   capability of both subscribed notifications and YANG-Push.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on May 8, 2019.

Copyright Notice

   Copyright (c) 2018 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

Voit, et al.               Expires May 8, 2019                  [Page 1]
Internet-Draft               RESTCONF-Notif                November 2018

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Dynamic Subscriptions . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Transport Connectivity  . . . . . . . . . . . . . . . . .   4
     3.2.  Discovery . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.3.  RESTCONF RPCs and HTTP Status Codes . . . . . . . . . . .   4
     3.4.  Call Flow for Server-Sent Events (SSE)  . . . . . . . . .   6
   4.  QoS Treatment . . . . . . . . . . . . . . . . . . . . . . . .   8
   5.  Notification Messages . . . . . . . . . . . . . . . . . . . .   8
   6.  YANG Tree . . . . . . . . . . . . . . . . . . . . . . . . . .   8
   7.  YANG module . . . . . . . . . . . . . . . . . . . . . . . . .   9
   8.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  10
   9.  Security Considerations . . . . . . . . . . . . . . . . . . .  11
   10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . .  11
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  12
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  12
     11.2.  Informative References . . . . . . . . . . . . . . . . .  13
   Appendix A.  Examples . . . . . . . . . . . . . . . . . . . . . .  14
     A.1.  Dynamic Subscriptions . . . . . . . . . . . . . . . . . .  14
       A.1.1.  Establishing Dynamic Subscriptions  . . . . . . . . .  14
       A.1.2.  Modifying Dynamic Subscriptions . . . . . . . . . . .  17
       A.1.3.  Deleting Dynamic Subscriptions  . . . . . . . . . . .  18
     A.2.  Subscription State Notifications  . . . . . . . . . . . .  19
       A.2.1.  subscription-modified . . . . . . . . . . . . . . . .  19
       A.2.2.  subscription-completed, subscription-resumed, and
               replay-complete . . . . . . . . . . . . . . . . . . .  20
       A.2.3.  subscription-terminated and subscription-suspended  .  20
     A.3.  Filter Example  . . . . . . . . . . . . . . . . . . . . .  21
   Appendix B.  Changes between revisions  . . . . . . . . . . . . .  22
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  24

1.  Introduction

   Mechanisms to support event subscription and push are defined in
   [I-D.draft-ietf-netconf-subscribed-notifications].  Enhancements to
   [I-D.draft-ietf-netconf-subscribed-notifications] which enable YANG
   datastore subscription and push are defined in
   [I-D.ietf-netconf-yang-push].  This document provides a transport
Show full document text