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