1b2a9b8f405e520183fa3fb6b99f8c667859ce7f
[transportpce.git] / tests / honeynode / 2.2.1 / honeynode-plugin-impl / src / main / resources / honeycomb-minimal-resources / config / yang / devices / org-openroadm-otn-common@2017-06-26.yang
1 module org-openroadm-otn-common {
2   namespace "http://org/openroadm/otn-common";
3   prefix org-openroadm-otn-common;
4
5   organization
6     "Open ROADM MSA";
7   contact
8     "OpenROADM.org";
9   description
10     "YANG definitions for common OTN interface atrtributes and types.
11
12      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
13      AT&T Intellectual Property.  All other rights reserved.
14
15      Redistribution and use in source and binary forms, with or without modification,
16      are permitted provided that the following conditions are met:
17
18      * Redistributions of source code must retain the above copyright notice, this
19        list of conditions and the following disclaimer.
20      * Redistributions in binary form must reproduce the above copyright notice,
21        this list of conditions and the following disclaimer in the documentation and/or
22        other materials provided with the distribution.
23      * Neither the Members of the Open ROADM MSA Agreement nor the names of its
24        contributors may be used to endorse or promote products derived from this software
25        without specific prior written permission.
26
27      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
28      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
31      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
33      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
34      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36      POSSIBILITY OF SUCH DAMAGE.
37
38      Also contains code components extracted from IETF Interfaces.  These code components
39      are copyrighted and licensed as follows:
40
41      Copyright (c) 2016 IETF Trust and the persons identified as the document authors.
42      All rights reserved.
43
44      This document is subject to BCP 78 and the IETF Trust’s Legal Provisions Relating
45      to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of
46      publication of this document. Please review these documents carefully, as they
47      describe your rights and restrictions with respect to this document. Code Components
48      extracted from this document must include Simplified BSD License text as described in
49      Section 4.e of the Trust Legal Provisions and are provided without warranty as
50      described in the Simplified BSD License.";
51
52   revision 2017-06-26 {
53     description
54       "Version 2.0";
55   }
56
57   grouping trail-trace {
58     leaf tx-sapi {
59       type string {
60         length "0 .. 15";
61       }
62       description
63         "The provisioned 15 character transmit trace SAPI. Implementations shall add the [0] field automatically per ITU-T G.709";
64     }
65     leaf tx-dapi {
66       type string {
67         length "0 .. 15";
68       }
69       description
70         "The provisioned 15 character transmit trace DAPI. Implementations shall add the [0] field automatically per ITU-T G.709";
71     }
72     leaf tx-operator {
73       type string {
74         length "0 .. 32";
75       }
76       description
77         "The provisioned 32 character Operator Specific field";
78     }
79     leaf accepted-sapi {
80       type string;
81       config false;
82       description
83         "The accepted SAPI recovered from the recieved multi-frame TTI field.
84          Received SAPI contains the receive data, minus the sapi[0] and any 0x00 padding at the end";
85     }
86     leaf accepted-dapi {
87       type string;
88       config false;
89       description
90         "The accepted DAPI recovered from the recieved multi-frame TTI field
91          Received DAPI contains the receive data, minus the dapi[0] and any 0x00 padding at the end";
92     }
93     leaf accepted-operator {
94       type string;
95       config false;
96       description
97         "The accepted Operator Specific field recovered from the recieved multi-frame TTI field";
98     }
99     leaf expected-sapi {
100       type string {
101         length "0 .. 15";
102       }
103       description
104         "The provisioned expected SAPI, to be compared with accepted TTI";
105     }
106     leaf expected-dapi {
107       type string {
108         length "0 .. 15";
109       }
110       description
111         "The provisioned expected DAPI, to be compared with accepted TTI";
112     }
113     leaf tim-act-enabled {
114       type boolean;
115       default "false";
116       description
117         "Enables TTI Mismatch consequent actions.";
118     }
119     leaf tim-detect-mode {
120       type enumeration {
121         enum "Disabled" {
122           description
123             "TTI is ignored";
124         }
125         enum "SAPI" {
126           description
127             "Expected SAPI is compared to the Accpeted TTI. Other TTI fields are ignored";
128         }
129         enum "DAPI" {
130           description
131             "Expected DAPI is compared to the Accpeted TTI. Other TTI fields are ignored";
132         }
133         enum "SAPI-and-DAPI" {
134           description
135             "Expected SAPI and Expected DAPI are compared to the Accpeted TTI. Operator specific TTI field is ignored";
136         }
137       }
138       default "Disabled";
139     }
140   }
141
142   grouping deg-threshold {
143     leaf degm-intervals {
144       type uint8 {
145         range "2 .. 10";
146       }
147       default "2";
148       description
149         "G.806 - Consecutive bad intervals required for declare dDEG";
150     }
151     leaf degthr-percentage {
152       type uint16 {
153         range "1 .. 10000";
154       }
155       default "100";
156       description
157         "Percentage of errored blocks required to declare an interval bad, in units of 0.01%";
158     }
159   }
160 }