Self Explanation Data Object Tags
draft-tao-netmod-yang-node-tags-05

#x27;.The statistics-operation can be
       used to provide an additional statistics operation type(e.g., sum,
       min, max,sum,last, threshold) information associated with the performance metric
       data object.

       If the operation type is threshold type, the corresponding
       data object support threshold handling,e.g.,scan all interfaces
       for a certain type every 5 seconds and check the counters or
       status to cross threshold, return an array of interface entries
       that match the search.

       If the operation type is average,min,max,sum,last,
       it indicate the data object supports statistics operation, e.g.,
       scan all interfaces for a certain type every 5 seconds up to 60 seconds,
       only return min, average, max, sum value of specific data object rather than
       the values that are current at the end of 60 seconds.";
  }

  extension service-tag {
    argument tag;
    description
      "The argument 'tag' is of type 'tag'.The service-tag can be
       used to provide a service classification information (e.g., tunnel,
       l3vpn,l2vpn) information associated with YANG data object.";
  }

  extension task-tag {
    argument tag;
    description

Wu, et al.              Expires February 17, 2021              [Page 35]
Internet-Draft            Self Explanation Tags              August 2020

      "The argument 'tag' is of type 'tag'.The task-tag can be
       used to provide a task classification information (e.g., fault management,
       performance measurement) information associated with YANG data object.";
  }

  extension data-source {
    argument tag;
    description
      "The argument 'tag' is of type 'tag'.The data-source-type can be
       used to provide an additional data source type (e.g., connectivity,
       resource, hardware,qos,policy) information associated with
       the performance metric data object tag.";
  }

  extension multi-source-tag {
    argument tag;
    description
      "The argument 'tag' is of type 'tag'.The multi-source-tag can be
       used to identify multiple source aggregation tye(e.g., line card,
       member link in an aggregated Ethernet interface) related to performance
       metric data objects or interface related data objects).

       Two source aggregation source types are supported, one is aggregation
       which groups data from two or multiple different data objects,
       the other is membership which identify each data object(e.g.,
       linecard, member link from multiple source aggregation.";
  }

  augment "/tags:module-tags/tags:module" {
    description
      "Augment the Module Tags module with data object tag attributes";
    container data-object-tags {
      config false;
      status deprecated;
      description
        "Contains the list of data objects and their associated self explanation tags";
      list data-object {
        key "object-name";
        status deprecated;
        description
          "A list of self explanation nodes and their associated tags";
        leaf object-name {
          type nacm:node-instance-identifier;
          mandatory true;
          status deprecated;
          description
            "The YANG data object name.";
        }

Wu, et al.              Expires February 17, 2021              [Page 36]
Internet-Draft            Self Explanation Tags              August 2020

        leaf-list tag {
          type tags:tag;
          status deprecated;
          description
            "Tags associated with the data object within YANG module. See
             the IANA 'YANG Data Object Tag Prefixes' registry for reserved
             prefixes and the IANA'IETF YANG Data Object Tags' registry for
             IETF tags.

             The 'operational' state [RFC8342] view of this list is
             constructed using the following steps:

             1) System tags (i.e., tags of 'system' origin) are added.
             2) User configured tags (i.e., tags of 'intended' origin)
             are added.
             3) Any tag that is equal to a masked-tag is removed.";
        }
        leaf-list masked-tag {
          type tags:tag;
          status deprecated;
          description
            "The list of tags that should not be associated with the data
             object within YANG module. The user can remove (mask) tags from the
             operational state datastore [RFC8342] by adding them to
             this list. It is not an error to add tags to this list
             that are not associated with the data object within YANG module,
             but they have no operational effect.";
        }
      }
    }
  }
}
<CODE ENDS>

Appendix C.  Targeted data object subscription example

   The following subsections provides targeted data object subscription
   example.The subscription "id" values of 22 used below is just an
   example.  In production, the actual values of "id" might not be small
   integers.

