3 namespace "urn:o-ran:lbm:1.0";
6 import ietf-yang-types {
8 revision-date 2013-07-15;
11 import ietf-interfaces {
15 import o-ran-interfaces {
19 organization "O-RAN Alliance";
25 "This module defines the module capabilities for
26 the O-RAN Radio loop-back protocol (IEEE 802.1ag).
27 It is derived from MEF-38 (Service OAM Fault Management YANG Modules, April 2012)
29 Copyright 2021 the O-RAN Alliance.
31 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
32 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
35 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 POSSIBILITY OF SUCH DAMAGE.
43 Redistribution and use in source and binary forms, with or without
44 modification, are permitted provided that the following conditions are met:
46 * Redistributions of source code must retain the above copyright notice,
47 this list of conditions and the above disclaimer.
48 * Redistributions in binary form must reproduce the above copyright notice,
49 this list of conditions and the above disclaimer in the documentation
50 and/or other materials provided with the distribution.
51 * Neither the Members of the O-RAN Alliance nor the names of its
52 contributors may be used to endorse or promote products derived from
53 this software without specific prior written permission.";
55 revision "2021-12-01" {
59 1) typographical corrections in descriptions.";
61 reference "ORAN-WG4.M.0-v01.00";
64 revision "2021-03-22" {
68 1) typographical corrections in descriptions.";
70 reference "ORAN-WG4.M.0-v01.00";
73 revision "2019-02-04" {
77 1) imported model from xRAN
78 2) changed namespace and reference from xran to o-ran";
80 reference "ORAN-WG4.M.0-v01.00";
83 typedef priority-type {
88 "A 3 bit priority value to be used in the VLAN tag, if present
89 in the transmitted frame.";
90 reference "[802.1q] 12.14.7.3.2:e";
98 "Maintenance association End Point Identifier (MEPID): A small integer,
99 unique over a given Maintenance Association, identifying a
101 reference "[802.1q] 3.19 and 19.2.1";
104 typedef vlan-id-type {
109 "The VLAN-ID that uniquely identifies a VLAN. This is the 12-bit VLAN-ID
110 used in the VLAN Tag header.";
111 reference "[802.1q] 9.6";
114 typedef md-level-type {
119 "Maintenance Domain Level (MD Level) identifier. Higher numbers
120 correspond to higher Maintenance Domains, those with the greatest
121 physical reach, with the highest values for customers' CFM PDUs.
122 Lower numbers correspond to lower Maintenance Domains, those with
123 more limited physical reach, with the lowest values for CFM PDUs
124 protecting single bridges or physical links.";
125 reference "[802.1q] 18.3, 21.4.1, IEEE8021-CFM-MIB.Dot1agCfmMDLevel";
128 typedef lbm-transaction-id-type {
131 "A loopback transaction identifier";
132 reference "[802.1q] 21.7.3";
138 description "the maintenance domain grouping";
139 list maintenance-domain {
142 "A Maintenance Domain managed object is required in order to create an MA
143 with a MAID that includes that Maintenance Domain's Name. From
144 this Maintenance Domain managed object, all Maintenance
145 Association managed objects associated with that Maintenance
146 Domain managed object can be accessed, and thus controlled.";
147 reference "[802.1q] 12.14.5";
152 "A unique identifier of a Maintenance Domain";
153 reference "[802.1q] 12.14.5";
159 "The value for the Maintenance Domain Name. Only the name-type
160 'character-string' is supported";
161 reference "[802.1q] 21.6.5.1 (Table 21-19), 12.14.5.3.2:a";
168 "Integer identifying the Maintenance Domain Level (MD Level). Higher
169 numbers correspond to higher Maintenance Domains, those with the
170 greatest physical reach, with the highest values for customers'
171 CFM PDUs. Lower numbers correspond to lower Maintenance
172 Domains, those with more limited physical reach, with the lowest
173 values for CFM PDUs protecting single bridges or physical links.";
174 reference "[802.1q] 12.14.5.1.3:b";
177 list maintenance-association {
180 "This list represents Maintenance Entity Groups (Y.1731) or
181 Maintenance Associations (802.1ag). MEGs/MAs are sets of
182 MEPs, each configured to the same service inside a common
187 "A unique identifier of a Maintenance Association";
188 reference "[802.1q] 12.14.6";
194 "The value for the Maintenance Association Name. Only the name-type
195 'character-string' is supported";
196 reference "[802.1q] 12.14.5.3.2:b, Table 21-20";
199 list component-list {
202 "A list of components each of which can be managed in a manner
203 essentially equivalent to an 802.1Q bridge.";
204 reference "[802.1q] IEEE8021-CFM-V2-MIB.ieee8021CfmMaCompTable";
209 "The bridge component within the system to which the information
210 in this maintenance-association applies";
211 reference "[802.1q] IEEE8021-CFM-V2-MIB.ieee8021CfmMaComponentId";
218 "The value for the Maintenance Association Name. Only the name-type
219 'character-string' is supported";
220 reference "[802.1q] 12.14.5.3.2:b, Table 21-20";
225 path "/if:interfaces/if:interface/o-ran-int:vlan-id";
230 "The VID(s) monitored by this MA, or 0, if the MA is not attached to any
231 VID. The first VID returned is the MA's Primary VID";
232 reference "[802.1q] 12.14.5.3.2:b";
235 leaf-list remote-meps {
238 "A list of the MEPIDs of the MEPs in the MA.";
239 reference "[802.1q] 12.14.6.1.3:g";
242 list maintenance-association-end-point {
243 key "mep-identifier";
245 "The list of Maintenance association End Points in a specific Maintenance
248 leaf mep-identifier {
251 "Integer that is unique among all the MEPs in the same MA. Other
252 definition is: a small integer, unique over a given
253 Maintenance Association, identifying a specific Maintenance
254 association End Point.";
255 reference "[802.1q] 12.14.6.3.2:b";
260 path "/if:interfaces/if:interface/if:name";
264 "An interface, either a Bridge Port or an aggregated IEEE 802.3 port
265 within a Bridge Port, to which the MEP is attached. Each interface in
266 the system is uniquely identified by an interface-name. The structure
267 and content of the name is outside the scope of this specification.";
268 reference "[802.1q] 12.14.7.1.3:b";
273 path "/if:interfaces/if:interface/o-ran-int:vlan-id";
277 "The Primary VID of the MEP. The value 0 indicates that either the
278 Primary VID is that of the MEP's MA or that the MEP's MA is
279 associated with no VID";
280 reference "[802.1q] 12.14.7.1.3:d";
283 leaf administrative-state {
287 "The administrative state of the MEP";
288 reference "[802.1q] 12.14.7.1.3:e";
293 path "/if:interfaces/if:interface/o-ran-int:mac-address";
297 "The MAC address of the MEP";
298 reference "[802.1q] 12.14.7.1.3:i";
304 "Data definitions related to the Loopback function.";
305 leaf replies-transmitted {
310 "The total number of LBRs transmitted.";
311 reference "[802.1q] 12.14.7.1.3:ad";
320 // top level container
321 container md-data-definitions {
323 "Data definitions related to the maintenance domains used for supporting
324 Ethernet loopback connectivity checks";