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 managng the O-RAN Radio Unit
25 management plane interface.
27 Copyright 2019 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 "2019-04-11" {
57 1) Changes for ERI-001 - enabling NETCONF clients to be configured.
58 2) shifting new container to correct position.";
60 reference "ORAN-WG4.M.0-v01.00";
63 revision "2019-03-07" {
67 1) backward compatible changes to introduce groupings.";
69 reference "ORAN-WG4.M.0-v01.00";
72 revision "2019-02-04" {
76 1) imported model from xRAN
77 2) changed namespace and reference from xran to o-ran";
79 reference "ORAN-WG4.M.0-v01.00";
88 "Type definition representing a single-tagged VLAN";
93 grouping mplane-group {
94 container searchable-mplane-access-vlans-info {
96 "These parameters shall be stored by the equipment in reset persistant memory
97 to enable it to be re-used to optimize VALN discovery procerdures.";
98 leaf-list searchable-access-vlans {
101 "A list of access VLANs that may be operational on the transport
102 network. Can be used by the equipment to optimize its VLAN searching - for
103 M-plane operations.";
105 container vlan-range {
106 description "the range of VLAN IDs that may be configured for M-Plane";
107 leaf lowest-vlan-id {
110 "Value of this parameter informs equipment about lowest VID to be used
111 in VLAN scan procedure";
113 leaf highest-vlan-id {
116 "Value of this parameter informs about highest VID to be used
117 in VLAN scan procedure";
122 container m-plane-interfaces {
123 description "information concerning m-plane interfaces";
124 list m-plane-sub-interfaces {
125 key "interface-name sub-interface";
126 description "list of m-plane information";
127 leaf interface-name {
129 path "/if:interfaces/if:interface/if:name";
131 description "the name of the interface";
135 path "/if:interfaces/if:interface[if:name = current()/../interface-name]/o-ran-int:vlan-id";
138 "vlans used to communicate with management plane servers.";
140 container client-info {
143 "the NETCONF client information, discovered by DHCP or manually
144 configured during installation.";
145 list mplane-ipv4-info {
147 description "list of IPv4 NETCONF clients";
149 type inet:ipv4-address;
150 description "The IPv4 address of M-Plane client discovered by the O-RU
151 or manually configured.";
154 type inet:port-number;
156 "The call home port number discovered or manually configured.";
159 list mplane-ipv6-info {
161 description "list of IPv6 NETCONF clients";
163 type inet:ipv6-address;
164 description "The IPv6 address of M-Plane client discovered by the O-RU
165 or manually configured.";
168 type inet:port-number;
170 "The call home port number discovered or manually configured.";
173 leaf-list mplane-fqdn {
174 type inet:domain-name;
175 description "The discovered FQDN(s) of M-Plane client(s).";
180 container m-plane-ssh-ports {
181 description "leafs for managing SSH ports";
182 leaf call-home-ssh-port {
183 type inet:port-number;
185 description "The configured call home server port number";
187 leaf server-ssh-port {
188 type inet:port-number;
190 description "The configured SSH server port number";
194 container configured-client-info {
196 "the NETCONF client information that may be configured by another
197 NETCONF client. These clients are reported independently from clients
198 manually configured or discovered using DHCP.";
199 list mplane-ipv4-info {
201 description "list of IPv4 NETCONF clients";
203 type inet:ipv4-address;
204 description "The IPv4 address of configured M-Plane client.";
207 type inet:port-number;
209 "The configured call home port number.";
212 list mplane-ipv6-info {
214 description "list of IPv6 NETCONF clients";
216 type inet:ipv6-address;
217 description "The IPv6 address of configured M-Plane client..";
220 type inet:port-number;
222 "The configured call home port number.";
225 leaf-list mplane-fqdn {
226 type inet:domain-name;
227 description "The configured FQDN(s) of M-Plane client(s).";
233 // Top Level Container
235 container mplane-info {
236 description "top level container for management plane information";