data-model/yang/published/o-ran/ru-fh/o-ran-ethernet-forwarding@2021-12-01.yang

   1 module o-ran-ethernet-forwarding {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:ethernet-fwd:1.0";
   4   prefix "o-ran-eft";
   5
   6   import ietf-yang-types {
   7     prefix "yang";
   8   }
   9
  10   import o-ran-interfaces {
  11     prefix "or-if";
  12   }
  13
  14   import ietf-interfaces {
  15     prefix "if";
  16   }
  17
  18   organization "O-RAN Alliance";
  19
  20   contact
  21     "www.o-ran.org";
  22
  23   description
  24     "This module defines the Ethernet forwarding table of an O-RU.
  25     This is an option capability used when supporting 'shared cell' operation.
  26
  27     Copyright 2020 the O-RAN Alliance.
  28
  29     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  30     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  33     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  36     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  37     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39     POSSIBILITY OF SUCH DAMAGE.
  40
  41     Redistribution and use in source and binary forms, with or without
  42     modification, are permitted provided that the following conditions are met:
  43
  44     * Redistributions of source code must retain the above copyright notice,
  45     this list of conditions and the above disclaimer.
  46     * Redistributions in binary form must reproduce the above copyright notice,
  47     this list of conditions and the above disclaimer in the documentation
  48     and/or other materials provided with the distribution.
  49     * Neither the Members of the O-RAN Alliance nor the names of its
  50     contributors may be used to endorse or promote products derived from
  51     this software without specific prior written permission.";
  52
  53   revision "2021-12-01" {
  54     description
  55       "version 3.1.0
  56
  57       1. Typo corrections for british english";
  58
  59     reference "ORAN-WG4.M.0-v03.00";
  60   }
  61
  62
  63   revision "2020-04-17" {
  64     description
  65       "version 3.0.0
  66
  67       1. Initial version";
  68
  69     reference "ORAN-WG4.M.0-v03.00";
  70   }
  71
  72   grouping ethernet-ft {
  73     description
  74       "Ethernet forwarding table.";
  75
  76     leaf aging-time {
  77       type uint32 {
  78         range "10..10000000";
  79       }
  80       units "seconds";
  81       default "300";
  82       description
  83         "The timeout period in seconds for ageing out
  84         dynamically-learned forwarding information.";
  85     }
  86
  87     list filtering-entry {
  88       key "address vlan-id";
  89       config false;
  90       description
  91         "List of the entries within the Ethernet forwarding table.
  92         This list is keyed by the MAC address and VLAN of the Ethernet frame.";
  93
  94       leaf address {
  95         type yang:mac-address;
  96         description
  97           "A MAC address (unicast, multicast, broadcast) for
  98           which the device has forwarding and/or filtering
  99           information.";
 100       }
 101
 102       leaf vlan-id {
 103         type uint16 {
 104           range "0..4094";
 105         }
 106         description
 107           "VLAN-ID entry in the forwarding table, used during the
 108           look-up when receiving an in-coming Ethernet frame to determine
 109           how to forward.
 110
 111           A value of 0 indicates that the filtering entry is for an un-tagged
 112           frame/MAC address";
 113       }
 114
 115       list port-map {
 116         key "port-ref";
 117         description
 118           "The list of entries composing the port map.";
 119         leaf port-ref {
 120           type leafref {
 121             path "/if:interfaces/if:interface/or-if:port-reference/or-if:port-number";
 122             }
 123           description
 124             "The interface port reference associated with this map.";
 125         }
 126       }
 127     }
 128   }
 129
 130   container ethernet-forwarding-table {
 131     description "Top level container defining forwarding tables for Ethernet";
 132
 133     uses ethernet-ft;
 134   }
 135
 136 }