030c93c3279d7d2c2c2be817695b33ba3487cd7a
[transportpce.git] / tests / honeynode / 2.2.1 / honeynode-plugin-impl / src / main / resources / honeycomb-minimal-resources / config / yang / common / org-openroadm-probable-cause@2018-10-19.yang
1 module org-openroadm-probable-cause {
2   namespace "http://org/openroadm/probableCause";
3   prefix org-openroadm-probable-cause;
4
5   import org-openroadm-common-types {
6     prefix org-openroadm-common-types;
7     revision-date 2018-10-19;
8   }
9
10   organization
11     "Open ROADM MSA";
12   contact
13     "OpenROADM.org";
14   description
15     "YANG definitions of Probable Causes.
16
17       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
18       AT&T Intellectual Property.  All other rights reserved.
19
20       Redistribution and use in source and binary forms, with or without modification,
21       are permitted provided that the following conditions are met:
22
23       * Redistributions of source code must retain the above copyright notice, this
24         list of conditions and the following disclaimer.
25       * Redistributions in binary form must reproduce the above copyright notice,
26         this list of conditions and the following disclaimer in the documentation and/or
27         other materials provided with the distribution.
28       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
29         contributors may be used to endorse or promote products derived from this software
30         without specific prior written permission.
31
32       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
33       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
34       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
35       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
36       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
38       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
39       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41       POSSIBILITY OF SUCH DAMAGE";
42
43   revision 2018-10-19 {
44     description
45       "Version 2.2.1";
46   }
47   revision 2017-12-15 {
48     description
49       "Version 2.2";
50   }
51   revision 2017-09-29 {
52     description
53       "Version 2.1";
54   }
55   revision 2017-07-28 {
56     description
57       "Version 2.0.1 - added revision-date to imports";
58   }
59   revision 2017-06-26 {
60     description
61       "Version 2.0";
62   }
63   revision 2016-10-14 {
64     description
65       "Version 1.2";
66   }
67
68   typedef probable-cause-enum {
69     type enumeration {
70       enum "vendorExtension" {
71         value 1;
72         description
73           "vendorExtension";
74       }
75       enum "openConnectionIndication" {
76         value 2;
77         description
78           "Open connection indication (OCI)";
79         reference "G.798";
80       }
81       enum "alarmIndicationSignal" {
82         value 3;
83         description
84           "Alarm indication signal";
85         reference "G.798";
86       }
87       enum "lossOfSignal" {
88         value 4;
89         description
90           "Loss of Signal";
91       }
92       enum "opticalLineFail" {
93         value 5;
94         description
95           "Optical Line Fail";
96       }
97       enum "opticalPowerDegraded" {
98         value 6;
99         description
100           "Optical Line Fail";
101       }
102       enum "automaticLaserShutdown" {
103         value 7;
104         description
105           "Optical Line Fail";
106       }
107       enum "serverSignalFail" {
108         value 8;
109         description
110           "Server Signal Fail (SSF)";
111         reference "G.798";
112       }
113       enum "lockedDefect" {
114         value 10;
115         description
116           "Locked defect (LCK)";
117         reference "G.798";
118       }
119       enum "trailTraceIdentifierMismatch" {
120         value 11;
121         description
122           "Trail trace Identifier Mismatch (TIM)";
123         reference "G.798";
124       }
125       enum "degradedDefect" {
126         value 12;
127         description
128           "Degraded defect (DEG)";
129         reference "G.798";
130       }
131       enum "backwardsDefectIndication" {
132         value 13;
133         description
134           "Backward Defect Indication (BDI)";
135         reference "G.798";
136       }
137       enum "otsSpanlossPowerOutOfSpecificationHigh" {
138         value 14;
139       }
140       enum "automaticShutoffDisabled" {
141         value 15;
142       }
143       enum "portLossOfLight" {
144         value 17;
145       }
146       enum "reflectionTooHigh" {
147         value 18;
148       }
149       enum "payloadMissingIndication" {
150         value 22;
151         description
152           "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
153       }
154       enum "forwardDefectIndication" {
155         value 23;
156         description
157           "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
158       }
159       enum "oscPowerOutOfSpecificationHigh" {
160         value 24;
161       }
162       enum "oscPowerOutOfSpecificationLow" {
163         value 25;
164       }
165       enum "powerOutOfSpecificationHigh" {
166         value 26;
167       }
168       enum "lossOfSynchronization" {
169         value 27;
170       }
171       enum "linkDown" {
172         value 28;
173       }
174       enum "equipmentFault" {
175         value 29;
176       }
177       enum "equipmentRemoved" {
178         value 30;
179       }
180       enum "equipmentMismatch" {
181         value 31;
182       }
183       enum "equipmentWarmup" {
184         value 32;
185       }
186       enum "equipmentLedOn" {
187         value 33;
188       }
189       enum "equipmentInterConnectFailure" {
190         value 34;
191       }
192       enum "equipmentMiscabledConnection" {
193         value 35;
194       }
195       enum "softwareVersionMismatch" {
196         value 36;
197       }
198       enum "softwareStageInProgress" {
199         value 37;
200       }
201       enum "databaseCorruption" {
202         value 38;
203       }
204       enum "databaseVersionMismatch" {
205         value 44;
206       }
207       enum "firmwareVersionMismatch" {
208         value 46;
209       }
210       enum "incompatibleFirmware" {
211         value 49;
212       }
213       enum "firmwareDownloadOrActivationFailure" {
214         value 50;
215       }
216       enum "firmwareInitInProgress" {
217         value 51;
218       }
219       enum "softwareReset" {
220         value 52;
221       }
222       enum "fanCoolingFail" {
223         value 53;
224       }
225       enum "administrativeDown" {
226         value 54;
227       }
228       enum "lampTest" {
229         value 55;
230       }
231       enum "powerProblemA" {
232         value 56;
233       }
234       enum "powerProblemB" {
235         value 57;
236       }
237       enum "shelfProvisioningMode" {
238         value 58;
239       }
240       enum "sysNameChanged" {
241         value 59;
242       }
243       enum "sysNtpNotSynchronized" {
244         value 60;
245       }
246       enum "lossOfFrame" {
247         value 63;
248       }
249       enum "lossOfMultiframe" {
250         value 64;
251       }
252       enum "backwardIncomingAlignmentError" {
253         value 65;
254       }
255       enum "incomingAlignmentError" {
256         value 66;
257       }
258       enum "payloadMismatch" {
259         value 67;
260       }
261       enum "clientSignalFailDefect" {
262         value 68;
263       }
264       enum "highBER" {
265         value 123;
266       }
267       enum "localFault" {
268         value 124;
269       }
270       enum "remoteFault" {
271         value 125;
272       }
273       enum "lossOfAlignment" {
274         value 126;
275       }
276       enum "lossOfFECAlignment" {
277         value 127;
278       }
279       enum "facilityLoopbackActive" {
280         value 128;
281       }
282       enum "facilityLoopback2Active" {
283         value 129;
284       }
285       enum "terminalLoopbackActive" {
286         value 130;
287       }
288       enum "facilityTestsignalActive" {
289         value 131;
290       }
291       enum "terminalTestsignalActive" {
292         value 132;
293       }
294       enum "certificateNotInstalled" {
295         value 134;
296       }
297       enum "lockoutOfProtection" {
298         value 135;
299       }
300       enum "forcedSwitchAwayFromWorking" {
301         value 136;
302       }
303       enum "forcedSwitchAwayFromProtect" {
304         value 137;
305       }
306       enum "automaticSwitchAwayFromWorkingDueToSF" {
307         value 138;
308       }
309       enum "automaticSwitchAwayFromProtectDueToSF" {
310         value 139;
311       }
312       enum "automaticSwitchDueToWTR" {
313         value 140;
314       }
315       enum "manualSwitchAwayFromWork" {
316         value 141;
317       }
318       enum "manualSwitchAwayFromProtect" {
319         value 142;
320       }
321       enum "automaticPowerReduction" {
322         value 143;
323       }
324       enum "lossOfSignalOSC" {
325         value 144;
326       }
327       enum "softwareValidateInProgress" {
328         value 145;
329       }
330       enum "databaseRollbackTimerInProgress" {
331         value 146;
332       }
333       enum "otdrScanInProgress" {
334         value 147;
335       }
336       enum "lldpFail" {
337         value 148;
338       }
339       enum "omsPowerOutOfSpecificationHigh" {
340         value 149;
341       }
342       enum "omsPowerOutOfSpecificationLow" {
343         value 150;
344       }
345       enum "automaticSwitchAwayFromWorkingDueToSD" {
346         value 151;
347       }
348       enum "automaticSwitchAwayFromProtectDueToSD" {
349         value 152;
350       }
351       enum "backwardIncomingAlignmentErrorTCM1-up" {
352         value 153;
353       }
354       enum "backwardIncomingAlignmentErrorTCM2-up" {
355         value 154;
356       }
357       enum "backwardIncomingAlignmentErrorTCM3-up" {
358         value 155;
359       }
360       enum "backwardIncomingAlignmentErrorTCM4-up" {
361         value 156;
362       }
363       enum "backwardIncomingAlignmentErrorTCM5-up" {
364         value 157;
365       }
366       enum "backwardIncomingAlignmentErrorTCM6-up" {
367         value 158;
368       }
369       enum "incomingAlignmentErrorTCM1-up" {
370         value 159;
371       }
372       enum "incomingAlignmentErrorTCM2-up" {
373         value 160;
374       }
375       enum "incomingAlignmentErrorTCM3-up" {
376         value 161;
377       }
378       enum "incomingAlignmentErrorTCM4-up" {
379         value 162;
380       }
381       enum "incomingAlignmentErrorTCM5-up" {
382         value 163;
383       }
384       enum "incomingAlignmentErrorTCM6-up" {
385         value 164;
386       }
387       enum "backwardsDefectIndicationTCM1-up" {
388         value 165;
389       }
390       enum "backwardsDefectIndicationTCM2-up" {
391         value 166;
392       }
393       enum "backwardsDefectIndicationTCM3-up" {
394         value 167;
395       }
396       enum "backwardsDefectIndicationTCM4-up" {
397         value 168;
398       }
399       enum "backwardsDefectIndicationTCM5-up" {
400         value 169;
401       }
402       enum "backwardsDefectIndicationTCM6-up" {
403         value 170;
404       }
405       enum "degradedDefectTCM1-up" {
406         value 171;
407       }
408       enum "degradedDefectTCM2-up" {
409         value 172;
410       }
411       enum "degradedDefectTCM3-up" {
412         value 173;
413       }
414       enum "degradedDefectTCM4-up" {
415         value 174;
416       }
417       enum "degradedDefectTCM5-up" {
418         value 175;
419       }
420       enum "degradedDefectTCM6-up" {
421         value 176;
422       }
423       enum "trailTraceIdentifierMisMatchTCM1-up" {
424         value 177;
425       }
426       enum "trailTraceIdentifierMisMatchTCM2-up" {
427         value 178;
428       }
429       enum "trailTraceIdentifierMisMatchTCM3-up" {
430         value 179;
431       }
432       enum "trailTraceIdentifierMisMatchTCM4-up" {
433         value 180;
434       }
435       enum "trailTraceIdentifierMisMatchTCM5-up" {
436         value 181;
437       }
438       enum "trailTraceIdentifierMisMatchTCM6-up" {
439         value 182;
440       }
441       enum "alarmIndicationSignalTCM1-up" {
442         value 183;
443       }
444       enum "alarmIndicationSignalTCM2-up" {
445         value 184;
446       }
447       enum "alarmIndicationSignalTCM3-up" {
448         value 185;
449       }
450       enum "alarmIndicationSignalTCM4-up" {
451         value 186;
452       }
453       enum "alarmIndicationSignalTCM5-up" {
454         value 187;
455       }
456       enum "alarmIndicationSignalTCM6-up" {
457         value 188;
458       }
459       enum "openConnectionIndicationTCM1-up" {
460         value 189;
461       }
462       enum "openConnectionIndicationTCM2-up" {
463         value 190;
464       }
465       enum "openConnectionIndicationTCM3-up" {
466         value 191;
467       }
468       enum "openConnectionIndicationTCM4-up" {
469         value 192;
470       }
471       enum "openConnectionIndicationTCM5-up" {
472         value 193;
473       }
474       enum "openConnectionIndicationTCM6-up" {
475         value 194;
476       }
477       enum "lockedDefectTCM1-up" {
478         value 195;
479       }
480       enum "lockedDefectTCM2-up" {
481         value 196;
482       }
483       enum "lockedDefectTCM3-up" {
484         value 197;
485       }
486       enum "lockedDefectTCM4-up" {
487         value 198;
488       }
489       enum "lockedDefectTCM5-up" {
490         value 199;
491       }
492       enum "lockedDefectTCM6-up" {
493         value 200;
494       }
495       enum "lossofTandemConnectionTCM1-up" {
496         value 201;
497       }
498       enum "lossofTandemConnectionTCM2-up" {
499         value 202;
500       }
501       enum "lossofTandemConnectionTCM3-up" {
502         value 203;
503       }
504       enum "lossofTandemConnectionTCM4-up" {
505         value 204;
506       }
507       enum "lossofTandemConnectionTCM5-up" {
508         value 205;
509       }
510       enum "lossofTandemConnectionTCM6-up" {
511         value 206;
512       }
513       enum "backwardIncomingAlignmentErrorTCM1-down" {
514         value 207;
515       }
516       enum "backwardIncomingAlignmentErrorTCM2-down" {
517         value 208;
518       }
519       enum "backwardIncomingAlignmentErrorTCM3-down" {
520         value 209;
521       }
522       enum "backwardIncomingAlignmentErrorTCM4-down" {
523         value 210;
524       }
525       enum "backwardIncomingAlignmentErrorTCM5-down" {
526         value 211;
527       }
528       enum "backwardIncomingAlignmentErrorTCM6-down" {
529         value 212;
530       }
531       enum "incomingAlignmentErrorTCM1-down" {
532         value 213;
533       }
534       enum "incomingAlignmentErrorTCM2-down" {
535         value 214;
536       }
537       enum "incomingAlignmentErrorTCM3-down" {
538         value 215;
539       }
540       enum "incomingAlignmentErrorTCM4-down" {
541         value 216;
542       }
543       enum "incomingAlignmentErrorTCM5-down" {
544         value 217;
545       }
546       enum "incomingAlignmentErrorTCM6-down" {
547         value 218;
548       }
549       enum "backwardsDefectIndicationTCM1-down" {
550         value 219;
551       }
552       enum "backwardsDefectIndicationTCM2-down" {
553         value 220;
554       }
555       enum "backwardsDefectIndicationTCM3-down" {
556         value 221;
557       }
558       enum "backwardsDefectIndicationTCM4-down" {
559         value 222;
560       }
561       enum "backwardsDefectIndicationTCM5-down" {
562         value 223;
563       }
564       enum "backwardsDefectIndicationTCM6-down" {
565         value 224;
566       }
567       enum "degradedDefectTCM1-down" {
568         value 225;
569       }
570       enum "degradedDefectTCM2-down" {
571         value 226;
572       }
573       enum "degradedDefectTCM3-down" {
574         value 227;
575       }
576       enum "degradedDefectTCM4-down" {
577         value 228;
578       }
579       enum "degradedDefectTCM5-down" {
580         value 229;
581       }
582       enum "degradedDefectTCM6-down" {
583         value 230;
584       }
585       enum "trailTraceIdentifierMisMatchTCM1-down" {
586         value 231;
587       }
588       enum "trailTraceIdentifierMisMatchTCM2-down" {
589         value 232;
590       }
591       enum "trailTraceIdentifierMisMatchTCM3-down" {
592         value 233;
593       }
594       enum "trailTraceIdentifierMisMatchTCM4-down" {
595         value 234;
596       }
597       enum "trailTraceIdentifierMisMatchTCM5-down" {
598         value 235;
599       }
600       enum "trailTraceIdentifierMisMatchTCM6-down" {
601         value 236;
602       }
603       enum "alarmIndicationSignalTCM1-down" {
604         value 237;
605       }
606       enum "alarmIndicationSignalTCM2-down" {
607         value 238;
608       }
609       enum "alarmIndicationSignalTCM3-down" {
610         value 239;
611       }
612       enum "alarmIndicationSignalTCM4-down" {
613         value 240;
614       }
615       enum "alarmIndicationSignalTCM5-down" {
616         value 241;
617       }
618       enum "alarmIndicationSignalTCM6-down" {
619         value 242;
620       }
621       enum "openConnectionIndicationTCM1-down" {
622         value 243;
623       }
624       enum "openConnectionIndicationTCM2-down" {
625         value 244;
626       }
627       enum "openConnectionIndicationTCM3-down" {
628         value 245;
629       }
630       enum "openConnectionIndicationTCM4-down" {
631         value 246;
632       }
633       enum "openConnectionIndicationTCM5-down" {
634         value 247;
635       }
636       enum "openConnectionIndicationTCM6-down" {
637         value 248;
638       }
639       enum "lockedDefectTCM1-down" {
640         value 249;
641       }
642       enum "lockedDefectTCM2-down" {
643         value 250;
644       }
645       enum "lockedDefectTCM3-down" {
646         value 251;
647       }
648       enum "lockedDefectTCM4-down" {
649         value 252;
650       }
651       enum "lockedDefectTCM5-down" {
652         value 253;
653       }
654       enum "lockedDefectTCM6-down" {
655         value 254;
656       }
657       enum "lossofTandemConnectionTCM1-down" {
658         value 255;
659       }
660       enum "lossofTandemConnectionTCM2-down" {
661         value 256;
662       }
663       enum "lossofTandemConnectionTCM3-down" {
664         value 257;
665       }
666       enum "lossofTandemConnectionTCM4-down" {
667         value 258;
668       }
669       enum "lossofTandemConnectionTCM5-down" {
670         value 259;
671       }
672       enum "lossofTandemConnectionTCM6-down" {
673         value 260;
674       }
675       enum "multiplexStructureIdentifierMismatch" {
676         value 261;
677         description
678           "G798 : 6.2.9 (dMSIM)";
679       }
680       enum "lossOfOmfIndication" {
681         value 262;
682         description
683           "G798 : 14.3.10.2 Figure 14-73 (dLOOMFI)";
684       }
685       enum "lossOfFrameAndLossOfMultiframe" {
686         value 263;
687         description
688           "G798 : 6.2.5.3 (dLOFLOM)";
689       }
690       enum "lossOfDatabaseRedundancy" {
691         value 264;
692         description
693           "loss of database redundancy";
694       }
695       enum "databaseLocked" {
696         value 265;
697         description
698           "Database locked";
699       }
700       enum "createTechInfoInProgress" {
701         value 266;
702         description
703           "create-tech-info in progress";
704       }
705       enum "circuitPackActivateFailed" {
706         value 267;
707         description
708           "circuit-pack activation failed";
709       }
710       enum "softwareSubsystemFailed" {
711         value 268;
712         description
713           "Software subsystem failed";
714       }
715       enum "diskFull" {
716         value 269;
717         description
718           "Disk full";
719       }
720     }
721   }
722
723   grouping probable-cause {
724     leaf cause {
725       type probable-cause-enum;
726       mandatory true;
727     }
728     leaf extension {
729       type string;
730       mandatory false;
731     }
732     leaf direction {
733       type org-openroadm-common-types:direction;
734       mandatory true;
735       description
736         "Direction indication of the alarm.";
737     }
738     leaf location {
739       type org-openroadm-common-types:location;
740       mandatory true;
741       description
742         "location indication of the alarm.";
743     }
744     leaf type {
745       type enumeration {
746         enum "communication" {
747           value 1;
748         }
749         enum "qualityOfService" {
750           value 2;
751         }
752         enum "processingError" {
753           value 3;
754         }
755         enum "equipment" {
756           value 4;
757         }
758         enum "environmental" {
759           value 5;
760         }
761       }
762       mandatory false;
763       description
764         "Type of alarm. Based on X.733 event Type.";
765     }
766   }
767 }