ordmodels/device/src/main/yang/org-openroadm-otn-otu-interfaces@2020-05-29.yang

   1 module org-openroadm-otn-otu-interfaces {
   2   namespace "http://org/openroadm/otn-otu-interfaces";
   3   prefix org-openroadm-otn-otu-interfaces;
   4
   5   import org-openroadm-device {
   6     prefix org-openroadm-device;
   7     revision-date 2020-05-29;
   8   }
   9   import org-openroadm-interfaces {
  10     prefix openROADM-if;
  11     revision-date 2019-11-29;
  12   }
  13   import org-openroadm-maintenance-loopback {
  14     prefix org-openroadm-maint-loopback;
  15     revision-date 2019-11-29;
  16   }
  17   import org-openroadm-otn-common {
  18     prefix org-openroadm-otn-common;
  19     revision-date 2020-03-27;
  20   }
  21   import org-openroadm-otn-common-types {
  22     prefix org-openroadm-otn-common-types;
  23     revision-date 2020-03-27;
  24   }
  25   import org-openroadm-common-attributes {
  26     prefix org-openroadm-common-attributes;
  27     revision-date 2020-03-27;
  28   }
  29   import org-openroadm-common-types {
  30     prefix org-openroadm-common-types;
  31     revision-date 2020-05-29;
  32   }
  33
  34   organization
  35     "Open ROADM MSA";
  36   contact
  37     "OpenROADM.org";
  38   description
  39     "YANG definitions for device facility otnotu interfaces.
  40
  41      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  42      All other rights reserved.
  43
  44      Redistribution and use in source and binary forms, with or without modification,
  45      are permitted provided that the following conditions are met:
  46
  47      * Redistributions of source code must retain the above copyright notice, this
  48        list of conditions and the following disclaimer.
  49      * Redistributions in binary form must reproduce the above copyright notice,
  50        this list of conditions and the following disclaimer in the documentation and/or
  51        other materials provided with the distribution.
  52      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  53        contributors may be used to endorse or promote products derived from this software
  54        without specific prior written permission.
  55
  56      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  57      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  58      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  59      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  60      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  61      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  62      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  63      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  64      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  65      POSSIBILITY OF SUCH DAMAGE.
  66
  67      Also contains code components extracted from IETF Interfaces.  These code components
  68      are copyrighted and licensed as follows:
  69
  70      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
  71      All rights reserved.
  72
  73      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
  74      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
  75      publication of this document. Please review these documents carefully, as they
  76      describe your rights and restrictions with respect to this document. Code Components
  77      extracted from this document must include Simplified BSD License text as described in
  78      Section 4.e of the Trust Legal Provisions and are provided without warranty as
  79      described in the Simplified BSD License.";
  80
  81   revision 2020-05-29 {
  82     description
  83       "Version 7.1.0";
  84   }
  85   revision 2020-03-27 {
  86     description
  87       "Version 7.0.0";
  88   }
  89   revision 2019-11-29 {
  90     description
  91       "Version 6.1.0";
  92   }
  93   revision 2019-09-27 {
  94     description
  95       "Version 6.0.0";
  96   }
  97   revision 2019-05-31 {
  98     description
  99       "Version 5.1.0";
 100   }
 101   revision 2019-03-29 {
 102     description
 103       "Version 5.0.0";
 104   }
 105   revision 2018-11-30 {
 106     description
 107       "Version 4.1.0";
 108   }
 109   revision 2018-09-28 {
 110     description
 111       "Version 4.0.0";
 112   }
 113   revision 2018-05-30 {
 114     description
 115       "Version 3.1.0";
 116   }
 117   revision 2018-03-30 {
 118     description
 119       "Version 3.0.0";
 120   }
 121   revision 2017-12-15 {
 122     description
 123       "Version 2.2";
 124   }
 125   revision 2017-09-29 {
 126     description
 127       "Version 2.1";
 128   }
 129   revision 2017-07-28 {
 130     description
 131       "Version 2.0.1 - added revision-date to imports";
 132   }
 133   revision 2017-06-26 {
 134     description
 135       "Version 2.0";
 136   }
 137   revision 2016-10-14 {
 138     description
 139       "Version 1.2";
 140   }
 141
 142   grouping otu-attributes {
 143     description
 144       "OTU attributes";
 145     leaf rate {
 146       type identityref {
 147         base org-openroadm-otn-common-types:otu-rate-identity;
 148       }
 149       description
 150         "rate identity of the OTU. 'identityref' is used
 151          to allow to extend for future higher rates";
 152     }
 153     leaf otu4-member-id {
 154       when "../rate = 'org-openroadm-otn-common-types:OTU4'";
 155       type uint16;
 156       description
 157         "To uniquely identify each member of an OTSi group and the order of each member in the group.
 158          Similar to FlexO PHY-ID in the FlexO Group (PID in G.709.1/3)";
 159     }
 160     leaf otucn-n-rate {
 161       type uint16;
 162       description
 163         "Specify the N associated with OTUCn, e.g. N = 2,3,4 for 200G/300G/400G respectively";
 164     }
 165     leaf otucn-M-subrate {
 166       type uint16;
 167       description
 168         "OTUCn subrate (OTUCn-M), value of M specifies the number of active
 169          5 Gbit/s OPUCn tributary slots (G.709 Annex H)";
 170     }
 171
 172     uses org-openroadm-common-types:fec-grouping {
 173       description
 174         "OTU FEC / Forward Error Correction";
 175     }
 176     uses org-openroadm-otn-common:trail-trace;
 177     uses org-openroadm-common-attributes:deg-threshold;
 178   }
 179
 180   grouping otu-container {
 181     container otu {
 182       description
 183         "Optical Channel Transport Unit (OTU)";
 184       uses otu-attributes;
 185       uses org-openroadm-maint-loopback:maint-loopback;
 186     }
 187   }
 188
 189   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 190     when "org-openroadm-device:type = 'openROADM-if:otnOtu'";
 191     uses otu-container;
 192   }
 193 }