Network Working Group A. Huang Feng Internet-Draft P. Francois Updates: RFC5277 (if approved) INSA-Lyon Intended status: Standards Track T. Graf Expires: 29 July 2023 Swisscom B. Claise Huawei 25 January 2023 YANG model for NETCONF Event Notifications draft-ahuang-netconf-notif-yang-00 Abstract 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 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 29 July 2023. Copyright Notice Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved. Huang Feng, et al. Expires 29 July 2023 [Page 1] Internet-Draft NETCONF Event Notification YANG January 2023 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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 2 2.1. YANG Tree Diagram . . . . . . . . . . . . . . . . . . . . 2 2.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 3 3. Security Considerations . . . . . . . . . . . . . . . . . . . 4 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 4 4.1. URI . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 4.2. YANG module name . . . . . . . . . . . . . . . . . . . . 4 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 5 6. References . . . . . . . . . . . . . . . . . . . . . . . . . 5 6.1. Normative References . . . . . . . . . . . . . . . . . . 5 6.2. Informative References . . . . . . . . . . . . . . . . . 5 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 6 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 Huang Feng, et al. Expires 29 July 2023 [Page 2] Internet-Draft NETCONF Event Notification YANG January 2023 2.2. YANG Module file "ietf-notification@2023-01-16.yang" module ietf-notification { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-notification"; prefix inn; import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-yang-structure-ext { prefix sx; reference "RFC 8791: YANG Data Structure Extensions"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: Authors: Thomas Graf Benoit Claise Pierre Francois Alex Huang Feng "; description "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 (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; Huang Feng, et al. Expires 29 July 2023 [Page 3] Internet-Draft NETCONF Event Notification YANG January 2023 revision 2023-01-16 { description "First revision"; reference "RFC XXXX: NETCONF Event Notification YANG"; } sx:structure notification { leaf eventTime { type yang:date-and-time; mandatory true; description "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: Huang Feng, et al. Expires 29 July 2023 [Page 4] Internet-Draft NETCONF Event Notification YANG January 2023 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 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, DOI 10.17487/RFC5277, July 2008, . [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, October 2010, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [W3C.REC-xml-20001006] Bray, T., Paoli, J., Sperberg-McQueen, M., and E. Maler, "Extensible Markup Language (XML) 1.0 (Second Edition)", W3C, October 2000, . 6.2. Informative References [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . Huang Feng, et al. Expires 29 July 2023 [Page 5] Internet-Draft NETCONF Event Notification YANG January 2023 [RFC9254] 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, July 2022, . Authors' Addresses Alex Huang Feng INSA-Lyon Lyon France Email: alex.huang-feng@insa-lyon.fr Pierre Francois INSA-Lyon Lyon France Email: pierre.francois@insa-lyon.fr Thomas Graf Swisscom Binzring 17 CH-8045 Zurich Switzerland Email: thomas.graf@swisscom.com Benoit Claise Huawei Email: benoit.claise@huawei.com Huang Feng, et al. Expires 29 July 2023 [Page 6]