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