YANG Groupings for UDP Clients and UDP Servers

This document defines two YANG 1.1 modules to support the configuration of UDP clients and UDP servers , either as standalone or in conjunction with configuration of other layers.

The "ietf-udp-client" YANG module defines the "udp-client-grouping" grouping for configuring UDP clients with remote server information.

The following tree diagram illustrates the tree structure of the "udp-client-grouping" grouping:

This section presents an example of usage of the "udp-client-grouping" grouping.

www.example.com

10000

192.0.2.2

12345

]]>

This module imports types defined in .

file "ietf-udp-client@2024-06-27.yang" module ietf-udp-client { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-udp-client"; prefix udpc; import ietf-inet-types { prefix inet; reference "RFC 6991: Common YANG Data Types"; } organization "IETF NETCONF (Network Configuration) Working Group"; contact "WG Web: WG List: Authors: Alex Huang Feng Pierre Francois "; description "Defines a generic grouping for UDP-based client applications. Copyright (c) 2024 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-to-be; see the RFC itself for full legal notices."; revision 2024-06-27 { description "Initial revision"; reference "RFC-to-be: YANG Groupings for UDP Clients and UDP Servers"; } feature local-binding-supported { description "Indicates that the UDP client supports configuring local bindings (i.e., the local address and local port) for UDP clients."; } grouping udp-client-grouping { description "A reusable grouping for configuring a UDP client. Note that this grouping uses fairly typical descendant node names such that a stack of 'uses' statements will have name conflicts. It is intended that the consuming data model will resolve the issue (e.g., by wrapping the 'uses' statement in a container called 'udp-client-parameters'). This model purposely does not do this itself so as to provide maximum flexibility to consuming models."; leaf remote-address { type inet:host; mandatory true; description "The IP address or hostname of the remote UDP server. If a domain name is configured, then the DNS resolution should happen on each connection attempt. If the DNS resolution results in multiple IP addresses, the IP addresses are tried according to local preference order until a connection has been established or until all IP addresses have failed."; } leaf remote-port { type inet:port-number; description "The port number of the remote UDP server."; } leaf local-address { if-feature "local-binding-supported"; type inet:ip-address; description "The local IP address to bind to when sending UDP messages to the remote server. INADDR_ANY ('0.0.0.0') or INADDR6_ANY ('0:0:0:0:0:0:0:0' a.k.a. '::') may be used so that the server can bind to any IPv4 or IPv6 address."; } leaf local-port { if-feature "local-binding-supported"; type inet:port-number; description "The local port number to bind to when sending UDP messages to the remote server."; } } } ]]>



    
      The "ietf-udp-server" YANG module defines the "udp-server-grouping" grouping for
      configuring UDP servers.

      
        The following tree diagram  illustrates the structure of
        "udp-server-grouping" grouping:
        
          
              
            
        
      

      
        This section presents two examples of usage of the "udp-server-grouping"
        grouping. This example shows an example of a server configured for listening
        to a IPv4 address:

        



  
    192.0.2.2
    49152
  

    ]]>

        This example shows an example of a server configured to listen to an IPv4 and
        IPv6 together:

        



  
    192.0.2.2
    49152
  
  
    2001:db8::0
    49153
  

    ]]>

      

      
        The "ietf-udp-server" imports types defined in .

        
           file "ietf-udp-server@2024-06-27.yang"
module ietf-udp-server {
  yang-version 1.1;
  namespace
    "urn:ietf:params:xml:ns:yang:ietf-udp-server";
  prefix udps;
  import ietf-inet-types {
    prefix inet;
    reference
      "RFC 6991: Common YANG Data Types";
  }

  organization "IETF NETCONF (Network Configuration) Working Group";
  contact
    "WG Web:   
     WG List:  

     Authors:  Alex Huang Feng
               
               Pierre Francois
               ";

  description
    "Defines a generic grouping for UDP-based server applications.

    Copyright (c) 2024 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-to-be; see the RFC
    itself for full legal notices.";

  revision 2024-06-27 {
    description
      "Initial revision";
    reference
      "RFC-to-be: YANG Groupings for UDP Clients and UDP Servers";
  }

  grouping udp-server-grouping {
    description
      "Provides a reusable grouping for configuring a UDP server.
      
      Note that this grouping uses fairly typical descendant
      node names such that a stack of 'uses' statements will
      have name conflicts.  It is intended that the consuming
      data model will resolve the issue (e.g., by wrapping
      the 'uses' statement in a container called
      'udp-server-parameters').  This model purposely does
      not do this itself so as to provide maximum flexibility
      to consuming models.";

    list local-bind {
      key local-address;
      min-elements 1;
      description 
        "A list of bind (listen) points for this server
        instance.  A server instance may have multiple
        bind points to support, e.g., the same port in
        different address families or different ports
        in the same address family.";

      leaf local-address {
        type inet:ip-address;
        mandatory true;
        description
          "The local IP address to listen on for incoming
          UDP messages.  To configure listening
          on all IPv4 addresses the value must be '0.0.0.0'
          (INADDR_ANY).  To configure listening on all IPv6
          addresses the value must be '::' (INADDR6_ANY).";
      }

      leaf local-port {
        type inet:port-number;
        description
          "The local port number to listen on for incoming UDP
          messages.";
      }
    }
  }
}
]]>
            

          
      

    


    

      This section uses the template described in Section 3.7 of
      .

      The YANG module specified in this document defines a schema for data
        that is designed to be accessed via network management protocols such
        as NETCONF  or RESTCONF . These network management
        protocols are required to use a secure transport layer and mutual
        authentication, e.g., SSH  without the "none" authentication
        option, Transport Layer Security (TLS)  with mutual X.509
        authentication, and HTTPS with HTTP authentication (Section 11 of
        ).
      

      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.
      

      The YANG module defines a set of identities, types, and
        groupings. These nodes are intended to be reused by other YANG
        modules. The module by itself does not expose any data nodes that
        are writable, data nodes that contain read-only state, or RPCs.
        As such, there are no additional security issues related to
        the YANG module that need to be considered.
      

      Modules that use the groupings that are defined in this document
        should identify the corresponding security considerations. For
        example, reusing some of these groupings will expose privacy-related
        information (e.g., 'node-example').
      
    

    
      This document describes the URIs from IETF
      XML Registry and the registration of a two new YANG module names
      
        IANA is requested to assign two new URIs from the IETF XML Registry. The following two URIs are
        suggested:

        
            
          

        
            
          
      

      
        This document also requests IANA to register the following YANG modules in the
        YANG Module Names registry within the "YANG Parameters"
        registry group:

        
            
          

        
            
          
      
    

    
      The authors would like to thank Mohamed Boucadair, Benoit Claise, Qiufang Ma
      and Qin Wu for their review and valuable comments.