Import OPNVF Yang based Event Stream
[scp/oam/modeling.git] / data-model / yang / published / opnfv / yes-pm-types-openroadm.yang
1 module yes-pm-types-openroadm {
2
3     yang-version 1.1;
4     namespace "urn:opendaylight:params:xml:ns:yang:yes-pm-types-openroadm";
5     prefix ypmto;
6
7     import yes-types {
8         prefix yt;
9         reference
10           "wiki.opnfv.org/display/ves/VES+goes+YES";
11     }
12
13     organization
14       "Open Platform for NFV (OPNFV) - Virtual Event Streaming (VES) project";
15     contact
16       "wiki.opnfv.org/display/ves";
17
18     description
19       "This module defines the performance measurement name identities
20        for yang based event streaming.
21
22        This yang module converts the OpenROADM yang:enumeration into
23        yang:identities.
24
25        Copyright 2020 highstreet technologies GmbH and others.
26
27        Licensed under the Apache License, Version 2.0 (the 'License');
28        you may not use this file except in compliance with the License.
29        You may obtain a copy of the License at
30
31          http://www.apache.org/licenses/LICENSE-2.0
32
33        Unless required by applicable law or agreed to in writing, software
34        distributed under the License is distributed on an 'AS IS' BASIS,
35        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36        See the License for the specific language governing permissions and
37        limitations under the License.";
38
39     revision 2020-04-13 {
40         description
41           "Initial revision";
42         reference
43           "https://jira.onap.org/browse/SDNC-???";
44     }
45
46     // --- typedef
47     identity performance-measurement-type-id {
48         base yt:performance-measurement-type-id;
49         description
50           "An abstract base performance measurement type which must not be used as
51            reference in data objects.";
52     }
53
54     // [sko] no need to define vendor extension - yang augment should be used
55     //       SDN Controller will ignore such values.
56     // identity vendorExtension {
57     //     base performance-measurement-type-id;
58     //     description
59     //       "vendor extension";
60     // }
61
62     identity bitErrorRate {
63         base performance-measurement-type-id;
64         description
65           "Bit error rate (BER)";
66     }
67     identity opticalPowerOutput {
68         base performance-measurement-type-id;
69         description
70           "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
71     }
72     identity opticalReturnLoss {
73         base performance-measurement-type-id;
74         description
75           "Optical Return Loss (ORL-OTS) - at MW port(s) B";
76     }
77     identity opticalPowerInput {
78         base performance-measurement-type-id;
79         description
80           "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
81     }
82     identity codeViolations {
83         base performance-measurement-type-id;
84         description
85           "Code Violations (CV)";
86     }
87
88     // [sko] exists already in G826
89     // identity erroredSeconds {
90     //     base performance-measurement-type-id;
91     //     description
92     //       "Errored Seconds (ES)";
93     // }
94
95     // [sko] exists already in G826
96     // identity severelyErroredSeconds {
97     //     base performance-measurement-type-id;
98     //     description
99     //       "Severely Errored Seconds (SES)";
100     // }
101
102     identity unavailableSeconds {
103         base performance-measurement-type-id;
104         description
105           "Unavailable Seconds (UAS)";
106     }
107     identity inFrames {
108         base performance-measurement-type-id;
109         description
110           "In frames (INFRAMES-E)";
111     }
112     identity inFramesErrored {
113         base performance-measurement-type-id;
114         description
115           "In frames errored (INFRAMESERR-E)";
116     }
117     identity outFrames {
118         base performance-measurement-type-id;
119         description
120           "Out frames (OUTFRAMES-E)";
121     }
122     identity erroredSecondsEthernet {
123         base performance-measurement-type-id;
124         description
125           "Errored Seconds Ethernet (ES-E)";
126     }
127     identity severelyErroredSecondsEthernet {
128         base performance-measurement-type-id;
129         description
130           "Severely Errored Seconds, Ethernet (SES-E)";
131     }
132     identity unavailableSecondsEthernet {
133         base performance-measurement-type-id;
134         description
135           "Unavailable Seconds, Ethernet (UAS-E)";
136     }
137     identity erroredBlockCount {
138         base performance-measurement-type-id;
139         description
140           "Errored block count";
141     }
142     identity delay {
143         base performance-measurement-type-id;
144         description
145           "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
146     }
147     identity defectSeconds {
148         base performance-measurement-type-id;
149         description
150           "Defect Seconds (DS)";
151     }
152     identity backwardIncomingAlignmentError {
153         base performance-measurement-type-id;
154         description
155           "Backward Incoming Alignment Error (BIAE)";
156     }
157     identity incomingAlignmentError {
158         base performance-measurement-type-id;
159         description
160           "Incoming Alignment Error (IAE)";
161     }
162     identity opticalPowerOutputMin {
163         base performance-measurement-type-id;
164         description
165           "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
166     }
167     identity opticalPowerOutputMax {
168         base performance-measurement-type-id;
169         description
170           "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
171     }
172     identity opticalPowerOutputAvg {
173         base performance-measurement-type-id;
174         description
175           "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
176     }
177     identity opticalPowerInputMin {
178         base performance-measurement-type-id;
179         description
180           "Minimum Optical Power Input (OPIN-OTS). Total optical power";
181     }
182     identity opticalPowerInputMax {
183         base performance-measurement-type-id;
184         description
185           "Maximum Optical Power Input (OPIN-OTS). Total optical power";
186     }
187     identity opticalPowerInputAvg {
188         base performance-measurement-type-id;
189         description
190           "Average Optical Power Input (OPIN-OTS). Total optical power";
191     }
192     identity opticalPowerOutputOSC {
193         base performance-measurement-type-id;
194         description
195           "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
196     }
197     identity opticalPowerOutputOSCMin {
198         base performance-measurement-type-id;
199         description
200           "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
201     }
202     identity opticalPowerOutputOSCMax {
203         base performance-measurement-type-id;
204         description
205           "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
206     }
207     identity opticalPowerOutputOSCAvg {
208         base performance-measurement-type-id;
209         description
210           "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
211     }
212     identity opticalPowerInputOSC {
213         base performance-measurement-type-id;
214         description
215           "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
216     }
217     identity opticalPowerInputOSCMin {
218         base performance-measurement-type-id;
219         description
220           "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
221     }
222     identity opticalPowerInputOSCMax {
223         base performance-measurement-type-id;
224         description
225           "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
226     }
227     identity opticalPowerInputOSCAvg {
228         base performance-measurement-type-id;
229         description
230           "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
231     }
232     identity preFECCorrectedErrors {
233         base performance-measurement-type-id;
234         description
235           "pFEC corrected Errors";
236     }
237     identity totalOpticalPowerInput {
238         base performance-measurement-type-id;
239         description
240           "Total Optical Power Input.";
241     }
242     identity totalOpticalPowerInputMin {
243         base performance-measurement-type-id;
244         description
245           "Minimum Total Optical Power Input.";
246     }
247     identity totalOpticalPowerInputMax {
248         base performance-measurement-type-id;
249         description
250           "Maximum Total Optical Power Input.";
251     }
252     identity totalOpticalPowerInputAvg {
253         base performance-measurement-type-id;
254         description
255           "Average Total Optical Power Input.";
256     }
257     identity FECCorrectableBlocks {
258         base performance-measurement-type-id;
259         description
260           "FEC Correctable Blocks.";
261     }
262     identity FECUncorrectableBlocks {
263         base performance-measurement-type-id;
264         description
265           "FEC Uncorrectable Blocks.";
266     }
267     identity BIPErrorCounter {
268         base performance-measurement-type-id;
269         description
270           "BIP Error Counter";
271     }
272     identity protectionSwitchingCount {
273         base performance-measurement-type-id;
274         description
275           "Protection Switching Count (PSC)";
276     }
277     identity protectionSwitchingDuration {
278         base performance-measurement-type-id;
279         description
280           "Protection Switching Duration in seconds (PSD)";
281     }
282     identity erroredBlockCountTCM1-up {
283         base performance-measurement-type-id;
284         description
285           "errored Blocks Count on TCM1 up direction.";
286     }
287     identity erroredBlockCountTCM2-up {
288         base performance-measurement-type-id;
289         description
290           "errored Blocks Count on TCM2 up direction.";
291     }
292     identity erroredBlockCountTCM3-up {
293         base performance-measurement-type-id;
294         description
295           "errored Blocks Count on TCM3 up direction.";
296     }
297     identity erroredBlockCountTCM4-up {
298         base performance-measurement-type-id;
299         description
300           "errored Blocks Count on TCM4 up direction.";
301     }
302     identity erroredBlockCountTCM5-up {
303         base performance-measurement-type-id;
304         description
305           "errored Blocks Count on TCM5 up direction.";
306     }
307     identity erroredBlockCountTCM6-up {
308         base performance-measurement-type-id;
309         description
310           "errored Blocks Count on TCM6 up direction.";
311     }
312     identity delayTCM1-up {
313         base performance-measurement-type-id;
314         description
315           "Delay on TCM1 up direction.";
316     }
317     identity delayTCM2-up {
318         base performance-measurement-type-id;
319         description
320           "Delay on TCM2 up direction.";
321     }
322     identity delayTCM3-up {
323         base performance-measurement-type-id;
324         description
325           "Delay on TCM3 up direction.";
326     }
327     identity delayTCM4-up {
328         base performance-measurement-type-id;
329         description
330           "Delay on TCM4 up direction.";
331     }
332     identity delayTCM5-up {
333         base performance-measurement-type-id;
334         description
335           "Delay on TCM5 up direction.";
336     }
337     identity delayTCM6-up {
338         base performance-measurement-type-id;
339         description
340           "Delay on TCM6 up direction.";
341     }
342     identity erroredBlockCountTCM1-down {
343         base performance-measurement-type-id;
344         description
345           "errored Blocks Count on TCM1 down direction.";
346     }
347     identity erroredBlockCountTCM2-down {
348         base performance-measurement-type-id;
349         description
350           "errored Blocks Count on TCM2 down direction.";
351     }
352     identity erroredBlockCountTCM3-down {
353         base performance-measurement-type-id;
354         description
355           "errored Blocks Count on TCM3 down direction.";
356     }
357     identity erroredBlockCountTCM4-down {
358         base performance-measurement-type-id;
359         description
360           "errored Blocks Count on TCM4 down direction.";
361     }
362     identity erroredBlockCountTCM5-down {
363         base performance-measurement-type-id;
364         description
365           "errored Blocks Count on TCM5 down direction.";
366     }
367     identity erroredBlockCountTCM6-down {
368         base performance-measurement-type-id;
369         description
370           "errored Blocks Count on TCM6 down direction.";
371     }
372     identity delayTCM1-down {
373         base performance-measurement-type-id;
374         description
375           "Delay on TCM1 down direction.";
376     }
377     identity delayTCM2-down {
378         base performance-measurement-type-id;
379         description
380           "Delay on TCM2 down direction.";
381     }
382     identity delayTCM3-down {
383         base performance-measurement-type-id;
384         description
385           "Delay on TCM3 down direction.";
386     }
387     identity delayTCM4-down {
388         base performance-measurement-type-id;
389         description
390           "Delay on TCM4 down direction.";
391     }
392     identity delayTCM5-down {
393         base performance-measurement-type-id;
394         description
395           "Delay on TCM5 down direction.";
396     }
397     identity delayTCM6-down {
398         base performance-measurement-type-id;
399         description
400           "Delay on TCM6 down direction.";
401     }
402     identity partialRateDiscard {
403         base performance-measurement-type-id;
404         description
405           "Discarded packet as a result of policing or rate limiting for subrate ethernet.";
406     }
407     identity erroredSecondsTCM1-up {
408         base performance-measurement-type-id;
409         description
410           "errored Seconds Count on TCM1 up direction.";
411     }
412     identity erroredSecondsTCM2-up {
413         base performance-measurement-type-id;
414         description
415           "errored Seconds Count on TCM2 up direction.";
416     }
417     identity erroredSecondsTCM3-up {
418         base performance-measurement-type-id;
419         description
420           "errored Seconds Count on TCM3 up direction.";
421     }
422     identity erroredSecondsTCM4-up {
423         base performance-measurement-type-id;
424         description
425           "errored Seconds Count on TCM4 up direction.";
426     }
427     identity erroredSecondsTCM5-up {
428         base performance-measurement-type-id;
429         description
430           "errored Seconds Count on TCM5 up direction.";
431     }
432     identity erroredSecondsTCM6-up {
433         base performance-measurement-type-id;
434         description
435           "errored Seconds Count on TCM6 up direction.";
436     }
437     identity severelyErroredSecondsTCM1-up {
438         base performance-measurement-type-id;
439         description
440           "severely Errored Seconds Count on TCM1 up direction.";
441     }
442     identity severelyErroredSecondsTCM2-up {
443         base performance-measurement-type-id;
444         description
445           "severely Errored Seconds Count on TCM2 up direction.";
446     }
447     identity severelyErroredSecondsTCM3-up {
448         base performance-measurement-type-id;
449         description
450           "severely Errored Seconds Count on TCM3 up direction.";
451     }
452     identity severelyErroredSecondsTCM4-up {
453         base performance-measurement-type-id;
454         description
455           "severely Errored Seconds Count on TCM4 up direction.";
456     }
457     identity severelyErroredSecondsTCM5-up {
458         base performance-measurement-type-id;
459         description
460           "severely Errored Seconds Count on TCM5 up direction.";
461     }
462     identity severelyErroredSecondsTCM6-up {
463         base performance-measurement-type-id;
464         description
465           "severely Errored Seconds Count on TCM6 up direction.";
466     }
467     identity unavailableSecondsTCM1-up {
468         base performance-measurement-type-id;
469         description
470           "unavailable Seconds Count on TCM1 up direction.";
471     }
472     identity unavailableSecondsTCM2-up {
473         base performance-measurement-type-id;
474         description
475           "unavailable Seconds Count on TCM2 up direction.";
476     }
477     identity unavailableSecondsTCM3-up {
478         base performance-measurement-type-id;
479         description
480           "unavailable Seconds Count on TCM3 up direction.";
481     }
482     identity unavailableSecondsTCM4-up {
483         base performance-measurement-type-id;
484         description
485           "unavailable Seconds Count on TCM4 up direction.";
486     }
487     identity unavailableSecondsTCM5-up {
488         base performance-measurement-type-id;
489         description
490           "unavailable Seconds Count on TCM5 up direction.";
491     }
492     identity unavailableSecondsTCM6-up {
493         base performance-measurement-type-id;
494         description
495           "unavailable Seconds Count on TCM6 up direction.";
496     }
497     identity erroredSecondsTCM1-down {
498         base performance-measurement-type-id;
499         description
500           "errored Seconds Count on TCM1 down direction.";
501     }
502     identity erroredSecondsTCM2-down {
503         base performance-measurement-type-id;
504         description
505           "errored Seconds Count on TCM2 down direction.";
506     }
507     identity erroredSecondsTCM3-down {
508         base performance-measurement-type-id;
509         description
510           "errored Seconds Count on TCM3 down direction.";
511     }
512     identity erroredSecondsTCM4-down {
513         base performance-measurement-type-id;
514         description
515           "errored Seconds Count on TCM4 down direction.";
516     }
517     identity erroredSecondsTCM5-down {
518         base performance-measurement-type-id;
519         description
520           "errored Seconds Count on TCM5 down direction.";
521     }
522     identity erroredSecondsTCM6-down {
523         base performance-measurement-type-id;
524         description
525           "errored Seconds Count on TCM6 down direction.";
526     }
527     identity severelyErroredSecondsTCM1-down {
528         base performance-measurement-type-id;
529         description
530           "severely Errored Seconds Count on TCM1 down direction.";
531     }
532     identity severelyErroredSecondsTCM2-down {
533         base performance-measurement-type-id;
534         description
535           "severely Errored Seconds Count on TCM2 down direction.";
536     }
537     identity severelyErroredSecondsTCM3-down {
538         base performance-measurement-type-id;
539         description
540           "severely Errored Seconds Count on TCM3 down direction.";
541     }
542     identity severelyErroredSecondsTCM4-down {
543         base performance-measurement-type-id;
544         description
545           "severely Errored Seconds Count on TCM4 down direction.";
546     }
547     identity severelyErroredSecondsTCM5-down {
548         base performance-measurement-type-id;
549         description
550           "severely Errored Seconds Count on TCM5 down direction.";
551     }
552     identity severelyErroredSecondsTCM6-down {
553         base performance-measurement-type-id;
554         description
555           "severely Errored Seconds Count on TCM6 down direction.";
556     }
557     identity unavailableSecondsTCM1-down {
558         base performance-measurement-type-id;
559         description
560           "unavailable Seconds Count on TCM1 down direction.";
561     }
562     identity unavailableSecondsTCM2-down {
563         base performance-measurement-type-id;
564         description
565           "unavailable Seconds Count on TCM2 down direction.";
566     }
567     identity unavailableSecondsTCM3-down {
568         base performance-measurement-type-id;
569         description
570           "unavailable Seconds Count on TCM3 down direction.";
571     }
572     identity unavailableSecondsTCM4-down {
573         base performance-measurement-type-id;
574         description
575           "unavailable Seconds Count on TCM4 down direction.";
576     }
577     identity unavailableSecondsTCM5-down {
578         base performance-measurement-type-id;
579         description
580           "unavailable Seconds Count on TCM5 down direction.";
581     }
582     identity unavailableSecondsTCM6-down {
583         base performance-measurement-type-id;
584         description
585           "unavailable Seconds Count on TCM6 down direction.";
586     }
587     identity fecCorrectedCodewords {
588         base performance-measurement-type-id;
589         description
590           "FEC Corrected Codewords Counter";
591     }
592     identity fecUncorrectedCodewords {
593         base performance-measurement-type-id;
594         description
595           "FEC Uncorrected Codewords Counter";
596     }
597     identity fecSymbolErrors {
598         base performance-measurement-type-id;
599         description
600           "FEC Symbol Error Counter";
601     }
602     identity localFaultSeconds {
603         base performance-measurement-type-id;
604         description
605           "Local Fault Seconds";
606     }
607     identity remoteFaultSeconds {
608         base performance-measurement-type-id;
609         description
610           "Remote Fault Seconds";
611     }
612 }