1 module org-openroadm-probable-cause {
2 namespace "http://org/openroadm/probableCause";
3 prefix org-openroadm-probable-cause;
5 import org-openroadm-common-alarm-pm-types {
6 prefix org-openroadm-common-alarm-pm-types;
7 revision-date 2019-11-29;
15 "YANG definitions of Probable Causes.
17 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
18 All other rights reserved.
20 Redistribution and use in source and binary forms, with or without modification,
21 are permitted provided that the following conditions are met:
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.
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";
85 "Version 2.0.1 - added revision-date to imports";
96 typedef probable-cause-enum {
98 enum vendorExtension {
103 enum openConnectionIndication {
106 "Open connection indication (OCI)";
110 enum alarmIndicationSignal {
113 "Alarm indication signal";
122 enum opticalLineFail {
127 enum opticalPowerDegraded {
130 "Optical Power Degraded";
132 enum automaticLaserShutdown {
135 "Automatic Laser Shutdown";
137 enum serverSignalFail {
140 "Server Signal Fail (SSF)";
147 "Locked defect (LCK)";
151 enum trailTraceIdentifierMismatch {
154 "Trail trace Identifier Mismatch (TIM)";
158 enum degradedDefect {
161 "Degraded defect (DEG)";
165 enum backwardsDefectIndication {
168 "Backward Defect Indication (BDI)";
172 enum otsSpanlossPowerOutOfSpecificationHigh {
175 enum automaticShutoffDisabled {
178 enum portLossOfLight {
181 enum reflectionTooHigh {
184 enum payloadMissingIndication {
187 "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
189 enum forwardDefectIndication {
192 "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
194 enum oscPowerOutOfSpecificationHigh {
197 enum oscPowerOutOfSpecificationLow {
200 enum powerOutOfSpecificationHigh {
203 enum lossOfSynchronization {
209 enum equipmentFault {
212 enum equipmentRemoved {
215 enum equipmentMismatch {
218 enum equipmentWarmup {
221 enum equipmentLedOn {
224 enum equipmentInterConnectFailure {
227 enum equipmentMiscabledConnection {
230 enum softwareVersionMismatch {
233 enum softwareStageInProgress {
236 enum databaseCorruption {
239 enum databaseVersionMismatch {
242 enum firmwareVersionMismatch {
245 enum incompatibleFirmware {
248 enum firmwareDownloadOrActivationFailure {
251 enum firmwareInitInProgress {
257 enum fanCoolingFail {
260 enum administrativeDown {
272 enum shelfProvisioningMode {
275 enum sysNameChanged {
278 enum sysNtpNotSynchronized {
284 enum lossOfMultiframe {
287 enum backwardIncomingAlignmentError {
290 enum incomingAlignmentError {
293 enum payloadMismatch {
296 enum clientSignalFailDefect {
308 enum lossOfAlignment {
311 enum lossOfFECAlignment {
314 enum facilityLoopbackActive {
317 enum facilityLoopback2Active {
320 enum terminalLoopbackActive {
323 enum facilityTestsignalActive {
326 enum terminalTestsignalActive {
329 enum certificateNotInstalled {
332 enum lockoutOfProtection {
335 enum forcedSwitchAwayFromWorking {
338 enum forcedSwitchAwayFromProtect {
341 enum automaticSwitchAwayFromWorkingDueToSF {
344 enum automaticSwitchAwayFromProtectDueToSF {
347 enum automaticSwitchDueToWTR {
350 enum manualSwitchAwayFromWork {
353 enum manualSwitchAwayFromProtect {
356 enum automaticPowerReduction {
359 enum lossOfSignalOSC {
362 enum softwareValidateInProgress {
365 enum databaseRollbackTimerInProgress {
368 enum otdrScanInProgress {
374 enum omsPowerOutOfSpecificationHigh {
377 enum omsPowerOutOfSpecificationLow {
380 enum automaticSwitchAwayFromWorkingDueToSD {
383 enum automaticSwitchAwayFromProtectDueToSD {
386 enum backwardIncomingAlignmentErrorTCM1-up {
389 enum backwardIncomingAlignmentErrorTCM2-up {
392 enum backwardIncomingAlignmentErrorTCM3-up {
395 enum backwardIncomingAlignmentErrorTCM4-up {
398 enum backwardIncomingAlignmentErrorTCM5-up {
401 enum backwardIncomingAlignmentErrorTCM6-up {
404 enum incomingAlignmentErrorTCM1-up {
407 enum incomingAlignmentErrorTCM2-up {
410 enum incomingAlignmentErrorTCM3-up {
413 enum incomingAlignmentErrorTCM4-up {
416 enum incomingAlignmentErrorTCM5-up {
419 enum incomingAlignmentErrorTCM6-up {
422 enum backwardsDefectIndicationTCM1-up {
425 enum backwardsDefectIndicationTCM2-up {
428 enum backwardsDefectIndicationTCM3-up {
431 enum backwardsDefectIndicationTCM4-up {
434 enum backwardsDefectIndicationTCM5-up {
437 enum backwardsDefectIndicationTCM6-up {
440 enum degradedDefectTCM1-up {
443 enum degradedDefectTCM2-up {
446 enum degradedDefectTCM3-up {
449 enum degradedDefectTCM4-up {
452 enum degradedDefectTCM5-up {
455 enum degradedDefectTCM6-up {
458 enum trailTraceIdentifierMisMatchTCM1-up {
461 enum trailTraceIdentifierMisMatchTCM2-up {
464 enum trailTraceIdentifierMisMatchTCM3-up {
467 enum trailTraceIdentifierMisMatchTCM4-up {
470 enum trailTraceIdentifierMisMatchTCM5-up {
473 enum trailTraceIdentifierMisMatchTCM6-up {
476 enum alarmIndicationSignalTCM1-up {
479 enum alarmIndicationSignalTCM2-up {
482 enum alarmIndicationSignalTCM3-up {
485 enum alarmIndicationSignalTCM4-up {
488 enum alarmIndicationSignalTCM5-up {
491 enum alarmIndicationSignalTCM6-up {
494 enum openConnectionIndicationTCM1-up {
497 enum openConnectionIndicationTCM2-up {
500 enum openConnectionIndicationTCM3-up {
503 enum openConnectionIndicationTCM4-up {
506 enum openConnectionIndicationTCM5-up {
509 enum openConnectionIndicationTCM6-up {
512 enum lockedDefectTCM1-up {
515 enum lockedDefectTCM2-up {
518 enum lockedDefectTCM3-up {
521 enum lockedDefectTCM4-up {
524 enum lockedDefectTCM5-up {
527 enum lockedDefectTCM6-up {
530 enum lossofTandemConnectionTCM1-up {
533 enum lossofTandemConnectionTCM2-up {
536 enum lossofTandemConnectionTCM3-up {
539 enum lossofTandemConnectionTCM4-up {
542 enum lossofTandemConnectionTCM5-up {
545 enum lossofTandemConnectionTCM6-up {
548 enum backwardIncomingAlignmentErrorTCM1-down {
551 enum backwardIncomingAlignmentErrorTCM2-down {
554 enum backwardIncomingAlignmentErrorTCM3-down {
557 enum backwardIncomingAlignmentErrorTCM4-down {
560 enum backwardIncomingAlignmentErrorTCM5-down {
563 enum backwardIncomingAlignmentErrorTCM6-down {
566 enum incomingAlignmentErrorTCM1-down {
569 enum incomingAlignmentErrorTCM2-down {
572 enum incomingAlignmentErrorTCM3-down {
575 enum incomingAlignmentErrorTCM4-down {
578 enum incomingAlignmentErrorTCM5-down {
581 enum incomingAlignmentErrorTCM6-down {
584 enum backwardsDefectIndicationTCM1-down {
587 enum backwardsDefectIndicationTCM2-down {
590 enum backwardsDefectIndicationTCM3-down {
593 enum backwardsDefectIndicationTCM4-down {
596 enum backwardsDefectIndicationTCM5-down {
599 enum backwardsDefectIndicationTCM6-down {
602 enum degradedDefectTCM1-down {
605 enum degradedDefectTCM2-down {
608 enum degradedDefectTCM3-down {
611 enum degradedDefectTCM4-down {
614 enum degradedDefectTCM5-down {
617 enum degradedDefectTCM6-down {
620 enum trailTraceIdentifierMisMatchTCM1-down {
623 enum trailTraceIdentifierMisMatchTCM2-down {
626 enum trailTraceIdentifierMisMatchTCM3-down {
629 enum trailTraceIdentifierMisMatchTCM4-down {
632 enum trailTraceIdentifierMisMatchTCM5-down {
635 enum trailTraceIdentifierMisMatchTCM6-down {
638 enum alarmIndicationSignalTCM1-down {
641 enum alarmIndicationSignalTCM2-down {
644 enum alarmIndicationSignalTCM3-down {
647 enum alarmIndicationSignalTCM4-down {
650 enum alarmIndicationSignalTCM5-down {
653 enum alarmIndicationSignalTCM6-down {
656 enum openConnectionIndicationTCM1-down {
659 enum openConnectionIndicationTCM2-down {
662 enum openConnectionIndicationTCM3-down {
665 enum openConnectionIndicationTCM4-down {
668 enum openConnectionIndicationTCM5-down {
671 enum openConnectionIndicationTCM6-down {
674 enum lockedDefectTCM1-down {
677 enum lockedDefectTCM2-down {
680 enum lockedDefectTCM3-down {
683 enum lockedDefectTCM4-down {
686 enum lockedDefectTCM5-down {
689 enum lockedDefectTCM6-down {
692 enum lossofTandemConnectionTCM1-down {
695 enum lossofTandemConnectionTCM2-down {
698 enum lossofTandemConnectionTCM3-down {
701 enum lossofTandemConnectionTCM4-down {
704 enum lossofTandemConnectionTCM5-down {
707 enum lossofTandemConnectionTCM6-down {
710 enum multiplexStructureIdentifierMismatch {
713 "G798 : 6.2.9 (dMSIM)";
715 enum lossOfOmfIndication {
718 "G798 : 14.3.10.2 Figure 14-73 (dLOOMFI)";
720 enum lossOfFrameAndLossOfMultiframe {
723 "G798 : 6.2.5.3 (dLOFLOM)";
725 enum lossOfDatabaseRedundancy {
728 "loss of database redundancy";
730 enum databaseLocked {
735 enum createTechInfoInProgress {
738 "create-tech-info in progress";
740 enum circuitPackActivateFailed {
743 "circuit-pack activation failed";
745 enum softwareSubsystemFailed {
748 "Software subsystem failed";
755 enum lossOfSignalPayload {
758 "Loss Of Signal Payload";
760 "G.798 6.2.1.2 dLOS-P, 16.8.2 OTSi/FlexO_A_Sk";
762 enum lossOfLaneAlignment {
765 "Loss Of Lane Alignment";
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";
771 enum groupIdMismatch {
776 "G.798 dGIDM in Annex B.1.1.2.1; G.798 15.3.1.2 FlexO-n/OTUCn_A_Sk";
778 enum flexoMapMismatch {
781 "FlexO Map Mismatch";
783 "G.798 dFMM in Annex B.1.1.2.2; G.798 15.3.1.2 FlexO-n/OTUCn_A_Sk";
785 enum powerOutOfSpecificationLow {
788 enum gfpLossOfFrameDelineation {
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";
793 enum cmfLossOfSignal {
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";
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";
803 enum cmfForwardDefectIndication {
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";
808 enum cmfReverseDefectIndication {
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";
813 enum localDegradedSER {
816 "Local Degraded SER";
818 "IEEE 802.3-2018 Section 45.2.3.60.1, IEEE 802.3-2018 Section 119";
820 enum remoteDegradedSER {
823 "Remote Degraded SER";
825 "IEEE 802.3-2018 Section 45.2.3.60.2, IEEE 802.3-2018 Section 119";
827 enum fecDegradedSER {
830 "PCS FEC Degrade SER";
832 "IEEE 802.3-2018 Section 119";
834 enum farEndFaultIndication {
837 "Far End Fault Indication";
839 "IEEE 802.3-2018 Section 24.3.2.1";
843 "probable cause group";
846 grouping probable-cause {
848 type probable-cause-enum;
856 type org-openroadm-common-alarm-pm-types:direction;
859 "Direction indication of the alarm.";
862 type org-openroadm-common-alarm-pm-types:location;
865 "location indication of the alarm.";
872 enum qualityOfService {
875 enum processingError {
887 "Type of alarm. Based on X.733 event Type.";