| Internet-Draft | YANG-Push Notification Envelope | October 2025 |
| Huang-Feng, et al. | Expires 23 April 2026 | [Page] |
This document defines a new extensible notification structure, defined in YANG, for use in YANG-Push Notification messages enabling any YANG-compatible encodings such as XML, JSON, or CBOR. Additionally, it defines two essential extensions to this structure, the support of a hostname and a sequence number and the support of a timestamp characterizing the moment when the changed data was observed.¶
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 23 April 2026.¶
Copyright (c) 2025 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.¶
YANG-Push [RFC8639] allows publishers to send notifications to a data collection system. The YANG-Push receiver decodes the message and optionally validates the header and the content before forwarding to the next process in the data collection system.¶
The notification container from YANG-Push is currently based on the XML model from NETCONF Event Notifications [RFC5277]. This model has the drawback that only a single mandatory "eventTime" leaf is defined and does not offer a way to extend this header with new notification metadata. Additionally, this XML model is only valid for XML-based environments. When messages are encoded in other YANG encodings, such as JSON [RFC7951] or CBOR [RFC9254], validators cannot use YANG to validate the message schema.¶
YANG data consumers receiving notifications require additional notification metadata to understand the full context of the received message. For example, in addition to the timestamp of when the event was encoded, it is also important to know the timestamp when the metrics were observed, the hostname that sourced the message, and have sequence numbers. The hostname is required because transport-level source information is not preserved once notifications are forwarded to downstream systems, and having sequence numbers at the notification level enable operators to detect lost notifications throughout the data processing chain. This additional notification metadata is also helpful in correlating the data with other sources of Network Telemetry [RFC9232] information.¶
For such reasons, this document proposes the following:¶
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.¶
The terms "subscriber", "publisher", and "receiver" are used as defined in [RFC8639].¶
The term "client" is used as defined in [RFC6241] for NETCONF and [RFC8040] for RESTCONF.¶
The terms "implementation-time information" and "runtime information" are used as defined in [RFC9196].¶
In addition, this document defines the following terms:¶
Notification Metadata: Additional data describing the context of a notification that is sent in each message, e.g. which node generated the messsage or at which time the notification was published.¶
Notification Envelope: YANG structure encapsulating the payload of a notification, allowing the inclusion of metadata.¶
This section shows the relationship to [RFC5277], [RFC8639], [RFC7951] and [RFC9254].¶
[RFC5277] defines a mechanism for NETCONF nodes to send notifications to a collector. These are the key relationships between the current document and [RFC5277]:¶
Subscribed Notifications [RFC8639] defines a mechanism on top of [RFC5277] to stream notifications from the server (typically a NETCONF or a RESTCONF server). These are the key relationships between the current document and [RFC8639]:¶
[RFC7950] defines how YANG data is encoded in XML. These are the key relationship points between the current document and [RFC7950]:¶
[RFC7951] defines how YANG data is encoded using JSON. These are the key relationship points between the current document and [RFC7951]:¶
[RFC9254] defines how YANG data is encoded using CBOR. These are the key relationship points between the current document and [RFC9254]:¶
Section 4.2.10 of [RFC7950] defines the encoding of YANG notifications. A notification is defined by a 'notification' statement in the YANG module. When a NETCONF server sends a notification, it comprises two parts: a header containing notification metadata that encapsulates the content and the content defined by the 'notification' statement.¶
In YANG 1.1 [RFC7950], the notification header is based on the model defined in [RFC5277] which contains a single metadata 'eventTime' leaf. An example extracted from [RFC7950] is shown in the following XML:¶
<notification
xmlns="urn:ietf:params:netconf:capability:notification:1.0">
<eventTime>2007-09-01T10:00:00Z</eventTime>
<link-failure xmlns="urn:example:system">
<if-name>so-1/2/3.0</if-name>
<if-admin-status>up</if-admin-status>
<if-oper-status>down</if-oper-status>
</link-failure>
</notification>
¶
This document defines a new notification header and enables extending this header with new notification metadata. The notification header and extensions defined in the following sections are to be used in YANG-Push [RFC8641] environments and can be implemented with NETCONF [RFC6241] and RESTCONF [RFC8040]. Thus, when enabled, this new header globally replaces all notifications defined in both Subscribed Notifications [RFC8639] and YANG-Push [RFC8641] for the entire server.¶
Section 3.1 defines how a client enables the header defined in this document. Section 3.2 extends the model from [RFC9196] to enable clients to discover the capability of using the new notification header for both implementation-time and runtime information. Lastly, Section 3.3.2 defines the new notification header and how it is encoded using XML, JSON, and CBOR.¶
The notification envelope defined in this document can be enabled either prior to or within the same NETCONF transaction that configures the YANG-Push subscriptions. This document augments the "ietf-subscribed-notification" model [RFC8639] to support the configuration of the "notification-envelope". When the node 'enable-notification-envelope' is enabled, all the notifications defined in Subscribed Notification [RFC8639] and YANG-Push [RFC8641] are encoded as defined in Section 3.3. If additionally, any notification metadata is enabled, the notification metadata nodes are present in the header. When the node 'enable-notification-envelope' is disabled, notifications are encoded as defined in NETCONF Event Notifications [RFC5277].¶
module: ietf-yp-notification
augment /sn:subscriptions:
+--rw enable-notification-envelope? boolean
+--rw metadata
¶
When there are existing subscriptions and a client changes the node 'enable-notification-envelope', all existing subscriptions MUST be terminated. The publisher MUST send a 'subscription-terminated' notification to all the existing subscriptions using the header configured before the change. Any new subscription after the change uses the header defined by the node 'enable-notification-envelope', i.e. encoded as Section 3.3.1 when enabled and as defined in [RFC5277] if disabled.¶
A client can discover the support of 'notification-envelope' model through the capabilities model defined in [RFC9196]. This documents extends the 'ietf-notification-capabilities' model with:¶
The "ietf-yp-notification" model defined in Section 5 augments the 'ietf-notification-capabilities' model with the leaf and container listed above:¶
augment /sysc:system-capabilities/notc:subscription-capabilities:
+--ro notification-metadata
+--ro envelope? boolean
+--ro metadata
¶
This section defines how YANG notifications are structured when the notification envelope is enabled on YANG-Push subscriptions. The following sections define how this model is encoded in XML, JSON and CBOR.¶
When a YANG-Push publisher uses the notification model defined in this document, the notification is structured as follows:¶
The following YANG tree [RFC8340] illustrates the notification envelope supporting only the mandatory metadata 'event-time'. See Section 3.4 for more extensions to this header.¶
structure envelope:
+-- event-time yang:date-and-time
+-- contents? <anydata>
¶
The YANG notification can be encoded using XML [W3C.REC-xml-20001006][RFC7951], JSON [RFC7951] and CBOR [RFC9254].¶
A YANG notification encoded in XML is structured as a root "envelope" container. The namespace of this container is the namespace defined in the YANG module "ietf-yp-notification":¶
urn:ietf:params:xml:ns:yang:ietf-yp-notification¶
Two mandatory child nodes within the "envelope" container are expected, representing the event time and the notification payload.¶
When other notification metadata is enabled through configuration, the supplementary nodes are encoded at the same level as the mandatory "event-time" node. The YANG nodes in the notification header use the XML namespace from the module that defines the nodes. This document defines two notification metadata. See Section 3.4 for more details.¶
The content of the notification that is defined by the 'notification' statement is encoded in the "contents" node. The name and namespace of this 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:¶
<envelope xmlns="urn:ietf:params:xml:ns:yang:ietf-yp-notification">
<event-time>2024-10-10T10:59:55.32Z</event-time>
<contents>
<push-update xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push">
<id>1011</id>
<datastore-contents>
<interfaces
xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
<interface>
<name>eth0</name>
<type>iana-if-type:ethernetCsmacd</type>
<if-index>1</if-index>
<admin-status>down</admin-status>
<oper-status>down</oper-status>
<statistics>
<discontinuity-time>
2013-04-01T03:00:00+00:00
</discontinuity-time>
</statistics>
</interface>
</interfaces>
</datastore-contents>
</push-update>
</contents>
</envelope>
A YANG notification encoded in JSON is structured as a root "envelope" container. The namespace of this container is the name of the YANG module "ietf-yp-notification" defined in Section 5.1.2.¶
Two mandatory child nodes within the "ietf-notification:envelope" container are expected, representing the event time and the notification payload. The "event-time" node is defined within the same namespace as the "ietf-yp-notification:envelope" container.¶
When other notification metadata is enabled through configuration, the supplementary nodes are encoded at the same level as the mandatory 'event-time' node. The YANG nodes in the notification header use the YANG module name from the module that defines the nodes as its namespace. Two additional metadata are described in this document. Refer to Section 3.4 for more details.¶
The content of the notification that is defined by the 'notification' statement is encoded in the "contents" node. The name and namespace of this 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 JSON:¶
{
"ietf-yp-notification:envelope": {
"event-time": "2024-10-10T08:00:11.22Z",
"contents": {
"ietf-yang-push:push-update": {
"id": 1011,
"datastore-contents": {
"ietf-interfaces:interfaces": {
"interface": [
{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "up",
"statistics": {
"discontinuity-time": "2024-10-10T07:50:00Z"
}
}
]
}
}
}
}
}
}
YANG notifications can be encoded in CBOR using Names or SIDs in keys.¶
Notifications encoded using names is similar to JSON encoding as defined in Section 3.3 of [RFC9254]. The key of the element can be the name of the element itself or be namespace-qualified. In the latter case, the namespace of the notification container uses the YANG module name "ietf-yp-notification", defined in Section 5.1.2.¶
Notification encoded using YANG-SIDs replaces the names of the keys of the CBOR encoded message with a 63-bit unsigned integer. In this case, the keys of the encoded data use the SID value as defined in Section 3.2 of [RFC9254]. A SID allocation process is needed beforehand as defined in [RFC9595].¶
In the notification, two mandatory child nodes within the "ietf-yp-notification:envelope" container are expected, representing the event time and the notification payload. The "event-time" node is defined within the same namespace as the "ietf-yp-notification:envelope" container.¶
When other notification metadata is enabled through configuration, the supplementary nodes are encoded at the same level as the mandatory "event-time" node. The YANG nodes in the notification header use the YANG module name from the module that defines the nodes as its namespace when they are encoded as names. When encoded using YANG SIDs, the SID value assigned to the metadata node is used. A .sid file requesting the SID values for the metadata defined in this document can be found in Appendix A. The .sid file includes the metadata defined in Section 3.4.¶
The content of the notification that is defined by the 'notification' statement is encoded in the "contents" node. The name and namespace of this payload element are determined by the YANG module containing the 'notification' statement representing the notification message. Similarly, SIDs can be used as keys if they are allocated following the process defined in [RFC9595].¶
Figure 3 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-yp-notification:envelope": {
"event-time": "2024-10-10T08:00:11.22Z",
"contents": {
"ietf-yang-push:push-update": {
"id": 1011,
"datastore-contents": {
"ietf-interfaces:interfaces": {
"interface": [
{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "up",
"statistics": {
"discontinuity-time": "2024-10-10T07:50:00Z"
}
}
]
}
}
}
}
}
}
Figure 4 shows the same notification encoded using SIDs:¶
{
2957: { / ietf-yp-notification:envelope (SID 2957) /
2: "2024-10-10T08:00:11.22Z", / event-time (SID 2959) /
1: { / contents (SID 2958) /
"ietf-yang-push:push-update": {
"id": 1011,
"datastore-contents": {
"ietf-interfaces:interfaces": {
"interface": [
{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "up",
"statistics": {
"discontinuity-time": "2024-10-10T07:50:00.00Z"
}
}
]
}
}
}
}
}
}
Note that in the example shown in Figure 4, the notification payload uses names as keys. These keys can also be encoded as SIDs. The corresponding SID values must be allocated in the IANA registry, following the procedures defined in [RFC9595].¶
When SIDs are used throughout the notification envelope, they are encoded as deltas relative to the parent node by default. The absolute SID can also be used using the tag 47. Refer to [RFC9254] for more details.¶
This section describes two optional YANG nodes for the envelope header. When the envelope is enabled via the "enable-notification-envelope" node, the publisher includes by default the "hostname" and "sequence-number" defined in Section 3.4.1. The client discovers the support of these two optional leafs with the mechanism defined in Section 3.2. When the leafs defined in this document are supported by the server, the client discovers the presence of new metadata with the following augmentations in the 'ietf-notification-capabilities':¶
module: ietf-yp-notification
augment /sysc:system-capabilities/notc:subscription-capabilities:
+--ro notification-metadata
+--ro envelope? boolean
+--ro metadata
+--ro hostname-sequence-number? boolean
module: ietf-yp-observation
augment /sysc:system-capabilities/notc:subscription-capabilities:
+--ro yang-push-observation-supported? boolean
¶
This document defines the following notification metadata as shown in the following YANG tree [RFC8340].¶
structure envelope:
+-- event-time yang:date-and-time
+-- hostname? inet:host-name {hostname-sequence-number}?
+-- sequence-number? yang:counter32 {hostname-sequence-number}?
+-- contents? <anydata>
¶
When YANG-Push notification messages are forwarded from a receiver to another system, such as a message broker or a time series database, the transport context is lost since it is not part of the notification metadata of the notification container. Therefore, the downstream system is unable to associate the message with the publishing process (the exporting network node), nor able to detect message loss or reordering.¶
To correlate network data among different Network Telemetry planes as described in Section 3.1 of [RFC9232] or among different YANG-Push subscription types as defined in Section 3.1 of [RFC8641], a reference to the node streaming the data is needed. This is essential for understanding the timely relationship among these different planes and YANG-Push subscription types.¶
Today, network operators work around this impediment by preserving the transport source IP address and sequence numbers of the publishing process. However, this implies encoding this information in the YANG-Push notification messages which impact the semantic readability of the message in the downstream system.¶
On top of that, the transport source IP address might not represent the management IP address by which the YANG-Push publisher should be known. In other terms, the "source-host" [RFC6470], which is the "Address of the remote host for the session" might not be the management IP address.¶
To overcome these issues, this document defines a notification container extension with a hostname and a sequence number. This allows the downstream system to not only be able to identify from which network node, subscription, and time the message was published but also, the order of the published messages.¶
Figure 5 provides an example of a JSON encoded, [RFC8259], "push-update" notification message with 'hostname' and 'sequence-number' included.¶
{
"ietf-yp-notification:envelope": {
"event-time": "2023-03-25T08:30:11.22Z",
"hostname": "example-router.example.com",
"sequence-number": 1,
"contents": {
"ietf-yang-push:push-update": {
"id": 6666,
"datastore-contents": {
"ietf-interfaces:interfaces": {
"interface": [
{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "up",
"statistics": {
"discontinuity-time": "2023-03-25T08:20:00.00Z"
}
}
]
}
}
}
}
}
}
This section described two optional 'push-update' and 'push-change-update' notification header extensions which are enabled by default when using the notification envelope defined in this document. The client discovers the support of these two leafs with the mechanism defined in Section 3.2.¶
This document defines the following notification metadata as shown in the following YANG tree [RFC8340]. See the following sections for more details.¶
module: ietf-yp-observation
augment /yp:push-update:
+--ro timestamp? yang:date-and-time
+--ro point-in-time? enumeration
augment /yp:push-change-update:
+--ro timestamp? yang:date-and-time
+--ro point-in-time? enumeration
¶
To correlate network data among different Network Telemetry planes, as described in Section 3.1 of [RFC9232], or among different YANG-Push subscription types, as defined in Section 3.1 of [RFC8641], a receiver needs a timestamp reference to align all the metrics and events. The observation timestamp defined in this document characterizes the moment the state change was observed or the moment when the data was measured, so that a receiver can correctly align the collected data.¶
The delay between the YANG-Push export process and the reception of the message at the receiver instance can be measured using the node 'event-time' defined in Section 3.3.1. However, as the 'event-time' node only establishes the moment when the YANG-Push message was crafted and sent, the moment when such metrics were collected or the state changes were observed cannot be measured using this timestamp. The observation timestamp defined in this section characterizes the moment when the metrics were observed, which enable aligning the received metrics to the actual moment they were measured.¶
When the time bucket length in a time series database and the periodic YANG-Push subscription time are configured with the same values, the 'event-time' of the NETCONF notification message header can be used for indexing the data in the time series database. There is a variable delay between the observation timestamp, the 'event-time', and the "anchor-time" as described in Section 4.2 of [RFC8641]. When these timestamps are close to the time bucket boundaries, a time bucket may experience data collection discrepancies, e.g. 0 measurements are aggregated into one time bucket while the next time bucket contains 2 measurements. This leads to inconsistent accounting errors in the time series database. This problem is resolved using the observation timestamp instead of the 'event-time' for time series database indexation.¶
By extending YANG-Push Notifications with the observation timestamp and a 'point-in-time' node, the data collection process can always ensure it has the best available time for indexing the data. It can therefore use unconditionally the observation timestamp node in the data processing chain to correctly align the metrics and events. At the same time, the 'point-in-time' node ensures that the semantics associated with the timestamp are not lost throughout the data processing chain.¶
Besides the Subscription ID as described in Section 3.7 of [RFC8641], the following network observation time metadata objects are part of "push-update" and "push-change-update" notifications.¶
States the measurement observation time for the "push-update" notification in "periodic" subscriptions and for the "push-change-update" notification in "on-change" subscriptions.¶
By comparing the observation timestamp of two "push-update" notifications in a periodic subscription, the collector can deduce the actual cadence of the measurements, and compare it with the subscription configuration. In case of an "on-change" subscription it states the time when the network state change was observed.¶
The enumeration states at which point in time the value of the observation timestamp was observed. Choices are:¶
'current-accounting' states the point in time where the metrics are polled and observed in "periodic" subscriptions.¶
'initial-state' states the initial point in time when the subscription was established and the state was observed for "on-change sync on start" subscriptions.¶
'state-changed' states the point in time when the state change was observed after the subscription was established for "on-change" and "on-change sync on start" subscriptions.¶
This section illustrates the usage of the "point-in-time" node in two different subscriptions. Section 3.5.1.1.1 showcases a YANG-Push subscription monitoring the state of an interface using an 'on-change sync on start' subscription. Section 3.5.1.1.2 illustrates the usage of the 'point-in-time' node within periodic subscriptions.¶
Figure 6 illustrates the set of events that lead to the generation of 'on-change' YANG-Push notifications. This timeline depicts the following states and events:¶
Timeline ----------------------------------------------------------------------> | (T1) Interface | (T2) YANG-Push | (T3) Interface | (T4) YANG-Push | state changed | "on-change sync | state changed | "on-change" | to "Up". | on start" | to "Down". | notification | | subscription for | | with the new | | interface state | | interface state. | | is established. | | v v v v
At T2, after configuring the subscription, the publisher triggers a 'push-update' notification as depicted in Figure 7. The 'event-time' is the moment the YANG-Push process generates the notification (T2). The 'ietf-yp-observation:timestamp' node characterizes the moment of the interface changed it status to "Up" (T1). T1 is the latest moment this state was observed by the process. In this case, the 'point-in-time' node is set to 'initial-state'.¶
{
"ietf-yp-notification:envelope": {
"event-time": "2025-03-25T08:30:11.22Z",
"hostname": "example-router.example.com",
"sequence-number": 1,
"contents": {
"ietf-yang-push:push-update": {
"id": 6666,
"ietf-yp-observation:timestamp": "2025-03-25T08:29:30.22Z",
"ietf-yp-observation:point-in-time": "initial-state",
"datastore-contents": {
"ietf-interfaces:interfaces": {
"interface": [{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "up",
"statistics": {
"discontinuity-time": "2025-03-25T06:43:12Z"
}
}]
}
}
}
}
}
}
After T3, the publisher triggers a 'push-change-update' notification announcing an interface status change to the receiver as depicted in Figure 8. In this case, the 'ietf-yp-observation:timestamp' node characterizes the moment the interface changed its status at T3. The value of the 'event-time' node characterizes the moment the YANG-Push process generated the notification at T4.¶
{
"ietf-yp-notification:envelope": {
"event-time": "2025-03-25T08:35:12.22Z",
"hostname": "example-router.example.com",
"sequence-number": 1,
"contents": {
"ietf-yang-push:push-change-update": {
"id": 2222,
"ietf-yp-observation:timestamp": "2025-03-25T08:34:05.22Z",
"ietf-yp-observation:point-in-time": "state-changed",
"datastore-contents": {
"yang-patch": {
"patch-id": "52",
"edit": {
"edit-id": "edit_example_1",
"operation": "replace",
"target": "/ietf-interfaces:interfaces",
"value": {
"ietf-interfaces:interfaces": {
"interface": [{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "down",
"statistics": {
"discontinuity-time": "2025-03-25T06:43:12Z"
}
}]
}
}
}
}
}
}
}
}
}
In periodic subscription, the observation time characterizes the time when the metrics were polled from the datastore before it generates the actual YANG-Push message.¶
Figure 9 illustrates the delays associated with the generation of the YANG-Push message. The timeline shows the following states:¶
At every N interval, the process repeats the steps from T2 and T3, first polling the datastore to retrieve the data (T2) and then building and sending the notification to the receiver (T3).¶
Timeline
------------------------------------------------------>
| (T1) YANG-Push | (T2) YANG-Push | (T3) YANG-Push
| "periodic" | process polls | "periodic"
| subscription | the metrics | current
| for interface | from the | accounting.
| counter is | datastore. |
| established | |
v v v
An example of a 'push-update' notification is illustrated in Figure 10. This example represents a message sent at T3, after the process built the YANG-Push notification. The node 'event-time' characterizes the moment the YANG-Push process generated the message (T3). The node 'ietf-yp-observation:timestamp' establishes the moment when the metrics were polled from the datastore (T2). For these periodic subscriptions, the 'point-in-time' node must be set to 'current-accounting'.¶
{
"ietf-yp-notification:envelope": {
"event-time": "2023-03-25T08:30:12.25Z",
"hostname": "example-router.example.com",
"sequence-number": 1,
"contents": {
"ietf-yang-push:push-update": {
"id": 6666,
"ietf-yp-observation:timestamp": "2023-03-25T08:30:00.00Z",
"ietf-yp-observation:point-in-time": "current-accounting",
"datastore-contents": {
"ietf-interfaces:interfaces": {
"interface": [{
"name": "eth0",
"type": "iana-if-type:ethernetCsmacd",
"if-index": 1,
"admin-status": "up",
"oper-status": "up",
"statistics": {
"discontinuity-time": "2023-03-25T07:43:12Z",
"in-octets": 200,
"in-octets": 250
}
}]
}
}
}
}
}
}
As stated in Section 3.1, the notification envelope defined in this document replaces the header defined by NETCONF Event Notifications [RFC5277] when enabled. The NETCONF Event Notifications [RFC5277] header and the notification envelope defined in this document may coexist in a network. An operator deploying the header defined in this document should ensure clear separation of notification formats, either by assigning distinct receivers to each header type or by implementing validation and filtering mechanisms when both are present in the same network.¶
The following sections show the YANG tree and YANG module for the 'ietf-yp-notification' module.¶
This YANG module extends "ietf-subscribed-notifications" [RFC8641] and "ietf-notification-capabilities" [RFC9196] as shown in the following YANG tree [RFC8340]:¶
module: ietf-yp-notification
augment /sn:subscriptions:
+--rw enable-notification-envelope? boolean
+--rw metadata
augment /sysc:system-capabilities/notc:subscription-capabilities:
+--ro notification-metadata
+--ro envelope? boolean
+--ro metadata
+--ro hostname-sequence-number? boolean
structure envelope:
+-- event-time yang:date-and-time
+-- hostname? inet:host-name {hostname-sequence-number}?
+-- sequence-number? yang:counter32 {hostname-sequence-number}?
+-- contents? <anydata>
¶
The YANG module augments the module "ietf-subscribed-notifications" [RFC8641], augments the module "ietf-notification-capabilities" [RFC9196] and uses "ietf-yang-types" module [RFC6991] and "ietf-yang-structure-ext" module [RFC8791].¶
<CODE BEGINS> file "ietf-yp-notification@2025-10-20.yang"
module ietf-yp-notification {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-yp-notification";
prefix iypn;
import ietf-yang-types {
prefix yang;
reference
"draft-ietf-netmod-rfc6991-bis-18: Common YANG Data Types";
}
import ietf-inet-types {
prefix inet;
reference
"draft-ietf-netmod-rfc6991-bis-18: Common YANG Data Types";
}
import ietf-subscribed-notifications {
prefix sn;
reference
"RFC 8639: Subscription to YANG Notifications";
}
import ietf-system-capabilities {
prefix sysc;
reference
"RFC 9196: YANG Modules Describing Capabilities for
Systems and Datastore Update Notifications";
}
import ietf-notification-capabilities {
prefix notc;
reference
"RFC 9196: YANG Modules Describing Capabilities for
Systems and Datastore Update Notifications";
}
import ietf-yang-structure-ext {
prefix sx;
reference
"RFC 8791: YANG Data Structure Extensions";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <https://datatracker.ietf.org/group/netconf/>
WG List: <mailto:netconf@ietf.org>
Authors: Alex Huang Feng
<mailto:alex.huang-feng@insa-lyon.fr>
Pierre Francois
<mailto:pierre.francois@insa-lyon.fr>
Thomas Graf
<mailto:thomas.graf@swisscom.com>
Benoit Claise
<mailto:benoit@everything-ops.net>";
description
"Defines a notification header for Subscribed Notifications
[RFC8639] and YANG-Push [RFC8641]. When this notification header
is enabled through configuration, the root container of the
notification is encoded as defined in RFCXXX.
This module can be used to validate XML-encoded notifications
[RFC7950], JSON-encoded messages [RFC7951], and CBOR-encoded
messages [RFC9254]. Refer to Section 3.3.2 of RFC XXXX for more
details.
Copyright (c) 2025 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 2025-10-20 {
description
"Initial version.";
reference
"RFC XXXX: Extensible YANG Model for YANG-Push Notifications";
}
feature notification-envelope {
description
"This feature indicates the support of the notification
envelope structure defined in RFC XXXX.";
}
feature hostname-sequence-number {
description
"This feature indicates that hostname and sequence numbers are
supported.";
}
grouping notif-env-capabilities {
description
"This grouping defines the capabilities for
the notification-envelope defined in RFC XXXX
and the different supported metadata.";
leaf envelope {
type boolean;
default "false";
description
"Supports YANG-Push to use the notification-envelope
defined in RFC XXXX.";
}
container metadata {
description
"Container with the supported optional metadata by the
YANG-Push publisher.";
leaf hostname-sequence-number {
type boolean;
default "false";
description
"Supports hostname and sequence-number
in the YANG-Push notifications as defined in the
YANG-Push notification-envelope in RFC XXXX.";
}
}
}
sx:structure envelope {
leaf event-time {
type yang:date-and-time;
mandatory true;
description
"The date and time the event was generated by the network
node.";
}
leaf hostname {
if-feature "hostname-sequence-number";
type inet:host-name;
description
"The hostname of the network node. This value is usually
configured on the node by the administrator to identify
the node in the network uniquely.";
}
leaf sequence-number {
if-feature "hostname-sequence-number";
type yang:counter32;
description
"Unique sequence number as described in [RFC9187] for each
published message.";
}
anydata contents {
description
"This contains the values defined by the 'notification'
statement unchanged.";
}
}
// Subscription container
augment "/sn:subscriptions" {
description
"This augmentation adds the configuration switches for
enabling the notification envelope and metadata.";
leaf enable-notification-envelope {
type boolean;
default "false";
description
"Enables YANG-Push to use the notification-envelope
defined in RFC XXXX.";
}
container metadata {
description
"Container for configuring optional metadata.
Refer to Section 3.1 of RFC XXXX for more details.";
}
}
// YANG-Push Capabilities extension
augment "/sysc:system-capabilities"
+ "/notc:subscription-capabilities" {
description
"Extension to the subscription-capabilities model to enable
clients to learn whether the publisher supports the
notification-envelope";
container notification-metadata {
description
"Adds the notification metadata capabilities to subscription
capabilities.";
uses notif-env-capabilities;
}
}
}
<CODE ENDS>¶
The following sections show the YANG tree and YANG module for the 'ietf-yp-observation' module.¶
This YANG module extends "ietf-yang-push" [RFC8641] and "ietf-notification-capabilities" [RFC9196] as shown in the following YANG tree [RFC8340]:¶
module: ietf-yp-observation
augment /yp:push-update:
+--ro timestamp? yang:date-and-time
+--ro point-in-time? enumeration
augment /yp:push-change-update:
+--ro timestamp? yang:date-and-time
+--ro point-in-time? enumeration
augment /sysc:system-capabilities/notc:subscription-capabilities:
+--ro yang-push-observation-supported? boolean
¶
The YANG module augments the module "ietf-yang-push" [RFC8641], augments the module "ietf-system-capabilities" [RFC9196].¶
<CODE BEGINS> file "ietf-yp-observation@2025-10-20.yang"
module ietf-yp-observation {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-yp-observation";
prefix iypo;
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-yang-push {
prefix yp;
reference
"RFC 8641: Subscription to YANG Notifications for Datastore Updates";
}
import ietf-system-capabilities {
prefix sysc;
reference
"RFC 9196: YANG Modules Describing Capabilities for
Systems and Datastore Update Notifications";
}
import ietf-notification-capabilities {
prefix notc;
reference
"RFC 9196: YANG Modules Describing Capabilities for
Systems and Datastore Update Notifications";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <http:/tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
Authors: Thomas Graf
<mailto:thomas.graf@swisscom.com>
Benoit Claise
<mailto:benoit@everything-ops.net>
Alex Huang Feng
<mailto:alex.huang-feng@insa-lyon.fr>";
description
"Defines YANG-Push event notification header with the observation
time in streaming update notifications.
Copyright (c) 2025 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.";
revision 2025-10-20 {
description
"Initial version.";
reference
"RFC XXXX: Extensible YANG Model for YANG-Push Notifications";
}
grouping yang-push-observation {
description
"This grouping adds the observation timestamp for the observed metrics.";
leaf timestamp {
type yang:date-and-time;
description
"This is the time when the metrics were observed.";
}
leaf point-in-time {
type enumeration {
enum current-accounting {
description
"For periodic subscriptions, the point-in-time
where the metrics are being polled and observed.";
}
enum initial-state {
description
"For 'on-change sync on start' subscriptions, the
initial point in time when the subscription was established
and the state was observed.";
}
enum state-changed {
description
"For 'on-change sync on start' subscriptions, the
point in time when the state change was observed after the
subscription was established.";
}
}
description
"This describes at which point in time the metrics were observed";
}
}
// Event notifications
augment "/yp:push-update" {
description
"This augmentation adds the observation timestamp of the accounted
metrics in the push-update notification.";
uses iypo:yang-push-observation;
}
augment "/yp:push-change-update" {
description
"This augmentation adds the observation timestamp of the event
in the push-change-update notification.";
uses iypo:yang-push-observation;
}
// Event capabilities
augment "/sysc:system-capabilities"
+ "/notc:subscription-capabilities" {
description
"Add YANG-Push notification capabilities to system-level capability
container.";
leaf yang-push-observation-supported {
type boolean;
default "false";
description
"Specifies whether the publisher supports exporting
observation-timestamp and point-in-time in notifications.";
reference
"RFC XXXX: Extensible YANG Model for YANG-Push Notifications";
}
}
}
<CODE ENDS>¶
Note to the RFC-Editor: Please remove this section before publishing.¶
Huawei implemented in push-update and push-change-update notifications the timestamp and point-in-time extension as described in Section 3.5 for a YANG-Push publisher on UDP-based Transport for Configured Subscriptions [I-D.ietf-netconf-udp-notif] in their VRP platform.¶
6WIND implemented in push-update and push-change-update notifications the timestamp and point-in-time extension as described in Section 3.5 for a YANG-Push publisher on UDP-based Transport for Configured Subscriptions [I-D.ietf-netconf-udp-notif] in their VSR platform.¶
Cisco implemented in push-update and push-change-update notifications the timestamp and point-in-time extension as described in Section 3.5 for a YANG-Push publisher on UDP-based Transport for Configured Subscriptions [I-D.ietf-netconf-udp-notif] in their IOS XR platform.¶
This section uses the template described in Section 3.7 of [I-D.ietf-netmod-rfc8407bis].¶
The "ietf-yp-notification" and "ietf-yp-observation" YANG modules define data models that are designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. These YANG-based management protocols (1) have to use a secure transport layer (e.g., SSH [RFC6242], TLS [RFC8446], and QUIC [RFC9000]) and (2) have to use mutual authentication.¶
The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.¶
There are a number of data nodes defined in this YANG module that are writable/creatable/deletable (i.e., "config true", which is the default). All writable data nodes are likely to be reasonably sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) and delete operations to these data nodes without proper protection or authentication can have a negative effect on network operations. The following subtrees and data nodes have particular sensitivities/vulnerabilities:¶
The entries in the list above will show whether the mechanism defined in this document is enabled. Access control MUST be set so that only someone with proper access permissions has the ability to access and modify this resource.¶
Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. Specifically, the following subtrees and data nodes have particular sensitivities/ vulnerabilities:¶
The entries in the list above will show the identity of the originating device. Exposure of this information may assist an attacker in mapping the network or in injecting spoofed notifications. Implementations SHOULD ensure that access to this data is restricted and that notifications are sent over secure and authenticated channels.¶
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's in the IETF XML Registry [RFC3688].¶
URI: urn:ietf:params:xml:ns:yang:ietf-yp-notification Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. Reference: RFC-to-be¶
URI: urn:ietf:params:xml:ns:yang:ietf-yp-observation Registrant Contact: The IESG. XML: N/A; the requested URI is an XML namespace. Reference: RFC-to-be¶
This document registers the following YANG modules in the YANG Module Names Registry [RFC6020], within the "YANG Parameters" registry:¶
name: ietf-yp-notification namespace: urn:ietf:params:xml:ns:yang:ietf-yp-notification prefix: iypn reference: RFC-to-be¶
name: ietf-yp-observation namespace: urn:ietf:params:xml:ns:yang:ietf-yp-observation prefix: iypo reference: RFC-to-be¶
IANA is requested to register a new ".sid" file in the "IETF YANG SID Registry" [RFC9595]:¶
SID range entry point: TBD SID range size: 50 YANG module name: ietf-yp-notification reference: RFC-to-be¶
A ".sid" file is proposed in Appendix A.¶
Note to the RFC-Editor:¶
Please replace TBD with the value allocated by IANA.¶
The authors would like to thank Paul Aitken, Per Anderson, Andy Bierman, Carsten Bormann, Mohamed Boucadair, Tom Petch, Reshad Rahman, Jürgen Schönwälder, Jason Sterne, Kent Watsen, Rob Wilton and Qin Wu for their review and valuable comments.¶
This appendix is normative. For CBOR encoding using YANG-SIDs identifiers, a ".sid" file is requested to IANA in Section 8.3.¶
Note to the RFC-Editor:¶
Please replace the entry-point and SID values with the ones allocated by IANA.¶
Please change the 'sid-file-status' to 'published' once the .sid file is published.¶
<CODE BEGINS> file "ietf-yp-notification@2025-10-20.sid"
{
"ietf-sid-file:sid-file": {
"module-name": "ietf-yp-notification",
"module-revision": "2025-10-20",
"sid-file-status":"unpublished",
"description": "draft-ietf-netconf-notif-envelope-03: Extensible YANG Model for YANG-Push Notifications",
"dependency-revision": [
{
"module-name":"ietf-datastores",
"module-revision":"2018-02-14"
},
{
"module-name":"ietf-interfaces",
"module-revision":"2018-02-20"
},
{
"module-name":"ietf-ip",
"module-revision":"2018-02-22"
},
{
"module-name":"ietf-netconf-acm",
"module-revision":"2018-02-14"
},
{
"module-name":"ietf-network-instance",
"module-revision":"2019-01-21"
},
{
"module-name":"ietf-restconf",
"module-revision":"2017-01-26"
},
{
"module-name":"ietf-yang-library",
"module-revision":"2019-01-04"
},
{
"module-name":"ietf-yang-patch",
"module-revision":"2017-02-22"
},
{
"module-name":"ietf-yang-schema-mount",
"module-revision":"2019-01-14"
},
{
"module-name": "ietf-yang-types",
"module-revision": "2013-07-15"
},
{
"module-name": "ietf-inet-types",
"module-revision": "2021-02-22"
},
{
"module-name": "ietf-subscribed-notifications",
"module-revision": "2019-09-09"
},
{
"module-name": "ietf-system-capabilities",
"module-revision": "2022-02-17"
},
{
"module-name": "ietf-notification-capabilities",
"module-revision": "2022-02-17"
},
{
"module-name": "ietf-yang-structure-ext",
"module-revision": "2020-06-17"
}
],
"assignment-range": [
{
"entry-point": "2950",
"size": "50"
}
],
"item": [
{
"status":"unstable",
"namespace":"module",
"identifier":"ietf-yp-notification",
"sid":"2950"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-subscribed-notifications:subscriptions/ietf-yp-notification:enable-notification-envelope",
"sid":"2951"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-subscribed-notifications:subscriptions/ietf-yp-notification:metadata",
"sid":"2952"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-system-capabilities:system-capabilities/ietf-notification-capabilities:subscription-capabilities/ietf-yp-notification:notification-metadata",
"sid":"2953"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-system-capabilities:system-capabilities/ietf-notification-capabilities:subscription-capabilities/ietf-yp-notification:notification-metadata/envelope",
"sid":"2954"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-system-capabilities:system-capabilities/ietf-notification-capabilities:subscription-capabilities/ietf-yp-notification:notification-metadata/metadata",
"sid":"2955"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-system-capabilities:system-capabilities/ietf-notification-capabilities:subscription-capabilities/ietf-yp-notification:notification-metadata/metadata/hostname-sequence-number",
"sid":"2956"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-yp-notification:envelope",
"sid":"2957"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-yp-notification:envelope/contents",
"sid":"2958"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-yp-notification:envelope/event-time",
"sid":"2959"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-yp-notification:envelope/hostname",
"sid":"2960"
},
{
"status":"unstable",
"namespace":"data",
"identifier":"/ietf-yp-notification:envelope/sequence-number",
"sid":"2961"
}
]
}
}
<CODE ENDS>
This appendix provides a non-normative example illustrating how an extension to the notification envelope should be implemented. The example does not define valid metadata, but serves to demonstrate how future extensions should be specified.¶
Specifically, the example extends the notification envelope with a metadata field named "foo". The YANG module illustrates the necessary augmentations to both the 'ietf-yp-notification' module and the 'ietf-notification-capabilities' module.¶
<CODE BEGINS> file "example-foo-extension.yang"
module example-foo-extension {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:example-foo-extension";
prefix fooext;
import ietf-subscribed-notifications {
prefix sn;
}
import ietf-system-capabilities {
prefix sysc;
}
import ietf-notification-capabilities {
prefix notc;
}
import ietf-yang-structure-ext {
prefix sx;
}
import ietf-yp-notification {
prefix iypn;
}
description
"Defines a new 'foo' metadata for the notification envelope.";
// Extending the notification envelope header with a new
// 'foo' metadata
sx:augment-structure "/iypn:envelope" {
leaf foo {
type string;
description
"Description of the 'foo' extension.";
}
}
// Extending the notifications capabilities so that clients can
// learn whether this new extension is supported or not
augment "/sysc:system-capabilities"
+ "/notc:subscription-capabilities"
+ "/iypn:notification-metadata/iypn:metadata" {
description
"Extension to the subscription-capabilities model to enable
clients to learn whether the publisher supports the new
'foo' metadata.";
leaf foo {
type boolean;
default "false";
description
"Adds the 'foo' capability.";
}
}
// (Optional) A user can optionally add knobs for enabling and
// disabling specific metadata.
augment "/sn:subscriptions/iypn:metadata" {
description
"An user can optionally, support a configuration knob for enabling
or disabling a metadata.";
leaf foo {
type boolean;
default "false";
description
"Configuration knob for enabling and disabling the 'foo' metadata.";
}
}
}
<CODE ENDS>¶
The extensions result in the following YANG tree:¶
module: example-foo-extension
augment /sysc:system-capabilities/notc:subscription-capabilities
/iypn:notification-metadata/iypn:metadata:
+--ro foo? boolean
augment /sn:subscriptions/iypn:metadata:
+--rw foo? boolean
augment-structure /iypn:envelope:
+-- foo? string
¶