1 module org-openroadm-otn-odu-interfaces {
2 namespace "http://org/openroadm/otn-odu-interfaces";
3 prefix org-openroadm-otn-odu-interfaces;
5 import org-openroadm-device {
6 prefix org-openroadm-device;
8 import org-openroadm-interfaces {
11 import org-openroadm-maintenance-testsignal {
12 prefix org-openroadm-maint-testsignal;
15 organization "Open ROADM MSA";
19 "YANG definitions for device facility otnodu interfaces.
21 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
22 AT&T Intellectual Property. All other rights reserved.
24 Redistribution and use in source and binary forms, with or without modification,
25 are permitted provided that the following conditions are met:
27 * Redistributions of source code must retain the above copyright notice, this
28 list of conditions and the following disclaimer.
29 * Redistributions in binary form must reproduce the above copyright notice,
30 this list of conditions and the following disclaimer in the documentation and/or
31 other materials provided with the distribution.
32 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
33 contributors may be used to endorse or promote products derived from this software
34 without specific prior written permission.
36 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
37 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
38 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
39 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
40 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
42 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
43 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
45 POSSIBILITY OF SUCH DAMAGE.
47 Also contains code components extracted from IETF Interfaces. These code components
48 are copyrighted and licensed as follows:
50 Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
53 This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
54 to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
55 publication of this document. Please review these documents carefully, as they
56 describe your rights and restrictions with respect to this document. Code Components
57 extracted from this document must include Simplified BSD License text as described in
58 Section 4.e of the Trust Legal Provisions and are provided without warranty as
59 described in the Simplified BSD License.";
66 identity odu-rate-identity {
68 "A unique rate identification of the ODUk.";
72 base odu-rate-identity;
74 "Identity for an ODU4";
78 base odu-rate-identity;
80 "Identity for an ODU3";
84 base odu-rate-identity;
86 "Identity for an ODU2";
90 base odu-rate-identity;
92 "Identity for an ODU2e";
96 base odu-rate-identity;
98 "Identity for an ODU1";
102 base odu-rate-identity;
104 "Identity for an ODU0";
108 base odu-rate-identity;
110 "Identity for an ODUflex";
113 identity odtu-type-identity {
115 "A unique identification for the MSI odtu type.";
118 identity ODTU4.ts-Allocated {
119 base odtu-type-identity;
121 "OPU4 MSI - ODTU4.ts, TS is occupied/allocated";
125 base odtu-type-identity;
131 base odtu-type-identity;
137 base odtu-type-identity;
143 base odtu-type-identity;
149 base odtu-type-identity;
155 base odtu-type-identity;
161 base odtu-type-identity;
167 base odtu-type-identity;
173 base odtu-type-identity;
179 base odtu-type-identity;
184 identity unallocated {
185 base odtu-type-identity;
187 "Unallocated MSI type";
194 "tributary slot (TS)";
198 base odtu-type-identity;
201 "ODTU type, part of the MSI (Multiplex Structure Identifier)";
206 "Tributray Port Number (0-based), part of the MSI";
208 leaf trib-port-payload {
211 "interface name being mapped to trib-port";
215 grouping odu-attributes {
220 base odu-rate-identity;
223 "rate identity of the ODU. 'identityref' is used
224 to allow to extend for future higher rates";
226 leaf monitoring-mode {
228 enum "not-terminated" {
230 "Not Terminated: no detection or generation.
231 Overhead is passed through the interface transparently in receive direction";
235 "Terminated: detection and generation enabled.
236 Overhead is erased (replaced with all zeros) in receive direction";
240 "Monitored: detection enabled.
241 Overhead is passed through the interface transparently in receive direction";
245 "Monitoring mode of the ODU Overhead";
247 leaf proactive-delay-measurement-enabled {
250 "enable/disable proactive Delay Measurement";
257 "Tandem Connection Management";
264 when "../monitoring-mode = 'terminated' or ../monitoring-mode = 'monitored'";
266 "Optical Channel Payload Unit (OPU)";
270 pattern "[0-9a-fA-F]*";
275 leaf rx-payload-type {
278 pattern "[0-9a-fA-F]*";
281 "Received Payload Type";
283 leaf exp-payload-type {
286 pattern "[0-9a-fA-F]*";
289 "Expected Payload Type";
291 leaf payload-interface {
294 "Expected Payload of OPU. It designates client interface name";
297 when "../payload-type = '20' or ../payload-type = '21'";
320 grouping tcm-attributes {
322 "Tandem Connection Monitoring (TCM) attributes";
330 leaf monitoring-mode {
332 enum "not-terminated" {
334 "Not Terminated: no detection or generation.
335 Overhead is passed through the interface transparently in receive direction
336 unless extension is set for erase";
340 "Terminated: detection and generation enabled.
341 Overhead is erased (replaced with all zeros) in receive direction, unless
342 extension is set to passthrough";
346 "Monitored: detection enabled.
347 Overhead is passed through the interface transparently in receive direction
348 unless extension is set for erase";
352 "Monitoring mode of the TCM layer";
354 leaf ltc-act-enabled {
357 "enable/disable alarm transfer on detection of Loss of Tandem Connection (LTC)";
359 leaf proactive-delay-measurement-enabled {
362 "enable/disable proactive Delay Measurement";
366 grouping odu-container {
368 presence "Attribute Nodes for Optical Data Unit (ODU)";
370 "Optical Channel Data Unit (ODU)";
371 uses odu-attributes {
372 refine "opu/rx-payload-type" {
379 uses org-openroadm-maint-testsignal:maint-testsignal;
383 augment "/org-openroadm-device:org-openroadm-device/org-openroadm-device:interface" {
384 when "org-openroadm-device:type = 'openROADM-if:otnOdu'";