3 namespace "urn:o-ran:fm:1.0";
6 import ietf-yang-types {
8 revision-date 2013-07-15;
11 organization "O-RAN Alliance";
17 "This module defines alarm reporting mechanism.
19 Copyright 2021 the O-RAN Alliance.
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.
33 Redistribution and use in source and binary forms, with or without
34 modification, are permitted provided that the following conditions are met:
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.";
45 revision "2022-08-15" {
49 1) removed min-elements 1 from affected-objects list
50 2) added identifier to affected-objects list
51 3) added new additional-information list";
53 reference "ORAN-WG4.M.0-v10.00";
56 revision "2022-04-18" {
60 1) added feature HISTORICAL-ALARM-LIST
61 2) added corresponding historical-alarm-list container";
63 reference "ORAN-WG4.M.0-v09.00";
67 revision "2021-12-01" {
71 1) typographical corrections in descriptions.
72 2) add new leafs probable-cause, specific-problem, proposed-repair-actions
75 reference "ORAN-WG4.M.0-v08.00";
78 revision "2021-03-22" {
82 1) typographical corrections in descriptions.";
84 reference "ORAN-WG4.M.0-v01.00";
87 revision "2019-02-04" {
91 1) imported model from xRAN
92 2) changed namespace and reference from xran to o-ran";
94 reference "ORAN-WG4.M.0-v01.00";
97 feature HISTORICAL-ALARM-LIST {
99 "O-RU supports Historical Alarm List to keep a historical
100 record of alarms events over M-plane.";
105 "Grouping which can uniquely identify alarm";
112 "Fault specific Id that identifies the fault.";
122 "Represents the Object or source that is suspected to be faulty.
123 If the fault source is external and can not be represented by an object in the model, external alarm source info should be set as the value.
124 If the fault source can be represented by an object in the model, the YANG instance-identifier should be set as the value";
127 list affected-objects {
136 "Represents the Object or source that is suspected to be affected by this fault.";
141 description "An optional parameter used to indicate a YANG instance-identifier for the affected
142 object. Used when the object or source is represented in the object model.";
148 "List of affected-objects";
151 leaf fault-severity {
155 "Critical alarm means that this device is not able to perform any further service";
159 "Major alarm appeared on the device";
163 "Minor alarm appeared on the device";
167 "Warning is being reported by the device";
173 "Fault severity defines the severity level of the fault. A notification, whose fault severity has the value 'warning',
174 is a special type of alarm notification. For these alarm notifications,
175 the Master Agent does not expect to receive a clear alarm notification.";
183 "Fault state determines the type of the event. Not used if faultSeverity is WARNING.";
192 "Textual description of the fault.";
195 leaf probable-cause {
200 "Probable cause of an alarm as defined in ITU-T Rec. X.733.
201 It qualifies alarm and provides further information than alarm-type.
203 The value of the probable cause strings are not standardized in this YANG model.
205 An O-RU shall populate this leaf, if the fault-text string does not indicate
206 the probable cause.";
209 leaf specific-problem {
214 "An optional leaf providing further qualification on the alarm than probable-cause,
215 as defined in ITU-T Recommendation X.733 ";
218 leaf proposed-repair-actions {
223 "Optional leaf, used if the cause is known and the O-RU can suggest one or
224 more solutions to fix the problem causing the alarm as defined in ITU-T Rec. X. 733";
228 type yang:date-and-time;
232 "Timestamp to indicate the time when the fault is detected/cleared.";
235 list additional-information {
238 "This parameter allows the inclusion of an additional
239 information set in the alarm. It is a series of data
240 structures, each of which contains items of
241 information: an identifier,
242 and the problem information. Refer to RFC8632.";
246 "Identifies the data type of the information parameter.";
251 "Additional information about the alarm.";
257 enum COMMUNICATIONS-ALARM {
259 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
261 enum PROCESSING-ERROR-ALARM {
263 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
265 enum ENVIRONMENTAL-ALARM {
267 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
269 enum QUALITY-OF-SERVICE-ALARM {
271 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
273 enum EQUIPMENT-ALARM {
275 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
277 enum INTEGRITY-VIOLATION {
279 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
281 enum OPERATIONAL-VIOLATION {
283 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
285 enum PHYSICAL-VIOLATION {
287 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
289 enum SECURITY-SERVICE-OR-MECHANISM-VIOLATION {
291 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
293 enum TIME-DOMAIN-VIOLATION {
295 "See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for description";
299 "An optional alarm type that can be used with vendor specific alarms.
300 See Table 12.2.1.4.4.6-1 in 3GPP 28.532 for definitions.
302 WG4 common O-RU alarms have pre-defined alarm types, see Annex A of
307 container active-alarm-list {
312 "List of currently active alarms";
317 "List of currently active alarms. An alarm is removed from this table when the state transitions to clear.";
320 container historical-alarm-list {
321 if-feature HISTORICAL-ALARM-LIST;
323 "an optional container to notify the event subscriber of historical alarms information. When the O-RU
324 is reset, the alarm entries from historical-alarm-list will be purged. O-RU vendor can make this
325 list persistent optionally.";
327 list historical-alarms {
332 "List of historical alarm events. This list only captures the alarm events when <is-cleared>=TRUE.";
337 notification alarm-notif {
341 "Notification sent on initial alarm creation, as well as any time the alarm changes state, including clear";