ordmodels/common/src/main/yang/org-openroadm-common-attributes@2020-03-27.yang

   1 module org-openroadm-common-attributes {
   2   namespace "http://org/openroadm/common-attributes";
   3   prefix org-openroadm-common-attributes;
   4
   5   import org-openroadm-otn-common-types {
   6     prefix org-openroadm-otn-common-types;
   7     revision-date 2020-03-27;
   8   }
   9
  10   organization
  11     "Open ROADM MSA";
  12   contact
  13     "OpenROADM.org";
  14   description
  15     "YANG definitions of common attributes.
  16
  17       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  18       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 2020-03-27 {
  44     description
  45       "Version 7.0.0";
  46   }
  47   revision 2019-11-29 {
  48     description
  49       "Version 6.1.0";
  50   }
  51
  52   grouping parent-odu-allocation {
  53     description
  54       "parent odu allocation group";
  55     container parent-odu-allocation {
  56       presence "Explicit assignment of parent ODU trib-slot and trib-port allocation. ";
  57       description
  58         "parent odu allocation";
  59       leaf trib-port-number {
  60         type uint16 {
  61           range "1 .. 80";
  62         }
  63         mandatory true;
  64         description
  65           "Assigned tributary port number in parent OPU";
  66       }
  67       choice trib-slots-choice {
  68         description
  69           "trib slot selection";
  70         case opu {
  71           leaf-list trib-slots {
  72             type uint16 {
  73               range "1 .. 80";
  74             }
  75             min-elements 1;
  76             max-elements 80;
  77             description
  78               "Assigned trib slots occupied in parent OPU MSI";
  79           }
  80         }
  81         case opucn {
  82           leaf-list opucn-trib-slots {
  83             type org-openroadm-otn-common-types:opucn-trib-slot-def;
  84             description
  85               "Specify the list of OPUCn 5G tributary slots in the form of
  86                TS #A.B (G.709 Figure 20-9) in the case of provisioning the low
  87                 order ODUk to the parent server ODUCn";
  88           }
  89         }
  90       }
  91     }
  92   }
  93
  94   grouping deg-threshold {
  95     description
  96       "Deg threshold grouping";
  97     leaf degm-intervals {
  98       type uint8 {
  99         range "2 .. 10";
 100       }
 101       default "2";
 102       description
 103         "G.806 - Consecutive bad intervals required for declare dDEG";
 104     }
 105     leaf degthr-percentage {
 106       type uint16 {
 107         range "1 .. 10000";
 108       }
 109       default "100";
 110       description
 111         "Percentage of errored blocks required to declare an interval bad, in units of 0.01%";
 112     }
 113   }
 114
 115   grouping trail-trace-tx {
 116     description
 117       "Trail trace tx grouping";
 118     leaf tx-sapi {
 119       type string {
 120         length "0 .. 15";
 121       }
 122       description
 123         "The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709";
 124     }
 125     leaf tx-dapi {
 126       type string {
 127         length "0 .. 15";
 128       }
 129       description
 130         "The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709";
 131     }
 132     leaf tx-operator {
 133       type string {
 134         length "0 .. 32";
 135       }
 136       description
 137         "The provisioned 32 character Operator Specific field";
 138     }
 139   }
 140
 141   grouping trail-trace-other {
 142     description
 143       "Trail trace other grouping";
 144     leaf expected-sapi {
 145       type string {
 146         length "0 .. 15";
 147       }
 148       description
 149         "The provisioned expected SAPI, to be compared with accepted TTI";
 150     }
 151     leaf expected-dapi {
 152       type string {
 153         length "0 .. 15";
 154       }
 155       description
 156         "The provisioned expected DAPI, to be compared with accepted TTI";
 157     }
 158     leaf tim-act-enabled {
 159       type boolean;
 160       default "false";
 161       description
 162         "Enables TTI Mismatch consequent actions.";
 163     }
 164     leaf tim-detect-mode {
 165       type enumeration {
 166         enum Disabled {
 167           description
 168             "TTI is ignored";
 169         }
 170         enum SAPI {
 171           description
 172             "Expected SAPI is compared to the Accepted TTI. Other TTI fields are ignored";
 173         }
 174         enum DAPI {
 175           description
 176             "Expected DAPI is compared to the Accepted TTI. Other TTI fields are ignored";
 177         }
 178         enum SAPI-and-DAPI {
 179           description
 180             "Expected SAPI and Expected DAPI are compared to the Accepted TTI. Operator specific TTI field is ignored";
 181         }
 182       }
 183       default "Disabled";
 184       description
 185         "tim detect mode leaf";
 186     }
 187   }
 188 }