1 module o-ran-sc-du-hello-world {
3 namespace "urn:o-ran-sc:yang:o-ran-sc-du-hello-world";
7 "O-RAN Software Community";
11 "This module contains the O-RAN Software Community Distributed Unit
12 API description. This schema was created to support the
13 O-RAN-SC D-Release RSAC use case.
14 This standalone model is the absolute minimum and therefore
17 Copyright 2021 the O-RAN Software Community.
19 Licensed under the Apache License, Version 2.0 (the 'License');
20 you may not use this file except in compliance with the License.
21 You may obtain a copy of the License at
23 http://www.apache.org/licenses/LICENSE-2.0
25 Unless required by applicable law or agreed to in writing, software
26 distributed under the License is distributed on an 'AS IS' BASIS,
27 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
28 See the License for the specific language governing permissions and
29 limitations under the License.";
33 "Updates based on the RSAC call 2021-04-08.";
35 "https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878423";
41 "https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=20878423";
46 typedef connection-status {
51 "The connection to the remote network function is not established.";
56 "The system is about to connect to the remote network function.";
61 "The system is connected to the remote network function.";
66 "The system is about to disconnect from the remote network
69 enum unable-to-connect {
72 "This value is reported, when the system tried several times
73 to connect and finally gave up.";
77 "A non extensible enumeration representing a connection status.";
80 typedef o-ru-reference {
82 path "/network-function/du-to-ru-connection/name";
85 "A reference to a remote network function representing an O-RU.";
88 // Abstract object classes - groupings
90 grouping connection-grp {
92 "An abstract object class representing a connection or link to an
97 "It is proposed to use the network unique identifier of the remote
99 Note: After discussion the string was not restricted by a 'length'
100 statement of a 'pattern' statement. Please avoid leading and ending
101 spaces and consecutive spaces and any character outside of UTF-8-";
103 leaf operational-state {
107 "The resource is not functional.";
111 "The resource is functional.";
116 "Operational state of a connection. Indicates
117 whether the resource is functional (ENABLED) or not (DISABLED).";
119 "3GPP TS 28.625 and ITU-T X.731";
121 leaf administrative-state {
125 "LOCKED refers to a situation which is NOT considered as
126 ‘normal operation'. Therefore, the O-DU will shut down the
127 connection to the related O-RU, when the value is set to LOCKED.";
131 "UNLOCKED refers to a situation which is considered as
132 'normal operation'. Therefore, the O-DU will establish the
133 connection to the related O-RU, when the value is set to UNLOCKED.";
137 "This value should not be used. At least the system
138 behavior is not defined.";
143 "Administrative state of a connection.";
145 "3GPP TS 28.625 and ITU-T X.731";
151 "Indicates whether the O-RU is not in use.";
155 "Indicates whether the O-RU is in use but not
156 configured to carry traffic.";
160 "Indicates whether the O-RU is in use and
161 configured to carry traffic.";
166 "Cell state of the O-RU instance.";
171 type connection-status;
172 default "disconnected";
175 "The value represents the connection status. ";
179 grouping network-function-grp {
181 "An abstract object class grouping the O-RAN-SC-DU parameters with
182 focus on RSAC D-release Closed-Loop use case.";
183 list du-to-ru-connection {
186 "A list of connection objects to O-RAN-SC radio units.";
191 grouping rpc-output {
193 "A generic RPC output syntax.";
194 leaf response-status {
199 "The system has successfully performed that request.";
204 "The system has received and accepted the request. It continues
205 processing the request. The final status of the processing
206 procedures are reported by a notification service. This response
207 status is typically for long running transactions.";
209 enum internal-server-error {
212 "The request cannot be performed.";
217 "The response status related to the corresponding request.
218 Its values are inspired by HTTP response status codes.";
220 "RFC 7231 – Response Status Codes - Section 6.3.4";
225 "A human readable text complementary to the response status. ";
231 container network-function {
233 "The root container for the configuration and operational data.
234 The object implements the 'network-function-grp'";
235 uses network-function-grp;
238 // Remote procedure calls - actions on root level
243 "An action to establish the connection to a remote network function.";
245 leaf remote-network-function {
249 "An reference to a remote network function - an O-RU - to which
250 a connection should be established.";
261 "An action to destroy the connection to a remote network function.";
263 leaf remote-network-function {
267 "An reference to a remote network function - an O-RU - to which
268 the connection should be destroyed.";