data-model/yang/working/o-ran-sc/near-rt-ric/o-ran-sc-ric-alarms-v1.yang

   1 module o-ran-sc-ric-alarms-v1 {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:ric:alarms:1.0";
   4   prefix osc-ric-al;
   5
   6   import ietf-alarms {
   7     prefix al;
   8   }
   9
  10   organization
  11     "O-RAN Software Community";
  12   contact
  13     "www.o-ran.org";
  14   description
  15     "This module defines the alarm identities for the O-RAN-SC Near realtime RAN Intelligent Controller.
  16
  17      Copyright 2019 the O-RAN Alliance.
  18
  19      Licensed under the Apache License, Version 2.0 (the 'License');
  20      you may not use this file except in compliance with the License.
  21      You may obtain a copy of the License at
  22
  23       http://www.apache.org/licenses/LICENSE-2.0
  24
  25      Unless required by applicable law or agreed to in writing, software
  26      distributed under the License is distributed on an 'AS IS' BASIS,
  27      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  28      See the License for the specific language governing permissions and
  29      limitations under the License.";
  30
  31   revision 2020-03-08 {
  32     description
  33       "initial revision";
  34     reference
  35       "O-RAN-OAM-Interface-Specification (O1)";
  36   }
  37
  38   identity alarm-type-id {
  39     base al:alarm-type-id;
  40     description
  41       "An abstract alarm type used for all O-RAN-SC specific alarm types for
  42        Managed Function Non-RT-RIC.";
  43   }
  44
  45   identity e2-connection-loss {
  46     base alarm-type-id;
  47     description
  48       "Loss of E2 connection to E2 node.
  49        Instructions:
  50        Check if reconnect happened, e.g. using the health check in RIC-95.";
  51   }
  52
  53   identity time-out {
  54     base alarm-type-id;
  55     description
  56       "Internal routing table update distribution might be incomplete
  57        due to time out.
  58        Instructions:
  59        Operator to check if there were any failures in any of the components
  60        involved (xApp restarts, for example)if no such failures, operator
  61        might have to update time out settings in the configuration to
  62        adjust RIC system to scheduling latencies of the underlying cloud
  63        platform.";
  64   }
  65
  66   identity overload {
  67     base alarm-type-id;
  68     description
  69       "RIC messages could not be send or received due to temporary overload.
  70        Instructions:
  71        Operator to check for any failures. If no failures, operator might
  72        have to adjust buffer sizes and timeouts and/or scale out the system.";
  73   }
  74 }