Extensions to Yang Push

The subscription mechanism defined in yang-push draft supports a subscription mechanism where datastore and its datanodes can be provided as targets. However there are a few scenarios where a subscription to datanodes may not be sufficient. An application on the client may want to track ONLY the configuration changes in a particular module. If a module contains "config true" mixed with "config false" nodes, setting up such a filter at multiple levels will be cumbersome. An application on the client may want to track the configuration (other than intended) which the device applied. Yang-push subscription does not provide such control.

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 following terms are defined in and are not redefined here: operational state datastore intended configuration datastore

There are two new filter nodes added to the Yang push subscription mechanism. They are listed below. config-filter with-origin

This is a filter for nodes with the given value for their 'config' property. When this leaf is set to 'true', only 'config true' nodes are selected and, when set to 'false', only 'config false' nodes are selected. If this leaf is not present, this filter is not applied.

This document defines the "with-origin" parameter, which if present, requests that the server includes "origin" metadata annotations as defined in in notifications which are part of this subscription. This parameter is only valid for the operational state datastore and any datastores with identities derived from the "operational" identity. Otherwise, if an invalid datastore is specified then a suitable error is returned. Data in the operational state datastore can come from multiple sources. The server should return the most accurate value for the "origin" metadata annotation as possible, indicating the source of the operational value, as specified in Section 5.3.4 of RFC8342 When encoding the origin metadata annotation for a hierarchy of returned nodes, the annotation may be omitted for a child node when the value matches that of the parent node, as described in the "ietf-origin" YANG module . The "with-origin" parameter is optional to support. It is identified with the feature "origin".

In this example, the following fictional module is used:

module example-interface { yang-version 1.1; namespace urn:example:interface; prefix int; import ietf-inet-types { prefix inet; } container interface { leaf name{ type string; } leaf speed{ type string; config false; } } } A subscription on the "config true" nodes of the operational state datastore. This subscription also requests to get the origin of the datanodes as part of Yang-push notifications. This is considering that the NETCONF protocol was used for this subscription.

<rpc xmlns="urn:ietf:params:xml:ns:netconf:1.0"> <establish-subscription \ xmlns="urn:ietf:params:xml:ns:netconf:1.0" \ xmlns:yp="urn:ietf:params:xml:ns:netconf:1.0" \ xmlns:ypext="urn:ietf:params:xml:ns:netconf:1.0"> <yp:datastore>operational</yp:datastore> <ypext:config-filter>true</ypext:config-filter> <ypext:with-origin/> </establish-subscription> </rpc> The operator has configured an interface ("eth1"), the system has recognised an interface ("eth0") which was plugged in recently. The below NETCONF notification is an example for a yang-push notification when the device applies the "eth0" configuration.

<notification \ xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> <eventTime>2019-01-25T08:00:11.22Z</eventTime> <push-change-update xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-push" \ xmlns:or="urn:ietf:params:xml:ns:yang:ietf-origin" > <id>10</id> <datastore-changes> <yang-patch> <patch-id>1</patch-id> <edit> <edit-id>edit1</edit-id> <operation>create</operation> <target>/example-interface:interface</target> <value> <interface xmlns="urn:example:interface" \ or:origin="or:system"> <name>eth0</name> </interface> </value> </edit> </yang-patch> </push-change-update> </notification>

<CODE BEGINS> file "ietf-yang-push-ext@2019-02-01.yang" module ietf-yang-push-ext { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-yang-push-ext"; prefix ypext; import ietf-subscribed-notifications { prefix sn; } import ietf-yang-push { prefix yp; } import ietf-datastores { prefix ds; reference "RFC 8342: Network Management Datastore Architecture."; } import ietf-origin { prefix or; reference "RFC 8342: Network Management Datastore Architecture."; } organization "IETF NETMOD (Network Modeling) Working Group"; contact "WG Web: <http://tools.ietf.org/wg/netmod/> WG List: <mailto:netmod@ietf.org> WG Chair: Kent Watsen <mailto:kwatsen@juniper.net> Editor: Rohit Ranade <mailto:rohitrranade@huawei.com>"; description "This module defines extensions to subscription mechanism to yang-push on operational state datastore. Copyright (c) 2019 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 Simplified 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). The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', and 'OPTIONAL' in the module text are to be interpreted as described in RFC 2119 (https://tools.ietf.org/html/rfc2119). This version of this YANG module is part of RFC XXXX (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for full legal notices."; revision 2019-02-01 { description "Initial revision."; reference "RFCXXXX"; } feature origin { description "Indicates that the server supports the 'origin' annotation."; reference "RFC 8342: Network Management Datastore Architecture"; } grouping subscription-filter-extension{ description "This grouping describes the extensions to subscription conditions."; leaf config-filter { type boolean; description "Filter for nodes with the given value for their 'config' property. When this leaf is set to 'true', only 'config true' nodes are selected and, when set to 'false', only 'config false' nodes are selected. If this leaf is not present, this filter is not applied."; } leaf with-origin { when 'derived-from-or-self(../yp:datastore, "ds:operational")'; if-feature origin; type empty; description "If this parameter is present, the server will return the 'origin' annotation for the nodes that has one."; } } augment "/sn:establish-subscription/sn:input/sn:target/ + yp:datastore" { description "This augmentation adds the filter extensions for the subscription to RPC input."; uses subscription-filter-extension; } } <CODE ENDS>

This document registers one URI in the IETF XML Registry . The following registration has been made: URI: urn:ietf:params:xml:ns:yang:ietf-yang-push-oper-ext Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. This document registers one YANG module in the YANG Module Names Registry [RFC6020]. The following registration has been made: name: ietf-yang-push-oper-ext namespace: urn:ietf:params:xml:ns:yang:ietf-yang-push-oper-ext prefix: ypext RFC: xxxx

TBD.