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