data-model/yang/published/xran/xran-fm@2018-07-20.yang

   1 module xran-fm {
   2   yang-version 1.1;
   3   namespace "urn:xran:fm:1.0";
   4   prefix "xran-fm";
   5
   6   import ietf-yang-types {
   7     prefix yang;
   8     revision-date 2013-07-15;
   9   }
  10
  11   organization "xRAN Forum";
  12
  13   contact
  14     "www.xran.org";
  15
  16   description
  17     "This module defines alarm reporting mechanism.
  18
  19     Copyright 2018 the xRAN Forum.
  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 xRAN Forum 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 "2018-07-20" {
  46     description
  47       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  48
  49       This version of the model supports v01.00 of the corrsponding xRAN
  50       M-Plane Specification.";
  51     reference "XRAN-FH.MP.0-v01.00";
  52   }
  53
  54   grouping alarm {
  55     description
  56       "Gropuping which can uniquely identify alarm";
  57
  58     leaf fault-id {
  59       type uint16;
  60       mandatory true;
  61
  62       description
  63         "Fault specific Id that identifies the fault.";
  64     }
  65
  66     leaf fault-source {
  67       type string {
  68         length "1..255";
  69       }
  70       mandatory true;
  71
  72       description
  73         "Represents the Object or source that is suspected to be faulty.";
  74     }
  75
  76     list affected-objects {
  77       leaf name {
  78         type string {
  79           length "1..255";
  80         }
  81         mandatory true;
  82
  83         description
  84           "Represents the Object or source that is suspected to be affected by this fault";
  85       }
  86       min-elements 1;
  87       max-elements 100;
  88
  89       description
  90         "List of affected-objects";
  91     }
  92
  93     leaf fault-severity {
  94       type enumeration {
  95         enum CRITICAL {
  96           description
  97             "Critical alarm means that this device is not able to perform any further service";
  98         }
  99         enum MAJOR {
 100           description
 101             "Major alarm appeared on the device";
 102         }
 103         enum MINOR {
 104           description
 105             "Minor alarm appeared on the device";
 106         }
 107         enum WARNING {
 108           description
 109             "Warning is being reported by the device";
 110         }
 111       }
 112       mandatory true;
 113
 114       description
 115         "Fault severity defines the severity level of the fault. A notification, whose fault severity has the value 'warning',
 116         is a special type of an alarm notification. For these alarm notifications,
 117         the Master Agent does not expect to receive a clear alarm notification.";
 118     }
 119
 120     leaf is-cleared {
 121       type boolean;
 122       mandatory true;
 123
 124       description
 125         "Fault state determines the type of the event. Not used if faultSeverity is WARNING.";
 126     }
 127
 128     leaf fault-text {
 129       type string {
 130         length "0..255";
 131       }
 132
 133       description
 134         "Textual description of the fault.";
 135     }
 136
 137     leaf event-time {
 138       type yang:date-and-time;
 139       mandatory true;
 140
 141       description
 142         "Timestamp to indicate the time when the fault is detected/cleared.";
 143     }
 144   }
 145
 146   container active-alarm-list {
 147     list active-alarms {
 148       uses alarm;
 149
 150       description
 151         "List of currenty active alarms";
 152     }
 153     config false;
 154
 155     description
 156       "List of currently active alarms. An alarm is removed from this table when the state transitions to clear.";
 157   }
 158
 159   notification alarm-notif {
 160     uses alarm;
 161
 162     description
 163       "Notification sent on initial alarm creation, as well as any time the alarm changes state, including clear";
 164   }
 165 }