ntsimulator/yang/o-ran/ru-fh/o-ran-alarm-id.yang

   1 module o-ran-alarm-id {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:alarms:1.0";
   4   prefix "o-ran-alarms";
   5
   6   organization "oO-RAN Alliance";
   7
   8   contact
   9     "www.o-ran.org";
  10
  11   description
  12     "This module defines the alarm identities for the oRAN Equipment.
  13
  14     Copyright 2019 the O-RAN Alliance.
  15
  16     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  17     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26     POSSIBILITY OF SUCH DAMAGE.
  27
  28     Redistribution and use in source and binary forms, with or without
  29     modification, are permitted provided that the following conditions are met:
  30
  31     * Redistributions of source code must retain the above copyright notice,
  32     this list of conditions and the above disclaimer.
  33     * Redistributions in binary form must reproduce the above copyright notice,
  34     this list of conditions and the above disclaimer in the documentation
  35     and/or other materials provided with the distribution.
  36     * Neither the Members of the O-RAN Alliance nor the names of its
  37     contributors may be used to endorse or promote products derived from
  38     this software without specific prior written permission.";
  39
  40   revision "2019-02-04" {
  41     description
  42       "version 1.0.0
  43
  44       1) imported model from xRAN
  45       2) changed namespace and reference from xran to o-ran";
  46
  47     reference "ORAN-WG4.M.0-v01.00";
  48   }
  49
  50
  51   typedef alarm-id {
  52     type enumeration {
  53       enum ORAN_HIGH_TEMP_ALARM {
  54         value 1;
  55         description "A temperature is higher than expected";
  56       }
  57       enum ORAN_OVERHEATING_ALARM {
  58         value 2;
  59         description "A temperature is dangerously high";
  60       }
  61       enum ORAN_AMBIENT_TEMP_ALARM {
  62         value 3;
  63         description "A temperature related alarm due to ambient temperature
  64         value going outside the allowed ambient temperature range";
  65       }
  66       enum ORAN_TEMP_TOO_LOW_ALARM {
  67         value 4;
  68         description "A temperature related alarm due to the temperature inside
  69         the unit being too low";
  70       }
  71       enum ORAN_BROKEN_FAN_ALARM {
  72         value 5;
  73         description "A broken fan";
  74       }
  75       enum ORAN_FAN_NOT_DETECTED_ALARM {
  76         value 6;
  77         description "A fan not detected";
  78       }
  79       enum ORAN_TUNING_ALARM {
  80         value 7;
  81         description "A tuning failure.";
  82       }
  83       enum ORAN_FILTER_ALARM {
  84         value 8;
  85         description "A faulty filter.";
  86       }
  87       enum ORAN_TX_QUALITY_ALARM {
  88         value 9;
  89         description "A transmission quality.";
  90       }
  91       enum ORAN_OVERVOLTAGE_ALARM {
  92         value 10;
  93         description "A RF  overvoltage protection.";
  94       }
  95       enum ORAN_CONFIG_ALARM {
  96         value 11;
  97         description "A configuration failed.";
  98       }
  99       enum ORAN_CRITICAL_FILE_ALARM {
 100         value 12;
 101         description "A Critical file not found.";
 102       }
 103       enum ORAN_FILE_ALARM {
 104         value 13;
 105         description "A non-critical file not found.";
 106       }
 107       enum ORAN_CORRUPT_FILE_ALARM {
 108         value 14;
 109         description "A corrupt configuration file.";
 110       }
 111       enum ORAN_OPERATION_ALARM {
 112         value 15;
 113         description "A unit out of order.";
 114       }
 115       enum ORAN_NO_IDENTITY_ALARM {
 116         value 16;
 117         description "A unit cannot be identified.";
 118       }
 119       enum ORAN_NO_EXT_SYNC_SOURCE {
 120         value 17;
 121         description "A unit has no external sync source.";
 122       }
 123       enum ORAN_SYNC_ALARM {
 124         value 18;
 125         description "A unit is out of synchronization.";
 126       }
 127       enum ORAN_TX_OUT_OF_ORDER_ALARM {
 128         value 19;
 129         description "A TX path is not usable.";
 130       }
 131       enum ORAN_RX_OUT_OF_ORDER_ALARM {
 132         value 20;
 133         description "A RX path is not usable.";
 134       }
 135       enum ORAN_OPTICAL_BER_ALARM {
 136         value 21;
 137         description "An increased bit error rate on the optical link";
 138       }
 139       enum ORAN_SELF_TEST_ALARM {
 140         value 22;
 141         description "A power-on self test";
 142       }
 143       enum ORAN_FPGA_UPDATE_ALARM {
 144         value 23;
 145         description "An FPGA software update";
 146       }
 147       enum ORAN_UNIT_BLOCKED_ALARM {
 148         value 24;
 149         description "A unit is blocked";
 150       }
 151       enum ORAN_RESET_REQUEST_ALARM {
 152         value 25;
 153         description "A unit requires a reset";
 154       }
 155       enum ORAN_POWER_SUPPLY_FAULTY {
 156         value 26;
 157         description "A power supply unit has a fault";
 158       }
 159       enum ORAN_POWER_AMPLIFIER_FAULTY {
 160         value 27;
 161         description "A power amplifier unit has a fault";
 162       }
 163       enum ORAN_C_U_PLANE_LOGICAL_CONNECTION_FAULTY {
 164         value 28;
 165         description "A C/U-plane logical connection has a fault";
 166       }
 167       enum ORAN_TRANSCEIVER_FAULT {
 168         value 29;
 169         description "A transceiver unit has a fault";
 170       }
 171       enum ORAN_INTERFACE_FAULT {
 172         value 30;
 173         description "An interface unit has a fault";
 174       }
 175       enum ORAN_UNEXPECTED_C_U_PLANE_MESSAGE_CONTENT_FAULT {
 176         value 31;
 177         description "C/U-plane message content was faulty for undetermined reason.";
 178       }
 179     }
 180     description
 181       "A typedef defining an enumerated list of O-RAN alarms which corresponds to
 182       the fault-id in the o-ran management plane specification.";
 183   }
 184 }