ntsimulator/yang/x-ran/xran-alarm-id.yang

   1 module xran-alarm-id {
   2   yang-version 1.1;
   3   namespace "urn:xran:alarms:1.0";
   4   prefix "xran-alarms";
   5
   6   organization "xRAN Forum";
   7
   8   contact
   9     "www.xran.org";
  10
  11   description
  12     "This module defines the alarm identities for the RU.
  13
  14     Copyright 2018 the xRAN Forum.
  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 xRAN Forum 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 "2018-07-20" {
  41     description
  42       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  43
  44       This version of the model supports v01.00 of the corrsponding xRAN
  45       M-Plane Specification.";
  46     reference "XRAN-FH.MP.0-v01.00";
  47   }
  48
  49   typedef alarm-id {
  50     type enumeration {
  51       enum XRAN_HIGH_TEMP_ALARM {
  52         value 1;
  53         description "A temperature is higher than expected";
  54       }
  55       enum XRAN_OVERHEATING_ALARM {
  56         value 2;
  57         description "A temperature is dangerously high";
  58       }
  59       enum XRAN_AMBIENT_TEMP_ALARM {
  60         value 3;
  61         description "A temperature related alarm due to ambient temperature
  62         value going outside the allowed ambient temperature range";
  63       }
  64       enum XRAN_TEMP_TOO_LOW_ALARM {
  65         value 4;
  66         description "A temperature related alarm due to the temperature inside
  67         the unit being too low";
  68       }
  69       enum XRAN_BROKEN_FAN_ALARM {
  70         value 5;
  71         description "A broken fan";
  72       }
  73       enum XRAN_FAN_NOT_DETECTED_ALARM {
  74         value 6;
  75         description "A fan not detected";
  76       }
  77       enum XRAN_TUNING_ALARM {
  78         value 7;
  79         description "A tuning failure.";
  80       }
  81       enum XRAN_FILTER_ALARM {
  82         value 8;
  83         description "A faulty filter.";
  84       }
  85       enum XRAN_TX_QUALITY_ALARM {
  86         value 9;
  87         description "A transmission quality.";
  88       }
  89       enum XRAN_OVERVOLTAGE_ALARM {
  90         value 10;
  91         description "A RF  overvoltage protection.";
  92       }
  93       enum XRAN_CONFIG_ALARM {
  94         value 11;
  95         description "A configuration failed.";
  96       }
  97       enum XRAN_CRITICAL_FILE_ALARM {
  98         value 12;
  99         description "A Critical file not found.";
 100       }
 101       enum XRAN_FILE_ALARM {
 102         value 13;
 103         description "A non-critical file not found.";
 104       }
 105       enum XRAN_CORRUPT_FILE_ALARM {
 106         value 14;
 107         description "A corrupt configuration file.";
 108       }
 109       enum XRAN_OPERATION_ALARM {
 110         value 15;
 111         description "A unit out of order.";
 112       }
 113       enum XRAN_NO_IDENTITY_ALARM {
 114         value 16;
 115         description "A unit cannot be identified.";
 116       }
 117       enum XRAN_NO_EXT_SYNC_SOURCE {
 118         value 17;
 119         description "An RU has no external sync source.";
 120       }
 121       enum XRAN_SYNC_ALARM {
 122         value 18;
 123         description "A unit is out of synchronization.";
 124       }
 125       enum XRAN_TX_OUT_OF_ORDER_ALARM {
 126         value 19;
 127         description "A TX path is not usable.";
 128       }
 129       enum XRAN_RX_OUT_OF_ORDER_ALARM {
 130         value 20;
 131         description "A RX path is not usable.";
 132       }
 133       enum XRAN_OPTICAL_BER_ALARM {
 134         value 21;
 135         description "An increased bit error rate on the optical link";
 136       }
 137       enum XRAN_SELF_TEST_ALARM {
 138         value 22;
 139         description "A power-on self test";
 140       }
 141       enum XRAN_FPGA_UPDATE_ALARM {
 142         value 23;
 143         description "An FPGA software update";
 144       }
 145       enum XRAN_UNIT_BLOCKED_ALARM {
 146         value 24;
 147         description "A unit is blocked";
 148       }
 149       enum XRAN_RESET_REQUEST_ALARM {
 150         value 25;
 151         description "A unit requires a reset";
 152       }
 153       enum XRAN_POWER_SUPPLY_FAULTY {
 154         value 26;
 155         description "A power supply unit has a fault";
 156       }
 157       enum XRAN_POWER_AMPLIFIER_FAULTY {
 158         value 27;
 159         description "A power amplifier unit has a fault";
 160       }
 161       enum XRAN_C_U_PLANE_LOGICAL_CONNECTION_FAULTY {
 162         value 28;
 163         description "A C/U-plane logical connection has a fault";
 164       }
 165       enum XRAN_TRANSCEIVER_FAULT {
 166         value 29;
 167         description "A transceiver unit has a fault";
 168       }
 169       enum XRAN_INTERFACE_FAULT {
 170         value 30;
 171         description "An interface unit has a fault";
 172       }
 173     }
 174     description
 175       "A typedef defining an enumerated list of XRAN alarms which corresponds to
 176       the fault-id in the xran management plane specification.";
 177   }
 178 }