ordmodels/device/src/main/yang/org-openroadm-optical-channel-interfaces@2017-12-15.yang

   1 module org-openroadm-optical-channel-interfaces {
   2   namespace "http://org/openroadm/optical-channel-interfaces";
   3   prefix org-openroadm-optical-channel-interfaces;
   4
   5   import org-openroadm-device {
   6     prefix org-openroadm-device;
   7     revision-date 2017-12-15;
   8   }
   9   import org-openroadm-interfaces {
  10     prefix openROADM-if;
  11     revision-date 2017-06-26;
  12   }
  13   import org-openroadm-common-types {
  14     prefix org-openroadm-common-types;
  15     revision-date 2017-12-15;
  16   }
  17
  18   organization
  19     "Open ROADM MSA";
  20   contact
  21     "OpenROADM.org";
  22   description
  23     "YANG definitions for device facility och 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 2017-12-15 {
  66     description
  67       "Version 2.2";
  68   }
  69   revision 2017-09-29 {
  70     description
  71       "Version 2.1";
  72   }
  73   revision 2017-07-28 {
  74     description
  75       "Version 2.0.1 - added revision-date to imports";
  76   }
  77   revision 2017-06-26 {
  78     description
  79       "Version 2.0";
  80   }
  81   revision 2016-10-14 {
  82     description
  83       "Version 1.2";
  84   }
  85
  86   grouping och-attributes {
  87     description
  88       "Optical Channel attributes";
  89     leaf rate {
  90       type identityref {
  91         base org-openroadm-common-types:och-rate-identity;
  92       }
  93       description
  94         "rate";
  95     }
  96     leaf frequency {
  97       type org-openroadm-common-types:frequency-THz;
  98       config true;
  99       description
 100         "Center Frequency in THz.";
 101     }
 102     leaf width {
 103       type org-openroadm-common-types:frequency-GHz;
 104       config false;
 105       description
 106         "Frequency width in GHz.";
 107     }
 108     leaf modulation-format {
 109       type org-openroadm-common-types:modulation-format;
 110     }
 111     leaf transmit-power {
 112       type org-openroadm-common-types:power-dBm;
 113       description
 114         "The target transmit power for this channel. When set, the xponder will work to ensure that port-current-power reaches this level. Applicable only to channel on top of xpdr-network port";
 115     }
 116   }
 117
 118   grouping och-container {
 119     container och {
 120       description
 121         "Optical Channel (OCh):
 122          Models the optical channel interfaces for an Optical White Box.";
 123       uses och-attributes;
 124     }
 125   }
 126
 127   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 128     when "org-openroadm-device:type = 'openROADM-if:opticalChannel'";
 129     uses och-container;
 130   }
 131 }