1 module o-ran-sc-root-v1 {
3 namespace "urn:o-ran-sc:yang:o-ran-sc-root-v1";
6 import o-ran-sc-types-v1 {
9 import ietf-yang-types {
12 "RFC 6991: Common YANG Data Types";
16 "O-RAN Software Community";
20 "This module defines the root controlled object classes for a
23 Copyright 2021 the O-RAN Software Community.
25 Licensed under the Apache License, Version 2.0 (the 'License');
26 you may not use this file except in compliance with the License.
27 You may obtain a copy of the License at
29 http://www.apache.org/licenses/LICENSE-2.0
31 Unless required by applicable law or agreed to in writing, software
32 distributed under the License is distributed on an 'AS IS' BASIS,
33 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34 See the License for the specific language governing permissions and
35 limitations under the License.";
39 "The namespace was updated according to O-RAN-SC yang guidelines.
40 The namespace must end with the full module name.";
42 "https://jira.o-ran-sc.org/browse/OAM-168";
48 "O-RAN-OAM-Interface-Specification (O1)";
53 grouping controlled-identifier-grp {
55 type ot:sized-printable-string;
57 "A name or identifier referencing the authority to which is
58 responsible to create, modify or delete
59 the controlled identifier. ";
66 "The external controlled identifier value for this controlled
70 "An object class specifying an object identifier, which is calculated
71 or generated by the consumer of the API..";
75 leaf operational-state {
77 base ot:operational-state;
81 "The operational state is used to indicate whether or not the
82 resource is installed and working.";
84 leaf administrative-control {
86 base ot:administrative-control;
89 "The administrative-control state provides control of the
90 availability of specific resources without modification to the
91 provisioning of those resources.
92 The value is the current control target. The actual
93 administrative-state may or may not be at target.";
95 leaf administrative-state {
97 base ot:administrative-state;
101 "Shows whether or not the client has permission to use or has a
102 prohibition against using the resource.
103 The administrative state expresses usage permissions for
104 specific resources without modification to the provisioning
105 of those resources.";
107 leaf lifecycle-state {
109 base ot:lifecycle-state;
112 "Used to track the planned deployment, allocation to clients and
113 withdrawal of resources.";
116 "Provides general state attributes.";
119 grouping control-base-grp {
124 "The network wide unique identifier an object. The value will
125 never change and maybe used as reference even long time after
126 the object instance itself was deleted.
127 The value is calculated of generated by the provider of this
130 list controlled-identifier {
132 uses controlled-identifier-grp;
134 "A list of external controlled identifiers, set by an external
135 authority. There must not be any function implemented on the
136 API provider itself next to updating the list on request and
137 storing it persistently. ";
140 type ot:sized-printable-string;
142 "A user defined human readable identifier. The value may chance
143 during the lifetime of the object and must not be used by any
144 software for references.";
151 "A human readable value that is not expected to be unique and is
152 allowed to change. A label carries no semantics with respect to
153 the purpose of the object and has no effect on the object
158 "The control-base object class representation an abstract object class,
159 which all is used by all important control object classes.";
162 container controlled-element {
163 presence "Enables O-RAN";
164 uses control-base-grp;
165 list controlled-function {
167 uses control-base-grp;
170 base ot:control-function-type;
173 "The reference to the O-RAN Alliance functions of the OAM
174 Architecture specification.";
177 "A list of abstract object classes which needs to be
178 augmented by the authority of providing the function.";
181 "The root container of an element (network-element,
182 manged-element, network-function, ...). it groups the
183 functions provided by the element. in a most disaggregated RAN
184 the each element provides only one function.";