ntsimulator/yang/o-ran/ru-fh/o-ran-supervision.yang

   1 module o-ran-supervision {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:supervision:1.0";
   4   prefix "o-ran-supervision";
   5
   6   import ietf-yang-types {
   7     prefix yang;
   8   }
   9
  10   organization "O-RAN Alliance";
  11
  12   contact
  13     "www.o-ran.org";
  14
  15   description
  16     "This module defines the configuration data and supervision RPCs that are
  17     used to detect loss M-Plane and CU-Plane connectivity.
  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-07-03" {
  46     description
  47       "version 2.0.0
  48
  49       1) added leafs for CU plane monitoring
  50       2) backward compatible changes to introduce groupings";
  51
  52     reference "ORAN-WG4.M.0-v01.00";
  53   }
  54
  55   revision "2019-02-04" {
  56     description
  57       "version 1.0.0
  58
  59       1) imported model from xRAN
  60       2) changed namespace and reference from xran to o-ran";
  61
  62     reference "ORAN-WG4.M.0-v01.00";
  63   }
  64
  65   grouping watchdog-input {
  66     leaf supervision-notification-interval {
  67       type uint16;
  68       units seconds;
  69       default 60;
  70       description
  71         "The interval in seconds at which supervision notifications are sent.
  72         If not specified the default value of 60 seconds shall apply.";
  73     }
  74     leaf guard-timer-overhead {
  75       type uint16;
  76       units seconds;
  77       default 10;
  78       description
  79         "This is overhead added to the supervision timer used to calculate the
  80          supervision wathcdog timer. i.e.,
  81
  82          supervision timer = notification timer + guard-timer-overhead
  83
  84          If not specified the default value of 10 seconds shall apply.
  85
  86          Failure to send this rpc again within the timeout sets the radio into
  87          'loss of supervision' state.
  88
  89          NOTE - The supervision timer MUST not be less that the confimed
  90          timeout timer (when the feature is supported).
  91
  92          This type of constraint (using an RPCs input) cannot be formally
  93          expressed in YANG.";
  94     }
  95   }
  96
  97   grouping watchdog-output {
  98     leaf next-update-at {
  99       type yang:date-and-time;
 100       description
 101         "Indicates the time when the next supervision notification is expected.";
 102     }
 103   }
 104
 105   grouping supervision-group {
 106     container cu-plane-monitoring {
 107       description "container describing operation of CU plane monitoring";
 108       presence
 109         "Indicates O-RU supports timer based cu-plane monitoring interval. If
 110         this container is NOT present, the opertaion of the O-RU is undefined.";
 111
 112       leaf configured-cu-monitoring-interval {
 113         type uint8 {
 114           range "0..160";
 115         }
 116         default 160;
 117         units milliseconds;
 118         description
 119           "This value corresponds to the configured value of the timer used by
 120           the O-RU to monitor the C/U plane connection.
 121
 122           A value of 0 means that the O-RU's shall disable its CU plane
 123           monitoring.
 124
 125           A NETCONF client should configure the value according to the
 126           configuration of the PHY layer and/or C/U plane section types
 127           supported and/or any fault tolerant operation. For example,
 128
 129           i) when opertaing with an O-DU supporting non-LAA LTE, this value can
 130           be configured to a value according to the repetition time of
 131           transmitted reference symbols across the fronthaul interface
 132           ii) when opertaing with an O-DU supporting C-Plane Section Type 0,
 133           this value can configured to a value according to the minimum
 134           repetition interval of section type 0.
 135           iii) when operating with an O-DU supporting fault tolerant operation,
 136           this value can be configured according to the fault tolerant heartbeat
 137           interval ";
 138       }
 139     }
 140   }
 141
 142   container supervision {
 143     uses supervision-group;
 144     // other WG specific monitoring containers follow here
 145   }
 146
 147   rpc supervision-watchdog-reset {
 148     description
 149       "rpc to reset the watchdog timer";
 150     input {
 151       uses watchdog-input;
 152     }
 153
 154           output {
 155       uses watchdog-output;
 156           }
 157   }
 158
 159   notification supervision-notification {
 160     description
 161       "Notification to indicate that NETCONF management interface is up
 162       and also indicate the values of the timers for this NETCONF session";
 163
 164   }
 165 }