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