data-model/yang/working/o-ran-sc/o-ran-sc-topology/o-ran-sc-topology-common.yang

   1 module o-ran-sc-topology-common {
   2   yang-version 1.1;
   3   namespace "urn:o-ran-sc:yang:o-ran-sc-topology-common:1.0";
   4   prefix osctc;
   5
   6   import ietf-interfaces {
   7     prefix if;
   8   }
   9
  10   organization
  11     "O-RAN Software Community";
  12   contact
  13     "www.o-ran.org";
  14   description
  15     "This module contains YANG definitions for the O-RAN Topology augmentation
  16      of TAPI Topology used as network model.
  17
  18      Copyright 2022 the O-RAN Software Community.
  19
  20      Licensed under the Apache License, Version 2.0 (the 'License');
  21      you may not use this file except in compliance with the License.
  22      You may obtain a copy of the License at
  23
  24      http://www.apache.org/licenses/LICENSE-2.0
  25
  26      Unless required by applicable law or agreed to in writing, software
  27      distributed under the License is distributed on an 'AS IS' BASIS,
  28      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  29      See the License for the specific language governing permissions and
  30      limitations under the License.";
  31
  32   revision 2022-02-05 {
  33     description
  34       "Initial revision";
  35     reference
  36       "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-248
  37        O-RAN.WG1.O-RAN-Architecture-Description
  38        Chapter: 1.3.1\tDefinitions";
  39   }
  40
  41   // O-RAN functional identity types
  42
  43   identity function-type {
  44     description
  45       "Base identity as abstract function type for by O-RAN Alliance and others
  46        entities.
  47        An unique identification of a (network) function.
  48
  49        This identity is abstract and MUST NOT be used for alarms.";
  50     reference
  51       "O-RAN.WG1.O-RAN-Architecture-Description
  52        Chapter: 1.3.1\tDefinitions
  53        https://jira.o-ran-sc.org/browse/OAM-248";
  54   }
  55
  56   identity smo {
  57     base function-type;
  58     description
  59       "An identity corresponding to an
  60        O-RAN Service Management and Orchestration Function (SMO).";
  61   }
  62
  63   identity non-rt-ric {
  64     base function-type;
  65     description
  66       "An identity corresponding to an
  67        O-RAN Service Management and Orchestration SMO component corresponding to
  68        a Non-real-time RAN Intelligent Controller Function (Near-RT-RIC).";
  69   }
  70
  71   identity oam-controller {
  72     base function-type;
  73     description
  74       "An identity corresponding to an
  75        O-RAN Service Management and Orchestration SMO component corresponding to
  76        an Operation and Maintenance Controller Controller Function
  77        (OAM Controller).";
  78   }
  79
  80   identity ves-collector {
  81     base function-type;
  82     description
  83       "An identity corresponding to an
  84        O-RAN Service Management and Orchestration SMO component corresponding to
  85        an (Virtual) Event Streaming Collector Function
  86        (VES Collector).";
  87   }
  88
  89   identity message-router {
  90     base function-type;
  91     description
  92       "An identity corresponding to an
  93        O-RAN Service Management and Orchestration SMO component corresponding to
  94        Message Router Function (MR).";
  95   }
  96
  97   identity transport-node {
  98     base function-type;
  99     description
 100       "An identity corresponding to a Transport Node Function
 101        (such as  Transponders, Muxponders, ROADM, Wavelength Selected Switch,
 102        Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter,
 103        Optical Multiplexer, Microwave Terminal, Carrier Ethernet Routers, ... .";
 104   }
 105
 106   identity fronthaul-gateway {
 107     base function-type;
 108     description
 109       "An identity corresponding to an O-RAN Fronthaul Gateway Function.";
 110   }
 111
 112   identity fronthaul-multiplexer {
 113     base function-type;
 114     description
 115       "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
 116   }
 117
 118   identity near-rt-ric {
 119     base function-type;
 120     description
 121       "An identity corresponding to an O-RAN Near real-time RAN intelligent
 122        controller Function (NEar-RT-RIC).";
 123   }
 124
 125   identity managed-application {
 126     base function-type;
 127     description
 128       "An identity corresponding to an O-RAN Managed Application Function (MA),
 129        also called 'xApp'.";
 130   }
 131
 132   identity o-cu {
 133     base function-type;
 134     description
 135       "An identity corresponding to an O-RAN Central Unit Functions.";
 136   }
 137
 138   identity o-cu-up {
 139     base function-type;
 140     description
 141       "An identity corresponding to an O-RAN Central Unit User Plane Function.";
 142   }
 143
 144   identity o-cu-cp {
 145     base function-type;
 146     description
 147       "An identity corresponding to an O-RAN Central Unit Control Plane
 148        Function.";
 149   }
 150
 151   identity o-du {
 152     base function-type;
 153     description
 154       "An identity corresponding to an O-RAN Distributed Unit Function.";
 155   }
 156
 157   identity o-ru {
 158     base function-type;
 159     description
 160       "An identity corresponding to an O-RAN Radio Unit Function.";
 161   }
 162
 163   identity o-enb {
 164     base function-type;
 165     description
 166       "An identity corresponding to an O-RAN E-UTRAN Node B Function.
 167        E-UTRAN: evolved UMTS Terrestrial Radio Access";
 168   }
 169
 170   identity user-equipment {
 171     base function-type;
 172     description
 173       "An identity corresponding to an User Equipment Function.";
 174   }
 175
 176   identity o-cloud-ims {
 177     base function-type;
 178     description
 179       "An identity corresponding to an Infrastructure Management Service
 180        Function (IMS).";
 181   }
 182
 183   identity o-cloud-dms {
 184     base function-type;
 185     description
 186       "An identity corresponding to a
 187        Deployment Management Service Function (DMS).";
 188   }
 189
 190   // O-RAN interface types
 191
 192   identity interface-type {
 193     base if:interface-type;
 194     description
 195       "Base identity for interface types used in RAN, Transport and Core.
 196        A unique identification of the management interface.
 197        This identity is abstract and MUST NOT be used as a value.";
 198   }
 199
 200   identity a1 {
 201     base interface-type;
 202     description
 203       "An identity for the a1 interface between Non-RT-RIC and Near-RT-RIC.";
 204   }
 205
 206   identity e1 {
 207     base interface-type;
 208     description
 209       "An identity for the e1 interface defined by 3GPP.";
 210   }
 211
 212   identity e2 {
 213     base interface-type;
 214     description
 215       "An identity for the e2 interface as defined by O-RAN Alliance.";
 216   }
 217
 218   identity o1 {
 219     base interface-type;
 220     description
 221       "An identity for the operation and maintenance management interface
 222        for network functions as defined by the O-RAN-Alliance as extension
 223        to 3GPP NG NRM.";
 224   }
 225
 226   identity o2 {
 227     base interface-type;
 228     description
 229       "An identity for the operation and maintenance management interface
 230        for a cloud infrastructure service and a could deployment service
 231        (O-Cloud).";
 232   }
 233
 234   identity open-fronthaul-management-plane {
 235     base interface-type;
 236     description
 237       "An identity for the operation and maintenance management interface for
 238        O-RU functions.";
 239   }
 240
 241   identity transport-management-interface {
 242     base interface-type;
 243     description
 244       "An identity for a yang based management interface for transport nodes.";
 245   }
 246 }