ordmodels/device/src/main/yang/org-openroadm-optical-channel-interfaces@2016-10-14.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-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     "YANG definitions for device facility och interfaces.
  23
  24      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  25      AT&T Intellectual Property.  All other rights reserved.
  26
  27      Redistribution and use in source and binary forms, with or without modification,
  28      are permitted provided that the following conditions are met:
  29
  30      * Redistributions of source code must retain the above copyright notice, this
  31        list of conditions and the following disclaimer.
  32      * Redistributions in binary form must reproduce the above copyright notice,
  33        this list of conditions and the following disclaimer in the documentation and/or
  34        other materials provided with the distribution.
  35      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  36        contributors may be used to endorse or promote products derived from this software
  37        without specific prior written permission.
  38
  39      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  40      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  41      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  42      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  43      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  45      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  46      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  47      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  48      POSSIBILITY OF SUCH DAMAGE.
  49
  50      Also contains code components extracted from IETF Interfaces.  These code components
  51      are copyrighted and licensed as follows:
  52
  53      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
  54      All rights reserved.
  55
  56      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
  57      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
  58      publication of this document. Please review these documents carefully, as they
  59      describe your rights and restrictions with respect to this document. Code Components
  60      extracted from this document must include Simplified BSD License text as described in
  61      Section 4.e of the Trust Legal Provisions and are provided without warranty as
  62      described in the Simplified BSD License.";
  63
  64   revision 2016-10-14 {
  65     description
  66       "Version 1.2";
  67   }
  68
  69   identity rate-identity {
  70     description
  71       "A unique rate identification";
  72   }
  73
  74   identity R200G {
  75     base rate-identity;
  76     description
  77       "Identity for 200G Rate";
  78   }
  79
  80   identity R100G {
  81     base rate-identity;
  82     description
  83       "Identity for 100G Rate";
  84   }
  85
  86   identity R10.7G {
  87     base rate-identity;
  88     description
  89       "Identity for 10.7G Rate";
  90   }
  91
  92   identity R11.1G {
  93     base rate-identity;
  94     description
  95       "Identity for 11.1G Rate";
  96   }
  97
  98   grouping och-attributes {
  99     description
 100       "Optical Channel attributes";
 101     leaf rate {
 102       type identityref {
 103         base rate-identity;
 104       }
 105       description
 106         "rate";
 107     }
 108     leaf wavelength-number {
 109       type uint32;
 110     }
 111     leaf modulation-format {
 112       type enumeration {
 113         enum "bpsk" {
 114           value 0;
 115           description
 116             "binary phase-shift keying";
 117         }
 118         enum "dc-dp-bpsk" {
 119           value 1;
 120           description
 121             "DC dual-polarization binary phase-shift keying";
 122         }
 123         enum "qpsk" {
 124           value 2;
 125           description
 126             "quadrature phase-shift keying";
 127         }
 128         enum "dp-qpsk" {
 129           value 3;
 130           description
 131             "dual-polarization binary phase-shift keying";
 132         }
 133         enum "qam16" {
 134           value 4;
 135           description
 136             "quadrature amplitude modulation 16";
 137         }
 138         enum "dp-qam16" {
 139           value 5;
 140           description
 141             "dual-polarization quadrature amplitude modulation 16";
 142         }
 143         enum "dc-dp-qam16" {
 144           value 6;
 145           description
 146             "DC dual-polarization quadrature amplitude modulation 16";
 147         }
 148         enum "qam8" {
 149           value 7;
 150           description
 151             "quadrature amplitude modulation 8";
 152         }
 153         enum "dp-qam8" {
 154           value 8;
 155           description
 156             "dual-polarization quadrature amplitude modulation 8";
 157         }
 158         enum "dc-dp-qam8" {
 159           value 9;
 160           description
 161             "DC dual-polarization quadrature amplitude modulation 8";
 162         }
 163       }
 164       description
 165         "modulation format";
 166     }
 167     leaf transmit-power {
 168       type org-openroadm-common-types:power-dBm;
 169       description
 170         "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";
 171     }
 172   }
 173
 174   grouping och-container {
 175     container och {
 176       description
 177         "Optical Channel (OCh):
 178          Models the optical channel interfaces for an Optical White Box.";
 179       uses och-attributes;
 180     }
 181   }
 182
 183   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 184     when "org-openroadm-device:type = 'openROADM-if:opticalChannel'";
 185     uses och-container;
 186   }
 187 }