Update docs conf.yaml version to Sulfur
[transportpce.git] / ordmodels / common / src / main / yang / org-openroadm-probable-cause@2020-05-29.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-alarm-pm-types {
6     prefix org-openroadm-common-alarm-pm-types;
7     revision-date 2019-11-29;
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       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 2020-05-29 {
44     description
45       "Version 7.1.0";
46   }
47   revision 2020-03-27 {
48     description
49       "Version 7.0.0";
50   }
51   revision 2019-11-29 {
52     description
53       "Version 6.1.0";
54   }
55   revision 2019-09-27 {
56     description
57       "Version 6.0.0";
58   }
59   revision 2019-05-31 {
60     description
61       "Version 5.1.0";
62   }
63   revision 2018-11-30 {
64     description
65       "Version 4.1.0";
66   }
67   revision 2018-09-28 {
68     description
69       "Version 4.0.0";
70   }
71   revision 2018-03-30 {
72     description
73       "Version 3.0.0";
74   }
75   revision 2017-12-15 {
76     description
77       "Version 2.2";
78   }
79   revision 2017-09-29 {
80     description
81       "Version 2.1";
82   }
83   revision 2017-07-28 {
84     description
85       "Version 2.0.1 - added revision-date to imports";
86   }
87   revision 2017-06-26 {
88     description
89       "Version 2.0";
90   }
91   revision 2016-10-14 {
92     description
93       "Version 1.2";
94   }
95
96   typedef probable-cause-enum {
97     type enumeration {
98       enum vendorExtension {
99         value 1;
100         description
101           "vendorExtension";
102       }
103       enum openConnectionIndication {
104         value 2;
105         description
106           "Open connection indication (OCI)";
107         reference
108           "G.798";
109       }
110       enum alarmIndicationSignal {
111         value 3;
112         description
113           "Alarm indication signal";
114         reference
115           "G.798";
116       }
117       enum lossOfSignal {
118         value 4;
119         description
120           "Loss of Signal";
121       }
122       enum opticalLineFail {
123         value 5;
124         description
125           "Optical Line Fail";
126       }
127       enum opticalPowerDegraded {
128         value 6;
129         description
130           "Optical Power Degraded";
131       }
132       enum automaticLaserShutdown {
133         value 7;
134         description
135           "Automatic Laser Shutdown";
136       }
137       enum serverSignalFail {
138         value 8;
139         description
140           "Server Signal Fail (SSF)";
141         reference
142           "G.798";
143       }
144       enum lockedDefect {
145         value 10;
146         description
147           "Locked defect (LCK)";
148         reference
149           "G.798";
150       }
151       enum trailTraceIdentifierMismatch {
152         value 11;
153         description
154           "Trail trace Identifier Mismatch (TIM)";
155         reference
156           "G.798";
157       }
158       enum degradedDefect {
159         value 12;
160         description
161           "Degraded defect (DEG)";
162         reference
163           "G.798";
164       }
165       enum backwardsDefectIndication {
166         value 13;
167         description
168           "Backward Defect Indication (BDI)";
169         reference
170           "G.798";
171       }
172       enum otsSpanlossPowerOutOfSpecificationHigh {
173         value 14;
174       }
175       enum automaticShutoffDisabled {
176         value 15;
177       }
178       enum portLossOfLight {
179         value 17;
180       }
181       enum reflectionTooHigh {
182         value 18;
183       }
184       enum payloadMissingIndication {
185         value 22;
186         description
187           "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
188       }
189       enum forwardDefectIndication {
190         value 23;
191         description
192           "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
193       }
194       enum oscPowerOutOfSpecificationHigh {
195         value 24;
196       }
197       enum oscPowerOutOfSpecificationLow {
198         value 25;
199       }
200       enum powerOutOfSpecificationHigh {
201         value 26;
202       }
203       enum lossOfSynchronization {
204         value 27;
205       }
206       enum linkDown {
207         value 28;
208       }
209       enum equipmentFault {
210         value 29;
211       }
212       enum equipmentRemoved {
213         value 30;
214       }
215       enum equipmentMismatch {
216         value 31;
217       }
218       enum equipmentWarmup {
219         value 32;
220       }
221       enum equipmentLedOn {
222         value 33;
223       }
224       enum equipmentInterConnectFailure {
225         value 34;
226       }
227       enum equipmentMiscabledConnection {
228         value 35;
229       }
230       enum softwareVersionMismatch {
231         value 36;
232       }
233       enum softwareStageInProgress {
234         value 37;
235       }
236       enum databaseCorruption {
237         value 38;
238       }
239       enum databaseVersionMismatch {
240         value 44;
241       }
242       enum firmwareVersionMismatch {
243         value 46;
244       }
245       enum incompatibleFirmware {
246         value 49;
247       }
248       enum firmwareDownloadOrActivationFailure {
249         value 50;
250       }
251       enum firmwareInitInProgress {
252         value 51;
253       }
254       enum softwareReset {
255         value 52;
256       }
257       enum fanCoolingFail {
258         value 53;
259       }
260       enum administrativeDown {
261         value 54;
262       }
263       enum lampTest {
264         value 55;
265       }
266       enum powerProblemA {
267         value 56;
268       }
269       enum powerProblemB {
270         value 57;
271       }
272       enum shelfProvisioningMode {
273         value 58;
274       }
275       enum sysNameChanged {
276         value 59;
277       }
278       enum sysNtpNotSynchronized {
279         value 60;
280       }
281       enum lossOfFrame {
282         value 63;
283       }
284       enum lossOfMultiframe {
285         value 64;
286       }
287       enum backwardIncomingAlignmentError {
288         value 65;
289       }
290       enum incomingAlignmentError {
291         value 66;
292       }
293       enum payloadMismatch {
294         value 67;
295       }
296       enum clientSignalFailDefect {
297         value 68;
298       }
299       enum highBER {
300         value 123;
301       }
302       enum localFault {
303         value 124;
304       }
305       enum remoteFault {
306         value 125;
307       }
308       enum lossOfAlignment {
309         value 126;
310       }
311       enum lossOfFECAlignment {
312         value 127;
313       }
314       enum facilityLoopbackActive {
315         value 128;
316       }
317       enum facilityLoopback2Active {
318         value 129;
319       }
320       enum terminalLoopbackActive {
321         value 130;
322       }
323       enum facilityTestsignalActive {
324         value 131;
325       }
326       enum terminalTestsignalActive {
327         value 132;
328       }
329       enum certificateNotInstalled {
330         value 134;
331       }
332       enum lockoutOfProtection {
333         value 135;
334       }
335       enum forcedSwitchAwayFromWorking {
336         value 136;
337       }
338       enum forcedSwitchAwayFromProtect {
339         value 137;
340       }
341       enum automaticSwitchAwayFromWorkingDueToSF {
342         value 138;
343       }
344       enum automaticSwitchAwayFromProtectDueToSF {
345         value 139;
346       }
347       enum automaticSwitchDueToWTR {
348         value 140;
349       }
350       enum manualSwitchAwayFromWork {
351         value 141;
352       }
353       enum manualSwitchAwayFromProtect {
354         value 142;
355       }
356       enum automaticPowerReduction {
357         value 143;
358       }
359       enum lossOfSignalOSC {
360         value 144;
361       }
362       enum softwareValidateInProgress {
363         value 145;
364       }
365       enum databaseRollbackTimerInProgress {
366         value 146;
367       }
368       enum otdrScanInProgress {
369         value 147;
370       }
371       enum lldpFail {
372         value 148;
373       }
374       enum omsPowerOutOfSpecificationHigh {
375         value 149;
376       }
377       enum omsPowerOutOfSpecificationLow {
378         value 150;
379       }
380       enum automaticSwitchAwayFromWorkingDueToSD {
381         value 151;
382       }
383       enum automaticSwitchAwayFromProtectDueToSD {
384         value 152;
385       }
386       enum backwardIncomingAlignmentErrorTCM1-up {
387         value 153;
388       }
389       enum backwardIncomingAlignmentErrorTCM2-up {
390         value 154;
391       }
392       enum backwardIncomingAlignmentErrorTCM3-up {
393         value 155;
394       }
395       enum backwardIncomingAlignmentErrorTCM4-up {
396         value 156;
397       }
398       enum backwardIncomingAlignmentErrorTCM5-up {
399         value 157;
400       }
401       enum backwardIncomingAlignmentErrorTCM6-up {
402         value 158;
403       }
404       enum incomingAlignmentErrorTCM1-up {
405         value 159;
406       }
407       enum incomingAlignmentErrorTCM2-up {
408         value 160;
409       }
410       enum incomingAlignmentErrorTCM3-up {
411         value 161;
412       }
413       enum incomingAlignmentErrorTCM4-up {
414         value 162;
415       }
416       enum incomingAlignmentErrorTCM5-up {
417         value 163;
418       }
419       enum incomingAlignmentErrorTCM6-up {
420         value 164;
421       }
422       enum backwardsDefectIndicationTCM1-up {
423         value 165;
424       }
425       enum backwardsDefectIndicationTCM2-up {
426         value 166;
427       }
428       enum backwardsDefectIndicationTCM3-up {
429         value 167;
430       }
431       enum backwardsDefectIndicationTCM4-up {
432         value 168;
433       }
434       enum backwardsDefectIndicationTCM5-up {
435         value 169;
436       }
437       enum backwardsDefectIndicationTCM6-up {
438         value 170;
439       }
440       enum degradedDefectTCM1-up {
441         value 171;
442       }
443       enum degradedDefectTCM2-up {
444         value 172;
445       }
446       enum degradedDefectTCM3-up {
447         value 173;
448       }
449       enum degradedDefectTCM4-up {
450         value 174;
451       }
452       enum degradedDefectTCM5-up {
453         value 175;
454       }
455       enum degradedDefectTCM6-up {
456         value 176;
457       }
458       enum trailTraceIdentifierMisMatchTCM1-up {
459         value 177;
460       }
461       enum trailTraceIdentifierMisMatchTCM2-up {
462         value 178;
463       }
464       enum trailTraceIdentifierMisMatchTCM3-up {
465         value 179;
466       }
467       enum trailTraceIdentifierMisMatchTCM4-up {
468         value 180;
469       }
470       enum trailTraceIdentifierMisMatchTCM5-up {
471         value 181;
472       }
473       enum trailTraceIdentifierMisMatchTCM6-up {
474         value 182;
475       }
476       enum alarmIndicationSignalTCM1-up {
477         value 183;
478       }
479       enum alarmIndicationSignalTCM2-up {
480         value 184;
481       }
482       enum alarmIndicationSignalTCM3-up {
483         value 185;
484       }
485       enum alarmIndicationSignalTCM4-up {
486         value 186;
487       }
488       enum alarmIndicationSignalTCM5-up {
489         value 187;
490       }
491       enum alarmIndicationSignalTCM6-up {
492         value 188;
493       }
494       enum openConnectionIndicationTCM1-up {
495         value 189;
496       }
497       enum openConnectionIndicationTCM2-up {
498         value 190;
499       }
500       enum openConnectionIndicationTCM3-up {
501         value 191;
502       }
503       enum openConnectionIndicationTCM4-up {
504         value 192;
505       }
506       enum openConnectionIndicationTCM5-up {
507         value 193;
508       }
509       enum openConnectionIndicationTCM6-up {
510         value 194;
511       }
512       enum lockedDefectTCM1-up {
513         value 195;
514       }
515       enum lockedDefectTCM2-up {
516         value 196;
517       }
518       enum lockedDefectTCM3-up {
519         value 197;
520       }
521       enum lockedDefectTCM4-up {
522         value 198;
523       }
524       enum lockedDefectTCM5-up {
525         value 199;
526       }
527       enum lockedDefectTCM6-up {
528         value 200;
529       }
530       enum lossofTandemConnectionTCM1-up {
531         value 201;
532       }
533       enum lossofTandemConnectionTCM2-up {
534         value 202;
535       }
536       enum lossofTandemConnectionTCM3-up {
537         value 203;
538       }
539       enum lossofTandemConnectionTCM4-up {
540         value 204;
541       }
542       enum lossofTandemConnectionTCM5-up {
543         value 205;
544       }
545       enum lossofTandemConnectionTCM6-up {
546         value 206;
547       }
548       enum backwardIncomingAlignmentErrorTCM1-down {
549         value 207;
550       }
551       enum backwardIncomingAlignmentErrorTCM2-down {
552         value 208;
553       }
554       enum backwardIncomingAlignmentErrorTCM3-down {
555         value 209;
556       }
557       enum backwardIncomingAlignmentErrorTCM4-down {
558         value 210;
559       }
560       enum backwardIncomingAlignmentErrorTCM5-down {
561         value 211;
562       }
563       enum backwardIncomingAlignmentErrorTCM6-down {
564         value 212;
565       }
566       enum incomingAlignmentErrorTCM1-down {
567         value 213;
568       }
569       enum incomingAlignmentErrorTCM2-down {
570         value 214;
571       }
572       enum incomingAlignmentErrorTCM3-down {
573         value 215;
574       }
575       enum incomingAlignmentErrorTCM4-down {
576         value 216;
577       }
578       enum incomingAlignmentErrorTCM5-down {
579         value 217;
580       }
581       enum incomingAlignmentErrorTCM6-down {
582         value 218;
583       }
584       enum backwardsDefectIndicationTCM1-down {
585         value 219;
586       }
587       enum backwardsDefectIndicationTCM2-down {
588         value 220;
589       }
590       enum backwardsDefectIndicationTCM3-down {
591         value 221;
592       }
593       enum backwardsDefectIndicationTCM4-down {
594         value 222;
595       }
596       enum backwardsDefectIndicationTCM5-down {
597         value 223;
598       }
599       enum backwardsDefectIndicationTCM6-down {
600         value 224;
601       }
602       enum degradedDefectTCM1-down {
603         value 225;
604       }
605       enum degradedDefectTCM2-down {
606         value 226;
607       }
608       enum degradedDefectTCM3-down {
609         value 227;
610       }
611       enum degradedDefectTCM4-down {
612         value 228;
613       }
614       enum degradedDefectTCM5-down {
615         value 229;
616       }
617       enum degradedDefectTCM6-down {
618         value 230;
619       }
620       enum trailTraceIdentifierMisMatchTCM1-down {
621         value 231;
622       }
623       enum trailTraceIdentifierMisMatchTCM2-down {
624         value 232;
625       }
626       enum trailTraceIdentifierMisMatchTCM3-down {
627         value 233;
628       }
629       enum trailTraceIdentifierMisMatchTCM4-down {
630         value 234;
631       }
632       enum trailTraceIdentifierMisMatchTCM5-down {
633         value 235;
634       }
635       enum trailTraceIdentifierMisMatchTCM6-down {
636         value 236;
637       }
638       enum alarmIndicationSignalTCM1-down {
639         value 237;
640       }
641       enum alarmIndicationSignalTCM2-down {
642         value 238;
643       }
644       enum alarmIndicationSignalTCM3-down {
645         value 239;
646       }
647       enum alarmIndicationSignalTCM4-down {
648         value 240;
649       }
650       enum alarmIndicationSignalTCM5-down {
651         value 241;
652       }
653       enum alarmIndicationSignalTCM6-down {
654         value 242;
655       }
656       enum openConnectionIndicationTCM1-down {
657         value 243;
658       }
659       enum openConnectionIndicationTCM2-down {
660         value 244;
661       }
662       enum openConnectionIndicationTCM3-down {
663         value 245;
664       }
665       enum openConnectionIndicationTCM4-down {
666         value 246;
667       }
668       enum openConnectionIndicationTCM5-down {
669         value 247;
670       }
671       enum openConnectionIndicationTCM6-down {
672         value 248;
673       }
674       enum lockedDefectTCM1-down {
675         value 249;
676       }
677       enum lockedDefectTCM2-down {
678         value 250;
679       }
680       enum lockedDefectTCM3-down {
681         value 251;
682       }
683       enum lockedDefectTCM4-down {
684         value 252;
685       }
686       enum lockedDefectTCM5-down {
687         value 253;
688       }
689       enum lockedDefectTCM6-down {
690         value 254;
691       }
692       enum lossofTandemConnectionTCM1-down {
693         value 255;
694       }
695       enum lossofTandemConnectionTCM2-down {
696         value 256;
697       }
698       enum lossofTandemConnectionTCM3-down {
699         value 257;
700       }
701       enum lossofTandemConnectionTCM4-down {
702         value 258;
703       }
704       enum lossofTandemConnectionTCM5-down {
705         value 259;
706       }
707       enum lossofTandemConnectionTCM6-down {
708         value 260;
709       }
710       enum multiplexStructureIdentifierMismatch {
711         value 261;
712         description
713           "G798 : 6.2.9 (dMSIM)";
714       }
715       enum lossOfOmfIndication {
716         value 262;
717         description
718           "G798 : 14.3.10.2 Figure 14-73 (dLOOMFI)";
719       }
720       enum lossOfFrameAndLossOfMultiframe {
721         value 263;
722         description
723           "G798 : 6.2.5.3 (dLOFLOM)";
724       }
725       enum lossOfDatabaseRedundancy {
726         value 264;
727         description
728           "loss of database redundancy";
729       }
730       enum databaseLocked {
731         value 265;
732         description
733           "Database locked";
734       }
735       enum createTechInfoInProgress {
736         value 266;
737         description
738           "create-tech-info in progress";
739       }
740       enum circuitPackActivateFailed {
741         value 267;
742         description
743           "circuit-pack activation failed";
744       }
745       enum softwareSubsystemFailed {
746         value 268;
747         description
748           "Software subsystem failed";
749       }
750       enum diskFull {
751         value 269;
752         description
753           "Disk full";
754       }
755       enum lossOfSignalPayload {
756         value 270;
757         description
758           "Loss Of Signal Payload";
759         reference
760           "G.798 6.2.1.2 dLOS-P, 16.8.2 OTSi/FlexO_A_Sk";
761       }
762       enum lossOfLaneAlignment {
763         value 271;
764         description
765           "Loss Of Lane Alignment";
766         reference
767           "G.798 15.3.1.2 FlexO-n/OTUCn_A_Sk that dLOL if the alignment process is in OLA state;
768            16.7.2 (OTSi/FlexO-1-SC_A_Sk) (G.709.3) & 16.8.2 (OTSiG/FlexO_A_Sk) (G.709.1)
769            that dLOL based on the FEC alignment state diagram";
770       }
771       enum groupIdMismatch {
772         value 272;
773         description
774           "Group Id Mismatch";
775         reference
776           "G.798 dGIDM in Annex B.1.1.2.1; G.798 15.3.1.2 FlexO-n/OTUCn_A_Sk";
777       }
778       enum flexoMapMismatch {
779         value 273;
780         description
781           "FlexO Map Mismatch";
782         reference
783           "G.798 dFMM in Annex B.1.1.2.2; G.798 15.3.1.2 FlexO-n/OTUCn_A_Sk";
784       }
785       enum powerOutOfSpecificationLow {
786         value 274;
787       }
788       enum gfpLossOfFrameDelineation {
789         value 275;
790         description
791           "GFP loss of frame delineation (dLFD G.806:6.2.5.2) is raised when the frame delineation process (clause 6.3.1 of [ITU-T G.7041]) is not in the 'SYNC' state";
792       }
793       enum cmfLossOfSignal {
794         value 276;
795         description
796           "GFP client signal fail (dCSF G.806:6.2.6.4.1) is raised when a GFP frame with correct tHEC, with aPTI = '100' and a valid UPI code 0x01(G.7041: Table 6-4) is received";
797       }
798       enum cmfLossOfSync {
799         value 277;
800         description
801           "GFP client signal fail (dCSF G.806:6.2.6.4.1) is raised when a GFP frame with correct tHEC, with aPTI = '100' and a valid UPI code 0x02(G.7041: Table 6-4) is received";
802       }
803       enum cmfForwardDefectIndication {
804         value 278;
805         description
806           "GFP client signal fail (dCSF G.806:6.2.6.4.1) is raised when a GFP frame with correct tHEC, with aPTI = '100' and a valid UPI code 0x04(G.7041: Table 6-4) is received";
807       }
808       enum cmfReverseDefectIndication {
809         value 279;
810         description
811           "GFP client signal fail (dCSF G.806:6.2.6.4.1) is raised when a GFP frame with correct tHEC, with aPTI = '100' and a valid UPI code 0x05(G.7041: Table 6-4) is received";
812       }
813       enum localDegradedSER {
814         value 280;
815         description
816           "Local Degraded SER";
817         reference
818           "IEEE 802.3-2018  Section 45.2.3.60.1,  IEEE 802.3-2018  Section 119";
819       }
820       enum remoteDegradedSER {
821         value 281;
822         description
823           "Remote Degraded SER";
824         reference
825           "IEEE 802.3-2018  Section 45.2.3.60.2,  IEEE 802.3-2018  Section 119";
826       }
827       enum fecDegradedSER {
828         value 282;
829         description
830           "PCS FEC Degrade SER";
831         reference
832           "IEEE 802.3-2018  Section 119";
833       }
834       enum farEndFaultIndication {
835         value 283;
836         description
837           "Far End Fault Indication";
838         reference
839           "IEEE 802.3-2018 Section 24.3.2.1";
840       }
841     }
842     description
843       "probable cause group";
844   }
845
846   grouping probable-cause {
847     leaf cause {
848       type probable-cause-enum;
849       mandatory true;
850     }
851     leaf extension {
852       type string;
853       mandatory false;
854     }
855     leaf direction {
856       type org-openroadm-common-alarm-pm-types:direction;
857       mandatory true;
858       description
859         "Direction indication of the alarm.";
860     }
861     leaf location {
862       type org-openroadm-common-alarm-pm-types:location;
863       mandatory true;
864       description
865         "location indication of the alarm.";
866     }
867     leaf type {
868       type enumeration {
869         enum communication {
870           value 1;
871         }
872         enum qualityOfService {
873           value 2;
874         }
875         enum processingError {
876           value 3;
877         }
878         enum equipment {
879           value 4;
880         }
881         enum environmental {
882           value 5;
883         }
884       }
885       mandatory false;
886       description
887         "Type of alarm. Based on X.733 event Type.";
888     }
889   }
890 }