ordmodels/network/src/main/yang/org-openroadm-amplifier@2021-09-24.yang

   1 module org-openroadm-amplifier {
   2   yang-version 1.1;
   3   namespace "http://org/openroadm/amplifier";
   4   prefix amp;
   5
   6   import org-openroadm-common-amplifier-types {
   7     prefix org-openroadm-common-amplifier-types;
   8     revision-date 2019-11-29;
   9   }
  10   import org-openroadm-common-link-types {
  11     prefix org-openroadm-common-link-types;
  12     revision-date 2019-11-29;
  13   }
  14
  15   organization
  16     "Open ROADM MSA";
  17   contact
  18     "OpenROADM.org.";
  19   description
  20     "YANG definitions for an amplifier in Network Model
  21
  22
  23      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2017,
  24      All other rights reserved.
  25
  26      Redistribution and use in source and binary forms, with or without modification,
  27      are permitted provided that the following conditions are met:
  28
  29      * Redistributions of source code must retain the above copyright notice, this
  30        list of conditions and the following disclaimer.
  31      * Redistributions in binary form must reproduce the above copyright notice,
  32        this list of conditions and the following disclaimer in the documentation and/or
  33        other materials provided with the distribution.
  34      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  35        contributors may be used to endorse or promote products derived from this software
  36        without specific prior written permission.
  37
  38      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  39      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  40      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  41      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  42      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  43      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  44      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  45      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  46      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  47      POSSIBILITY OF SUCH DAMAGE.";
  48
  49   revision 2021-09-24 {
  50         description
  51           "Version 10.0";
  52   }
  53   revision 2019-11-29 {
  54     description
  55       "Version 6.1.0";
  56   }
  57   revision 2019-03-29 {
  58     description
  59       "Version 5.0.0";
  60   }
  61   revision 2018-11-30 {
  62     description
  63       "Version 4.1.0";
  64   }
  65   revision 2018-03-30 {
  66     description
  67       "Version 3.0.0";
  68   }
  69   revision 2017-12-15 {
  70     description
  71       "Version 2.2";
  72   }
  73   revision 2017-09-29 {
  74     description
  75       "Version 2.1";
  76   }
  77   revision 2017-07-28 {
  78     description
  79       "Version 2.0.1 - added revision-date to imports";
  80   }
  81   revision 2017-06-17 {
  82     description
  83       "Version 2.0";
  84   }
  85
  86   grouping amplifier-node-attributes {
  87     description
  88       "Defines the group of amplifier attributes";
  89     leaf amp-type {
  90       type org-openroadm-common-amplifier-types:amplifier-types;
  91       config true;
  92       mandatory true;
  93       description
  94         "Amplifier type";
  95     }
  96     leaf amp-gain-range {
  97       type org-openroadm-common-amplifier-types:amplifier-gain-range;
  98       config true;
  99       description
 100         "Amplifier gain-range (gain-range 1 to 4 for switched gain amplifiers)
 101          gain-range-1 for standard amplifiers";
 102     }
 103     leaf ingress-span-loss-aging-margin {
 104       type org-openroadm-common-link-types:ratio-dB;
 105       config true;
 106       description
 107         "Span-loss margin used to set optical amplifier gain and output-voa
 108          extracted from corresponding device OTS interface container, optional
 109          since it concerns only line facing amp";
 110     }
 111     leaf gain {
 112       type org-openroadm-common-link-types:ratio-dB;
 113       config true;
 114       mandatory true;
 115       description
 116         "Overall Amplifier Signal gain, excluding ASE, including VOA attenuation
 117          retrieved from operational value (PM)";
 118     }
 119     leaf initially-planned-gain {
 120       type org-openroadm-common-link-types:ratio-dB;
 121       config true;
 122       description
 123         "Overall Amplifier Signal gain, excluding ASE, including VOA attenuation:
 124          value coming from planning tool initial design";
 125     }
 126     leaf tilt {
 127       type org-openroadm-common-link-types:ratio-dB;
 128       config true;
 129       description
 130         "Tilt of smart EDFA retrieved from operational value (PM)";
 131     }
 132     leaf initially-planned-tilt {
 133       type org-openroadm-common-link-types:ratio-dB;
 134       config true;
 135       description
 136         "Tilt of smart EDFA:
 137          value coming from planning tool initial design";
 138     }
 139     leaf out-voa-att {
 140       type org-openroadm-common-link-types:ratio-dB;
 141       config true;
 142       description
 143         "output VOA attenuation";
 144     }
 145     leaf initially-planned-out-voa-att {
 146       type org-openroadm-common-link-types:ratio-dB;
 147       config true;
 148       description
 149         "output VOA attenuation: value coming from planning tool initial design.
 150          As in R2.0, output VOA can not be configured by controller, this parameter may be used by the controller
 151          to check that value set by amplifiers is in the range of calculated value and take relevant decision if not";
 152     }
 153     leaf eol-max-load-pIn {
 154       type org-openroadm-common-link-types:power-dBm;
 155       config true;
 156       description
 157         "End Of Life Total input power at maximum load used for amplifier and VOA setting
 158          extracted from corresponding device OTS interface container";
 159     }
 160     leaf egress-average-channel-power {
 161       type org-openroadm-common-link-types:power-dBm;
 162       config true;
 163       description
 164         "Based upon the total max power across the 4.8 THz passband.";
 165     }
 166     leaf-list supported-operational-modes {
 167       type string;
 168       config true;
 169       description
 170         "defines the supported openroadm specifications";
 171     }
 172   }
 173 }