Support of Hostname and Sequencing in YANG Notifications

Section 4 of describes the NETCONF event notification header using a XML Schema. In the metadata of the event notification header, only the eventTime is present indicating at which time the notification message was published. For other encodings, the same schema is implemented using a YANG module in . Furthermore, in Section 3.7 of , the subscription ID is added to the "push-update" and "push-change-update" notification messages allowing to recognize to which xpath or sub-tree the node was subscribed to. When the NETCONF event notification message is forwarded from the receiver to another system, such as a messaging system or a time series database where the message is stored, the transport context is lost since it is not part of the NETCONF event notification message metadata. Therefore, the downstream system is unable to associate the message to the publishing process (the exporting router), nor able to detect message loss or reordering. Today, network operators workaround this impediment by preserving the transport source IP address and sequence numbers of the publishing process. However, this implies that this information needs to be encoded in the NETCONF event notification message which impacts 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 server should be known. In other terms, the source-host , which is the "Address of the remote host for the session" might not be the management IP address. By extending the NETCONF Event Notification header with sysName, the node's fully-qualified domain name, a reference to the YANG push publisher process and a sequence number as described in , the downstream system is not only able to identify from which network node, subscription, and time the message was published but also, the order of the published messages. To correlate network data among different Network Telemetry planes as described in Section 3.1 of or among different YANG push subscription types defined in Section 3.1 of , sysName describes from which network node the state change was observed or from when to when the data was accounted. This is essential for understanding the timely relationship among these different planes and YANG push subscription types.

Besides the eventTime described in Section 2.2.1 of the following metadata objects are part of a "push-update" and "push-change-update" notification message.

sysName:: Describes the node's fully-qualified domain name according to the 'sysName' object definition in from where the message was published from. This value is usually configured on the node by the administrator to uniquely identify the node in the network.

sequenceNumber:: Generates a unique sequence number as described in for each published message.

provides an example of a "push-change-update" message with the sysName and sequenceNumber. This "push-change-update" message is encoded in XML over the Network Configuration Protocol (NETCONF) as per .

2023-02-04T16:30:11.22Z example-router 187653 1011

eth0

]]>

This ietf-notification-sequencing YANG module augments the ietf-notification YANG module specified in adding the sysName and the sequenceNumber leaves as described in Section 2 of this document.

The following is the YANG tree diagram for the ietf-notification-sequencing augmentation within the ietf-notification.

file "ietf-notification-sequencing@2023-03-25.yang" module ietf-notification-sequencing { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-notification-sequencing"; prefix inotifseq; import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-notification { prefix inotif; reference "draft-ahuang-netconf-notif-yang: NETCONF Event Notification YANG"; } import ietf-yang-structure-ext { prefix sx; reference "RFC 8791: YANG Data Structure Extensions"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: Authors: Thomas Graf Jean Quilbeuf Alex Huang Feng "; description "Defines NETCONF Event Notification structure with the sysName and the sequenceNumber. Copyright (c) 2023 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 2023-04-28 { description "First revision"; reference "RFC XXXX: YANG Notifications Sequencing"; } sx:augment-structure "/inotif:notification" { leaf sysName { type inet:host; mandatory true; description "Fully-qualified domain name of the node according to [RFC1213]. This value is usually configured on the node by the administrator to uniquely identify the node in the network."; } leaf sequenceNumber { type yang:counter32; mandatory true; description "Unique sequence number as described in [RFC3339] for each published message."; } } } ]]>



    
      Note to the RFC-Editor: Please remove this section before
      publishing.

      
        6WIND implemented this document for a YANG Push publisher on UDP-based Transport for Configured
        Subscriptions in their VSR platform.
      
    

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

    
      
        This document registers the following URIs in the "IETF XML
        Registry" :

        
            
          
      

      
        This document registers the following YANG modules in the "YANG
        Module Names" registry :

        
            
          
      
    

    
      
        In order to allow data correlation among BGP Monitoring Protocol
        (BMP)  and YANG push, the same hostname value
        should be used as described in section 4.4 of 
        for the information TLV in the init BMP message type.
      
    

    
      The authors would like to thank Rob Wilton, Nick Corran, Pierre
      Francois, Benoit Claise, Ahmed Elhassany and Ignacio Dominguez
      Martinez-Casanueva for their review and valuable comments.