ntsimulator/yang/o-ran/ru-fh/o-ran-udp-echo.yang

   1 module o-ran-udp-echo {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:udpecho:1.0";
   4   prefix "o-ran-echo";
   5
   6   import o-ran-interfaces {
   7     prefix "o-ran-int";
   8   }
   9
  10   organization "O-RAN Alliance";
  11
  12   contact
  13     "www.o-ran.org";
  14
  15   description
  16     "This module covers off aspects of interface transport
  17     verification for UDP/IP based C/U plane connections based on UDP Echo.
  18
  19     Copyright 2019 the O-RAN Alliance.
  20
  21     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  22     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31     POSSIBILITY OF SUCH DAMAGE.
  32
  33     Redistribution and use in source and binary forms, with or without
  34     modification, are permitted provided that the following conditions are met:
  35
  36     * Redistributions of source code must retain the above copyright notice,
  37     this list of conditions and the above disclaimer.
  38     * Redistributions in binary form must reproduce the above copyright notice,
  39     this list of conditions and the above disclaimer in the documentation
  40     and/or other materials provided with the distribution.
  41     * Neither the Members of the O-RAN Alliance nor the names of its
  42     contributors may be used to endorse or promote products derived from
  43     this software without specific prior written permission.";
  44
  45   revision "2019-02-04" {
  46     description
  47       "version 1.0.0
  48
  49       1) imported model from xRAN
  50       2) changed namespace and reference from xran to o-ran";
  51
  52     reference "ORAN-WG4.M.0-v01.00";
  53   }
  54
  55 // groupings
  56
  57   grouping udp-echo-group {
  58     leaf enable-udp-echo {
  59       type boolean;
  60       default false;
  61       description
  62         "whether O-RU's UDP ech server is enabled";
  63     }
  64
  65     leaf dscp-config {
  66       type enumeration {
  67         enum REFLECTIVE {
  68           description
  69             "DSCP in echoed datagrams is copied from received datagram";
  70         }
  71         enum EF {
  72           description
  73             "DSCP in echoed datagrams is always be set to expeditied
  74             forwarding Per Hop Behaviour.";
  75         }
  76       }
  77       default EF;
  78       description "configuration of UDP echo DSCP";
  79     }
  80
  81     leaf echo-replies-transmitted {
  82       type uint32;
  83       config false;
  84       description
  85         "The total number of UDP echo replies transmitted by the O-RU.";
  86     }
  87   }
  88
  89   container udp-echo {
  90     if-feature o-ran-int:UDPIP-BASED-CU-PLANE;
  91     description "container for udp echo";
  92
  93     uses udp-echo-group;
  94   }
  95 }