1 module o-ran-sc-topology-common {
3 namespace "urn:o-ran-sc:yang:o-ran-sc-topology-common:1.0";
6 import ietf-interfaces {
15 "O-RAN Software Community";
19 "This module contains YANG definitions for the O-RAN Topology augmentation
20 of TAPI Topology used as network model.
22 Copyright 2022 the O-RAN Software Community.
24 Licensed under the Apache License, Version 2.0 (the 'License');
25 you may not use this file except in compliance with the License.
26 You may obtain a copy of the License at
28 http://www.apache.org/licenses/LICENSE-2.0
30 Unless required by applicable law or agreed to in writing, software
31 distributed under the License is distributed on an 'AS IS' BASIS,
32 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33 See the License for the specific language governing permissions and
34 limitations under the License.";
40 "O-RAN-SC: https://jira.o-ran-sc.org/browse/OAM-248
41 O-RAN.WG1.O-RAN-Architecture-Description
42 Chapter: 1.3.1\tDefinitions";
45 // O-RAN functional identity types
47 identity function-type {
49 "Base identity as abstract function type for by O-RAN Alliance and others
51 An unique identification of a (network) function.
53 This identity is abstract and MUST NOT be used for alarms.";
55 "O-RAN.WG1.O-RAN-Architecture-Description
56 Chapter: 1.3.1\tDefinitions
57 https://jira.o-ran-sc.org/browse/OAM-248";
63 "An identity corresponding to an
64 O-RAN Service Management and Orchestration Function (SMO).";
70 "An identity corresponding to an O-RAN Cloud component (O-Cloud).";
76 "An identity corresponding to an
77 O-RAN Service Management and Orchestration SMO component corresponding to
78 a Non-real-time RAN Intelligent Controller Function (Near-RT-RIC).";
81 identity oam-controller {
84 "An identity corresponding to an
85 O-RAN Service Management and Orchestration SMO component corresponding to
86 an Operation and Maintenance Controller Controller Function
90 identity ves-collector {
93 "An identity corresponding to an
94 O-RAN Service Management and Orchestration SMO component corresponding to
95 an (Virtual) Event Streaming Collector Function
99 identity message-router {
102 "An identity corresponding to an
103 O-RAN Service Management and Orchestration SMO component corresponding to
104 Message Router Function (MR).";
107 identity transport-node {
110 "An identity corresponding to a Transport Node Function
111 (such as Transponders, Muxponders, ROADM, Wavelength Selected Switch,
112 Optical Amplifier, Optical Terminal, Optical Repeater, Optical Filter,
113 Optical Multiplexer, Microwave Terminal, Carrier Ethernet Routers, ... .";
116 identity fronthaul-gateway {
119 "An identity corresponding to an O-RAN Fronthaul Gateway Function.";
122 identity fronthaul-multiplexer {
125 "An identity corresponding to an O-RAN Fronthaul Multiplexer Function.";
128 identity near-rt-ric {
131 "An identity corresponding to an O-RAN Near real-time RAN intelligent
132 controller Function (NEar-RT-RIC).";
135 identity managed-application {
138 "An identity corresponding to an O-RAN Managed Application Function (MA),
139 also called 'xApp'.";
145 "An identity corresponding to an O-RAN Central Unit Functions.";
151 "An identity corresponding to an O-RAN Central Unit User Plane Function.";
157 "An identity corresponding to an O-RAN Central Unit Control Plane
164 "An identity corresponding to an O-RAN Distributed Unit Function.";
170 "An identity corresponding to an O-RAN Radio Unit Function.";
176 "An identity corresponding to an O-RAN E-UTRAN Node B Function.
177 E-UTRAN: evolved UMTS Terrestrial Radio Access";
180 identity user-equipment {
183 "An identity corresponding to an User Equipment Function.";
186 identity o-cloud-ims {
189 "An identity corresponding to an Infrastructure Management Service
193 identity o-cloud-dms {
196 "An identity corresponding to a
197 Deployment Management Service Function (DMS).";
200 // O-RAN interface types
202 identity interface-type {
203 base if:interface-type;
205 "Base identity for interface types used in RAN, Transport and Core.
206 A unique identification of the management interface.
207 This identity is abstract and MUST NOT be used as a value.";
213 "An identity for the a1 interface between Non-RT-RIC and Near-RT-RIC.";
219 "An identity for the e1 interface defined by 3GPP.";
225 "An identity for the e2 interface as defined by O-RAN Alliance.";
231 "An identity for the operation and maintenance management interface
232 for network functions as defined by the O-RAN-Alliance as extension
239 "An identity for the operation and maintenance management interface
240 for a cloud infrastructure service and a could deployment service
244 identity open-fronthaul-management-plane {
247 "An identity for the operation and maintenance management interface for
251 identity transport-management-interface {
254 "An identity for a yang based management interface for transport nodes.";
257 // O-RAN-SC LAYER_PROTOCOL_QUALIFIER
258 identity LAYER_PROTOCOL_QUALIFIER {
259 base tapi-common:LAYER_PROTOCOL_QUALIFIER;
261 "Base identity for layer protocol qualifiers used in RAN, Transport and Core.
262 A unique identification of layer protocol qualifiers.
263 Typically the layer protocol qualifier is used to identify the interface
264 protocol, like VES or NETCONF.
265 This identity is abstract and MUST NOT be used as a value.";
269 base LAYER_PROTOCOL_QUALIFIER;
271 "An identity for an unknown qualifier.";
275 base LAYER_PROTOCOL_QUALIFIER;
277 "An identity for a FILE transfer protocol qualifier.";
281 base LAYER_PROTOCOL_QUALIFIER;
283 "An identity for an generic remote procedure call (gRPC) protocol qualifier.";
287 base LAYER_PROTOCOL_QUALIFIER;
289 "An identity for a NETCONF protocol qualifier.";
293 base LAYER_PROTOCOL_QUALIFIER;
295 "An identity for a REST protocol qualifier.";
299 base LAYER_PROTOCOL_QUALIFIER;
301 "An identity for a RESTCONF protocol qualifier.";
305 base LAYER_PROTOCOL_QUALIFIER;
307 "An identity for an REST based event stream (VES) protocol qualifier.";
311 base LAYER_PROTOCOL_QUALIFIER;
313 "An identity for an O-RAN Fronthaul based protocol qualifier.";