1 module org-openroadm-alarm {
2 namespace "http://org/openroadm/alarm";
3 prefix org-openroadm-alarm;
5 import ietf-yang-types {
7 revision-date 2013-07-15;
9 import org-openroadm-common-types {
10 prefix org-openroadm-common-types;
11 revision-date 2017-12-15;
13 import org-openroadm-resource {
14 prefix org-openroadm-resource;
15 revision-date 2017-12-15;
17 import org-openroadm-probable-cause {
18 prefix org-openroadm-probable-cause;
19 revision-date 2017-12-15;
27 "YANG definitions of an alarm.
29 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
30 AT&T Intellectual Property. All other rights reserved.
32 Redistribution and use in source and binary forms, with or without modification,
33 are permitted provided that the following conditions are met:
35 * Redistributions of source code must retain the above copyright notice, this
36 list of conditions and the following disclaimer.
37 * Redistributions in binary form must reproduce the above copyright notice,
38 this list of conditions and the following disclaimer in the documentation and/or
39 other materials provided with the distribution.
40 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
41 contributors may be used to endorse or promote products derived from this software
42 without specific prior written permission.
44 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
45 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
46 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
47 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
48 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
49 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
50 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
51 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
52 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
53 POSSIBILITY OF SUCH DAMAGE.";
65 "Version 2.0.1 - added revision-date to imports";
77 "Uniquely id for this alarm, within the given management domain";
81 "Resource under alarm";
82 uses org-openroadm-resource:resource;
84 container probableCause {
86 "Probable cause of alarm";
87 uses org-openroadm-probable-cause:probable-cause;
90 type yang:date-and-time;
93 "Time alarm was raised";
96 type org-openroadm-common-types:severity;
99 "Severity of alarm. Based on X.733 perceived severity.";
104 "Circuit-id for alarm correlation.";
106 leaf additional-detail {
109 "Provide additional descriptive text about the probable cause.";
111 leaf corrective-action {
114 "Provide recommended corrective actions for this probable cause, i.e. replace or restart a circuit pack, check wiring for the reported source, or secondary failure to be correlated ";
118 notification alarm-notification {
120 "Notification sent on initial alarm creation, as well as any time the alarm changes state, including clear";
123 container active-alarm-list {
126 "List of currently active alarms. An alarm is removed from this table when the state transitions to clear.";