ordmodels/common/src/main/yang/org-openroadm-tca@2016-10-14.yang

   1 module org-openroadm-tca {
   2   namespace "http://org/openroadm/tca";
   3   prefix org-openroadm-tca;
   4
   5   import ietf-yang-types {
   6     prefix yang;
   7   }
   8   import org-openroadm-common-types {
   9     prefix org-openroadm-common-types;
  10         revision-date 2016-10-14;
  11   }
  12   import org-openroadm-pm-types {
  13     prefix org-openroadm-pm-types;
  14   }
  15   import org-openroadm-resource {
  16     prefix org-openroadm-resource;
  17   }
  18   import org-openroadm-layerRate {
  19     prefix org-openroadm-layerRate;
  20   }
  21
  22   organization "Open ROADM MSA";
  23   contact
  24     "OpenROADM.org";
  25   description
  26     "YANG definitions of Threshold Crossing Alert types.
  27
  28       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  29       AT&T Intellectual Property.  All other rights reserved.
  30
  31       Redistribution and use in source and binary forms, with or without modification,
  32       are permitted provided that the following conditions are met:
  33
  34       * Redistributions of source code must retain the above copyright notice, this
  35         list of conditions and the following disclaimer.
  36       * Redistributions in binary form must reproduce the above copyright notice,
  37         this list of conditions and the following disclaimer in the documentation and/or
  38         other materials provided with the distribution.
  39       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  40         contributors may be used to endorse or promote products derived from this software
  41         without specific prior written permission.
  42
  43       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  44       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  45       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  46       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  47       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  48       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  49       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  50       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  51       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  52       POSSIBILITY OF SUCH DAMAGE";
  53
  54   revision 2016-10-14 {
  55     description
  56       "Version 1.2";
  57   }
  58
  59   grouping tca {
  60     leaf id {
  61       type string;
  62       mandatory true;
  63     }
  64     container resource {
  65       uses org-openroadm-resource:resource;
  66     }
  67     leaf granularity {
  68       type org-openroadm-pm-types:pm-granularity;
  69     }
  70     leaf raiseTime {
  71       type yang:date-and-time;
  72       mandatory true;
  73       config false;
  74     }
  75     container layerRate {
  76       uses org-openroadm-layerRate:layer-rate;
  77     }
  78     leaf severity {
  79       mandatory true;
  80       type org-openroadm-common-types:severity;
  81       description
  82         "Severity of alarm. Based on X.733 perceived severity.";
  83     }
  84     leaf thresholdType {
  85       mandatory false;
  86       type enumeration {
  87         enum "high" {
  88           value 1;
  89         }
  90         enum "low" {
  91           value 2;
  92         }
  93       }
  94       description
  95         "Threshold Crossed";
  96     }
  97     container thresholdMeasurement {
  98       uses org-openroadm-pm-types:pm-measurement;
  99     }
 100   }
 101
 102   grouping potential-tca {
 103     leaf lowThresholdValue {
 104       mandatory false;
 105       type uint64;
 106     }
 107     leaf highThresholdValue {
 108       mandatory false;
 109       type uint64;
 110     }
 111     uses tca;
 112   }
 113
 114   container potential-tca-list {
 115     list tca {
 116       key "id";
 117       uses potential-tca;
 118     }
 119   }
 120   notification tca-notification {
 121     uses tca;
 122   }
 123 }