Network Working Group A. Huang Feng Internet-Draft P. Francois Updates: RFC5277 RFC8639 RFC7951 RFC9254 (if INSA-Lyon approved) T. Graf Intended status: Standards Track Swisscom Expires: 19 December 2024 B. Claise Huawei 17 June 2024 YANG model for NETCONF Event Notifications draft-ahuang-netconf-notif-yang-05 Abstract This document defines the structure of NETCONF Event Notification in a YANG model to be used in NETCONF environments. The definition of this YANG model allows the encoding of NETCONF Event Notifications in YANG compatible encodings such as JSON and CBOR. 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 19 December 2024. Huang Feng, et al. Expires 19 December 2024 [Page 1] Internet-Draft NETCONF Event Notification YANG June 2024 Copyright Notice Copyright (c) 2024 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 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 . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Relationship to past documents . . . . . . . . . . . . . . . 3 2.1. Relationship to RFC5277 . . . . . . . . . . . . . . . . . 3 2.2. Relationship to RFC8639 . . . . . . . . . . . . . . . . . 4 2.3. Relationship to RFC7951 . . . . . . . . . . . . . . . . . 4 2.4. Relationship to RFC9254 . . . . . . . . . . . . . . . . . 4 3. Differences to draft-ietf-netconf-notification-messages . . . 4 4. NETCONF Notification structure . . . . . . . . . . . . . . . 5 4.1. XML Structure . . . . . . . . . . . . . . . . . . . . . . 5 4.2. JSON Structure . . . . . . . . . . . . . . . . . . . . . 5 4.3. CBOR Structure . . . . . . . . . . . . . . . . . . . . . 6 5. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 8 5.1. YANG Tree Diagram . . . . . . . . . . . . . . . . . . . . 8 5.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8 6. Security Considerations . . . . . . . . . . . . . . . . . . . 10 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 10 7.1. URI . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 7.2. YANG module name . . . . . . . . . . . . . . . . . . . . 10 7.3. YANG SID-file . . . . . . . . . . . . . . . . . . . . . . 11 8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 11 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 11 9.1. Normative References . . . . . . . . . . . . . . . . . . 11 9.2. Informative References . . . . . . . . . . . . . . . . . 13 Appendix A. .sid file . . . . . . . . . . . . . . . . . . . . . 13 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14 Huang Feng, et al. Expires 19 December 2024 [Page 2] Internet-Draft NETCONF Event Notification YANG June 2024 1. Introduction NETCONF Event Notifications [RFC5277] and YANG-Push [RFC8639] allow NETCONF [RFC6241] servers and YANG-Push publishers to send notifications to a data collection. The NETCONF client and the YANG- Push receiver decodes the message and optionally validates the header and the content before forward it to the next process. This schema validation process ensures to not break the data processing chain. The structure of a NETCONF Event notification has been defined in [RFC5277] using a XML Schema [W3C.REC-xml-20001006] allowing NETCONF nodes to validate the header schema of the notification message when it is encoded in XML. However, when these notifications are sent using YANG-Push [RFC8639][RFC8641], they can be encoded in other encodings such as JSON [RFC7951] or CBOR [RFC9254]. In such cases, the model defined in [RFC5277] cannot be used to validate the notification header. This document defines the content of the header of such notifications allowing implementations to validate the schema of the notifications when they are encoded in other encodings than XML. A YANG 1.1 [RFC7950] model is defined for such purposes. This document updates [RFC5277], [RFC8639] and [RFC7951] specifying how a Notification header should be encoded. RESTCONF Notifications [RFC8040] are out of scope of this document. 2. Relationship to past documents This section exposes the relationship to [RFC5277], [RFC8639], [RFC7951] and [RFC9254]. 2.1. Relationship to RFC5277 [RFC5277] defines a mechanism for NETCONF nodes to send notifications to a collector. These are the key relationships between the current document and [RFC5277]: * Section 2.1 of [RFC5277] defines how to configure a subscription to receive NETCONF Event Notifications. The RPCs are defined in the XML schema in Section 3.4 of [RFC5277]. This document does not update or add any new RPCs to this schema. * The notification structure is defined in Section 4 of [RFC5277] using a XML schema. This document defines the structure of the notification in XML, JSON and CBOR in Section 4. In XML, the same structure is used. Huang Feng, et al. Expires 19 December 2024 [Page 3] Internet-Draft NETCONF Event Notification YANG June 2024 2.2. Relationship to RFC8639 Subscribed Notifications [RFC8639] defines a mechanism on top of [RFC5277] to stream notifications from the NETCONF node. These are the key relationships between the current document and [RFC8639]: * Section 1.4 of [RFC8639] states that the the solution uses the notification structure defined in [RFC5277]. This document replaces this structure using a YANG module allowing JSON and CBOR encodings. 2.3. Relationship to RFC7951 [RFC7951] defines how YANG data is encoded using JSON. These are the key relationship points between the current document and [RFC7951]: * [RFC7951] does not define explicitely how a YANG notification should be encoded using JSON encoding. This document specifies the structure of such notification for JSON when these are used in a NETCONF [RFC6241] environment. 2.4. Relationship to RFC9254 [RFC9254] defines how YANG data is encoded using CBOR. These are the key relationship points between the current document and [RFC9254]: * [RFC9254] does not define explicitely how a YANG notification should be encoded using CBOR encoding. [RFC9254] states that Notifications are container-like instances which does not follow how notifications are encoded in XML and JSON encodings. This document replaces this statement and ensures consistency between the different notification structures in YANG. This structure is to be used within NETCONF [RFC6241] environments. 3. Differences to draft-ietf-netconf-notification-messages Note to the RFC-Editor: Please remove this section before publishing. [I-D.ietf-netconf-notification-messages] proposes a structure to send multiple notifications in a single message. Unlike [I-D.ietf-netconf-notification-messages], this document defines a YANG module to encode NETCONF Notifications with encodings other than XML, which is currently not existing. The structure for NETCONF notifications is defined in [RFC5277] using a XSD, but there is no YANG module defining the structure of the notification message sent by a server when the message is encoded in JSON [RFC7951] or CBOR [RFC9254]. Huang Feng, et al. Expires 19 December 2024 [Page 4] Internet-Draft NETCONF Event Notification YANG June 2024 4. NETCONF Notification structure This section defines how NETCONF YANG Notifications are structured in XML, JSON and CBOR encodings. The same namespace "ietf-notification" is used to be compliant with [RFC5277]. 4.1. XML Structure The same structure as defined in Section 4 of [RFC5277] is used. The structure uses the XML namespace that has been defined in [RFC5277]: urn:ietf:params:xml:ns:netconf:notification:1.0 Two child nodes within the "notification" container are expected, representing the event time and the notification payload. The "eventTime" node is defined within the same XML namespace as the "notification" element and is compliant with [RFC3339]. The name and namespace of the payload element are determined by the YANG module containing the notification statement representing the notification message. The following example shows a "push-update" notification defined in the YANG module of YANG-Push [RFC8641] encoded in XML: 2022-09-02T10:59:55.32Z 1011 eth0 up Figure 1: XML-encoded notification 4.2. JSON Structure A YANG notification encoded in JSON is structured as a root "notification" container. The namespace of this container is the name of the YANG module "ietf-notification" defined in Section 5. Huang Feng, et al. Expires 19 December 2024 [Page 5] Internet-Draft NETCONF Event Notification YANG June 2024 Two child nodes within the "ietf-notification:notification" container are expected, representing the event time and the notification payload. The "eventTime" node is defined within the same namespace as the "ietf-notification:notification" container and is compliant with [RFC3339]. The following example shows a "push-update" notification defined in the YANG module of YANG-Push [RFC8641] encoded in JSON: { "ietf-notification:notification": { "eventTime": "2023-02-10T08:00:11.22Z", "ietf-yang-push:push-update": { "id": 1011, "datastore-contents": { "ietf-interfaces:interfaces": [ { "interface": { "name": "eth0", "oper-status": "up" } } ] } } } } Figure 2: JSON-encoded notification When Notifications are implemented within RESTCONF [RFC8040] environments, the namespace of a notification stays "ietf- restconf:notification" as defined in Section 6.4 of [RFC8040]. 4.3. CBOR Structure YANG data can be represented in CBOR using Names or SIDs in keys. The following sections shows how these messages are encoded in both cases. 4.3.1. CBOR encoded messages Notifications encoded using keys is similar to JSON encoding as defined in Section 3.3 of [RFC9254]. The key of the element can be the element itself or be namespace-qualified. In the latter case, the namespace of the notification container uses the YANG module name "ietf-notification" defined in Section 5. Huang Feng, et al. Expires 19 December 2024 [Page 6] Internet-Draft NETCONF Event Notification YANG June 2024 Two child nodes within the "ietf-notification:notification" container are expected, representing the event time and the notification payload. The "eventTime" node is defined within the same namespace as the "ietf-notification:notification" container and is compliant with [RFC3339]. The following example shows a "push-update" notification defined in the YANG module of YANG-Push [RFC8641] encoded in CBOR using names as keys. The example uses the CBOR diagnostic notation as defined in section 3.1 of [RFC9254]: { "ietf-notification:notification": { "eventTime": "2023-02-10T08:00:11.22Z", "ietf-yang-push:push-update": { "id": 1011, "datastore-contents": { "ietf-interfaces:interfaces": [ { "interface": { "name": "eth0", "oper-status": "up" } } ] } } } } Figure 3: CBOR-encoded notification using diagnostic notation 4.3.2. CBOR encoded messages using YANG-SIDs A Notification encoded using YANG-SIDs replaces the names of the keys of the CBOR encoded message for a 63 bit unsigned integer. This is defined in Section 3.2 of [RFC9254] and a process for SID allocation is defined in [I-D.ietf-core-sid]. Two child nodes within the root container are expected, representing the event time and the notification payload. The root container and the "eventTime" node uses a SID and the content of the "eventTime" is compliant with [RFC3339]. This is an example of YANG-CBOR encoded notification using YANG SIDs [RFC9254]. The Figure 4 shows the message using the CBOR diagnostic notation as defined in section 3.1 of [RFC9254]: Huang Feng, et al. Expires 19 December 2024 [Page 7] Internet-Draft NETCONF Event Notification YANG June 2024 { 2551: { 1: "2023-02-10T08:00:11.22Z", "ietf-yang-push:push-update": { "id": 1011, "datastore-contents": { "ietf-interfaces:interfaces": [ { "interface": { "name": "eth0", "oper-status": "up" } } ] } } } } Figure 4: CBOR-encoded notification using YANG SIDs in CBOR diagnostic notation 5. YANG Module 5.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]. The name of the leaf matches the definition of the XSD element name defined in Section 4 of [RFC5277]. module: ietf-notification structure notification: +-- eventTime yang:date-and-time 5.2. YANG Module The YANG module uses the same namespace from the XML Schema defined in Section 4 of [RFC5277] allowing to use this YANG module to also validate already implemented XML encoded NETCONF Event Notifications. file "ietf-notification@2024-06-17.yang" module ietf-notification { yang-version 1.1; namespace "urn:ietf:params:xml:ns:netconf:notification:1.0"; prefix inotif; import ietf-yang-types { Huang Feng, et al. Expires 19 December 2024 [Page 8] Internet-Draft NETCONF Event Notification YANG June 2024 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: Alex Huang Feng Pierre Francois Thomas Graf Benoit Claise "; description "Defines NETCONF Event Notification structure as defined in RFC5277 and RFC7950. This YANG module uses the same namespace from the XML schema defined in Section 4 of RFC5277 to be able to validate already implemented XML encoded messages. This module can be used to validate XML encoded notifications [RFC7950], JSON encoded messages [RFC7951] and CBOR encoded messages [RFC9254]. Refer to Section 4 of RFC XXXX for more details. Copyright (c) 2024 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 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; Huang Feng, et al. Expires 19 December 2024 [Page 9] Internet-Draft NETCONF Event Notification YANG June 2024 revision 2024-06-17 { description "First revision"; reference "RFC XXXX: NETCONF Event Notification YANG"; } sx:structure notification { leaf eventTime { type yang:date-and-time; mandatory true; description "The date and time the event was generated by the event source. This parameter is of type dateTime and compliant to [RFC3339]. Implementations must support time zones. The leaf name in camel case matches the name of the XSD element defined in Section 4 of RFC5277."; } } } 6. Security Considerations The security considerations for the NETCONF Event notifications are described in [RFC5277]. This documents adds no additional security considerations. 7. IANA Considerations This document describes the URI used for the IETF XML Registry and registers a new YANG module name. 7.1. URI IANA is requested to add this document as a reference in the following URI in the IETF XML Registry [RFC3688]. URI: urn:ietf:params:xml:ns:netconf:notification:1.0 Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. Reference: RFC5277; RFC-to-be 7.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 19 December 2024 [Page 10] Internet-Draft NETCONF Event Notification YANG June 2024 name: ietf-notification namespace: urn:ietf:params:xml:ns:netconf:notification:1.0 prefix: inotif reference: RFC-to-be 7.3. YANG SID-file IANA is requested to register a new ".sid" file in the "IETF YANG SID Registry" [I-D.ietf-core-sid]: SID range entry point: TBD SID range size: 50 YANG module name: ietf-notification reference: RFC-to-be A ".sid" file is proposed in Appendix A. 8. Acknowledgements The authors would like to thank Per Anderson, Andy Bierman, Carsten Bormann, Mohamed Boucadair, Tom Petch, Jason Sterne, Kent Watsen and Rob Wilton for their review and valuable comments. 9. References 9.1. Normative References [I-D.ietf-core-sid] Veillette, M., Pelov, A., Petrov, I., Bormann, C., and M. Richardson, "YANG Schema Item iDentifier (YANG SID)", Work in Progress, Internet-Draft, draft-ietf-core-sid-24, 22 December 2023, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, DOI 10.17487/RFC3339, July 2002, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . Huang Feng, et al. Expires 19 December 2024 [Page 11] Internet-Draft NETCONF Event Notification YANG June 2024 [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, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, DOI 10.17487/RFC6991, July 2013, . [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, . [RFC7951] Lhotka, L., "JSON Encoding of Data Modeled with YANG", RFC 7951, DOI 10.17487/RFC7951, August 2016, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8639] Voit, E., Clemm, A., Gonzalez Prieto, A., Nilsen-Nygaard, E., and A. Tripathy, "Subscription to YANG Notifications", RFC 8639, DOI 10.17487/RFC8639, September 2019, . [RFC8641] Clemm, A. and E. Voit, "Subscription to YANG Notifications for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641, September 2019, . [RFC8791] Bierman, A., Björklund, M., and K. Watsen, "YANG Data Structure Extensions", RFC 8791, DOI 10.17487/RFC8791, June 2020, . [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, . Huang Feng, et al. Expires 19 December 2024 [Page 12] Internet-Draft NETCONF Event Notification YANG June 2024 [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, . 9.2. Informative References [I-D.ietf-netconf-notification-messages] Voit, E., Jenkins, T., Birkholz, H., Bierman, A., and A. Clemm, "Notification Message Headers and Bundles", Work in Progress, Internet-Draft, draft-ietf-netconf-notification- messages-08, 17 November 2019, . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, . Appendix A. .sid file Note to the RFC-Editor: Please remove this section before publishing. For CBOR encoding using YANG-SIDs identifiers, a ".sid" file is requested to IANA in Section 7.3. Huang Feng, et al. Expires 19 December 2024 [Page 13] Internet-Draft NETCONF Event Notification YANG June 2024 file "ietf-notification@2024-05-27.sid" { "ietf-sid-file:sid-file": { "module-name": "ietf-notification", "module-revision": "2024-05-27", "description": "NETCONF Event Notification structure", "dependency-revision": [ { "module-name": "ietf-yang-types", "module-revision": "2013-07-15" }, { "module-name": "ietf-yang-structure-ext", "module-revision": "2020-06-17" } ], "assignment-range": [ { "entry-point": "2550", "size": "50" } ], "item": [ { "namespace": "module", "identifier": "ietf-notification", "sid": "2550" }, { "namespace": "data", "identifier": "/ietf-notification:notification", "sid": "2551" }, { "namespace": "data", "identifier": "/ietf-notification:notification/eventTime", "sid": "2552" } ] } } Figure 5: .sid file for "ietf-notification" module Authors' Addresses Huang Feng, et al. Expires 19 December 2024 [Page 14] Internet-Draft NETCONF Event Notification YANG June 2024 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 19 December 2024 [Page 15]