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   Definitions";
  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
  51     reference
  52       "O-RAN.WG1.O-RAN-Architecture-Description
  53        Chapter: 1.3.1   Definitions
  54        https://jira.o-ran-sc.org/browse/OAM-248";
  55   }
  56
  57   identity smo {
  58     base function-type;
  59     description
  60       "An identity corresponding to an
  61        O-RAN Service Management and Orchestration Function (SMO).";
  62   }
  63
  64   identity non-rt-ric {
  65     base function-type;
  66     description
  67       "An identity corresponding to an
  68        O-RAN Service Management and Orchestration SMO component corresponding to
  69        a Non-real-time RAN Intelligent Controller Function (Near-RT-RIC).";
  70   }
  71
  72   identity oam-controller {
  73     base function-type;
  74     description
  75       "An identity corresponding to an
  76        O-RAN Service Management and Orchestration SMO component corresponding to
  77        an Operation and Maintenance Controller Controller Function
  78        (OAM Controller).";
  79   }
  80
  81   identity ves-collector {
  82     base function-type;
  83     description
  84       "An identity corresponding to an
  85        O-RAN Service Management and Orchestration SMO component corresponding to
  86        an (Virtual) Event Streaming Collector Function
  87        (VES Collector).";
  88   }
  89
  90   identity message-router {
  91     base function-type;
  92     description
  93       "An identity corresponding to an
  94        O-RAN Service Management and Orchestration SMO component corresponding to
  95        Message Router Function (MR).";
  96   }
  97
  98   identity transport-node {
  99     base function-type;
 100     description
 101       "An identity corresponding to a Transport Node Function
 102        (such as  Transponders, Muxponders, ROADM, Wavelength Selected Switch,
 103        Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter,
 104        Optical Multiplexer, Microwave Terminal, Carrier Ethernet Routers, ... .";
 105   }
 106
 107   identity fronthaul-gateway {
 108     base function-type;
 109     description
 110       "An identity corresponding to an O-RAN Fronthaul Gateway Function.";
 111   }
 112
 113   identity fronthaul-multiplexer {
 114     base function-type;
 115     description
 116       "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
 117   }
 118
 119   identity near-rt-ric {
 120     base function-type;
 121     description
 122       "An identity corresponding to an O-RAN Near real-time RAN intelligent
 123        controller Function (NEar-RT-RIC).";
 124   }
 125
 126   identity managed-application {
 127     base function-type;
 128     description
 129       "An identity corresponding to an O-RAN Managed Application Function (MA),
 130        also called 'xApp'.";
 131   }
 132
 133   identity o-cu {
 134     base function-type;
 135     description
 136       "An identity corresponding to an O-RAN Central Unit Functions.";
 137   }
 138
 139   identity o-cu-up {
 140     base o-cu-function-type;
 141     description
 142       "An identity corresponding to an O-RAN Central Unit User Plane Function.";
 143   }
 144
 145   identity o-cu-cp {
 146     base o-cu-function-type;
 147     description
 148       "An identity corresponding to an O-RAN Central Unit Control Plane
 149        Function.";
 150   }
 151
 152   identity o-du {
 153     base function-type;
 154     description
 155       "An identity corresponding to an O-RAN Distributed Unit Function.";
 156   }
 157
 158   identity o-ru {
 159     base function-type;
 160     description
 161       "An identity corresponding to an O-RAN Radio Unit Function.";
 162   }
 163
 164   identity o-enb {
 165     base function-type;
 166     description
 167       "An identity corresponding to an O-RAN E-UTRAN Node B Function.
 168        E-UTRAN: evolved UMTS Terrestrial Radio Access";
 169   }
 170
 171   identity user-equipment {
 172     base function-type;
 173     description
 174       "An identity corresponding to an User Equipment Function.";
 175   }
 176
 177   identity o-cloud-ims {
 178     base function-type;
 179     description
 180       "An identity corresponding to an Infrastructure Management Service
 181        Function (IMS).";
 182   }
 183
 184   identity o-cloud-dms {
 185     base function-type;
 186     description
 187       "An identity corresponding to a
 188        Deployment Management Service Function (DMS).";
 189   }
 190
 191   // O-RAN interface types
 192
 193   identity interface-type {
 194     base if:interface-type
 195     description
 196       "Base identity for interface types used in RAN, Transport and Core.
 197        A unique identification of the management interface.
 198        This identity is abstract and MUST NOT be used as a value.";
 199   }
 200
 201   identity a1 {
 202     base interface-type;
 203     description
 204       "An identity for the a1 interface between Non-RT-RIC and Near-RT-RIC.";
 205   }
 206
 207   identity e1 {
 208     base interface-type;
 209     description
 210       "An identity for the e1 interface defined by 3GPP.";
 211   }
 212
 213   identity e2 {
 214     base interface-type;
 215     description
 216       "An identity for the e2 interface as defined by O-RAN Alliance.";
 217   }
 218
 219   identity o1 {
 220     base interface-type;
 221     description
 222       "An identity for the operation and maintenance management interface
 223        for network functions as defined by the O-RAN-Alliance as extension
 224        to 3GPP NG NRM.";
 225   }
 226
 227   identity o2 {
 228     base interface-type;
 229     description
 230       "An identity for the operation and maintenance management interface
 231        for a cloud infrastructure service and a could deployment service
 232        (O-Cloud).";
 233   }
 234
 235   identity open-fronthaul-management-plane {
 236     base interface-type;
 237     description
 238       "An identity for the operation and maintenance management interface for
 239        O-RU functions.";
 240   }
 241
 242   identity transport-management-interface {
 243     base interface-type;
 244     description
 245       "An identity for a yang based management interface for transport nodes.";
 246   }
 247 }