Internet-Draft NETCONF Event Notification YANG January 2023
Huang Feng, et al. Expires 29 July 2023 [Page]
Network Working Group
RFC5277 (if approved)
Intended Status:
Standards Track
A. Huang Feng
P. Francois
T. Graf
B. Claise

YANG model for NETCONF Event Notifications


This document defines the YANG model for NETCONF Event Notifications.

Requirements Language

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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

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

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 29 July 2023.

1. Introduction

This document defines a YANG data model for NETCONF Event Notifications [RFC5277]. The notification structure defined in [RFC5277] uses a XML Schema [W3C.REC-xml-20001006] allowing to encode and validate the message in XML. Nevertheless, when the notification message is encoded using other encodings such as JSON [RFC8040] or CBOR [RFC9254], a YANG model to validate or encode the message is necessary. This document extends [RFC5277], defining the NETCONF Event Notification structure in a YANG module.

2. YANG Module

2.1. YANG Tree Diagram

This YANG module adds a structure with one leaf for the datetime as defined in section 2.2.1 of [RFC5277].

module: ietf-notification

  structure notification:
    +-- eventTime    yang:date-and-time

2.2. YANG Module

<CODE BEGINS> file "ietf-notification@2023-01-16.yang"

module ietf-notification {
  yang-version 1.1;
  prefix inn;
  import ietf-yang-types {
    prefix yang;
      "RFC 6991: Common YANG Data Types";
  import ietf-yang-structure-ext {
    prefix sx;
      "RFC 8791: YANG Data Structure Extensions";

  organization "IETF NETCONF (Network Configuration) Working Group";
    "WG Web:   <http:/>
     WG List:  <>

     Authors:  Thomas Graf
               Benoit Claise
               Pierre Francois
               Alex Huang Feng

    "Defines NETCONF Event Notification structure.

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

    This version of this YANG module is part of RFC XXXX; see the RFC
    itself for full legal notices.";

  revision 2023-01-16 {
      "First revision";
      "RFC XXXX: NETCONF Event Notification YANG";

  sx:structure notification {
    leaf eventTime {
      type yang:date-and-time;
      mandatory true;
        "The time the event was generated by the event source.  This
         parameter is of type dateTime and compliant to [RFC3339].
         Implementations must support time zones.";


3. Security Considerations

The security considerations for the NETCONF Event notifications are described in [RFC5277]. This documents adds no additional security considerations.

4. IANA Considerations

This document describes a URI for the IETF XML Registry and registers a new YANG module name.

4.1. URI

IANA is requested to assign a new URI from the IETF XML Registry [RFC3688]. The following URI is suggested:

URI: urn:ietf:params:xml:ns:yang:ietf-notification
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.

4.2. YANG module name

This document registers the following YANG module in the YANG Module Names Registry [RFC6020], within the "YANG Parameters" registry:

name: ietf-notification
namespace: urn:ietf:params:xml:ns:yang:ietf-notification
prefix: inn
reference: RFC XXXX

5. Acknowledgements

The authors would like to thank Andy Bierman for his review and valuable comments.

6. References

6.1. Normative References

Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, , <>.
Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, , <>.
Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, DOI 10.17487/RFC5277, , <>.
Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, , <>.
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, , <>.
Bray, T., Paoli, J., Sperberg-McQueen, M., and E. Maler, "Extensible Markup Language (XML) 1.0 (Second Edition)", W3C, , <>.

6.2. Informative References

Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, , <>.
Veillette, M., Ed., Petrov, I., Ed., Pelov, A., Bormann, C., and M. Richardson, "Encoding of Data Modeled with YANG in the Concise Binary Object Representation (CBOR)", RFC 9254, DOI 10.17487/RFC9254, , <>.

Authors' Addresses

Alex Huang Feng
Pierre Francois
Thomas Graf
Binzring 17
CH-8045 Zurich
Benoit Claise