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   import tapi-common {
  10     prefix tapi-common;
  11   }
  12
  13   organization
  14     "O-RAN Software Community";
  15   contact
  16     "www.o-ran.org";
  17   description
  18     "This module contains YANG definitions for the O-RAN Topology augmentation
  19      of TAPI Topology used as network model.
  20
  21      Copyright 2022 the O-RAN Software Community.
  22
  23      Licensed under the Apache License, Version 2.0 (the 'License');
  24      you may not use this file except in compliance with the License.
  25      You may obtain a copy of the License at
  26
  27      http://www.apache.org/licenses/LICENSE-2.0
  28
  29      Unless required by applicable law or agreed to in writing, software
  30      distributed under the License is distributed on an 'AS IS' BASIS,
  31      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  32      See the License for the specific language governing permissions and
  33      limitations under the License.";
  34
  35   revision 2022-05-26 {
  36     description
  37       "SCTP protocol added for E2 interfaces";
  38     reference
  39       "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-269";
  40   }
  41   revision 2022-03-06 {
  42     description
  43       "Initial revision";
  44     reference
  45       "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-255";
  46   }
  47   revision 2022-02-05 {
  48     description
  49       "Initial revision";
  50     reference
  51       "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-248
  52        O-RAN.WG1.O-RAN-Architecture-Description
  53        Chapter: 1.3.1\tDefinitions";
  54   }
  55
  56   // O-RAN functional identity types
  57
  58   identity function-type {
  59     description
  60       "Base identity as abstract function type for by O-RAN Alliance and others
  61        entities.
  62        An unique identification of a (network) function.
  63
  64        This identity is abstract and MUST NOT be used for alarms.";
  65     reference
  66       "O-RAN.WG1.O-RAN-Architecture-Description
  67        Chapter: 1.3.1\tDefinitions
  68        https://jira.o-ran-sc.org/browse/OAM-248";
  69   }
  70
  71   identity smo {
  72     base function-type;
  73     description
  74       "An identity corresponding to an
  75        O-RAN Service Management and Orchestration Function (SMO).";
  76   }
  77
  78   identity o-cloud {
  79     base function-type;
  80     description
  81       "An identity corresponding to an O-RAN Cloud component (O-Cloud).";
  82   }
  83
  84   identity non-rt-ric {
  85     base function-type;
  86     description
  87       "An identity corresponding to an
  88        O-RAN Service Management and Orchestration SMO component corresponding to
  89        a Non-real-time RAN Intelligent Controller Function (Near-RT-RIC).";
  90   }
  91
  92   identity oam-controller {
  93     base function-type;
  94     description
  95       "An identity corresponding to an
  96        O-RAN Service Management and Orchestration SMO component corresponding to
  97        an Operation and Maintenance Controller Controller Function
  98        (OAM Controller).";
  99   }
 100
 101   identity ves-collector {
 102     base function-type;
 103     description
 104       "An identity corresponding to an
 105        O-RAN Service Management and Orchestration SMO component corresponding to
 106        an (Virtual) Event Streaming Collector Function
 107        (VES Collector).";
 108   }
 109
 110   identity message-router {
 111     base function-type;
 112     description
 113       "An identity corresponding to an
 114        O-RAN Service Management and Orchestration SMO component corresponding to
 115        Message Router Function (MR).";
 116   }
 117
 118   identity transport-node {
 119     base function-type;
 120     description
 121       "An identity corresponding to a Transport Node Function
 122        (such as  Transponders, Muxponders, ROADM, Wavelength Selected Switch,
 123        Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter,
 124        Optical Multiplexer, Microwave Terminal, Carrier Ethernet Routers, ... .";
 125   }
 126
 127   identity fronthaul-gateway {
 128     base function-type;
 129     description
 130       "An identity corresponding to an O-RAN Fronthaul Gateway Function.";
 131   }
 132
 133   identity fronthaul-multiplexer {
 134     base function-type;
 135     description
 136       "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
 137   }
 138
 139   identity access-and-mobility-management-function {
 140     base function-type;
 141     description
 142       "An identity corresponding to a 3GPP 5G-Core Access and mobility Management Function (AMF).";
 143   }
 144
 145   identity user-plane-function {
 146     base function-type;
 147     description
 148       "An identity corresponding to a3GPP 5G-Core User Plane Function (UPF).";
 149   }
 150
 151   identity near-rt-ric {
 152     base function-type;
 153     description
 154       "An identity corresponding to an O-RAN Near real-time RAN intelligent
 155        controller Function (Near-RT-RIC).";
 156   }
 157
 158   identity managed-application {
 159     base function-type;
 160     description
 161       "An identity corresponding to an O-RAN Managed Application Function (MA),
 162        also called 'xApp'.";
 163   }
 164
 165   identity o-cu {
 166     base function-type;
 167     description
 168       "An identity corresponding to an O-RAN Central Unit Functions.";
 169   }
 170
 171   identity o-cu-up {
 172     base function-type;
 173     description
 174       "An identity corresponding to an O-RAN Central Unit User Plane Function.";
 175   }
 176
 177   identity o-cu-cp {
 178     base function-type;
 179     description
 180       "An identity corresponding to an O-RAN Central Unit Control Plane
 181        Function.";
 182   }
 183
 184   identity o-du {
 185     base function-type;
 186     description
 187       "An identity corresponding to an O-RAN Distributed Unit Function.";
 188   }
 189
 190   identity o-ru {
 191     base function-type;
 192     description
 193       "An identity corresponding to an O-RAN Radio Unit Function.";
 194   }
 195
 196   identity o-enb {
 197     base function-type;
 198     description
 199       "An identity corresponding to an O-RAN E-UTRAN Node B Function.
 200        E-UTRAN: evolved UMTS Terrestrial Radio Access";
 201   }
 202
 203   identity user-equipment {
 204     base function-type;
 205     description
 206       "An identity corresponding to an User Equipment Function.";
 207   }
 208
 209   identity o-cloud-ims {
 210     base function-type;
 211     description
 212       "An identity corresponding to an Infrastructure Management Service
 213        Function (IMS).";
 214   }
 215
 216   identity o-cloud-dms {
 217     base function-type;
 218     description
 219       "An identity corresponding to a
 220        Deployment Management Service Function (DMS).";
 221   }
 222
 223   // O-RAN interface types
 224
 225   identity interface-type {
 226     base if:interface-type;
 227     description
 228       "Base identity for interface types used in RAN, Transport and Core.
 229        A unique identification of the management interface.
 230        This identity is abstract and MUST NOT be used as a value.";
 231   }
 232
 233   identity a1 {
 234     base interface-type;
 235     description
 236       "An identity for the a1 interface between Non-RT-RIC and Near-RT-RIC.";
 237   }
 238
 239   identity e1 {
 240     base interface-type;
 241     description
 242       "An identity for the e1 interface defined by 3GPP.";
 243   }
 244
 245   identity e2 {
 246     base interface-type;
 247     description
 248       "An identity for the e2 interface as defined by O-RAN Alliance.";
 249   }
 250
 251   identity n1 {
 252     base interface-type;
 253     description
 254       "An identity for the n1 interface as defined by 3GPP.";
 255     reference
 256       "3GPP TS 23.501 System architecture for the 5G System (5GS)";
 257   }
 258
 259   identity n2 {
 260     base interface-type;
 261     description
 262       "An identity for the n1 interface as defined by 3GPP.";
 263     reference
 264       "3GPP TS 23.501 System architecture for the 5G System (5GS)";
 265   }
 266
 267   identity n3 {
 268     base interface-type;
 269     description
 270       "An identity for the n1 interface as defined by 3GPP.";
 271     reference
 272       "3GPP TS 23.501 System architecture for the 5G System (5GS)";
 273   }
 274
 275   identity o1 {
 276     base interface-type;
 277     description
 278       "An identity for the operation and maintenance management interface
 279        for network functions as defined by the O-RAN-Alliance as extension
 280        to 3GPP NG NRM.";
 281   }
 282
 283   identity o2 {
 284     base interface-type;
 285     description
 286       "An identity for the operation and maintenance management interface
 287        for a cloud infrastructure service and a could deployment service
 288        (O-Cloud).";
 289   }
 290
 291   identity open-fronthaul-management-plane {
 292     base interface-type;
 293     description
 294       "An identity for the operation and maintenance management interface for
 295        O-RU functions.";
 296   }
 297
 298   identity transport-management-interface {
 299     base interface-type;
 300     description
 301       "An identity for a yang based management interface for transport nodes.";
 302   }
 303
 304   // O-RAN-SC LAYER_PROTOCOL_QUALIFIER
 305
 306   identity LAYER_PROTOCOL_QUALIFIER {
 307     base tapi-common:LAYER_PROTOCOL_QUALIFIER;
 308     description
 309       "Base identity for layer protocol qualifiers used in RAN, Transport and Core.
 310        A unique identification of layer protocol qualifiers.
 311        Typically the layer protocol qualifier is used to identify the interface
 312        protocol, like VES or NETCONF.
 313        This identity is abstract and MUST NOT be used as a value.";
 314   }
 315
 316   identity unknown {
 317     base LAYER_PROTOCOL_QUALIFIER;
 318     description
 319       "An identity for an unknown qualifier.";
 320   }
 321
 322   identity file {
 323     base LAYER_PROTOCOL_QUALIFIER;
 324     description
 325       "An identity for a FILE transfer protocol qualifier.";
 326   }
 327
 328   identity grpc {
 329     base LAYER_PROTOCOL_QUALIFIER;
 330     description
 331       "An identity for an generic remote procedure call (gRPC) protocol qualifier.";
 332   }
 333
 334   identity nas {
 335     base LAYER_PROTOCOL_QUALIFIER;
 336     description
 337       "An identity for a Non-access stratum protocol qualifier.";
 338     reference
 339       "3GPP TS 24.301\tNon-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3";
 340   }
 341
 342   identity netconf {
 343     base LAYER_PROTOCOL_QUALIFIER;
 344     description
 345       "An identity for a NETCONF protocol qualifier.";
 346   }
 347
 348   identity radio {
 349     base LAYER_PROTOCOL_QUALIFIER;
 350     description
 351       "An identity for a Radio protocol qualifier.";
 352   }
 353
 354   identity rest {
 355     base LAYER_PROTOCOL_QUALIFIER;
 356     description
 357       "An identity for a REST protocol qualifier.";
 358   }
 359
 360   identity restconf {
 361     base LAYER_PROTOCOL_QUALIFIER;
 362     description
 363       "An identity for a RESTCONF protocol qualifier.";
 364   }
 365
 366   identity ves {
 367     base LAYER_PROTOCOL_QUALIFIER;
 368     description
 369       "An identity for an REST based event stream (VES) protocol qualifier.";
 370   }
 371
 372   identity ofh {
 373     base LAYER_PROTOCOL_QUALIFIER;
 374     description
 375       "An identity for an O-RAN Fronthaul based protocol qualifier.";
 376   }
 377
 378   identity sctp {
 379     base LAYER_PROTOCOL_QUALIFIER;
 380     description
 381       "An identity for an Stream Control Transmission Protocol (SCTP)  based
 382        protocol qualifier.";
 383     reference
 384       "RFC 8261,
 385        RFC 4960";
 386   }
 387 }