ntsimulator/deploy/smo-nts-ng-topology-server/yang/o-ran-common-identity-refs.yang

   1 module o-ran-common-identity-refs {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:wg1identityref:1.0";
   4   prefix o-ran-iref;
   5
   6   import iana-hardware {
   7     prefix ianahw;
   8   }
   9
  10   organization
  11     "O-RAN Alliance";
  12   contact
  13     "www.o-ran.org";
  14   description
  15     "This module defines a set of re-usable identity references, that can be
  16      re-used across O-RAN working groups.
  17
  18      Copyright 2021 the O-RAN Alliance.
  19
  20      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  21      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22      IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23      ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  24      LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25      CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27      INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28      CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30      POSSIBILITY OF SUCH DAMAGE.
  31
  32      Redistribution and use in source and binary forms, with or without
  33      modification, are permitted provided that the following conditions are met:
  34
  35      * Redistributions of source code must retain the above copyright notice,
  36      this list of conditions and the above disclaimer.
  37      * Redistributions in binary form must reproduce the above copyright notice,
  38      this list of conditions and the above disclaimer in the documentation
  39      and/or other materials provided with the distribution.
  40      * Neither the Members of the O-RAN Alliance nor the names of its
  41      contributors may be used to endorse or promote products derived from
  42      this software without specific prior written permission.";
  43
  44   revision 2021-10-12 {
  45     description
  46       "O-RAN SC: added SMO and UE functions";
  47     reference
  48       "O-RAN SC SIM project.";
  49   }
  50
  51   revision 2021-07-16 {
  52     description
  53       "version 1.0.1
  54
  55        1) Updates according to change requests:
  56          CR#xyz
  57          CR#xyz";
  58     reference
  59       "O-RAN-WG2.IM.0-v02.00";
  60   }
  61   revision 2020-11-01 {
  62     description
  63       "version 1.0.0
  64
  65        1) initial version.";
  66     reference
  67       "ORAN-WG1.IM.0-v01.00";
  68   }
  69
  70   // O-RAN functional identity types
  71
  72   identity o-ran-function-base {
  73     description
  74       "Base identity from which all O-RAN defined functions are derived.
  75        This identity is abstract and MUST NOT be used as a value.";
  76     reference
  77       "O-RAN.WG1.O-RAN-Architecture-Description
  78        Chapter: 1.3.1   Definitions";
  79   }
  80
  81   identity o-ru-function {
  82     base o-ran-function-base;
  83     description
  84       "An identity corresponding to an O-RAN Radio Unit Function.";
  85   }
  86
  87   identity o-du-function {
  88     base o-ran-function-base;
  89     description
  90       "An identity corresponding to an O-RAN Distributed Unit Function.";
  91   }
  92
  93   identity o-cu-function {
  94     base o-ran-function-base;
  95     description
  96       "An identity corresponding to all O-RAN Central Unit Functions.
  97        This identity is abstract and MUST NOT be used as a value.";
  98   }
  99
 100   identity o-cu-up-function {
 101     base o-cu-function;
 102     description
 103       "An identity corresponding to an O-RAN Central Unit User Plane Function.";
 104   }
 105
 106   identity o-cu-cp-function {
 107     base o-cu-function;
 108     description
 109       "An identity corresponding to an O-RAN Central Unit Control Plane
 110        Function.";
 111   }
 112
 113   identity o-enb-function {
 114     base o-ran-function-base;
 115     description
 116       "An identity corresponding to an O-RAN E-UTRAN Node B Function.
 117        E-UTRAN: evolved UMTS Terrestrial Radio Access";
 118   }
 119
 120   identity near-rt-ric-function {
 121     base o-ran-function-base;
 122     description
 123       "An identity corresponding to an O-RAN Near real-time RAN intelligent
 124        controller Function.";
 125   }
 126
 127   identity user-equipment-function {
 128     base o-ran-function-base;
 129     description
 130       "An identity corresponding to an UE Function.";
 131   }
 132
 133   identity smo-function {
 134     base o-ran-function-base;
 135     description
 136       "An identity corresponding to an O-RAN SMO Function.";
 137   }
 138
 139   identity managed-application-function {
 140     base o-ran-function-base;
 141     description
 142       "An identity corresponding to an O-RAN managed application function
 143        (also called 'xApp').";
 144   }
 145
 146   // TODO to be aligned with OAM Architecture
 147   //      2021-07-21: email to Lyndon send - CR required
 148
 149   identity fronthaul-gateway-function {
 150     base o-ran-function-base;
 151     description
 152       "An identity corresponding to an O-RAN Fronthaul Gateway Function.";
 153   }
 154
 155   identity fronthaul-multiplexer-function {
 156     base o-ran-function-base;
 157     description
 158       "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
 159   }
 160
 161   identity transport-node-function {
 162     base o-ran-function-base;
 163     description
 164       "An identity corresponding to a Transport Node Function
 165        (such as  Transponders, Muxponders, ROADM, Wavelength Selected Switch,
 166        Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter,
 167        Optical Multiplexer, Microwave Terminal, Carrier Ethernet Routers, ... .";
 168   }
 169
 170   identity o-cloud-ims-function {
 171     base o-ran-function-base;
 172     description
 173       "An identity corresponding to an Infrastructure Management Service
 174        Function.";
 175   }
 176
 177   identity o-cloud-dms-function {
 178     base o-ran-function-base;
 179     description
 180       "An identity corresponding to a Deployment Management Service Function.";
 181   }
 182
 183   // O-RAN radio technology identity types
 184
 185   identity o-ran-radio-technology-base {
 186     description
 187       "Base identity for O-RAN defined radio technology types.
 188
 189        This identity is abstract and MUST NOT be used as a value.";
 190   }
 191
 192   identity new-radio-technology {
 193     base o-ran-radio-technology-base;
 194     description
 195       "An identity corresponding to new radio technology.
 196
 197        This identity is abstract and MUST NOT be used as a value.";
 198   }
 199
 200   identity lte-technology {
 201     base o-ran-radio-technology-base;
 202     description
 203       "An identity corresponding to lte technology.
 204
 205        This identity is abstract and MUST NOT be used as a value.";
 206   }
 207
 208   identity nb-iot {
 209     base lte-technology;
 210     description
 211       "An identity corresponding to nb-iot technology.
 212
 213        This identity is abstract and MUST NOT be used as a value.";
 214   }
 215
 216   // O-RAN Transport technology identity types
 217
 218   identity o-ran-transport-technology-base {
 219     description
 220       "Base identity from which all O-RAN defined transport technology identities are derived.
 221
 222        This identity is abstract and MUST NOT be used as a value.";
 223   }
 224
 225   // O-RAN Fronthaul transport identity types
 226
 227   identity o-ran-fronthaul-transport-base {
 228     description
 229       "Base identity from which all O-RAN defined fronthaul transports are derived.
 230
 231        This identity is abstract and MUST NOT be used as a value.";
 232   }
 233
 234   identity ethernet-fronthaul-transport {
 235     base o-ran-fronthaul-transport-base;
 236     description
 237       "an identity corresponding to fronthaul transport using ethernet based flows.
 238
 239        This identity is abstract and MUST NOT be used as a value.";
 240   }
 241
 242   // Hardware component identity types
 243
 244   identity o-ran-module {
 245     base ianahw:module;
 246     description
 247       "Any O-RAN module that represents a self-contained sub-system.
 248
 249        This identity is abstract and MUST NOT be used as a value.";
 250   }
 251
 252   identity o-ran-hardware-class {
 253     base ianahw:hardware-class;
 254     description
 255       "This identity corresponding to a generic O-RAN hardware class.
 256
 257        This identity is abstract and MUST NOT be used as a value.";
 258   }
 259
 260   identity fpga {
 261     base o-ran-hardware-class;
 262     description
 263       "Represent an FPGA.
 264
 265        This identity is abstract and MUST NOT be used as a value.";
 266   }
 267
 268   // O-RAN management interface identifiers
 269
 270   identity management-interface-id {
 271     description
 272       "Base identity for entity types. A unique identification of the
 273        management interface.
 274        This identity is abstract and MUST NOT be used for entries.";
 275   }
 276
 277   identity o1 {
 278     base management-interface-id;
 279     description
 280       "An identity for the operation and maintenance management interface
 281        for network functions as defined by the O-RAN-Alliance WG10 as extension
 282        to 3GPP NG NRM.";
 283     reference
 284       "O-RAN OAM Interface Specification by WG10";
 285   }
 286
 287   identity o2 {
 288     base management-interface-id;
 289     description
 290       "An identity for the operation and maintenance management interface
 291        for a cloud infrastructure service and a could deployment service
 292        (O-Cloud) as defined by O-RAN-Alliance WG 6.";
 293     reference
 294       "O-RAN xxx by WG6
 295        TODO update!";
 296   }
 297
 298   identity open-fronthaul-management-plane {
 299     base management-interface-id;
 300     description
 301       "An identity for the operation and maintenance management interface for
 302        O-RU functions as defined by O-RAN-Alliance WG 4.";
 303     reference
 304       "O-RAN Management Plane Specification by WG4";
 305   }
 306
 307   identity transport-management-interface {
 308     base management-interface-id;
 309     description
 310       "An identity for a yang based management interface for transport nodes.";
 311   }
 312 }