1 module org-openroadm-common-types {
2 namespace "http://org/openroadm/common-types";
3 prefix org-openroadm-common-types;
10 "YANG definitions of common types.
12 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
13 All other rights reserved.
15 Redistribution and use in source and binary forms, with or without modification,
16 are permitted provided that the following conditions are met:
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.
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";
91 typedef activate-notification-type {
96 "software or database activation";
101 "commit the software or database.
102 For software activate, this event can happen in the following scenarios:
103 1) immediately when user issue sw-activate command without validationTimer
104 or if the validationTimer is specified as 00-00-00;
105 2) when user issue cancel-validation-timer before it expires and with accept=true.
106 For database activate, this event can occur in the following scenarios:
107 1) immediately when user issue db-activate command without rollBackTimer
108 or if the rollBackTimer is specified as 00-00-00;
109 2) when user issue cancel-rollback-timer before it expires and with accept=true.";
114 "cancel the database or software activation operation.
115 For software activate, this event can happen in the following cases:
116 1) when the validationTimer expires;
117 2) when the user issues cancel-validation-timer with accept=false.
118 For database activate, this event can happen in the following cases:
119 1) when the rollBackTimer expires;
120 2) when the user issues cancel-rollback-timer with accept=false.";
124 "Type of notification on software or database activation events";
140 typedef extended-rpc-status {
156 typedef openroadm-version-type {
240 "OpenROADM version enum type";
243 grouping rpc-response-status {
248 "Successful or Failed";
250 leaf status-message {
253 "Gives a more detailed status";
257 grouping extended-rpc-response-status {
259 type extended-rpc-status;
262 "Successful, Failed or In-progress";
264 leaf status-message {
267 "Gives a more detailed status.";
271 grouping eth-rate-and-burst-size {
273 "Grouping of ethernet committed rate and burst size.";
274 leaf committed-info-rate {
278 "Committed Information Rate (CIR), unit in Mbps. For example, 1250 Mbps";
280 leaf committed-burst-size {
284 "Committed Burst Size, unit in 1KB (K Byte).
285 Range 16 | 32 | 64 | 128 | 512 | 1024. Default: 16";
289 identity otn-protection-type {
291 "OTN base protection identity from which
292 specific protection types are derived.";
295 typedef tcm-direction-capability-type {
299 "Port supports up TCM termination, e.g., direction facing the switch fabric";
303 "Port supports down TCM termination, e.g., direction facing out of the equipment ";
307 "Port supports both up and down TCM terminations";
311 "TCM direction capability for the port";
320 // Identities for FEC -- used for Device and Service models
324 identity fec-identity {
326 "A unique FEC identification";
329 // FEC Off (duplications for backwards compatibility)
342 // Staircase FEC (duplications for backwards compatibility)
347 "Staircase FEC identification";
352 "Staircase FEC identification";
355 // Reed Solomon FEC (duplication for backwards compatibility)
360 "Reed Solomon FEC identification";
365 "Reed Solomon FEC identification";
368 // OpenROADM FEC (duplication for backwards compatibility)
373 "OpenROADM FEC identification";
378 "OpenROADM FEC identification";
417 grouping fec-grouping {
420 base org-openroadm-common-types:fec-identity;
423 "FEC / Forward Error Correction";