ordmodels/device/src/main/yang/org-openroadm-optical-transport-interfaces@2020-05-29.yang

   1 module org-openroadm-optical-transport-interfaces {
   2   namespace "http://org/openroadm/optical-transport-interfaces";
   3   prefix org-openroadm-optical-transport-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-common-link-types {
  14     prefix org-openroadm-common-link-types;
  15     revision-date 2019-11-29;
  16   }
  17
  18   organization
  19     "Open ROADM MSA";
  20   contact
  21     "OpenROADM.org";
  22   description
  23     "This module contains YANG definitions
  24      for the Optical Transport Interfaces.
  25
  26      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  27      All other rights reserved.
  28
  29      Redistribution and use in source and binary forms, with or without modification,
  30      are permitted provided that the following conditions are met:
  31
  32      * Redistributions of source code must retain the above copyright notice, this
  33        list of conditions and the following disclaimer.
  34      * Redistributions in binary form must reproduce the above copyright notice,
  35        this list of conditions and the following disclaimer in the documentation and/or
  36        other materials provided with the distribution.
  37      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  38        contributors may be used to endorse or promote products derived from this software
  39        without specific prior written permission.
  40
  41      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  42      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  43      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  44      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  45      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  47      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  48      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  50      POSSIBILITY OF SUCH DAMAGE.
  51
  52      Also contains code components extracted from IETF Interfaces.  These code components
  53      are copyrighted and licensed as follows:
  54
  55      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
  56      All rights reserved.
  57
  58      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
  59      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
  60      publication of this document. Please review these documents carefully, as they
  61      describe your rights and restrictions with respect to this document. Code Components
  62      extracted from this document must include Simplified BSD License text as described in
  63      Section 4.e of the Trust Legal Provisions and are provided without warranty as
  64      described in the Simplified BSD License.";
  65
  66   revision 2020-05-29 {
  67     description
  68       "Version 7.1.0";
  69   }
  70   revision 2020-03-27 {
  71     description
  72       "Version 7.0.0";
  73   }
  74   revision 2019-11-29 {
  75     description
  76       "Version 6.1.0";
  77   }
  78   revision 2019-09-27 {
  79     description
  80       "Version 6.0.0";
  81   }
  82   revision 2019-05-31 {
  83     description
  84       "Version 5.1.0";
  85   }
  86   revision 2019-03-29 {
  87     description
  88       "Version 5.0.0";
  89   }
  90   revision 2018-11-30 {
  91     description
  92       "Version 4.1.0";
  93   }
  94   revision 2018-05-30 {
  95     description
  96       "Version 3.1.0";
  97   }
  98   revision 2018-03-30 {
  99     description
 100       "Version 3.0.0";
 101   }
 102   revision 2017-12-15 {
 103     description
 104       "Version 2.2";
 105   }
 106   revision 2017-09-29 {
 107     description
 108       "Version 2.1";
 109   }
 110   revision 2017-07-28 {
 111     description
 112       "Version 2.0.1 - added revision-date to imports";
 113   }
 114   revision 2017-06-26 {
 115     description
 116       "Version 2.0";
 117   }
 118   revision 2016-10-14 {
 119     description
 120       "Version 1.2";
 121   }
 122
 123   grouping ots-attributes {
 124     description
 125       "Optical Transport Section (OTS) attributes";
 126     leaf fiber-type {
 127       type enumeration {
 128         enum smf {
 129           value 0;
 130           description
 131             "Single Mode Fiber";
 132         }
 133         enum eleaf {
 134           value 1;
 135           description
 136             "ELEAF";
 137         }
 138         enum oleaf {
 139           value 2;
 140           description
 141             "OLEAF";
 142         }
 143         enum dsf {
 144           value 3;
 145           description
 146             "DSF";
 147         }
 148         enum truewave {
 149           value 4;
 150           description
 151             "TRUEWAVE Reduced Slope";
 152         }
 153         enum truewavec {
 154           value 5;
 155           description
 156             "TRUEWAVE Classic";
 157         }
 158         enum nz-dsf {
 159           value 6;
 160           description
 161             "NZ-DSF";
 162         }
 163         enum ull {
 164           value 7;
 165           description
 166             "Ultra Low Loss (ULL)";
 167         }
 168       }
 169       default "smf";
 170       description
 171         "fiber type
 172          Default    : SMF ";
 173     }
 174     leaf span-loss-receive {
 175       type org-openroadm-common-link-types:ratio-dB;
 176       description
 177         "Span loss on the receiver side. Set by the controller and used by device to set AMP gain.";
 178     }
 179     leaf span-loss-transmit {
 180       type org-openroadm-common-link-types:ratio-dB;
 181       description
 182         "Span loss on the transmitter side. Set by the controller and used by device to configure MSA compliant channel launch power";
 183     }
 184     leaf ingress-span-loss-aging-margin {
 185       type org-openroadm-common-link-types:ratio-dB;
 186       default "0";
 187       config true;
 188       description
 189         "Span-loss margin used to set optical amplifier gain and output-voa.
 190          Day one attenuation of the link, at initial commissioning may increase across wdm link life.
 191          span-loss-aging-margin defines the maximum additional loss the wdm link may experience in addition
 192          to initial loss without requiring a new design (new amplifier settings). ";
 193     }
 194     leaf eol-max-load-pIn {
 195       type org-openroadm-common-link-types:power-dBm;
 196       config true;
 197       description
 198         "End Of Life Total input power at maximum load used for amplifier control.
 199          Calculated during the design, this value shall be used by the amplifier device
 200          for the setting so that the reasonable margin is kept to reach this value
 201          at the end of life of the wdm link, considering span-loss aging margins are reached ";
 202     }
 203   }
 204
 205   grouping ots-container {
 206     container ots {
 207       description
 208         "Optical Transport Section (OTS):
 209           Models the optical interfaces for an Optical White Box.
 210           The network side is represented by the OTS/OMS.";
 211       uses ots-attributes;
 212     }
 213   }
 214
 215   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 216     when "org-openroadm-device:type = 'openROADM-if:opticalTransport'";
 217     uses ots-container;
 218   }
 219 }