data-model/yang/published/o-ran/ru-fh/o-ran-supervision@2020-04-17.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 connectivity.
  18
  19     Copyright 2020 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 "2020-04-17" {
  46     description
  47       "version 3.0.0
  48
  49       1) added output string to enable indication if config modification change has failed
  50       2) corrected model description
  51       3) removed erroneous text in notification description";
  52
  53     reference "ORAN-WG4.M.0-v03.00";
  54   }
  55
  56   revision "2019-07-03" {
  57     description
  58       "version 2.0.0
  59
  60       1) added leafs for CU plane monitoring
  61       2) backward compatible changes to introduce groupings";
  62
  63     reference "ORAN-WG4.M.0-v01.00";
  64   }
  65
  66   revision "2019-02-04" {
  67     description
  68       "version 1.0.0
  69
  70       1) imported model from xRAN
  71       2) changed namespace and reference from xran to o-ran";
  72
  73     reference "ORAN-WG4.M.0-v01.00";
  74   }
  75
  76   grouping watchdog-input {
  77     leaf supervision-notification-interval {
  78       type uint16;
  79       units seconds;
  80       default 60;
  81       description
  82         "The interval in seconds at which supervision notifications are sent.
  83         If not specified the default value of 60 seconds shall apply.";
  84     }
  85     leaf guard-timer-overhead {
  86       type uint16;
  87       units seconds;
  88       default 10;
  89       description
  90         "This is overhead added to the supervision timer used to calculate the
  91          supervision wathcdog timer. i.e.,
  92
  93          supervision timer = notification timer + guard-timer-overhead
  94
  95          If not specified the default value of 10 seconds shall apply.
  96
  97          Failure to send this rpc again within the timeout sets the radio into
  98          'loss of supervision' state.
  99
 100          NOTE - The supervision timer MUST not be less that the confimed
 101          timeout timer (when the feature is supported).
 102
 103          This type of constraint (using an RPCs input) cannot be formally
 104          expressed in YANG.";
 105     }
 106   }
 107
 108   grouping watchdog-output {
 109     leaf next-update-at {
 110       type yang:date-and-time;
 111       description
 112         "Indicates the time when the next supervision notification is expected.";
 113     }
 114     leaf error-message {
 115       type string;
 116
 117       description
 118         "An optional error message, e.g., used when the RPC input attempts to
 119         modify a locked running configuration.
 120
 121         Take note, the supervision-notification-interval and guard-timer-overhead
 122         have default values and so their values can be modified even when a leaf is
 123         not included in the RPC input.";
 124     }
 125   }
 126
 127   grouping supervision-group {
 128     container cu-plane-monitoring {
 129       description "container describing operation of CU plane monitoring";
 130       presence
 131         "Indicates O-RU supports timer based cu-plane monitoring interval. If
 132         this container is NOT present, the opertaion of the O-RU is undefined.";
 133
 134       leaf configured-cu-monitoring-interval {
 135         type uint8 {
 136           range "0..160";
 137         }
 138         default 160;
 139         units milliseconds;
 140         description
 141           "This value corresponds to the configured value of the timer used by
 142           the O-RU to monitor the C/U plane connection.
 143
 144           A value of 0 means that the O-RU's shall disable its CU plane
 145           monitoring.
 146
 147           A NETCONF client should configure the value according to the
 148           configuration of the PHY layer and/or C/U plane section types
 149           supported and/or any fault tolerant operation. For example,
 150
 151           i) when opertaing with an O-DU supporting non-LAA LTE, this value can
 152           be configured to a value according to the repetition time of
 153           transmitted reference symbols across the fronthaul interface
 154           ii) when opertaing with an O-DU supporting C-Plane Section Type 0,
 155           this value can configured to a value according to the minimum
 156           repetition interval of section type 0.
 157           iii) when operating with an O-DU supporting fault tolerant operation,
 158           this value can be configured according to the fault tolerant heartbeat
 159           interval ";
 160       }
 161     }
 162   }
 163
 164   container supervision {
 165     uses supervision-group;
 166     // other WG specific monitoring containers follow here
 167   }
 168
 169   rpc supervision-watchdog-reset {
 170     description
 171       "rpc to reset the watchdog timer";
 172     input {
 173       uses watchdog-input;
 174     }
 175
 176           output {
 177       uses watchdog-output;
 178           }
 179   }
 180
 181   notification supervision-notification {
 182     description
 183       "Notification to indicate that NETCONF management interface is up.";
 184
 185   }
 186 }