Support of Versioning
in YANG Notifications SubscriptionSwisscomBinzring 17Zurich8045Switzerlandthomas.graf@swisscom.comHuaweibenoit@everything-ops.netINSA-LyonLyonFrancealex.huang-feng@insa-lyon.frThis document extends the YANG-Push Subscription mechanism to
enforce that particular revisions or semantic versions are used
when configuring or establishing a Subscription. It also extends
the YANG-Push Subscription state change Notifications with
additional context regarding the YANG schema associated with the
Subscription.In order to process the YANG-Push Notification messages
described in at the YANG-Push Receiver, the Publisher's
instance of ietf-yang-library needs to be
queried each time a Subscription state change Notification, as described in , is being
received to understand whether the YANG module(s) semantic has
changed. To notify the Receiver whether the YANG module(s)
semantic has changed, a semantic reference to the YANG modules and
the XPath or subtree in the Subscription state change
Notifications is needed.This specification is primarily aimed for YANG-Push Configured
Subscription, as defined in , since the schema of a YANG-Push Publisher
datastore could change after a Configured Subscription has been
established and the 'subscription-started' Notification has
already been sent to the Receiver. Without the mechanism described
in and , a subscriber is
unable to control the supported YANG module revision or version
nor would the YANG-Push Receiver be notified of changes in YANG
module revision or version in the YANG-Push Subscription. Although
this mechanism is primarily designed for YANG-Push Configured
Subscriptions, the extensions defined in for 'subscription-started' are also applicable to
Dynamic Subscriptions as defined in .This semantic reference is available when the Subscription is
established as described in Section 2.4 and 2.5 of and being streamed from the Publisher to the
Receiver with the Subscription state change Notifications, as
described in . For each Subscription, a locally unique
Subscription ID, as described in , is issued and streamed
as metadata with the Notification message in the YANG-Push
message header.The YANG module version statement is specified in and states
that the newer revision needs to be backward compatible to the
previous revision. specifies that
newer semantic versions introduced in MAY not be backward
compatible to the previous version when indicated with
non-backwards-compatible keyword.The YANG Notifications Subscription mechanism defined in does not include the YANG module revision.
Hence, when a network node is upgraded, the subscribed YANG module
revision might have changed, and might consequently break the data
processing pipeline since the YANG-Push Receiver may not be aware
of this change.This document extends the current YANG Notifications
Subscription mechanism to allow Subscriptions to a specific
revision or latest YANG module semantic version to which the
YANG module version needs to be backward compatible to.The Subscription state change 'subscription-started' and
'subscription-modified' Notification messages are also extended to
include the YANG module revision, version, and YANG library
content-id. Changes in the revision and version fields
allow a YANG-Push Receiver to detect whenever the subscribed YANG
module has changed. Changes in yang-library-content-id indicates
that YANG module(s) on the network management Server of the
YANG-Push Publisher has or have changed.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 when, and only when, they appear in all
capitals, as shown here.The terms "subscriber", "subscription",
"dynamic subscription", "configured subscription", "publisher",
"receiver" and "notification message" are used as defined in
.The terms "client", and "server" are used as defined in .The terms "YANG library" and "YANG library content
identifier" are used as defined in .The ability to configure or establish a Dynamic Subscription
can be constrained to particular module versions or revisions
using the following fields that are defined in
the 'ietf-yang-push-revision' YANG module:
module:
Restricts the Subscription to one or more YANG module names
on the Subscription path with revision and version together for
the related streamed content.
revision:
Restricts the Subscription to a specific YANG module
revision. Example: "2014-05-08".
version:
Restricts the Subscription to the latest compatible YANG
module semantic version referenced to. Example: "2.0.0".
When a NETCONF client creates or modifies a Subscription,
either by updating the Subscription configuration or by invoking the
'establish-subscription' or 'modify-subscription' RPCs, and the NETCONF
server does not support the specified revision or version in the request,
the server MUST return an RPC reply containing an <rpc-error>
element as defined in ,
with the error information populated as follows:
an "error-type" node of "application".
an "error-tag" node whose value is a string that corresponds
to an identity associated with the error.
General
Subscription Error Identities and Associated "error-tag" Use
Error identity
Uses "error-tag"
revision-unsupported
invalid-value
version-unsupported
invalid-value
incompatible-revision-and-version
invalid-value
provides an example of a Dynamic periodic YANG-Push
"establish-subscription" RPC call with YANG revision and
datastore-xpath-filter.
shows the response when the RPC has been accepted by the NETCONF
Server and
the error sent by the NETCONF Server when the revision is not
supported.
ds:operational
/ex:foo
foo2023-09-17500
]]>
52
]]>applicationoperation-failederror
ypr:revision-unsupported
]]>
provides an example of configured periodic YANG-Push Subscription
with YANG revision and datastore-xpath-filter.53ds:operational
/if:interfaces
ietf-interfaces2018-02-20unt:udp-notifencode-jsonsubscription-specific-receiver-def
global-udp-notif-receiver-def
6000global-udp-notif-receiver-def
192.0.5.1
12345true
]]>The YANG-Push Publisher MUST NOT send Notifications if the
'revision' or 'version' of the YANG module name in the
Subscription policy configuration does not match with the YANG
library .Besides the Subscription ID and the xpath or subtree filter
reference as described in , the following metadata objects are part of a
'subscription-started' or 'subscription-modified' Subscription
state change Notifications.
module:
Describes the YANG module names from the Subscription path
for the related streamed content.
revision:
Describes the YANG module revision as specified in for the
related streamed content.
version:
Describes the YANG module semantic version as specified in
for the related
streamed content.
yang-library-content-id:
Contains the YANG library content identifier which is an implementation-specific
identifier representing the current information in the YANG
library on a specific Server.
provides an example of a 'subscription-modified' Subscription
state change Notification message with the YANG module name,
revision, version and datastore-xpath-filter for tracking
the operational status of a single Ethernet interface (per ). This Subscription state change Notification
message is encoded in XML
over the Network Configuration Protocol (NETCONF) as per .2023-01-03T10:00:00Z101
/int:interfaces
NETCONFietf-interfaces2018-02-202.0.01
]]>
provides an example of a JSON encoded, ,
Subscription state change Notification message over HTTPS-based
or UDP-based transport for the same
Subscription.A Client can discover whether the Server supports the
'ietf-yang-push-revision' model through the capabilities model
defined in . This document extends the
'ietf-notification-capabilities' model
with:
A leaf 'yang-push-module-revision-supported', stating that
the YANG-Push Subscription state change Notifications are
extended with 'revision', 'version' and
'yang-library-content-id' extensions.
The YANG models defined in
augments the 'ietf-notification-capabilities' model with the leaf
listed above. /yanglib:yang-library/datastore/name
| +--ro per-node-capabilities* []
| +--ro (node-selection)?
| | +--:(node-selector)
| | +--ro node-selector?
| | nacm:node-instance-identifier
| +--ro notc:subscription-capabilities
| +--ro notc:max-nodes-per-update? uint32
| +--ro notc:periodic-notifications-supported?
| | notification-support
| +--ro (notc:update-period)?
| | +--:(notc:minimum-update-period)
| | | +--ro notc:minimum-update-period? uint32
| | +--:(notc:supported-update-period)
| | +--ro notc:supported-update-period* uint32
| +--ro notc:on-change-supported?
| | notification-support {yp:on-change}?
| +--ro notc:minimum-dampening-period? uint32
| | {yp:on-change}?
| +--ro notc:supported-excluded-change-type* union
| {yp:on-change}?
+--ro notc:subscription-capabilities
+--ro notc:max-nodes-per-update? uint32
+--ro notc:periodic-notifications-supported?
| notification-support
+--ro (notc:update-period)?
| +--:(notc:minimum-update-period)
| | +--ro notc:minimum-update-period? uint32
| +--:(notc:supported-update-period)
| +--ro notc:supported-update-period* uint32
+--ro notc:on-change-supported?
| notification-support {yp:on-change}?
+--ro notc:minimum-dampening-period? uint32
| {yp:on-change}?
+--ro notc:supported-excluded-change-type* union
| {yp:on-change}?
+--ro ypr:yang-push-module-revision-supported? boolean
]]>This model can be retrieved via a NETCONF <get> RPC.This 'ietf-yang-push-revision' YANG module augments the
'ietf-subscribed-notifications' module with the 'name',
'revision', 'version' and 'yang-library-content-id' in the
'subscription-started' and 'subscription-modified' Subscription
state change Notifications and the ability to define the
'revision' and 'version' in the 'establish-subscription' and
'modify-subscription' RPCs in the datastore push Subscription.
The following is the YANG tree diagram for the 'ietf-yang-push-revision' YANG
module /yanglib:yang-library/content-id
augment /sn:subscription-modified:
+--ro module-version* [name]
| +--ro name yang:yang-identifier
| +--ro revision rev:revision-date
| +--ro version? ysver:version
+--ro yang-library-content-id?
-> /yanglib:yang-library/content-id
augment /sn:subscriptions/sn:subscription:
+--rw module-version-subs* [name]
+--rw name yang:yang-identifier
+--rw (revision-version)?
+--:(revision)
| +--rw revision? rev:revision-date
+--:(version)
+--rw version? ysver:version
augment /sysc:system-capabilities/notc:subscription-capabilities:
+--ro yang-push-module-revision-supported? boolean
]]>The following is the YANG tree diagram for the 'ietf-yang-push-revision'
augmentation within the 'ietf-subscribed-notifications',
including the RPCs and Notifications. {subtree}?
| | +--:(stream-xpath-filter)
| | +--rw stream-xpath-filter? yang:xpath1.0 {xpath}?
| +--rw yp:selection-filter* [filter-id]
| +--rw yp:filter-id string
| +--rw (yp:filter-spec)?
| +--:(yp:datastore-subtree-filter)
| | +--rw yp:datastore-subtree-filter?
| | {sn:subtree}?
| +--:(yp:datastore-xpath-filter)
| +--rw yp:datastore-xpath-filter? yang:xpath1.0
| {sn:xpath}?
+--rw subscriptions
+--rw subscription* [id]
+--rw id
| subscription-id
+--rw (target)
| +--:(stream)
| | +--rw (stream-filter)?
| | | +--:(by-reference)
| | | | +--rw stream-filter-name
| | | | stream-filter-ref
| | | +--:(within-subscription)
| | | +--rw (filter-spec)?
| | | +--:(stream-subtree-filter)
| | | | +--rw stream-subtree-filter?
| | | | {subtree}?
| | | +--:(stream-xpath-filter)
| | | +--rw stream-xpath-filter?
| | | yang:xpath1.0 {xpath}?
| | +--rw stream
| | | stream-ref
| | +--ro replay-start-time?
| | | yang:date-and-time {replay}?
| | +--rw configured-replay? empty
| | {configured,replay}?
| +--:(yp:datastore)
| +--rw yp:datastore
| | identityref
| +--rw (yp:selection-filter)?
| +--:(yp:by-reference)
| | +--rw yp:selection-filter-ref
| | selection-filter-ref
| +--:(yp:within-subscription)
| +--rw (yp:filter-spec)?
| +--:(yp:datastore-subtree-filter)
| | +--rw yp:datastore-subtree-filter?
| | {sn:subtree}?
| +--:(yp:datastore-xpath-filter)
| +--rw yp:datastore-xpath-filter?
| yang:xpath1.0 {sn:xpath}?
+--rw stop-time?
| yang:date-and-time
+--rw dscp?
| inet:dscp {dscp}?
+--rw weighting? uint8
| {qos}?
+--rw dependency?
| subscription-id {qos}?
+--rw transport?
| transport {configured}?
+--rw encoding?
| encoding
+--rw purpose? string
| {configured}?
+--rw (notification-message-origin)? {configured}?
| +--:(interface-originated)
| | +--rw source-interface?
| | if:interface-ref {interface-designation}?
| +--:(address-originated)
| +--rw source-vrf?
| | -> /ni:network-instances/network-instance/name
| | {supports-vrf}?
| +--rw source-address?
| inet:ip-address-no-zone
+--ro configured-subscription-state?
| enumeration {configured}?
+--rw receivers
| +--rw receiver* [name]
| +--rw name string
| +--ro sent-event-records?
| | yang:zero-based-counter64
| +--ro excluded-event-records?
| | yang:zero-based-counter64
| +--ro state enumeration
| +---x reset {configured}?
| +--ro output
| +--ro time yang:date-and-time
+--rw (yp:update-trigger)?
| +--:(yp:periodic)
| | +--rw yp:periodic!
| | +--rw yp:period centiseconds
| | +--rw yp:anchor-time? yang:date-and-time
| +--:(yp:on-change) {on-change}?
| +--rw yp:on-change!
| +--rw yp:dampening-period? centiseconds
| +--rw yp:sync-on-start? boolean
| +--rw yp:excluded-change* change-type
+--rw ypr:module-version-subs* [name]
+--rw ypr:name yang:yang-identifier
+--rw (ypr:revision-version)?
+--:(ypr:revision)
| +--rw ypr:revision? rev:revision-date
+--:(ypr:version)
+--rw ypr:version? ysver:version
rpcs:
+---x establish-subscription
| +---w input
| | +---w (target)
| | | +--:(stream)
| | | | +---w (stream-filter)?
| | | | | +--:(by-reference)
| | | | | | +---w stream-filter-name
| | | | | | stream-filter-ref
| | | | | +--:(within-subscription)
| | | | | +---w (filter-spec)?
| | | | | +--:(stream-subtree-filter)
| | | | | | +---w stream-subtree-filter?
| | | | | | {subtree}?
| | | | | +--:(stream-xpath-filter)
| | | | | +---w stream-xpath-filter?
| | | | | yang:xpath1.0 {xpath}?
| | | | +---w stream
| | | | | stream-ref
| | | | +---w replay-start-time?
| | | | yang:date-and-time {replay}?
| | | +--:(yp:datastore)
| | | +---w yp:datastore
| | | | identityref
| | | +---w (yp:selection-filter)?
| | | +--:(yp:by-reference)
| | | | +---w yp:selection-filter-ref
| | | | selection-filter-ref
| | | +--:(yp:within-subscription)
| | | +---w (yp:filter-spec)?
| | | +--:(yp:datastore-subtree-filter)
| | | | +---w yp:datastore-subtree-filter?
| | | | {sn:subtree}?
| | | +--:(yp:datastore-xpath-filter)
| | | +---w yp:datastore-xpath-filter?
| | | yang:xpath1.0 {sn:xpath}?
| | +---w stop-time?
| | | yang:date-and-time
| | +---w dscp?
| | | inet:dscp {dscp}?
| | +---w weighting?
| | | uint8 {qos}?
| | +---w dependency?
| | | subscription-id {qos}?
| | +---w encoding?
| | | encoding
| | +---w (yp:update-trigger)?
| | | +--:(yp:periodic)
| | | | +---w yp:periodic!
| | | | +---w yp:period centiseconds
| | | | +---w yp:anchor-time? yang:date-and-time
| | | +--:(yp:on-change) {on-change}?
| | | +---w yp:on-change!
| | | +---w yp:dampening-period? centiseconds
| | | +---w yp:sync-on-start? boolean
| | | +---w yp:excluded-change* change-type
| | +---w ypr:module-version-subs* [name]
| | +---w ypr:name yang:yang-identifier
| | +---w (ypr:revision-version)?
| | +--:(ypr:revision)
| | | +---w ypr:revision? rev:revision-date
| | +--:(ypr:version)
| | +---w ypr:version? ysver:version
| +--ro output
| +--ro id subscription-id
| +--ro replay-start-time-revision? yang:date-and-time
| {replay}?
+---x modify-subscription
| +---w input
| +---w id
| | subscription-id
| +---w (target)
| | +--:(stream)
| | | +---w (stream-filter)?
| | | +--:(by-reference)
| | | | +---w stream-filter-name
| | | | stream-filter-ref
| | | +--:(within-subscription)
| | | +---w (filter-spec)?
| | | +--:(stream-subtree-filter)
| | | | +---w stream-subtree-filter?
| | | | {subtree}?
| | | +--:(stream-xpath-filter)
| | | +---w stream-xpath-filter?
| | | yang:xpath1.0 {xpath}?
| | +--:(yp:datastore)
| | +---w yp:datastore
| | | identityref
| | +---w (yp:selection-filter)?
| | +--:(yp:by-reference)
| | | +---w yp:selection-filter-ref
| | | selection-filter-ref
| | +--:(yp:within-subscription)
| | +---w (yp:filter-spec)?
| | +--:(yp:datastore-subtree-filter)
| | | +---w yp:datastore-subtree-filter?
| | | {sn:subtree}?
| | +--:(yp:datastore-xpath-filter)
| | +---w yp:datastore-xpath-filter?
| | yang:xpath1.0 {sn:xpath}?
| +---w stop-time?
| | yang:date-and-time
| +---w (yp:update-trigger)?
| | +--:(yp:periodic)
| | | +---w yp:periodic!
| | | +---w yp:period centiseconds
| | | +---w yp:anchor-time? yang:date-and-time
| | +--:(yp:on-change) {on-change}?
| | +---w yp:on-change!
| | +---w yp:dampening-period? centiseconds
| +---w ypr:module-version-subs* [name]
| +---w ypr:name yang:yang-identifier
| +---w (ypr:revision-version)?
| +--:(ypr:revision)
| | +---w ypr:revision? rev:revision-date
| +--:(ypr:version)
| +---w ypr:version? ysver:version
+---x delete-subscription
| +---w input
| +---w id subscription-id
+---x kill-subscription
+---w input
+---w id subscription-id
notifications:
+---n replay-completed {replay}?
| +--ro id subscription-id
+---n subscription-completed {configured}?
| +--ro id subscription-id
+---n subscription-modified
| +--ro id
| | subscription-id
| +--ro (target)
| | +--:(stream)
| | | +--ro (stream-filter)?
| | | | +--:(by-reference)
| | | | | +--ro stream-filter-name
| | | | | stream-filter-ref
| | | | +--:(within-subscription)
| | | | +--ro (filter-spec)?
| | | | +--:(stream-subtree-filter)
| | | | | +--ro stream-subtree-filter?
| | | | | {subtree}?
| | | | +--:(stream-xpath-filter)
| | | | +--ro stream-xpath-filter?
| | | | yang:xpath1.0 {xpath}?
| | | +--ro stream
| | | | stream-ref
| | | +--ro replay-start-time?
| | | yang:date-and-time {replay}?
| | +--:(yp:datastore)
| | +--ro yp:datastore
| | | identityref
| | +--ro (yp:selection-filter)?
| | +--:(yp:by-reference)
| | | +--ro yp:selection-filter-ref
| | | selection-filter-ref
| | +--:(yp:within-subscription)
| | +--ro (yp:filter-spec)?
| | +--:(yp:datastore-subtree-filter)
| | | +--ro yp:datastore-subtree-filter?
| | | {sn:subtree}?
| | +--:(yp:datastore-xpath-filter)
| | +--ro yp:datastore-xpath-filter?
| | yang:xpath1.0 {sn:xpath}?
| +--ro stop-time?
| | yang:date-and-time
| +--ro dscp?
| | inet:dscp {dscp}?
| +--ro weighting? uint8
| | {qos}?
| +--ro dependency?
| | subscription-id {qos}?
| +--ro transport?
| | transport {configured}?
| +--ro encoding?
| | encoding
| +--ro purpose? string
| | {configured}?
| +--ro (yp:update-trigger)?
| | +--:(yp:periodic)
| | | +--ro yp:periodic!
| | | +--ro yp:period centiseconds
| | | +--ro yp:anchor-time? yang:date-and-time
| | +--:(yp:on-change) {on-change}?
| | +--ro yp:on-change!
| | +--ro yp:dampening-period? centiseconds
| | +--ro yp:sync-on-start? boolean
| | +--ro yp:excluded-change* change-type
| +--ro ypr:module-version* [name]
| | +--ro ypr:name yang:yang-identifier
| | +--ro ypr:revision rev:revision-date
| | +--ro ypr:version? ysver:version
| +--ro ypr:yang-library-content-id?
| -> /yanglib:yang-library/content-id
+---n subscription-resumed
| +--ro id subscription-id
+---n subscription-started {configured}?
| +--ro id
| | subscription-id
| +--ro (target)
| | +--:(stream)
| | | +--ro (stream-filter)?
| | | | +--:(by-reference)
| | | | | +--ro stream-filter-name
| | | | | stream-filter-ref
| | | | +--:(within-subscription)
| | | | +--ro (filter-spec)?
| | | | +--:(stream-subtree-filter)
| | | | | +--ro stream-subtree-filter?
| | | | | {subtree}?
| | | | +--:(stream-xpath-filter)
| | | | +--ro stream-xpath-filter?
| | | | yang:xpath1.0 {xpath}?
| | | +--ro stream
| | | | stream-ref
| | | +--ro replay-start-time?
| | | | yang:date-and-time {replay}?
| | | +--ro replay-previous-event-time?
| | | yang:date-and-time {replay}?
| | +--:(yp:datastore)
| | +--ro yp:datastore
| | | identityref
| | +--ro (yp:selection-filter)?
| | +--:(yp:by-reference)
| | | +--ro yp:selection-filter-ref
| | | selection-filter-ref
| | +--:(yp:within-subscription)
| | +--ro (yp:filter-spec)?
| | +--:(yp:datastore-subtree-filter)
| | | +--ro yp:datastore-subtree-filter?
| | | {sn:subtree}?
| | +--:(yp:datastore-xpath-filter)
| | +--ro yp:datastore-xpath-filter?
| | yang:xpath1.0 {sn:xpath}?
| +--ro stop-time?
| | yang:date-and-time
| +--ro dscp?
| | inet:dscp {dscp}?
| +--ro weighting? uint8
| | {qos}?
| +--ro dependency?
| | subscription-id {qos}?
| +--ro transport?
| | transport {configured}?
| +--ro encoding?
| | encoding
| +--ro purpose? string
| | {configured}?
| +--ro (yp:update-trigger)?
| | +--:(yp:periodic)
| | | +--ro yp:periodic!
| | | +--ro yp:period centiseconds
| | | +--ro yp:anchor-time? yang:date-and-time
| | +--:(yp:on-change) {on-change}?
| | +--ro yp:on-change!
| | +--ro yp:dampening-period? centiseconds
| | +--ro yp:sync-on-start? boolean
| | +--ro yp:excluded-change* change-type
| +--ro ypr:module-version* [name]
| | +--ro ypr:name yang:yang-identifier
| | +--ro ypr:revision rev:revision-date
| | +--ro ypr:version? ysver:version
| +--ro ypr:yang-library-content-id?
| -> /yanglib:yang-library/content-id
+---n subscription-suspended
| +--ro id subscription-id
| +--ro reason identityref
+---n subscription-terminated
+--ro id subscription-id
+--ro reason identityref
]]>The YANG module has two leaves augmenting the model of Subscription to YANG Notifications.
WG List:
Authors: Thomas Graf
Benoit Claise
Alex Huang Feng
";
description
"Defines YANG-Push event notification header with the revision
and the version. Adds the support of the revision and
version selection in the YANG-Push subscription RPCs.
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).
All revisions of IETF and IANA published modules can be found
at the YANG Parameters registry
(https://www.iana.org/assignments/yang-parameters).
This version of this YANG module is part of RFC XXXX; see the RFC
itself for full legal notices.
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 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.";
revision 2025-12-07 {
description
"First revision";
reference
"RFC XXXX: Support of Versioning in YANG Notifications
Subscription";
}
// Identities
identity revision-unsupported {
base sn:establish-subscription-error;
base sn:modify-subscription-error;
description
"Revision not supported. This failure can be due to
subscribing to a specific revision not supported by the
publisher.";
}
identity version-unsupported {
base sn:establish-subscription-error;
base sn:modify-subscription-error;
description
"Specific version not supported. This failure can be due to
subscribing to a specific version not supported by the
publisher.";
}
identity incompatible-revision-and-version {
base sn:establish-subscription-error;
base sn:modify-subscription-error;
description
"The combination of revision and version are
incompatible. This failure happens when the revision and the
version are both specified in the RPC and the YANG
module supported by the publisher does not support one of them.";
}
grouping yang-push-module-version-subs {
description
"This grouping combines the module name, the revision and
version leaves. This grouping is to be used for
configuration and the leaves are not mandatory.";
leaf name {
type yang:yang-identifier;
description
"This references the YANG module name.";
}
choice revision-version {
description
"Specifies the revision or version of the YANG module sent
in the subscription.";
case revision {
leaf revision {
type rev:revision-date;
description
"This references the YANG module revision to be sent in the
subscription.";
}
}
case version {
leaf version {
type ysver:version;
description
"This references the YANG module semantic version to be sent
in the subscription.";
}
}
}
}
grouping yang-push-module-version-notif {
description
"This grouping combines the module name, the revision and
version leaves. This grouping is to be used for
read-only cases such as the content of YANG-Push Notifications.
The name and revision are mandatory and MUST be present
in the data.";
leaf name {
type yang:yang-identifier;
config false;
mandatory true;
description
"This references the YANG module name.";
}
leaf revision {
type rev:revision-date;
config false;
mandatory true;
description
"This references the YANG module revision of the sent
notification message.";
}
leaf version {
type ysver:version;
description
"This references the YANG module semantic version of the
sent notification message.";
}
}
grouping yang-push-module-version-notif-list {
description
"This grouping defines a list of yang-push-module-version-notif
grouping.";
list module-version {
key "name";
config false;
description
"List of yang-push-module-version grouping. The revision is
not configurable.";
uses ypr:yang-push-module-version-notif;
}
leaf yang-library-content-id {
type leafref {
path "/yanglib:yang-library/yanglib:content-id";
}
config false;
description
"Contains the YANG library content identifier RFC 8525
information.";
}
}
grouping yang-push-module-version-subs-list {
description
"This grouping defines a list of yang-push-module-version-subs
grouping.";
list module-version-subs {
key "name";
description
"List of yang-push-module-version-subs grouping. The
revision is configurable.";
uses ypr:yang-push-module-version-subs;
}
}
// Subscription parameters
augment "/sn:establish-subscription/sn:input" {
description
"Augment the establish-subscription RPC from the
ietf-subscribed-notifications YANG module with the
yang-push-module-version-subs-list grouping.";
uses ypr:yang-push-module-version-subs-list;
}
augment "/sn:modify-subscription/sn:input" {
description
"Augment the modify-subscription RPC from the
ietf-subscribed-notifications YANG module with the
yang-push-module-version-subs-list grouping.";
uses ypr:yang-push-module-version-subs-list;
}
// Subscription notifications
augment "/sn:subscription-started" {
description
"Augment the subscription-started notification from the
ietf-subscribed-notifications YANG module with the
yang-push-module-version-notif-list grouping.";
uses ypr:yang-push-module-version-notif-list;
}
augment "/sn:subscription-modified" {
description
"Augment the subscription-modified notification from the
ietf-subscribed-notifications YANG module with the
yang-push-module-version-notif-list grouping.";
uses ypr:yang-push-module-version-notif-list;
}
// Subscription container
augment "/sn:subscriptions/sn:subscription" {
description
"Augment the subscriptions RPC container from the
ietf-subscribed-notifications YANG module with the
yang-push-module-version-subs-list grouping.";
uses ypr:yang-push-module-version-subs-list;
}
// Subscription capabilities
augment "/sysc:system-capabilities/notc:subscription-capabilities" {
description
"Add system level capabilities";
leaf yang-push-module-revision-supported {
type boolean;
default true;
description
"Specifies whether the publisher supports exporting
revision and version in YANG-Push subscription state change
notifications. If set to true, publisher supports. If set to
false, publisher does not support.";
reference
"RFC XXXX: Support of Versioning in YANG Notifications
Subscription";
}
}
}
]]>This document registers the following URIs in the "IETF XML
Registry" :This document registers the following YANG modules in the
'YANG Module Names' registry :The solution described in this document allows Subscription
policies to be constrained to a particular module
revisions/versions that are used by the Publisher before a
Subscription is initiated. The augmentations to the
Subscription state change Notifications also gives the Receiver
additional context and confidence of the current schema associated
with a Subscription.
describes the Subscription state machine for Configured YANG-Push
Subscriptions. It states that 'subscription-modified' condition is
triggered when the Subscription policy is being changed. Since
this document proposes YANG version and revision extensions in
Subscription configuration and state change notifications, it is
expected that changes in YANG version and revision of a
Subscription during Subscription lifecycle accounts for
changes in Subscription policy and therefore MUST trigger
'subscription-modified' Subscription state change Notifications.
Note, that not all modules used or referenced under a
Subscription path are included in the Subscription state change
Notification, and hence, it is possible that the schema associated
with a Subscription MAY change without any corresponding change to
the advertise module revisions or versions. Therefore, the YANG
Library content-id that is also included in the Subscription state
change Notifications allows the Receiver to detect if there were
changes to the device schema. This includes changes not related to
the Subscription path as well. Take as
example. The Subscription path is '/ietf-interfaces:interfaces'
and the listed YANG module name is 'ietf-interfaces' with
revision '2018-02-20' and version '2.0.0'. The 'ietf-interfaces'
YANG module defined in and imports 'ietf-yang-types' YANG module. If
'ietf-interfaces' YANG module version or revision would change
during the Subscription lifecycle, a YANG-Push Receiver would
recognize the change since the revision or version in the
module-version and the YANG library content-id has changed.
However, if 'ietf-yang-types' YANG module version or revision
would change, a YANG-Push Receiver would only be able to recognize
the change using the YANG library content-id.A YANG package ,
specifies a versioned organizational structure used to manage a
set of YANG modules that collectively defines a package schema.
For example, a YANG package could contain a set of YANG modules
required to implement a L3VPN service on a network node. It offers
therefore a complementary information to the solution in this
draft by describing how one specific YANG module revision is part
of a set of YANG modules.Note to the RFC-Editor: Please remove this section before
publishing.Huawei implemented in Notification the 'module', 'revision'
and 'version' extension as described in for a YANG-Push Publisher on UDP-based Transport for
Configured Subscriptions in their VRP platform.6WIND implemented in Notification 'module', 'revision'
and 'library-content-id' extension as described in for a YANG-Push Publisher on UDP-based Transport for
Configured Subscriptions in their VSR platform.Cisco implemented in Notification 'module', 'revision' and
'library-content-id' extension as described in and 'module' and 'revision' in
Subscription as described in for a YANG-Push Publisher on
UDP-based Transport
for Configured Subscriptions in their IOS XR platform.
This section uses the template described in
.The "ietf-yang-push-revision" YANG module defines a data model
that is designed to be accessed via YANG-based management
protocols, such as NETCONF and RESTCONF
. These YANG-based management protocols
(1) have to use a secure transport layer (e.g., SSH , TLS , and QUIC ) and (2) have to use mutual authentication.The Network Configuration Access Control Model (NACM) 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 allow in a YANG-Push Subscription
to define the revision or version of a YANG module name. Access
control MUST be set so that only someone with proper access
permissions has the ability to access and modify this resource.The authors would like to thank Qiufang Ma, Robert Wilton,
Jian Ping Zhang, Robert Wills, Reshad Rahman, Camilo Cardona
Holger Keller and Gabriele Galimberti for their review and
valuable comments.Extensible Markup Language (XML) 1.0 (Fifth Edition)World Wide Web Consortium Recommendation
REC-xml-20081126