1 module openconfig-alarm-types {
6 namespace "http://openconfig.net/yang/alarms/types";
8 prefix "oc-alarm-types";
10 // import some basic types
11 import openconfig-extensions { prefix oc-ext; }
14 organization "OpenConfig working group";
17 "OpenConfig working group
21 "This module defines operational state data related to alarms
22 that the device is reporting.
24 This model reuses some data items defined in the draft IETF
26 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02
28 Portions of this code were derived from the draft IETF YANG Alarm
29 Module. Please reproduce this note if possible.
31 IETF code is subject to the following copyright and license:
32 Copyright (c) IETF Trust and the persons identified as authors of
36 Redistribution and use in source and binary forms, with or without
37 modification, is permitted pursuant to, and subject to the license
38 terms contained in, the Simplified BSD License set forth in
39 Section 4.c of the IETF Trust's Legal Provisions Relating
40 to IETF Documents (http://trustee.ietf.org/license-info).";
42 oc-ext:openconfig-version "0.2.0";
44 revision "2018-01-16" {
46 "Moved alarm identities into separate types module";
50 // identity statements
51 identity OPENCONFIG_ALARM_TYPE_ID {
53 "Base identity for alarm type ID profiles";
57 base OPENCONFIG_ALARM_TYPE_ID;
59 "Defines an alarm indication signal type of alarm";
63 base OPENCONFIG_ALARM_TYPE_ID;
65 "Defines an equipment related type of alarm that is specific
66 to the physical hardware";
70 base OPENCONFIG_ALARM_TYPE_ID;
72 "Defines a loss of signal type of alarm";
76 base OPENCONFIG_ALARM_TYPE_ID;
78 "Defines a optical transport signal type of alarm";
81 identity OPENCONFIG_ALARM_SEVERITY {
83 "Base identity for alarm severity profiles. Derived
84 identities are based on contents of the draft
85 IETF YANG Alarm Module";
87 "IETF YANG Alarm Module: Draft - typedef severity
88 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02";
93 base OPENCONFIG_ALARM_SEVERITY;
95 "Indicates that the severity level could not be determined.
96 This level SHOULD be avoided.";
100 base OPENCONFIG_ALARM_SEVERITY;
102 "Indicates the existence of a non-service affecting fault
103 condition and that corrective action should be taken in
104 order to prevent a more serious (for example, service
105 affecting) fault. Such a severity can be reported, for
106 example, when the detected alarm condition is not currently
107 degrading the capacity of the resource";
111 base OPENCONFIG_ALARM_SEVERITY;
113 "Indicates the detection of a potential or impending service
114 affecting fault, before any significant effects have been felt.
115 Action should be taken to further diagnose (if necessary) and
116 correct the problem in order to prevent it from becoming a more
117 serious service affecting fault.";
121 base OPENCONFIG_ALARM_SEVERITY;
123 "Indicates that a service affecting condition has developed
124 and an urgent corrective action is required. Such a severity
125 can be reported, for example, when there is a severe
126 degradation in the capability of the resource and its full
127 capability must be restored.";
131 base OPENCONFIG_ALARM_SEVERITY;
133 "Indicates that a service affecting condition has occurred
134 and an immediate corrective action is required. Such a
135 severity can be reported, for example, when a resource becomes
136 totally out of service and its capability must be restored.";