ordmodels/device/src/main/yang/org-openroadm-optical-transport-interfaces@2017-12-15.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 2017-12-15;
   8   }
   9   import org-openroadm-interfaces {
  10     prefix openROADM-if;
  11     revision-date 2017-06-26;
  12   }
  13   import org-openroadm-common-types {
  14     prefix org-openroadm-common-types;
  15     revision-date 2017-12-15;
  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      AT&T Intellectual Property.  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 2017-12-15 {
  67     description
  68       "Version 2.2";
  69   }
  70   revision 2017-09-29 {
  71     description
  72       "Version 2.1";
  73   }
  74   revision 2017-07-28 {
  75     description
  76       "Version 2.0.1 - added revision-date to imports";
  77   }
  78   revision 2017-06-26 {
  79     description
  80       "Version 2.0";
  81   }
  82   revision 2016-10-14 {
  83     description
  84       "Version 1.2";
  85   }
  86
  87   grouping ots-attributes {
  88     description
  89       "Optical Transport Section (OTS) attributes";
  90     leaf fiber-type {
  91       type enumeration {
  92         enum "smf" {
  93           value 0;
  94           description
  95             "Single Mode Fiber";
  96         }
  97         enum "eleaf" {
  98           value 1;
  99           description
 100             "ELEAF";
 101         }
 102         enum "oleaf" {
 103           value 2;
 104           description
 105             "OLEAF";
 106         }
 107         enum "dsf" {
 108           value 3;
 109           description
 110             "DSF";
 111         }
 112         enum "truewave" {
 113           value 4;
 114           description
 115             "TRUEWAVE Reduced Slope";
 116         }
 117         enum "truewavec" {
 118           value 5;
 119           description
 120             "TRUEWAVE Classic";
 121         }
 122         enum "nz-dsf" {
 123           value 6;
 124           description
 125             "NZ-DSF";
 126         }
 127         enum "ull" {
 128           value 7;
 129           description
 130             "Ultra Low Loss (ULL)";
 131         }
 132       }
 133       default "smf";
 134       description
 135         "fiber type
 136          Default    : SMF ";
 137     }
 138     leaf span-loss-receive {
 139       type org-openroadm-common-types:ratio-dB;
 140       description
 141         "Span loss on the receiver side. Set by the controller and used by device to set AMP gain.";
 142     }
 143     leaf span-loss-transmit {
 144       type org-openroadm-common-types:ratio-dB;
 145       description
 146         "Span loss on the transmitter side. Set by the controller and used by device to configure MSA compliant channel launch power";
 147     }
 148     leaf ingress-span-loss-aging-margin {
 149       type org-openroadm-common-types:ratio-dB;
 150       default "0";
 151       config true;
 152       description
 153         "Span-loss margin used to set optical amplifier gain and output-voa.
 154          Day one attenuation of the link, at initial commissioning may increase across wdm link life.
 155          span-loss-aging-margin defines the maximum additional loss the wdm link may experience in addition
 156          to initial loss without requiring a new design (new amplifier settings). ";
 157     }
 158     leaf eol-max-load-pIn {
 159       type org-openroadm-common-types:power-dBm;
 160       config true;
 161       description
 162         "End Of Life Total input power at maximum load used for amplifier control.
 163          Calculated during the design, this value shall be used by the amplifier device
 164          for the setting so that the reasonable margin is kept to reach this value
 165          at the end of life of the wdm link, considering span-loss aging margins are reached ";
 166     }
 167   }
 168
 169   grouping ots-container {
 170     container ots {
 171       description
 172         "Optical Transport Section (OTS):
 173           Models the optical interfaces for an Optical White Box.
 174           The network side is represented by the OTS/OMS.";
 175       uses ots-attributes;
 176     }
 177   }
 178
 179   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 180     when "org-openroadm-device:type = 'openROADM-if:opticalTransport'";
 181     uses ots-container;
 182   }
 183 }