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

   1 module org-openroadm-ethernet-interfaces {
   2   namespace "http://org/openroadm/ethernet-interfaces";
   3   prefix org-openroadm-eth-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
  14   organization
  15     "Open ROADM MSA";
  16   contact
  17     "OpenROADM.org";
  18   description
  19     "YANG definitions for device facility ethernet 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 2017-12-15 {
  62     description
  63       "Version 2.2";
  64   }
  65   revision 2017-09-29 {
  66     description
  67       "Version 2.1";
  68   }
  69   revision 2017-07-28 {
  70     description
  71       "Version 2.0.1 - added revision-date to imports";
  72   }
  73   revision 2016-10-14 {
  74     description
  75       "Version 1.2";
  76   }
  77
  78   grouping eth-attributes {
  79     leaf speed {
  80       type uint32;
  81       description
  82         "Set speed of the interface, unit mbps.
  83          This is for ETH facility. ";
  84     }
  85     leaf fec {
  86       type enumeration {
  87         enum "off";
  88         enum "rsfec";
  89       }
  90       description
  91         "Forward Error Correction Choices. ";
  92     }
  93     leaf duplex {
  94       type enumeration {
  95         enum "half" {
  96           value 0;
  97           description
  98             "half duplex";
  99         }
 100         enum "full" {
 101           value 1;
 102           description
 103             "full duplex";
 104         }
 105       }
 106       default "full";
 107       description
 108         "Set duplex selections.";
 109     }
 110     leaf mtu {
 111       type uint32 {
 112         range "1518..9000";
 113       }
 114       default "1522";
 115       description
 116         "Set Maximum Frame Size.";
 117     }
 118     leaf auto-negotiation {
 119       type enumeration {
 120         enum "enabled" {
 121           value 1;
 122           description
 123             "Auto Negotiation enabled";
 124         }
 125         enum "disabled" {
 126           value 0;
 127           description
 128             "Auto Negotiation disabled";
 129         }
 130       }
 131       default "enabled";
 132       description
 133         "Set Auto Negotiation: Enabled/Disabled.";
 134     }
 135     leaf curr-speed {
 136       type string;
 137       config false;
 138       description
 139         "speed (UNKNOWN/AUTO/10/100/1000/10000) corresponding to the interface";
 140     }
 141     leaf curr-duplex {
 142       type string;
 143       config false;
 144       description
 145         "duplex (HALF/FULL) corresponding to the interface";
 146     }
 147   }
 148
 149   grouping ethernet-container {
 150     container ethernet {
 151       description
 152         "Ethernet Interfaces";
 153       uses eth-attributes;
 154     }
 155   }
 156
 157   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 158     when "org-openroadm-device:type = 'openROADM-if:ethernetCsmacd'";
 159     uses ethernet-container;
 160   }
 161 }