ordmodels/device/src/main/yang/org-openroadm-optical-transport-interfaces@2016-10-14.yang

   1 module org-openroadm-optical-transport-interfaces {
   2   namespace "http://org/openroadm/optical-transport-interfaces";
   3   prefix org-openroadm-optical-transport-interfaces;
   4
   5   import org-openroadm-device {
   6     prefix org-openroadm-device;
   7     revision-date 2017-02-06;
   8   }
   9   import org-openroadm-interfaces {
  10     prefix openROADM-if;
  11     revision-date 2016-10-14;
  12   }
  13   import org-openroadm-common-types {
  14     prefix org-openroadm-common-types;
  15     revision-date 2016-10-14;
  16   }
  17
  18   organization "Open ROADM MSA";
  19   contact
  20     "OpenROADM.org";
  21   description
  22     "This module contains YANG definitions
  23      for the Optical Transport Interfaces.
  24
  25      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  26      AT&T Intellectual Property.  All other rights reserved.
  27
  28      Redistribution and use in source and binary forms, with or without modification,
  29      are permitted provided that the following conditions are met:
  30
  31      * Redistributions of source code must retain the above copyright notice, this
  32        list of conditions and the following disclaimer.
  33      * Redistributions in binary form must reproduce the above copyright notice,
  34        this list of conditions and the following disclaimer in the documentation and/or
  35        other materials provided with the distribution.
  36      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  37        contributors may be used to endorse or promote products derived from this software
  38        without specific prior written permission.
  39
  40      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  41      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  42      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  43      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  44      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  46      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  47      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  49      POSSIBILITY OF SUCH DAMAGE.
  50
  51      Also contains code components extracted from IETF Interfaces.  These code components
  52      are copyrighted and licensed as follows:
  53
  54      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
  55      All rights reserved.
  56
  57      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
  58      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
  59      publication of this document. Please review these documents carefully, as they
  60      describe your rights and restrictions with respect to this document. Code Components
  61      extracted from this document must include Simplified BSD License text as described in
  62      Section 4.e of the Trust Legal Provisions and are provided without warranty as
  63      described in the Simplified BSD License.";
  64
  65   revision 2016-10-14 {
  66     description
  67       "Version 1.2";
  68   }
  69
  70   grouping ots-attributes {
  71     description
  72       "Optical Transport Section (OTS) attributes";
  73     leaf fiber-type {
  74       type enumeration {
  75         enum "smf" {
  76           value 0;
  77           description
  78             "Single Mode Fiber";
  79         }
  80         enum "eleaf" {
  81           value 1;
  82           description
  83             "ELEAF";
  84         }
  85         enum "oleaf" {
  86           value 2;
  87           description
  88             "OLEAF";
  89         }
  90         enum "dsf" {
  91           value 3;
  92           description
  93             "DSF";
  94         }
  95         enum "truewave" {
  96           value 4;
  97           description
  98             "TRUEWAVE Reduced Slope";
  99         }
 100         enum "truewavec" {
 101           value 5;
 102           description
 103             "TRUEWAVE Classic";
 104         }
 105         enum "nz-dsf" {
 106           value 6;
 107           description
 108             "NZ-DSF";
 109         }
 110         enum "ull" {
 111           value 7;
 112           description
 113             "Ultra Low Loss (ULL)";
 114         }
 115       }
 116       default "smf";
 117       description
 118         "fiber type
 119          Default    : SMF ";
 120     }
 121     leaf span-loss-receive {
 122       description
 123         "Span loss on the receiver side. Set by the controller and used by device to set AMP gain.";
 124       type org-openroadm-common-types:ratio-dB;
 125     }
 126     leaf span-loss-transmit {
 127       description
 128         "Span loss on the transmitter side. Set by the controller and used by device to configure MSA compliant channel launch power";
 129       type org-openroadm-common-types:ratio-dB;
 130     }
 131   }
 132
 133   grouping ots-container {
 134     container ots {
 135       description
 136         "Optical Transport Section (OTS):
 137           Models the optical interfaces for an Optical White Box.
 138           The network side is represented by the OTS/OMS.";
 139       uses ots-attributes;
 140     }
 141   }
 142
 143   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 144     when "org-openroadm-device:type = 'openROADM-if:opticalTransport'";
 145     uses ots-container;
 146   }
 147 }