1 module org-openroadm-probable-cause {
2 namespace "http://org/openroadm/probableCause";
3 prefix org-openroadm-probable-cause;
5 import org-openroadm-common-types {
6 prefix org-openroadm-common-types;
7 revision-date 2017-12-15;
15 "YANG definitions of Probable Causes.
17 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
18 AT&T Intellectual Property. 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";
53 "Version 2.0.1 - added revision-date to imports";
64 typedef probable-cause-enum {
66 enum "vendorExtension" {
71 enum "openConnectionIndication" {
74 "Open connection indication (OCI)";
77 enum "alarmIndicationSignal" {
80 "Alarm indication signal";
88 enum "opticalLineFail" {
93 enum "opticalPowerDegraded" {
98 enum "automaticLaserShutdown" {
103 enum "serverSignalFail" {
106 "Server Signal Fail (SSF)";
109 enum "lockedDefect" {
112 "Locked defect (LCK)";
115 enum "trailTraceIdentifierMismatch" {
118 "Trail trace Identifier Mismatch (TIM)";
121 enum "degradedDefect" {
124 "Degraded defect (DEG)";
127 enum "backwardsDefectIndication" {
130 "Backward Defect Indication (BDI)";
133 enum "otsSpanlossPowerOutOfSpecificationHigh" {
136 enum "automaticShutoffDisabled" {
139 enum "portLossOfLight" {
142 enum "reflectionTooHigh" {
145 enum "payloadMissingIndication" {
148 "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
150 enum "forwardDefectIndication" {
153 "Will be applicable to ROADM when OSC signaling supported in future (G.709 2016-06 Figure 15-1A, 1B)";
155 enum "oscPowerOutOfSpecificationHigh" {
158 enum "oscPowerOutOfSpecificationLow" {
161 enum "powerOutOfSpecificationHigh" {
164 enum "lossOfSynchronization" {
170 enum "equipmentFault" {
173 enum "equipmentRemoved" {
176 enum "equipmentMismatch" {
179 enum "equipmentWarmup" {
182 enum "equipmentLedOn" {
185 enum "equipmentInterConnectFailure" {
188 enum "equipmentMiscabledConnection" {
191 enum "softwareVersionMismatch" {
194 enum "softwareStageInProgress" {
197 enum "databaseCorruption" {
200 enum "databaseVersionMismatch" {
203 enum "firmwareVersionMismatch" {
206 enum "incompatibleFirmware" {
209 enum "firmwareDownloadOrActivationFailure" {
212 enum "firmwareInitInProgress" {
215 enum "softwareReset" {
218 enum "fanCoolingFail" {
221 enum "administrativeDown" {
227 enum "powerProblemA" {
230 enum "powerProblemB" {
233 enum "shelfProvisioningMode" {
236 enum "sysNameChanged" {
239 enum "sysNtpNotSynchronized" {
245 enum "lossOfMultiframe" {
248 enum "backwardIncomingAlignmentError" {
251 enum "incomingAlignmentError" {
254 enum "payloadMismatch" {
257 enum "clientSignalFailDefect" {
269 enum "lossOfAlignment" {
272 enum "lossOfFECAlignment" {
275 enum "facilityLoopbackActive" {
278 enum "facilityLoopback2Active" {
281 enum "terminalLoopbackActive" {
284 enum "facilityTestsignalActive" {
287 enum "terminalTestsignalActive" {
290 enum "certificateNotInstalled" {
293 enum "lockoutOfProtection" {
296 enum "forcedSwitchAwayFromWorking" {
299 enum "forcedSwitchAwayFromProtect" {
302 enum "automaticSwitchAwayFromWorkingDueToSF" {
305 enum "automaticSwitchAwayFromProtectDueToSF" {
308 enum "automaticSwitchDueToWTR" {
311 enum "manualSwitchAwayFromWork" {
314 enum "manualSwitchAwayFromProtect" {
317 enum "automaticPowerReduction" {
320 enum "lossOfSignalOSC" {
323 enum "softwareValidateInProgress" {
326 enum "databaseRollbackTimerInProgress" {
329 enum "otdrScanInProgress" {
335 enum "omsPowerOutOfSpecificationHigh" {
338 enum "omsPowerOutOfSpecificationLow" {
341 enum "automaticSwitchAwayFromWorkingDueToSD" {
344 enum "automaticSwitchAwayFromProtectDueToSD" {
347 enum "backwardIncomingAlignmentErrorTCM1-up" {
350 enum "backwardIncomingAlignmentErrorTCM2-up" {
353 enum "backwardIncomingAlignmentErrorTCM3-up" {
356 enum "backwardIncomingAlignmentErrorTCM4-up" {
359 enum "backwardIncomingAlignmentErrorTCM5-up" {
362 enum "backwardIncomingAlignmentErrorTCM6-up" {
365 enum "incomingAlignmentErrorTCM1-up" {
368 enum "incomingAlignmentErrorTCM2-up" {
371 enum "incomingAlignmentErrorTCM3-up" {
374 enum "incomingAlignmentErrorTCM4-up" {
377 enum "incomingAlignmentErrorTCM5-up" {
380 enum "incomingAlignmentErrorTCM6-up" {
383 enum "backwardsDefectIndicationTCM1-up" {
386 enum "backwardsDefectIndicationTCM2-up" {
389 enum "backwardsDefectIndicationTCM3-up" {
392 enum "backwardsDefectIndicationTCM4-up" {
395 enum "backwardsDefectIndicationTCM5-up" {
398 enum "backwardsDefectIndicationTCM6-up" {
401 enum "degradedDefectTCM1-up" {
404 enum "degradedDefectTCM2-up" {
407 enum "degradedDefectTCM3-up" {
410 enum "degradedDefectTCM4-up" {
413 enum "degradedDefectTCM5-up" {
416 enum "degradedDefectTCM6-up" {
419 enum "trailTraceIdentifierMisMatchTCM1-up" {
422 enum "trailTraceIdentifierMisMatchTCM2-up" {
425 enum "trailTraceIdentifierMisMatchTCM3-up" {
428 enum "trailTraceIdentifierMisMatchTCM4-up" {
431 enum "trailTraceIdentifierMisMatchTCM5-up" {
434 enum "trailTraceIdentifierMisMatchTCM6-up" {
437 enum "alarmIndicationSignalTCM1-up" {
440 enum "alarmIndicationSignalTCM2-up" {
443 enum "alarmIndicationSignalTCM3-up" {
446 enum "alarmIndicationSignalTCM4-up" {
449 enum "alarmIndicationSignalTCM5-up" {
452 enum "alarmIndicationSignalTCM6-up" {
455 enum "openConnectionIndicationTCM1-up" {
458 enum "openConnectionIndicationTCM2-up" {
461 enum "openConnectionIndicationTCM3-up" {
464 enum "openConnectionIndicationTCM4-up" {
467 enum "openConnectionIndicationTCM5-up" {
470 enum "openConnectionIndicationTCM6-up" {
473 enum "lockedDefectTCM1-up" {
476 enum "lockedDefectTCM2-up" {
479 enum "lockedDefectTCM3-up" {
482 enum "lockedDefectTCM4-up" {
485 enum "lockedDefectTCM5-up" {
488 enum "lockedDefectTCM6-up" {
491 enum "lossofTandemConnectionTCM1-up" {
494 enum "lossofTandemConnectionTCM2-up" {
497 enum "lossofTandemConnectionTCM3-up" {
500 enum "lossofTandemConnectionTCM4-up" {
503 enum "lossofTandemConnectionTCM5-up" {
506 enum "lossofTandemConnectionTCM6-up" {
509 enum "backwardIncomingAlignmentErrorTCM1-down" {
512 enum "backwardIncomingAlignmentErrorTCM2-down" {
515 enum "backwardIncomingAlignmentErrorTCM3-down" {
518 enum "backwardIncomingAlignmentErrorTCM4-down" {
521 enum "backwardIncomingAlignmentErrorTCM5-down" {
524 enum "backwardIncomingAlignmentErrorTCM6-down" {
527 enum "incomingAlignmentErrorTCM1-down" {
530 enum "incomingAlignmentErrorTCM2-down" {
533 enum "incomingAlignmentErrorTCM3-down" {
536 enum "incomingAlignmentErrorTCM4-down" {
539 enum "incomingAlignmentErrorTCM5-down" {
542 enum "incomingAlignmentErrorTCM6-down" {
545 enum "backwardsDefectIndicationTCM1-down" {
548 enum "backwardsDefectIndicationTCM2-down" {
551 enum "backwardsDefectIndicationTCM3-down" {
554 enum "backwardsDefectIndicationTCM4-down" {
557 enum "backwardsDefectIndicationTCM5-down" {
560 enum "backwardsDefectIndicationTCM6-down" {
563 enum "degradedDefectTCM1-down" {
566 enum "degradedDefectTCM2-down" {
569 enum "degradedDefectTCM3-down" {
572 enum "degradedDefectTCM4-down" {
575 enum "degradedDefectTCM5-down" {
578 enum "degradedDefectTCM6-down" {
581 enum "trailTraceIdentifierMisMatchTCM1-down" {
584 enum "trailTraceIdentifierMisMatchTCM2-down" {
587 enum "trailTraceIdentifierMisMatchTCM3-down" {
590 enum "trailTraceIdentifierMisMatchTCM4-down" {
593 enum "trailTraceIdentifierMisMatchTCM5-down" {
596 enum "trailTraceIdentifierMisMatchTCM6-down" {
599 enum "alarmIndicationSignalTCM1-down" {
602 enum "alarmIndicationSignalTCM2-down" {
605 enum "alarmIndicationSignalTCM3-down" {
608 enum "alarmIndicationSignalTCM4-down" {
611 enum "alarmIndicationSignalTCM5-down" {
614 enum "alarmIndicationSignalTCM6-down" {
617 enum "openConnectionIndicationTCM1-down" {
620 enum "openConnectionIndicationTCM2-down" {
623 enum "openConnectionIndicationTCM3-down" {
626 enum "openConnectionIndicationTCM4-down" {
629 enum "openConnectionIndicationTCM5-down" {
632 enum "openConnectionIndicationTCM6-down" {
635 enum "lockedDefectTCM1-down" {
638 enum "lockedDefectTCM2-down" {
641 enum "lockedDefectTCM3-down" {
644 enum "lockedDefectTCM4-down" {
647 enum "lockedDefectTCM5-down" {
650 enum "lockedDefectTCM6-down" {
653 enum "lossofTandemConnectionTCM1-down" {
656 enum "lossofTandemConnectionTCM2-down" {
659 enum "lossofTandemConnectionTCM3-down" {
662 enum "lossofTandemConnectionTCM4-down" {
665 enum "lossofTandemConnectionTCM5-down" {
668 enum "lossofTandemConnectionTCM6-down" {
671 enum "multiplexStructureIdentifierMismatch" {
674 "G798 : 6.2.9 (dMSIM)";
676 enum "lossOfOmfIndication" {
679 "G798 : 14.3.10.2 Figure 14-73 (dLOOMFI)";
681 enum "lossOfFrameAndLossOfMultiframe" {
684 "G798 : 6.2.5.3 (dLOFLOM)";
686 enum "lossOfDatabaseRedundancy" {
689 "loss of database redundancy";
691 enum "databaseLocked" {
696 enum "createTechInfoInProgress" {
699 "create-tech-info in progress";
701 enum "circuitPackActivateFailed" {
704 "circuit-pack activation failed";
706 enum "softwareSubsystemFailed" {
709 "Software subsystem failed";
719 grouping probable-cause {
721 type probable-cause-enum;
729 type org-openroadm-common-types:direction;
732 "Direction indication of the alarm.";
735 type org-openroadm-common-types:location;
738 "location indication of the alarm.";
742 enum "communication" {
745 enum "qualityOfService" {
748 enum "processingError" {
754 enum "environmental" {
760 "Type of alarm. Based on X.733 event Type.";