ordmodels/common/src/main/yang/org-openroadm-otn-common-types@2017-12-15.yang

   1 module org-openroadm-otn-common-types {
   2   namespace "http://org/openroadm/otn-common-types";
   3   prefix org-openroadm-otn-common-types;
   4
   5   organization
   6     "Open ROADM MSA";
   7   contact
   8     "OpenROADM.org";
   9   description
  10     "YANG definitions for common otn related type definitions.
  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      Also contains code components extracted from IETF Interfaces.  These code components
  39      are copyrighted and licensed as follows:
  40
  41      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
  42      All rights reserved.
  43
  44      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
  45      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
  46      publication of this document. Please review these documents carefully, as they
  47      describe your rights and restrictions with respect to this document. Code Components
  48      extracted from this document must include Simplified BSD License text as described in
  49      Section 4.e of the Trust Legal Provisions and are provided without warranty as
  50      described in the Simplified BSD License.";
  51
  52   revision 2017-12-15 {
  53     description
  54       "Version 2.2";
  55   }
  56   revision 2017-09-29 {
  57     description
  58       "Version 2.1";
  59   }
  60
  61   identity otu-rate-identity {
  62     description
  63       "A unique rate identification of the OTU.";
  64   }
  65
  66   identity OTU4 {
  67     base otu-rate-identity;
  68     description
  69       "Identity for an OTU4";
  70   }
  71
  72   identity OTU3 {
  73     base otu-rate-identity;
  74     description
  75       "Identity for an OTU3";
  76   }
  77
  78   identity OTU2 {
  79     base otu-rate-identity;
  80     description
  81       "Identity for an OTU2";
  82   }
  83
  84   identity OTU2e {
  85     base otu-rate-identity;
  86     description
  87       "Identity for an OTU2e";
  88   }
  89
  90   identity OTU1 {
  91     base otu-rate-identity;
  92     description
  93       "Identity for an OTU1";
  94   }
  95
  96   identity OTU0 {
  97     base otu-rate-identity;
  98     description
  99       "Identity for an OTU0";
 100   }
 101
 102   identity OTUflex {
 103     base otu-rate-identity;
 104     description
 105       "Identity for an OTUflex";
 106   }
 107
 108   identity odu-rate-identity {
 109     description
 110       "A unique rate identification of the ODU.";
 111   }
 112
 113   identity ODU4 {
 114     base odu-rate-identity;
 115     description
 116       "Identity for an ODU4";
 117   }
 118
 119   identity ODU3 {
 120     base odu-rate-identity;
 121     description
 122       "Identity for an ODU3";
 123   }
 124
 125   identity ODU2 {
 126     base odu-rate-identity;
 127     description
 128       "Identity for an ODU2";
 129   }
 130
 131   identity ODU2e {
 132     base odu-rate-identity;
 133     description
 134       "Identity for an ODU2e";
 135   }
 136
 137   identity ODU1 {
 138     base odu-rate-identity;
 139     description
 140       "Identity for an ODU1";
 141   }
 142
 143   identity ODU0 {
 144     base odu-rate-identity;
 145     description
 146       "Identity for an ODU0";
 147   }
 148
 149   identity ODUflex-cbr {
 150     base odu-rate-identity;
 151     description
 152       "Identity for an ODUflex-cbr";
 153   }
 154
 155   identity ODUflex-gfp {
 156     base odu-rate-identity;
 157     description
 158       "Identity for an ODUflex-gfp";
 159   }
 160
 161   identity odtu-type-identity {
 162     description
 163       "A unique identification for the MSI odtu type.";
 164   }
 165
 166   identity ODTU4.ts-Allocated {
 167     base odtu-type-identity;
 168     description
 169       "OPU4 MSI - ODTU4.ts, OPU4 MSI TS is occupied/allocated.
 170        Applies to all ODTU4.x mappings";
 171   }
 172
 173   identity ODTU01 {
 174     base odtu-type-identity;
 175     description
 176       "ODTU01 MSI type";
 177   }
 178
 179   identity ODTU12 {
 180     base odtu-type-identity;
 181     description
 182       "ODTU12 MSI type";
 183   }
 184
 185   identity ODTU13 {
 186     base odtu-type-identity;
 187     description
 188       "ODTU13 MSI type";
 189   }
 190
 191   identity ODTU23 {
 192     base odtu-type-identity;
 193     description
 194       "ODTU23 MSI type";
 195   }
 196
 197   identity ODTU2.ts {
 198     base odtu-type-identity;
 199     description
 200       "ODTU2.ts MSI type";
 201   }
 202
 203   identity ODTU3.ts {
 204     base odtu-type-identity;
 205     description
 206       "ODTU3.ts MSI type";
 207   }
 208
 209   identity unallocated {
 210     base odtu-type-identity;
 211     description
 212       "Unallocated MSI type";
 213   }
 214
 215   identity odu-function-identity {
 216     description
 217       "A unique identification of the ODUk interface function.";
 218   }
 219
 220   identity ODU-TTP {
 221     base odu-function-identity;
 222     description
 223       "ODU TTP facility facing trail termination";
 224   }
 225
 226   identity ODU-CTP {
 227     base odu-function-identity;
 228     description
 229       "ODU CTP connection termination";
 230   }
 231
 232   identity ODU-TTP-CTP {
 233     base odu-function-identity;
 234     description
 235       "ODU CTP mapper level connection termination with trail termination and client adaptation";
 236   }
 237
 238   typedef payload-type-def {
 239     type string {
 240       length "2";
 241       pattern "[0-9a-fA-F]*";
 242     }
 243     description
 244       "Common type definition for odu payload-type";
 245   }
 246 }