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