ordmodels/network/src/main/yang/org-openroadm-amplifier@2017-12-15.yang

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