ordmodels/network/src/main/yang/org-openroadm-amplifier@2019-11-29.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 2019-11-29 {
  50     description
  51       "Version 6.1.0";
  52   }
  53   revision 2019-03-29 {
  54     description
  55       "Version 5.0.0";
  56   }
  57   revision 2018-11-30 {
  58     description
  59       "Version 4.1.0";
  60   }
  61   revision 2018-03-30 {
  62     description
  63       "Version 3.0.0";
  64   }
  65   revision 2017-12-15 {
  66     description
  67       "Version 2.2";
  68   }
  69   revision 2017-09-29 {
  70     description
  71       "Version 2.1";
  72   }
  73   revision 2017-07-28 {
  74     description
  75       "Version 2.0.1 - added revision-date to imports";
  76   }
  77   revision 2017-06-17 {
  78     description
  79       "Version 2.0";
  80   }
  81
  82   grouping amplifier-node-attributes {
  83     description
  84       "Defines the group of amplifier attributes";
  85     leaf amp-type {
  86       type org-openroadm-common-amplifier-types:amplifier-types;
  87       config true;
  88       mandatory true;
  89       description
  90         "Amplifier type";
  91     }
  92     leaf amp-gain-range {
  93       type org-openroadm-common-amplifier-types:amplifier-gain-range;
  94       config true;
  95       description
  96         "Amplifier gain-range (gain-range 1 to 4 for switched gain amplifiers)
  97          gain-range-1 for standard amplifiers";
  98     }
  99     leaf ingress-span-loss-aging-margin {
 100       type org-openroadm-common-link-types:ratio-dB;
 101       config true;
 102       description
 103         "Span-loss margin used to set optical amplifier gain and output-voa
 104          extracted from corresponding device OTS interface container, optional
 105          since it concerns only line facing amp";
 106     }
 107     leaf gain {
 108       type org-openroadm-common-link-types:ratio-dB;
 109       config true;
 110       mandatory true;
 111       description
 112         "Overall Amplifier Signal gain, excluding ASE, including VOA attenuation
 113          retrieved from operational value (PM)";
 114     }
 115     leaf initially-planned-gain {
 116       type org-openroadm-common-link-types:ratio-dB;
 117       config true;
 118       description
 119         "Overall Amplifier Signal gain, excluding ASE, including VOA attenuation:
 120          value coming from planning tool initial design";
 121     }
 122     leaf tilt {
 123       type org-openroadm-common-link-types:ratio-dB;
 124       config true;
 125       description
 126         "Tilt of smart EDFA retrieved from operational value (PM)";
 127     }
 128     leaf initially-planned-tilt {
 129       type org-openroadm-common-link-types:ratio-dB;
 130       config true;
 131       description
 132         "Tilt of smart EDFA:
 133          value coming from planning tool initial design";
 134     }
 135     leaf out-voa-att {
 136       type org-openroadm-common-link-types:ratio-dB;
 137       config true;
 138       description
 139         "output VOA attenuation";
 140     }
 141     leaf initially-planned-out-voa-att {
 142       type org-openroadm-common-link-types:ratio-dB;
 143       config true;
 144       description
 145         "output VOA attenuation: value coming from planning tool initial design.
 146          As in R2.0, output VOA can not be configured by controller, this parameter may be used by the controller
 147          to check that value set by amplifiers is in the range of calculated value and take relevant decision if not";
 148     }
 149     leaf eol-max-load-pIn {
 150       type org-openroadm-common-link-types:power-dBm;
 151       config true;
 152       description
 153         "End Of Life Total input power at maximum load used for amplifier and VOA setting
 154          extracted from corresponding device OTS interface container";
 155     }
 156     leaf egress-average-channel-power {
 157       type org-openroadm-common-link-types:power-dBm;
 158       config true;
 159       description
 160         "Based upon the total max power across the 4.8 THz passband.";
 161     }
 162   }
 163 }