1 module o-ran-common-identity-refs {
3 namespace "urn:o-ran:wg1identityref:1.0";
15 "This module defines a set of re-usable identity references, that can be
16 re-used across O-RAN working groups.
18 Copyright 2021 the O-RAN Alliance.
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.
32 Redistribution and use in source and binary forms, with or without
33 modification, are permitted provided that the following conditions are met:
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.";
46 "O-RAN SC: added SMO and UE functions";
48 "O-RAN SC SIM project.";
55 1) Updates according to change requests:
59 "O-RAN-WG2.IM.0-v02.00";
67 "ORAN-WG1.IM.0-v01.00";
70 // O-RAN functional identity types
72 identity o-ran-function-base {
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.";
77 "O-RAN.WG1.O-RAN-Architecture-Description
78 Chapter: 1.3.1 Definitions";
81 identity o-ru-function {
82 base o-ran-function-base;
84 "An identity corresponding to an O-RAN Radio Unit Function.";
87 identity o-du-function {
88 base o-ran-function-base;
90 "An identity corresponding to an O-RAN Distributed Unit Function.";
93 identity o-cu-function {
94 base o-ran-function-base;
96 "An identity corresponding to all O-RAN Central Unit Functions.
97 This identity is abstract and MUST NOT be used as a value.";
100 identity o-cu-up-function {
103 "An identity corresponding to an O-RAN Central Unit User Plane Function.";
106 identity o-cu-cp-function {
109 "An identity corresponding to an O-RAN Central Unit Control Plane
113 identity o-enb-function {
114 base o-ran-function-base;
116 "An identity corresponding to an O-RAN E-UTRAN Node B Function.
117 E-UTRAN: evolved UMTS Terrestrial Radio Access";
120 identity near-rt-ric-function {
121 base o-ran-function-base;
123 "An identity corresponding to an O-RAN Near real-time RAN intelligent
124 controller Function.";
127 identity user-equipment-function {
128 base o-ran-function-base;
130 "An identity corresponding to an UE Function.";
133 identity smo-function {
134 base o-ran-function-base;
136 "An identity corresponding to an O-RAN SMO Function.";
139 identity managed-application-function {
140 base o-ran-function-base;
142 "An identity corresponding to an O-RAN managed application function
143 (also called 'xApp').";
146 // TODO to be aligned with OAM Architecture
147 // 2021-07-21: email to Lyndon send - CR required
149 identity fronthaul-gateway-function {
150 base o-ran-function-base;
152 "An identity corresponding to an O-RAN Fronthaul Gateway Function.";
155 identity fronthaul-multiplexer-function {
156 base o-ran-function-base;
158 "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
161 identity transport-node-function {
162 base o-ran-function-base;
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, ... .";
170 identity o-cloud-ims-function {
171 base o-ran-function-base;
173 "An identity corresponding to an Infrastructure Management Service
177 identity o-cloud-dms-function {
178 base o-ran-function-base;
180 "An identity corresponding to a Deployment Management Service Function.";
183 // O-RAN radio technology identity types
185 identity o-ran-radio-technology-base {
187 "Base identity for O-RAN defined radio technology types.
189 This identity is abstract and MUST NOT be used as a value.";
192 identity new-radio-technology {
193 base o-ran-radio-technology-base;
195 "An identity corresponding to new radio technology.
197 This identity is abstract and MUST NOT be used as a value.";
200 identity lte-technology {
201 base o-ran-radio-technology-base;
203 "An identity corresponding to lte technology.
205 This identity is abstract and MUST NOT be used as a value.";
211 "An identity corresponding to nb-iot technology.
213 This identity is abstract and MUST NOT be used as a value.";
216 // O-RAN Transport technology identity types
218 identity o-ran-transport-technology-base {
220 "Base identity from which all O-RAN defined transport technology identities are derived.
222 This identity is abstract and MUST NOT be used as a value.";
225 // O-RAN Fronthaul transport identity types
227 identity o-ran-fronthaul-transport-base {
229 "Base identity from which all O-RAN defined fronthaul transports are derived.
231 This identity is abstract and MUST NOT be used as a value.";
234 identity ethernet-fronthaul-transport {
235 base o-ran-fronthaul-transport-base;
237 "an identity corresponding to fronthaul transport using ethernet based flows.
239 This identity is abstract and MUST NOT be used as a value.";
242 // Hardware component identity types
244 identity o-ran-module {
247 "Any O-RAN module that represents a self-contained sub-system.
249 This identity is abstract and MUST NOT be used as a value.";
252 identity o-ran-hardware-class {
253 base ianahw:hardware-class;
255 "This identity corresponding to a generic O-RAN hardware class.
257 This identity is abstract and MUST NOT be used as a value.";
261 base o-ran-hardware-class;
265 This identity is abstract and MUST NOT be used as a value.";
268 // O-RAN management interface identifiers
270 identity management-interface-id {
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.";
278 base management-interface-id;
280 "An identity for the operation and maintenance management interface
281 for network functions as defined by the O-RAN-Alliance WG10 as extension
284 "O-RAN OAM Interface Specification by WG10";
288 base management-interface-id;
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.";
298 identity open-fronthaul-management-plane {
299 base management-interface-id;
301 "An identity for the operation and maintenance management interface for
302 O-RU functions as defined by O-RAN-Alliance WG 4.";
304 "O-RAN Management Plane Specification by WG4";
307 identity transport-management-interface {
308 base management-interface-id;
310 "An identity for a yang based management interface for transport nodes.";