tests/honeynode/2.2.1/honeynode-plugin-impl/src/main/resources/honeycomb-minimal-resources/config/yang/common/org-openroadm-pm-types@2017-12-15.yang

   1 module org-openroadm-pm-types {
   2   namespace "http://org/openroadm/pm-types";
   3   prefix org-openroadm-pm-types;
   4
   5   organization
   6     "Open ROADM MSA";
   7   contact
   8     "OpenROADM.org";
   9   description
  10     "YANG definitions of performance management types.
  11
  12       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  13       AT&T Intellectual Property.  All other rights reserved.
  14
  15       Redistribution and use in source and binary forms, with or without modification,
  16       are permitted provided that the following conditions are met:
  17
  18       * Redistributions of source code must retain the above copyright notice, this
  19         list of conditions and the following disclaimer.
  20       * Redistributions in binary form must reproduce the above copyright notice,
  21         this list of conditions and the following disclaimer in the documentation and/or
  22         other materials provided with the distribution.
  23       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  24         contributors may be used to endorse or promote products derived from this software
  25         without specific prior written permission.
  26
  27       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  28       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  29       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  30       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  31       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  32       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  33       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  34       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  36       POSSIBILITY OF SUCH DAMAGE";
  37
  38   revision 2017-12-15 {
  39     description
  40       "Version 2.2";
  41   }
  42   revision 2017-09-29 {
  43     description
  44       "Version 2.1";
  45   }
  46   revision 2017-06-26 {
  47     description
  48       "Version 2.0";
  49   }
  50   revision 2016-10-14 {
  51     description
  52       "Version 1.2";
  53   }
  54
  55   typedef pm-granularity {
  56     type enumeration {
  57       enum "notApplicable" {
  58         value 1;
  59         description
  60           "This is for total statistic counters on devices that support
  61               them.";
  62       }
  63       enum "15min" {
  64         value 2;
  65       }
  66       enum "24Hour" {
  67         value 3;
  68       }
  69     }
  70     description
  71       "Granularity of PM bin";
  72   }
  73
  74   typedef pm-data-type {
  75     type union {
  76       type uint64;
  77       type int64;
  78       type decimal64 {
  79         fraction-digits 2;
  80       }
  81       type decimal64 {
  82         fraction-digits 17;
  83       }
  84     }
  85   }
  86
  87   typedef validity {
  88     type enumeration {
  89       enum "complete" {
  90         value 1;
  91       }
  92       enum "partial" {
  93         value 2;
  94       }
  95       enum "suspect" {
  96         value 3;
  97       }
  98     }
  99     description
 100       "Validity of data";
 101   }
 102
 103   typedef pm-names-enum {
 104     type enumeration {
 105       enum "vendorExtension" {
 106         value 1;
 107         description
 108           "vendor extension";
 109       }
 110       enum "bitErrorRate" {
 111         value 2;
 112         description
 113           "Bit error rate (BER)";
 114       }
 115       enum "opticalPowerOutput" {
 116         value 3;
 117         description
 118           "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
 119       }
 120       enum "opticalReturnLoss" {
 121         value 4;
 122         description
 123           "Optical Return Loss (ORL-OTS) - at MW port(s) B";
 124       }
 125       enum "opticalPowerInput" {
 126         value 5;
 127         description
 128           "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
 129       }
 130       enum "codeViolations" {
 131         value 8;
 132         description
 133           "Code Violations (CV)";
 134       }
 135       enum "erroredSeconds" {
 136         value 9;
 137         description
 138           "Errored Seconds (ES)";
 139       }
 140       enum "severelyErroredSeconds" {
 141         value 10;
 142         description
 143           "Severely Errored Seconds (SES)";
 144       }
 145       enum "unavailableSeconds" {
 146         value 11;
 147         description
 148           "Unavailable Seconds (UAS)";
 149       }
 150       enum "inFrames" {
 151         value 12;
 152         description
 153           "In frames (INFRAMES-E)";
 154       }
 155       enum "inFramesErrored" {
 156         value 13;
 157         description
 158           "In frames errored (INFRAMESERR-E)";
 159       }
 160       enum "outFrames" {
 161         value 14;
 162         description
 163           "Out frames (OUTFRAMES-E)";
 164       }
 165       enum "erroredSecondsEthernet" {
 166         value 15;
 167         description
 168           "Errored Seconds Ethernet (ES-E)";
 169       }
 170       enum "severelyErroredSecondsEthernet" {
 171         value 16;
 172         description
 173           "Severly Errored Seconds, Ethernet (SES-E)";
 174       }
 175       enum "unavailableSecondsEthernet" {
 176         value 17;
 177         description
 178           "Unavailable Seconds, Ethernet (UAS-E)";
 179       }
 180       enum "erroredBlockCount" {
 181         value 18;
 182         description
 183           "Errored block count";
 184       }
 185       enum "delay" {
 186         value 19;
 187         description
 188           "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
 189       }
 190       enum "defectSeconds" {
 191         value 20;
 192         description
 193           "Defect Seconds (DS)";
 194       }
 195       enum "backwardIncomingAlignmentError" {
 196         value 21;
 197         description
 198           "Backward Incoming Alignment Error (BIAE)";
 199       }
 200       enum "incomingAlignmentError" {
 201         value 22;
 202         description
 203           "Incoming Alignment Error (IAE)";
 204       }
 205       enum "opticalPowerOutputMin" {
 206         value 23;
 207         description
 208           "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
 209       }
 210       enum "opticalPowerOutputMax" {
 211         value 24;
 212         description
 213           "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
 214       }
 215       enum "opticalPowerOutputAvg" {
 216         value 25;
 217         description
 218           "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
 219       }
 220       enum "opticalPowerInputMin" {
 221         value 26;
 222         description
 223           "Minimum Optical Power Input (OPIN-OTS). Total optical power";
 224       }
 225       enum "opticalPowerInputMax" {
 226         value 27;
 227         description
 228           "Maximum Optical Power Input (OPIN-OTS). Total optical power";
 229       }
 230       enum "opticalPowerInputAvg" {
 231         value 28;
 232         description
 233           "Average Optical Power Input (OPIN-OTS). Total optical power";
 234       }
 235       enum "opticalPowerOutputOSC" {
 236         value 29;
 237         description
 238           "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
 239       }
 240       enum "opticalPowerOutputOSCMin" {
 241         value 30;
 242         description
 243           "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
 244       }
 245       enum "opticalPowerOutputOSCMax" {
 246         value 31;
 247         description
 248           "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
 249       }
 250       enum "opticalPowerOutputOSCAvg" {
 251         value 32;
 252         description
 253           "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
 254       }
 255       enum "opticalPowerInputOSC" {
 256         value 33;
 257         description
 258           "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
 259       }
 260       enum "opticalPowerInputOSCMin" {
 261         value 34;
 262         description
 263           "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
 264       }
 265       enum "opticalPowerInputOSCMax" {
 266         value 35;
 267         description
 268           "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
 269       }
 270       enum "opticalPowerInputOSCAvg" {
 271         value 36;
 272         description
 273           "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
 274       }
 275       enum "preFECCorrectedErrors" {
 276         value 37;
 277         description
 278           "pFEC corrected Errors";
 279       }
 280       enum "totalOpticalPowerInput" {
 281         value 38;
 282         description
 283           "Total Optical Power Input.";
 284       }
 285       enum "totalOpticalPowerInputMin" {
 286         value 39;
 287         description
 288           "Minumun Total Optical Power Input.";
 289       }
 290       enum "totalOpticalPowerInputMax" {
 291         value 40;
 292         description
 293           "Maximum Total Optical Power Input.";
 294       }
 295       enum "totalOpticalPowerInputAvg" {
 296         value 41;
 297         description
 298           "Average Total Optical Power Input.";
 299       }
 300       enum "FECCorrectableBlocks" {
 301         value 42;
 302         description
 303           "FEC Correctable Blocks.";
 304       }
 305       enum "FECUncorrectableBlocks" {
 306         value 43;
 307         description
 308           "FEC Uncorrectable Blocks.";
 309       }
 310       enum "BIPErrorCounter" {
 311         value 56;
 312         description
 313           "BIP Error Counter";
 314       }
 315       enum "protectionSwitchingCount" {
 316         value 57;
 317         description
 318           "Protection Switching Count (PSC)";
 319       }
 320       enum "protectionSwitchingDuration" {
 321         value 58;
 322         description
 323           "Protection Switching Duration in seconds (PSD)";
 324       }
 325       enum "erroredBlockCountTCM1-up" {
 326         value 59;
 327         description
 328           "errored Blocks Count on TCM1 up direction.";
 329       }
 330       enum "erroredBlockCountTCM2-up" {
 331         value 60;
 332         description
 333           "errored Blocks Count on TCM2 up direction.";
 334       }
 335       enum "erroredBlockCountTCM3-up" {
 336         value 61;
 337         description
 338           "errored Blocks Count on TCM3 up direction.";
 339       }
 340       enum "erroredBlockCountTCM4-up" {
 341         value 62;
 342         description
 343           "errored Blocks Count on TCM4 up direction.";
 344       }
 345       enum "erroredBlockCountTCM5-up" {
 346         value 63;
 347         description
 348           "errored Blocks Count on TCM5 up direction.";
 349       }
 350       enum "erroredBlockCountTCM6-up" {
 351         value 64;
 352         description
 353           "errored Blocks Count on TCM6 up direction.";
 354       }
 355       enum "delayTCM1-up" {
 356         value 65;
 357         description
 358           "Delay on TCM1 up direction.";
 359       }
 360       enum "delayTCM2-up" {
 361         value 66;
 362         description
 363           "Delay on TCM2 up direction.";
 364       }
 365       enum "delayTCM3-up" {
 366         value 67;
 367         description
 368           "Delay on TCM3 up direction.";
 369       }
 370       enum "delayTCM4-up" {
 371         value 68;
 372         description
 373           "Delay on TCM4 up direction.";
 374       }
 375       enum "delayTCM5-up" {
 376         value 69;
 377         description
 378           "Delay on TCM5 up direction.";
 379       }
 380       enum "delayTCM6-up" {
 381         value 70;
 382         description
 383           "Delay on TCM6 up direction.";
 384       }
 385       enum "erroredBlockCountTCM1-down" {
 386         value 71;
 387         description
 388           "errored Blocks Count on TCM1 down direction.";
 389       }
 390       enum "erroredBlockCountTCM2-down" {
 391         value 72;
 392         description
 393           "errored Blocks Count on TCM2 down direction.";
 394       }
 395       enum "erroredBlockCountTCM3-down" {
 396         value 73;
 397         description
 398           "errored Blocks Count on TCM3 down direction.";
 399       }
 400       enum "erroredBlockCountTCM4-down" {
 401         value 74;
 402         description
 403           "errored Blocks Count on TCM4 down direction.";
 404       }
 405       enum "erroredBlockCountTCM5-down" {
 406         value 75;
 407         description
 408           "errored Blocks Count on TCM5 down direction.";
 409       }
 410       enum "erroredBlockCountTCM6-down" {
 411         value 76;
 412         description
 413           "errored Blocks Count on TCM6 down direction.";
 414       }
 415       enum "delayTCM1-down" {
 416         value 77;
 417         description
 418           "Delay on TCM1 down direction.";
 419       }
 420       enum "delayTCM2-down" {
 421         value 78;
 422         description
 423           "Delay on TCM2 down direction.";
 424       }
 425       enum "delayTCM3-down" {
 426         value 79;
 427         description
 428           "Delay on TCM3 down direction.";
 429       }
 430       enum "delayTCM4-down" {
 431         value 80;
 432         description
 433           "Delay on TCM4 down direction.";
 434       }
 435       enum "delayTCM5-down" {
 436         value 81;
 437         description
 438           "Delay on TCM5 down direction.";
 439       }
 440       enum "delayTCM6-down" {
 441         value 82;
 442         description
 443           "Delay on TCM6 down direction.";
 444       }
 445     }
 446   }
 447
 448   grouping pm-measurement {
 449     description
 450       "Set of parameters related to a PM Measurement";
 451     leaf pmParameterValue {
 452       type pm-data-type;
 453       config false;
 454       mandatory true;
 455     }
 456     leaf pmParameterUnit {
 457       type string;
 458       mandatory false;
 459       description
 460         "Unit PM parameter has been measured - frames, packets, u, etc";
 461     }
 462     leaf validity {
 463       type validity;
 464       mandatory false;
 465     }
 466   }
 467
 468   grouping pm-names {
 469     description
 470       "Name of PM parameter. Consisists of a set list of parameters,
 471        plus an extension field to support addition parameters.";
 472     leaf type {
 473       type pm-names-enum;
 474       mandatory true;
 475     }
 476     leaf extension {
 477       type string;
 478       description
 479         "name of parameter, when enum value set to vendorExtension because
 480          name not found in pm-names-enum";
 481     }
 482   }
 483 }