YANG model for NETCONF Event Notifications

NETCONF Event Notifications and YANG-Push allow NETCONF 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 using a XML Schema 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 , they can be encoded in other encodings such as JSON or CBOR . In such cases, the model defined in 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 model is defined for such purposes. This document updates , and specifying how a Notification header should be encoded. RESTCONF Notifications are out of scope of this document.

This section exposes the relationship to , , and .

defines a mechanism for NETCONF nodes to send notifications to a collector. These are the key relationships between the current document and :

Section 2.1 of defines how to configure a subscription to receive NETCONF Event Notifications. The RPCs are defined in the XML schema in Section 3.4 of . This document does not update or add any new RPCs to this schema.
The notification structure is defined in Section 4 of using a XML schema. This document defines the structure of the notification in XML, JSON and CBOR in . In XML, the same structure is used.

Subscribed Notifications defines a mechanism on top of to stream notifications from the NETCONF node. These are the key relationships between the current document and :

Section 1.4 of states that the the solution uses the notification structure defined in . This document replaces this structure using a YANG module allowing JSON and CBOR encodings.

defines how YANG data is encoded using JSON. These are the key relationship points between the current document and :

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 environment.

defines how YANG data is encoded using CBOR. These are the key relationship points between the current document and :

does not define explicitely how a YANG notification should be encoded using CBOR encoding. 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 environments.

Note to the RFC-Editor: Please remove this section before publishing. proposes a structure to send multiple notifications in a single message. Unlike , 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 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 or CBOR .

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 .

The same structure as defined in Section 4 of is used. The structure uses the XML namespace that has been defined in : 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 . 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 encoded in XML:

2022-09-02T10:59:55.32Z 1011

eth0

]]>

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 . 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 . The following example shows a "push-update" notification defined in the YANG module of YANG-Push encoded in JSON:

When Notifications are implemented within RESTCONF environments, the namespace of a notification stays "ietf-restconf:notification" as defined in Section 6.4 of .

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.

Notifications encoded using keys is similar to JSON encoding as defined in Section 3.3 of . 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 . 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 . The following example shows a "push-update" notification defined in the YANG module of YANG-Push encoded in CBOR using names as keys. The example uses the CBOR diagnostic notation as defined in section 3.1 of :

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 and a process for SID allocation is defined in . 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 . This is an example of YANG-CBOR encoded notification using YANG SIDs . The shows the message using the CBOR diagnostic notation as defined in section 3.1 of :

This YANG module adds a structure with one leaf for the datetime as defined in section 2.2.1 of . The name of the leaf matches the definition of the XSD element name defined in Section 4 of .

The YANG module uses the same namespace from the XML Schema defined in Section 4 of allowing to use this YANG module to also validate already implemented XML encoded NETCONF Event Notifications. 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."; 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."; } } } ]]>

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

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

IANA is requested to add this document as a reference in the following URI in the IETF XML Registry.

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

IANA is requested to register a new ".sid" file in the "IETF YANG SID Registry": A ".sid" file is proposed in .

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.

Extensible Markup Language (XML) 1.0 (Second Edition) W3C

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 .