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