ordmodels/device/src/main/yang/org-openroadm-ethernet-interfaces@2016-10-14.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-02-06;
   8   }
   9   import org-openroadm-interfaces {
  10     prefix openROADM-if;
  11     revision-date 2016-10-14;
  12   }
  13
  14   organization "Open ROADM MSA";
  15   contact
  16     "OpenROADM.org";
  17   description
  18     "YANG definitions for device facility ethernet interfaces.
  19
  20      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  21      AT&T Intellectual Property.  All other rights reserved.
  22
  23      Redistribution and use in source and binary forms, with or without modification,
  24      are permitted provided that the following conditions are met:
  25
  26      * Redistributions of source code must retain the above copyright notice, this
  27        list of conditions and the following disclaimer.
  28      * Redistributions in binary form must reproduce the above copyright notice,
  29        this list of conditions and the following disclaimer in the documentation and/or
  30        other materials provided with the distribution.
  31      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  32        contributors may be used to endorse or promote products derived from this software
  33        without specific prior written permission.
  34
  35      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  36      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  37      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  38      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  39      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  40      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  41      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  42      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  43      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  44      POSSIBILITY OF SUCH DAMAGE.
  45
  46      Also contains code components extracted from IETF Interfaces.  These code components
  47      are copyrighted and licensed as follows:
  48
  49      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
  50      All rights reserved.
  51
  52      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
  53      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
  54      publication of this document. Please review these documents carefully, as they
  55      describe your rights and restrictions with respect to this document. Code Components
  56      extracted from this document must include Simplified BSD License text as described in
  57      Section 4.e of the Trust Legal Provisions and are provided without warranty as
  58      described in the Simplified BSD License.";
  59
  60   revision 2016-10-14 {
  61     description
  62       "Version 1.2";
  63   }
  64
  65   grouping eth-attributes {
  66     leaf speed {
  67       type uint32;
  68       description
  69         "Set speed of the interface, unit mbps.
  70          This is for ETH facility. ";
  71     }
  72     leaf fec {
  73       type enumeration {
  74         enum off;
  75         enum rsfec;
  76       }
  77       description "Forward Error Correction Choices. ";
  78     }
  79     leaf duplex {
  80       type enumeration {
  81         enum "half" {
  82           value 0;
  83           description
  84             "half duplex";
  85         }
  86         enum "full" {
  87           value 1;
  88           description
  89             "full duplex";
  90         }
  91       }
  92       default "full";
  93       description
  94         "Set duplex selections.";
  95     }
  96     leaf mtu {
  97       type uint32 {
  98         range "1518..9000";
  99       }
 100       default "1522";
 101       description
 102         "Set Maximum Frame Size.";
 103     }
 104     leaf auto-negotiation {
 105       type enumeration {
 106         enum "enabled" {
 107           value 1;
 108           description
 109             "Auto Negotiation enabled";
 110         }
 111         enum "disabled" {
 112           value 0;
 113           description
 114             "Auto Negotiation disabled";
 115         }
 116       }
 117       default "enabled";
 118       description
 119         "Set Auto Negotiation: Enabled/Disabled.";
 120     }
 121     leaf curr-speed {
 122       config false;
 123       type string;
 124       description
 125         "speed (UNKNOWN/AUTO/10/100/1000/10000) corresponding to the interface";
 126     }
 127     leaf curr-duplex {
 128       config false;
 129       type string;
 130       description
 131         "duplex (HALF/FULL) corresponding to the interface";
 132     }
 133   }
 134
 135   grouping ethernet-container {
 136     container ethernet {
 137       description
 138         "Ethernet Interfaces";
 139       uses eth-attributes;
 140     }
 141   }
 142
 143   augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
 144     when "org-openroadm-device:type = 'openROADM-if:ethernetCsmacd'";
 145     uses ethernet-container;
 146   }
 147 }