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