1 module o-ran-mplane-int {
3 namespace "urn:o-ran:mplane-interfaces:1.0";
4 prefix "o-ran-mplane-int";
6 import ietf-inet-types {
10 import ietf-interfaces {
14 import o-ran-interfaces {
18 organization "O-RAN Alliance";
24 "This module defines the YANG definitions for managing the O-RAN Radio Unit
25 management plane interface.
27 Copyright 2021 the O-RAN Alliance.
29 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
30 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
33 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39 POSSIBILITY OF SUCH DAMAGE.
41 Redistribution and use in source and binary forms, with or without
42 modification, are permitted provided that the following conditions are met:
44 * Redistributions of source code must retain the above copyright notice,
45 this list of conditions and the above disclaimer.
46 * Redistributions in binary form must reproduce the above copyright notice,
47 this list of conditions and the above disclaimer in the documentation
48 and/or other materials provided with the distribution.
49 * Neither the Members of the O-RAN Alliance nor the names of its
50 contributors may be used to endorse or promote products derived from
51 this software without specific prior written permission.";
53 revision "2021-12-01" {
57 1) typographical corrections";
59 reference "ORAN-WG4.M.0-v07.00";
62 revision "2021-07-26" {
66 1) new leaf for recommended scan interval ";
68 reference "ORAN-WG4.M.0-v07.00";
71 revision "2021-03-22" {
75 1) typographical corrections in descriptions.
76 2) new functionality to report TLS information ";
78 reference "ORAN-WG4.M.0-v06.00";
81 revision "2019-07-03" {
85 1) enabling NETCONF clients to be configured.
86 2) shifting new container to correct position
87 3) backward compatible changes to introduce groupings";
89 reference "ORAN-WG4.M.0-v01.00";
92 revision "2019-02-04" {
96 1) imported model from xRAN
97 2) changed namespace and reference from xran to o-ran";
99 reference "ORAN-WG4.M.0-v01.00";
108 "Type definition representing a single-tagged VLAN";
113 grouping mplane-group {
114 description "mplane grouping";
115 container searchable-mplane-access-vlans-info {
117 "These parameters shall be stored by the equipment in reset persistent memory
118 to enable it to be re-used to optimize VLAN discovery procedures.";
119 leaf-list searchable-access-vlans {
122 "A list of access VLANs that may be operational on the transport
123 network. Can be used by the equipment to optimize its VLAN searching - for
124 M-plane operations.";
126 container vlan-range {
127 description "the range of VLAN IDs that may be configured for M-Plane";
128 leaf lowest-vlan-id {
131 "Value of this parameter informs equipment about lowest VID to be used
132 in VLAN scan procedure";
134 leaf highest-vlan-id {
137 "Value of this parameter informs about highest VID to be used
138 in VLAN scan procedure";
146 "The O-RU should repeatedly search using untagged frames and previously configured
147 VLANs whenever it searches across the full range of VLAN IDs.The O-RU controller is
148 able to recommend the maximum interval between repeatedly scanning for M-Plane connectivity
149 on the untagged and configured VLANs using this timer schema node.
151 The O-RU shall store this schem-node in reset persistent memory.";
155 container m-plane-interfaces {
156 description "information concerning m-plane interfaces";
157 list m-plane-sub-interfaces {
158 key "interface-name sub-interface";
159 description "list of m-plane information";
160 leaf interface-name {
162 path "/if:interfaces/if:interface/if:name";
164 description "the name of the interface";
168 path "/if:interfaces/if:interface[if:name = current()/../interface-name]/o-ran-int:vlan-id";
171 "vlans used to communicate with management plane servers.";
173 container client-info {
176 "the NETCONF client information, discovered by DHCP or manually
177 configured during installation.";
178 list mplane-ipv4-info {
180 description "list of IPv4 NETCONF clients";
182 type inet:ipv4-address;
183 description "The IPv4 address of M-Plane client discovered by the O-RU
184 or manually configured.";
187 type inet:port-number;
189 "The call home port number discovered or manually configured.";
192 list mplane-ipv6-info {
194 description "list of IPv6 NETCONF clients";
196 type inet:ipv6-address;
197 description "The IPv6 address of M-Plane client discovered by the O-RU
198 or manually configured.";
201 type inet:port-number;
203 "The call home port number discovered or manually configured.";
206 leaf-list mplane-fqdn {
207 type inet:domain-name;
208 description "The discovered FQDN(s) of M-Plane client(s).";
213 container m-plane-ssh-ports {
214 description "leafs for managing SSH ports";
215 leaf call-home-ssh-port {
216 type inet:port-number;
218 description "The configured call home server port number";
220 leaf server-ssh-port {
221 type inet:port-number;
223 description "The configured SSH server port number";
226 container m-plane-tls-ports {
227 description "leafs for managing TLS ports";
228 leaf call-home-tls-port {
229 type inet:port-number;
231 description "The configured call home server port number";
233 leaf server-tls-port {
234 type inet:port-number;
236 description "The configured TLS server port number";
240 container configured-client-info {
242 "the NETCONF client information that may be configured by another
243 NETCONF client. These clients are reported independently from clients
244 manually configured or discovered using DHCP.";
245 list mplane-ipv4-info {
247 description "list of IPv4 NETCONF clients";
249 type inet:ipv4-address;
250 description "The IPv4 address of configured M-Plane client.";
253 type inet:port-number;
255 "The configured call home port number.";
258 list mplane-ipv6-info {
260 description "list of IPv6 NETCONF clients";
262 type inet:ipv6-address;
263 description "The IPv6 address of configured M-Plane client..";
266 type inet:port-number;
268 "The configured call home port number.";
271 leaf-list mplane-fqdn {
272 type inet:domain-name;
273 description "The configured FQDN(s) of M-Plane client(s).";
279 // Top Level Container
281 container mplane-info {
282 description "top-level container for management plane information";