1 module openconfig-alarms {
6 namespace "http://openconfig.net/yang/alarms";
10 // import some basic types
11 import openconfig-alarm-types { prefix oc-alarm-types; }
12 import openconfig-extensions { prefix oc-ext; }
13 import openconfig-types { prefix oc-types; }
14 import openconfig-platform { prefix oc-platform; }
17 organization "OpenConfig working group";
20 "OpenConfig working group
24 "This module defines operational state data related to alarms
25 that the device is reporting.
27 This model reuses some data items defined in the draft IETF
29 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02
31 Portions of this code were derived from the draft IETF YANG Alarm
32 Module. Please reproduce this note if possible.
34 IETF code is subject to the following copyright and license:
35 Copyright (c) IETF Trust and the persons identified as authors of
39 Redistribution and use in source and binary forms, with or without
40 modification, is permitted pursuant to, and subject to the license
41 terms contained in, the Simplified BSD License set forth in
42 Section 4.c of the IETF Trust's Legal Provisions Relating
43 to IETF Documents (http://trustee.ietf.org/license-info).";
45 oc-ext:openconfig-version "0.3.0";
47 revision "2018-01-16" {
49 "Moved alarm identities into separate types module";
53 revision "2018-01-10" {
55 "Make alarms list read only";
59 revision "2017-08-24" {
61 "Initial public release";
66 // grouping statements
68 grouping alarm-state {
70 "Operational state data for device alarms";
75 "Unique ID for the alarm -- this will not be a
76 configurable parameter on many implementations";
82 "The item that is under alarm within the device. The
83 resource may be a reference to an item which is
84 defined elsewhere in the model. For example, it
85 may be a platform/component, interfaces/interface,
86 terminal-device/logical-channels/channel, etc. In this
87 case the system should match the name of the referenced
88 item exactly. The referenced item could alternatively be
89 the path of the item within the model.";
91 "IETF YANG Alarm Module: Draft - typedef resource
92 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02";
98 "The string used to inform operators about the alarm. This
99 MUST contain enough information for an operator to be able
100 to understand the problem. If this string contains structure,
101 this format should be clearly documented for programs to be
102 able to parse that information";
104 "IETF YANG Alarm Module: Draft - typedef alarm-text
105 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02";
109 type oc-types:timeticks64;
111 "The time at which the alarm was raised by the system.
112 This value is expressed as nanoseconds since the Unix Epoch";
117 base oc-alarm-types:OPENCONFIG_ALARM_SEVERITY;
120 "The severity level indicating the criticality and impact
123 "IETF YANG Alarm Module: Draft - typedef severity
124 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02";
131 base oc-alarm-types:OPENCONFIG_ALARM_TYPE_ID;
135 "The abbreviated name of the alarm, for example LOS,
136 EQPT, or OTS. Also referred to in different systems as
137 condition type, alarm identifier, or alarm mnemonic. It
138 is recommended to use the OPENCONFIG_ALARM_TYPE_ID
139 identities where possible and only use the string type
140 when the desired identityref is not yet defined";
142 "IETF YANG Alarm Module: Draft - typedef alarm-type-id
143 https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02";
147 grouping alarm-config {
149 "Configuration data for device alarms";
152 grouping alarms-top {
154 "Top-level grouping for device alarms";
158 "Top-level container for device alarms";
165 "List of alarms, keyed by a unique id";
173 "References the unique alarm id";
178 "Configuration data for each alarm";
187 "Operational state data for a device alarm";
199 augment "/oc-platform:components/oc-platform:component/oc-platform:state" {
201 "Adds specific alarms related to a component.";
203 leaf equipment-failure {
207 "If true, the hardware indicates that the component's physical equipment
211 leaf equipment-mismatch {
215 "If true, the hardware indicates that the component inserted into the
216 affected component's physical location is of a different type than what