Wu, et al.              Expires February 17, 2021              [Page 37]
Internet-Draft            Self Explanation Tags              August 2020

    +-----------+                       +-----------+
    | Subscriber|                       | Publisher |
    +------+----+                       +-----+-----+
           |                                  |
           |                                  |
           |Telemery data Tagging Advertisement
           |  (node-selector, opm-tag = metric)
           |<---------------------------------|
           |                                  |
           |    establish-subscription        |
           |  (datasore,node-selector)        |
           |--------------------------------->|
           |                                  |
           |                                  |
           |                                  |
           |    RPC Reply: OK, id = 22        |
           |<---------------------------------|
           |                                  |
           |                                  |
           |                                  |
           |    Notification Message (for 22) |
           | <--------------------------------|
           |                                  |
           |                                  |
           |                                  |

   The publisher advertise telemetry data object capability to the
   subscriber to instruct the receiver to subscribe targeted data object
   with specific characteristics (e.g., performance metric data object)
   and specific data path corresponding to the targeted data object.

   The following XML example [W3C.REC-xml-20081126] illustrates the
   advertisment of the list of available target objects:

Wu, et al.              Expires February 17, 2021              [Page 38]
Internet-Draft            Self Explanation Tags              August 2020

<?xml version="1.0" encoding="UTF-8"?>
<instance-data-set xmlns=\
    "urn:ietf:params:xml:ns:yang:ietf-yang-instance-data">
  <name>acme-router-notification-capabilities</name>
  <content-schema>
    <module>ietf-system-capabilities@2020-03-23</module>
    <module>ietf-notification-capabilities@2020-03-23</module>
    <module>ietf-data-export-capabilities@2020-03-23</module>
  </content-schema>
  <!-- revision date, contact, etc. -->
  <description>Defines the notification capabilities of an acme-router.
    The router only has running, and operational datastores.
    Every change can be reported on-change from running, but
    only config=true nodes and some config=false data from operational.
    Statistics are not reported based on timer based trigger and counter
    threshold based trigger.
  </description>
  <content-data>
    <system-capabilities \
      xmlns="urn:ietf:params:xml:ns:yang:ietf-system-capabilities" \
      xmlns:inc=\
        "urn:ietf:params:xml:ns:yang:ietf-notification-capabilities" \
      xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
      <datastore-capabilities>
        <datastore>ds:operational</datastore>
        <per-node-capabilities>
          <node-selector>\
              /if:interfaces/if:interface/if:statistics/if:in-errors\
          </node-selector>
          <sec:self-describing-capabilities>
            <sec:self-tag-id>counter</sec:self-tag-id>
            <sec:opm-tag>metric</sec:opm-tag>
            <sec:operation-type>avg</sec:operation-type>
          </sec:self-describing-capabilities>
        </per-node-capabilities>
      </datastore-capabilities>
    </system-capabilities>
  </content-data>
</instance-data-set>

   With telemetry data tagging information carried in the Telemetry data
   Tagging Advertisement, the subscriber identifies targeted data object
   and associated data path to the datastore node and sends a establish-
   subscription RPC to subscribe specific data objects that are
   interests to the client application from the publisher.

Wu, et al.              Expires February 17, 2021              [Page 39]
Internet-Draft            Self Explanation Tags              August 2020

 <netconf:rpc message-id="101"
     xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
   <establish-subscription
       xmlns="urn:ietf:params:xml:ns:yang:ietf-subscribed-notifications"
       xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
     <yp:datastore
          xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
       ds:operational
     </yp:datastore>
     <yp:datastore-xpath-filter
         xmlns:ex="https://example.com/sample-data/1.0">
       /if:interfaces/if:interface/if:statistics/if:in-errors
     </yp:datastore-xpath-filter>
     <yp:periodic>
       <yp:period>500</yp:period>
     </yp:periodic>
   </establish-subscription>
 </netconf:rpc>

   The publisher returns specific object type of operational state
   subscribed by the client.

Authors' Addresses

   Qin Wu
   Huawei
   101 Software Avenue, Yuhua District
   Nanjing, Jiangsu  210012
   China

   Email: bill.wu@huawei.com

   Benoit Claise
   Cisco
   De Kleetlaan 6a b1
   Diegem  1831
   Belgium

   Email: bclaise@cisco.com

   Liang Geng
   China Mobile
   32 Xuanwumen West St, Xicheng District
   Beijing  10053

   Email: gengliang@chinamobile.com

Wu, et al.              Expires February 17, 2021              [Page 40]
Internet-Draft            Self Explanation Tags              August 2020

   Zongpeng Du
   China Mobile
   32 Xuanwumen West St, Xicheng District
   Beijing  10053

   Email: duzongpeng@chinamobile.com

Wu, et al.              Expires February 17, 2021              [Page 41]