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