blob: 21c05a6646fd95afddb0da2517e19d807e6bbe39 [file] [log] [blame]
Sean Condonfae8e662016-12-15 10:25:13 +00001module msea-soam-pm {
2
3 namespace "http://www.microsemi.com/microsemi-edge-assure/msea-soam-pm";
4 prefix "msea-soam-pm"; //MicroSemi EdgeAssure (msea)
5
6 import ietf-yang-types {
7 prefix yang;
8 revision-date 2013-07-15;
9 }
10
11 import msea-cfm {
12 prefix msea-cfm;
13 }
14
15 import msea-types {
16 prefix msea;
17 }
18
19 organization
20 "Microsemi Inc., FTD Division";
21
22 contact
23 "Web URL: http://www.microsemi.com/
24 E-mail: info@microsemi.com
25 Postal: Microsemi Corporation Corporate Headquarters
26 One Enterprise Aliso Viejo,
27 CA 92656
28 U.S.A.
29 Phone: +1 949 380 6100
30 Fax: +1 949 215-4996";
31
32 description
33 "This YANG module is a fork of the original mef-soam-pm YANG Module defined in MEF 39
34 for the management of Ethernet Services Operations, Administration and
35 Maintenance for Performance Monitoring and extends the Connectivity Fault
36 Management (CFM) YANG modules.
37 This fork is done specifically to suit the EdgeAssure which has some extra
38 constraints that are not handled by the original YANG.
39
40 Copyright 2016 Microsemi Inc.
41 All rights reserved.";
42
43 revision "2016-02-29" {
44 description
45 "Initial EdgeAssure version forked from mef-soam-pm@2012-04-16 - Sean Condon, Microsemi";
46 reference
47 "Service OAM Fault Management YANG Modules (MEF 39), April 2012";
48 }
49
50 //
51 // Type definitions related to MEF SOAM PM
52 //
53
54 typedef suspect-status-type {
55 type boolean;
56 description
57 "This boolean data type indicates whether the measurement interval
58 has been marked as suspect.
59
60 The object is set to false at the start of a measurement
61 interval. It is set to true when there is a discontinuity in the
62 performance measurements during the measurement interval.
63 Conditions for a discontinuity include, but are not limited to
64 the following:
65
66 1 - The local time-of-day clock is adjusted by at least 10
67 seconds
68 2 - The conducting of a performance measurement is halted before
69 the current measurement interval is completed
70 3 - A local test, failure, or reconfiguration that disrupts
71 service";
72 reference
73 "[MEF SOAM PM IA] R39, R40, 41 and R42";
74 }
75
76 typedef performance-monitoring-interval-type {
77 type uint32 {
78 range "3..3600000";
79 }
80 units ms;
81 description
82 "This integer data type indicates the transmission time between the
83 SOAM PM frames for session, in ms.";
84 }
85
86
87 typedef session-status-type {
88 type enumeration {
89 enum active {
90 description
91 "Indicates the measurement instance is active.";
92 }
93 enum not-active {
94 description
95 "Indicates the measurement instance is not active.";
96 }
97 }
98
99 description
100 "This enumeration data type defines the status of PM session of a MEP.";
101 reference
102 "MEF-SOAM-TC-MIB.MefSoamTcStatusType";
103 }
104
105
106 typedef measurement-bin-type {
107 type enumeration {
108 enum two-way-frame-delay {
109 description
110 "Indicates a measurement bin for two-way Frame Delay.";
111 }
112
113 enum two-way-inter-frame-delay-variation {
114 description
115 "Indicates a measurement bin for two-way Inter-frame Delay
116 Variation.";
117 }
118 }
119
120 description
121 "This enumeration data type indicates whether the bin number is for Frame
122 Delay and Inter-Frame Delay Variation.";
123 reference
124 "MEF-SOAM-TC-MIB.MefSoamTcDelayMeasurementBinType";
125 }
126
127 //
128 // Groupings related to MEF SOAM PM
129 //
130
131 grouping remote-mep-group {
132 description
133 "This grouping includes objects which identify a remote MEP.";
134 choice remote-mep {
135 mandatory true;
136 description
137 "The remote MEP can be identified by either a MAC address or a MEP ID";
138
139 case mac-address {
140 leaf mac-address {
141 type yang:mac-address;
142// msea:not-changeable;
143
144 description
145 "The Target MAC Address Field to be transmitted: A unicast
146 destination MAC address.
147
148 This object is only valid for the entity transmitting the
149 SOAM Loss and Delay Measurement frames and is ignored by
150 the entity receiving SOAM Loss and Delay Measurement
151 frames.";
152 }
153 }
154 case mep-id {
155 leaf mep-id {
156 type leafref {
157 path "/msea-cfm:mef-cfm/msea-cfm:maintenance-domain/msea-cfm:maintenance-association/msea-cfm:remote-meps";
158 }
159// msea:not-changeable;
160
161 description
162 "The Maintenance Association End Point Identifier of another MEP in
163 the same Maintenance Association to which the SOAM Loss or Delay
164 Measurement frame is to be sent.
165
166 This object is only valid for the entity transmitting the
167 SOAM Loss Measurement or Delay Measurement frames and is
168 ignored by the entity receiving SOAM Loss Measurement or
169 Delay Measurement frames.";
170 }
171 }
172 }
173 }
174
175 grouping measurement-timing-group {
176 description
177 "This grouping includes objects used for proactive and on-demand
178 scheduling of PM measurement sessions.";
179
180 container start-time {
181 description
182 "This container defines the session start time";
183
184 choice start-time {
185 default immediate;
186 description
187 "Measurement session start time can be immediate, relative or
188 absolute.";
189
190 container immediate {
191 presence "Start the measurement session immediately.";
192
193 description
194 "This object specifies the start time to be immediately at the time
195 of session creation.";
196 }
197 }
198 }
199
200 container stop-time {
201 description
202 "This container defines the session stop time";
203
204 choice stop-time {
205 default none;
206 description
207 "Measurement session stop time can be none, relative or
208 absolute.";
209
210 container none {
211 presence "Never end the measurement session.";
212
213 description
214 "This object specifies the measurement session to never end.";
215 }
216 }
217 }
218 }
219
220 grouping loss-measurement-stats-group {
221 description
222 "This grouping includes statistics objects for a SOAM Loss Measurement
223 session.";
224
225 leaf suspect-status {
226 type suspect-status-type;
227
228 description
229 "Whether the Measurement Interval has been marked as suspect.
230
231 The object is set to false at the start of a measurement
232 interval. It is set to true when there is a discontinuity in
233 the performance measurements during the Measurement Interval.
234 Conditions for a discontinuity include, but are not limited to
235 the following:
236
237 1 - The local time-of-day clock is adjusted by at least 10 seconds
238 2 - The conducting of a performance measurement is halted before the
239 current Measurement Interval is completed
240 3 - A local test, failure, or reconfiguration that disrupts service";
241 reference
242 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsSuspect";
243 }
244
245 leaf forward-transmitted-frames {
246 type yang:gauge32;
247 mandatory true;
248
249 description
250 "This object contains the number of frames transmitted in the forward
251 direction by this MEP.
252
253 For a PM Session of types lmm or ccm this includes Ethernet
254 Service Frames and SOAM PDUs that are in a higher MEG level
255 only.
256
257 For a PM Session of type slm this includes the count of SOAM
258 ETH-SLM frames only.";
259 reference
260 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsForwardTransmittedFrames";
261 }
262
263 leaf forward-received-frames {
264 type yang:gauge32;
265 mandatory true;
266
267 description
268 "This object contains the number of frames received in the forward
269 direction by this MEP.
270
271 For a PM Session of types lmm or ccm this includes Ethernet
272 Service Frames and SOAM PDUs that are in a higher MEG level only.
273
274 For a PM Session of type slm this includes the count of SOAM
275 ETH-SLM frames only.";
276 reference
277 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsForwardReceivedFrames";
278 }
279
280 leaf forward-average-frame-loss-ratio {
281 type uint32 {
282 range "0..100000";
283 }
284 units milli-percent;
285
286 description
287 "This object contains the average one-way frame loss ratio in the
288 forward direction calculated by this MEP for this Measurement
289 Interval. The FLR value is a ratio that is expressed as a
290 percent with a value of 0 (ratio 0.00) through 100000 (ratio
291 1.00).
292
293 Units are in milli-percent, where 1 indicates 0.001 percent.";
294 reference
295 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsForwardAvgFlr";
296 }
297
298 leaf backward-transmitted-frames {
299 type yang:gauge32;
300 mandatory true;
301
302 description
303 "This object contains the number of frames transmitted in the backward
304 direction by this MEP.
305
306 For a PM Session of type lmm or ccm this includes Ethernet
307 Service Frames and SOAM PDUs that are in a higher MEG level
308 only.
309
310 For a PM Session of type slm this includes the count of SOAM
311 ETH-SLM frames only.";
312 reference
313 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsBackwardTransmittedFrames";
314 }
315
316 leaf backward-received-frames {
317 type yang:gauge32;
318 mandatory true;
319
320 description
321 "This object contains the number of frames received in the backward
322 direction by this MEP.
323
324 For a PM Session of type lmm this includes Ethernet Service
325 Frames and SOAM PDUs that are in a higher MEG level only.
326
327 For a PM Session of type slm this includes the count of SOAM
328 ETH-SLM frames only.";
329 reference
330 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsBackwardReceivedFrames";
331 }
332
333 leaf backward-average-frame-loss-ratio {
334 type uint32 {
335 range "0..100000";
336 }
337 units milli-percent;
338
339 description
340 "This object contains the average one-way frame loss ratio in the
341 backward direction calculated by this MEP for this Measurement
342 Interval. The FLR value is a ratio that is expressed as a
343 percent with a value of 0 (ratio 0.00) through 100000 (ratio
344 1.00).
345
346 Units are in milli-percent, where 1 indicates 0.001 percent.";
347 reference
348 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsBackwardAvgFlr";
349 }
350
351 leaf soam-pdus-sent {
352 type yang:gauge32;
353 description
354 "This object contains the count of the number of SOAM PDUs sent during
355 this Measurement Interval.
356
357 This object applies when type is lmm, slm or ccm. It indicates
358 the number of LMM, CCM, or SLM SOAM frames transmitted.";
359 reference
360 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsSoamPdusSent";
361 }
362
363 leaf soam-pdus-received {
364 type yang:gauge32;
365
366 description
367 "This object contains the count of the number of SOAM PDUs PDUs received
368 in this Measurement Interval.
369
370 This object applies when type is lmm, slm, or ccm. This object
371 indicates the number of LMR, CCM, or SLR SOAM frames received.";
372 reference
373 "MEF-SOAM-PM-MIB.mefSoamLmCurrentStatsSoamPdusReceived";
374 }
375 }
376
377 grouping delay-measurement-stats-group {
378 description
379 "This grouping includes statistics objects for a SOAM Delay Measurement
380 session.";
381
382 leaf suspect-status {
383 type suspect-status-type;
384 description
385 "Whether the Measurement Interval has been marked as suspect.
386
387 The object is to be set to false at the start of a measurement
388 interval. It is set to true when there is a discontinuity in
389 the performance measurements during the Measurement Interval.
390 Conditions for a discontinuity include, but are not limited to
391 the following:
392
393 1 - The local time-of-day clock is adjusted by at least 10 seconds
394 2 - The conducting of a performance measurement is halted before the
395 current Measurement Interval is completed
396 3 - A local test, failure, or reconfiguration that disrupts service";
397 }
398
399 leaf frame-delay-two-way-min {
400 type yang:gauge32;
401 units "μs";
402
403 description
404 "This object contains the minimum two-way frame delay calculated by this
405 MEP for this Measurement Interval.
406
407 This object is undefined if measurement-type is dm1-transmitted
408 or dm1-received.";
409 }
410
411 leaf frame-delay-two-way-max {
412 type yang:gauge32;
413 units "μs";
414
415 description
416 "This object contains the maximum two-way frame delay calculated by this
417 MEP for this Measurement Interval.
418
419 This object is undefined if measurement-type is dm1DmTx or
420 dm1-received.";
421 }
422
423 leaf frame-delay-two-way-average {
424 type yang:gauge32;
425 units "μs";
426
427 description
428 "This object contains the average two-way frame delay calculated by this
429 MEP for this Measurement Interval.
430
431 This object is undefined if measurement-type is dm1-transmitted or
432 dm1-received.";
433 }
434
435 leaf inter-frame-delay-variation-two-way-min {
436 type yang:gauge32;
437 units "μs";
438
439 description
440 "This object contains the minimum two-way inter-frame delay interval
441 calculated by this MEP for this Measurement Interval.
442
443 The value of this object is undefined when measurement-type is
444 dm1-transmitted or dm1-received.";
445 }
446
447 leaf inter-frame-delay-variation-two-way-max {
448 type yang:gauge32;
449 units "μs";
450
451 description
452 "This object contains the maximum two-way inter-frame delay interval
453 calculated by this MEP for this Measurement Interval.
454
455 The value of this object is undefined when measurement-type is
456 dm1-transmitted or dm1-received.";
457 }
458
459 leaf inter-frame-delay-variation-two-way-average {
460 type yang:gauge32;
461 units "μs";
462
463 description
464 "This object contains the average two-way inter-frame delay interval
465 calculated by this MEP for this Measurement Interval.
466
467 The value of this object is undefined when measurement-type is
468 dm1-transmitted or dm1-received.";
469 }
470
471 leaf soam-pdus-received {
472 type yang:gauge32;
473 description
474 "This object contains the count of the number of SOAM PDUs received in
475 this Measurement Interval.
476
477 This object indicates the number of DMR and 1DM SOAM frames
478 received. This object applies when measurement-type is dmm or
479 dm1-received and is undefined if measurement-type is
480 dm1-transmitted.";
481 }
482 }
483
484 grouping delay-measurement-bins-content-group {
485 description
486 "This grouping contains result measurement bin objects for a SOAM Delay
487 Measurement session.";
488
489 leaf type {
490 type measurement-bin-type;
491
492 description
493 "This object specifies whether the bin number is for Frame Delay and
494 Inter-Frame Delay Variation.";
495 }
496
497 leaf number {
498 type uint8 {
499 range "1..4";
500 }
501
502 description
503 "This object specifies the bin number for the configured boundary. The
504 first bin has bin number 1.";
505 }
506
507 leaf lower-bound {
508 type yang:gauge32;
509 units "μs";
510
511 description
512 "This object specifies the lower boundary for a measurement bin. The
513 upper boundary is defined by the next bin value or infinite for
514 the last bin defined. The measurement boundary for each
515 measurement bin is to be larger than the measurement boundary
516 of the preceding measurement bin. By default, the next bin is
517 set to 5000us larger than the lower bin boundary.
518
519 The values in a bin boundary object represents the time range
520 used to segregate delay data into the appropriate statistical
521 data bin. For five bins with default values, each bin has the
522 following time range:
523
524 bin 1 = 0, range is 0us
525 bin 2 = 5000, range is 5,000us
526 bin 3 = 10000, range is 10,000us
527 bin 4 = 15000, range is 15,000us
528 bin 5 = 20000, range is 20,000us
529
530 The first bin boundary (number set to 1) always contains the
531 value of 0. Attempting to write a non-zero value to this bin
532 will result in an error.";
533 }
534
535 leaf counter {
536 type yang:gauge32;
537 config false;
538
539 description
540 "This object contains the count of the number of completed measurements
541 initiated in this Measurement Interval whose value falls within
542 the range specified for this bin (that is, greater than or
543 equal to the measurement boundary for the bin, and (unless the
544 bin is the last bin) less than the measurement boundary for the
545 following bin.";
546 reference
547 "MEF-SOAM-PM-MIB.mefSoamDmCurrentStatsBinsCounter";
548 }
549 }
550
551 grouping delay-measurement-bins-group {
552 description
553 "This grouping contains the top-level structure for the three types of
554 measurements (frame delay and inter frame delay variation)";
555
556 container bins {
557 description
558 "This container defines the bins content for FD, IFDR, and FDR
559 sessions.";
560
561 list frame-delay {
562 key "type number";
563 uses delay-measurement-bins-content-group;
564
565 description
566 "Data definitions related to frame delay bins content.";
567 }
568
569 list inter-frame-delay-variation {
570 key "type number";
571 uses delay-measurement-bins-content-group;
572
573 description
574 "Data definitions related to inter frame delay bins content.";
575 }
576
577 }
578 }
579
580
581 grouping bin-lower-limit-override-attribs {
582
583 description
584 "Bin 1 of each type will always be 0.
585 The upper limit of each bin will be defined by the lower
586 limit of the next bin. The upper limit of the last bin
587 is unbounded.";
588
589 leaf bin2-lower-limit {
590 type uint32 {
591 range "10..max";
592 }
593 units "μs";
594 must "current() < ../bin3-lower-limit" {
595 error-message "Bin 2 must be between 0 and bin 3 lower limit";
596 error-app-tag "msea-soampm-must-01";
597 }
598 description "The lower limit of the bin 2 in microseconds";
599 }
600
601 leaf bin3-lower-limit {
602 type uint32 {
603 range "10..max";
604 }
605 units "μs";
606 must "current() > ../bin2-lower-limit and current() < ../bin4-lower-limit" {
607 error-message "Bin 3 must be between bin 2 and bin 4 lower limits";
608 error-app-tag "msea-soampm-must-02";
609 }
610 description "The lower limit of the bin 3 in microseconds";
611 }
612
613 leaf bin4-lower-limit {
614 type uint32 {
615 range "10..max";
616 }
617 units "μs";
618 must "current() > ../bin3-lower-limit" {
619 error-message "Bin 4 must be greater than 3 lower limit";
620 error-app-tag "msea-soampm-must-03";
621 }
622 description "The lower limit of the bin 4 in microseconds";
623 }
624 }
625
626 //
627 // Augments into CFM related to MEF SOAM PM
628 //
629
630 augment "/msea-cfm:mef-cfm/msea-cfm:pm-global" {
631
632 description "High level attributes that apply to the whole device generally
633 or that apply equally across all instances of a child entity.
634 Delay measurement services should be stopped before changing
635 these values, including the limit overrides";
636
637 leaf dm-bins-per-fd-interval {
638 type uint16 {
639 range "4";
640 }
641 default 4;
642
643 description
644 "This object specifies the number of measurement bins per Measurement
645 Interval for Frame Delay measurements.
646
647 Fixed at 4.";
648 }
649
650 leaf dm-bins-per-ifdv-interval {
651 type uint16 {
652 range "4";
653 }
654 default 4;
655
656 description
657 "This object specifies the number of measurement bins per Measurement
658 Interval for Inter-Frame Delay Variation measurements.
659
660 Fixed at 4.";
661 }
662
663
664 container bin-lower-limit-override-two-way-frame-delay {
665
666 uses bin-lower-limit-override-attribs {
667 refine bin2-lower-limit {
668 default 10000;
669 }
670 refine bin3-lower-limit {
671 default 20000;
672 }
673 refine bin4-lower-limit {
674 default 37000;
675 }
676 }
677
678 description "Override of the default Measurement Bin default
679 lower limits for Two Way Frame Delay.";
680
681 }
682
683 container bin-lower-limit-override-two-way-ifdv {
684
685 uses bin-lower-limit-override-attribs {
686 refine bin2-lower-limit {
687 default 3000;
688 }
689 refine bin3-lower-limit {
690 default 8000;
691 }
692 refine bin4-lower-limit {
693 default 100000;
694 }
695 }
696
697 description "Override of the default Measurement Bin default
698 lower limits for Two Way Interframe Delay Variation.";
699 }
700 }
701
702
703 augment "/msea-cfm:mef-cfm/msea-cfm:maintenance-domain/msea-cfm:maintenance-association" +
704 "/msea-cfm:maintenance-association-end-point" {
705 description
706 "This set of data definitions extends the MEG End Point (as described
707 Y.1731) or Maintenance End Point (as described in 802.1q) defined
708 in the MEF CFM module (MEF-CFM), specifically with regards to
709 Loss Measurement and Delay Measurement.";
710
711 container loss-measurements {
712 description
713 "This container contains a collection of data definitions related to
714 Loss Measurements.";
715
716 list loss-measurement {
717 key lm-id;
718 max-elements 16;
719
720 description
721 "A list of Loss Measurement PM Sessions where each instance is uniquely
722 identified by an id attribute.
723 This grouping includes configuration objects for the Frame Loss
724 Measurement function defined in [Y.1731] and [MEF SOAM PM IA].";
725 reference
726 "MEF-SOAM-PM-MIB.mefSoamLmCfgTable, [Y.1731] and [MEF SOAM PM IA]";
727
728 leaf lm-id {
729 type uint8 {
730 range 1..16;
731 }
732
733 description
734 "This object uniquely identifies a scheduled loss measurement.";
735 }
736
737 must "count(/msea-cfm:mef-cfm/msea-cfm:maintenance-domain/msea-cfm:maintenance-association/msea-cfm:maintenance-association-end-point/msea-soam-pm:loss-measurement) <= 128" {
738 error-message "The maximum number of LMs on the whole device must not exceed 128";
739 error-app-tag "msea-soampm-must-04";
740 }
741
742 uses remote-mep-group;
743 uses measurement-timing-group;
744
745 leaf administrative-state {
746 type boolean;
747 default false;
748
749 description
750 "The administrative state of the MEP. Setting to true starts this Loss Measurement";
751 }
752
753 leaf measurement-type {
754 type enumeration {
755 enum slm {
756 description
757 "SLM SOAM PDU generated and received SLR responses tracked.";
758 }
759 }
760 default slm;
761
762 description
763 "This object specifies what type of Loss Measurement will be
764 performed.";
765 reference
766 "MEF-SOAM-PM-MIB.mefSoamLmCfgType";
767 }
768
769 leaf version {
770 type enumeration {
771 enum Y.1731-2008 {
772 description
773 "Indicates the PDU formats defined in Y.1731-2008";
774 }
775 }
776 default Y.1731-2008;
777
778 description
779 "This object indicates the version of the PDUs used to perform Loss
780 Measurement.
781 The exact PDUs to use are specified by this object in
782 combination with measurement-type.";
783 reference
784 "MEF-SOAM-PM-MIB.mefSoamLmCfgVersion";
785 }
786
787 leaf enabled-counters {
788 type bits {
789 bit forward-transmitted-frames {description "Count the number of frames transmitted in the forward direction by this MEP";}
790 bit forward-received-frames {description "Count the number of frames received in the forward direction by this MEP";}
791 bit forward-average-flr {description "Calculate the average one-way frame loss ratio in the forward direction calculated by this MEP";}
792 bit backward-transmitted-frames {description "Count the number of frames transmitted in the backward direction by this MEP";}
793 bit backward-received-frames {description "Count the number of frames received in the backward direction by this MEP";}
794 bit backward-average-flr {description "Calculate the average one-way frame loss ratio in the backward direction calculated by this MEP";}
795 bit soam-pdus-sent {description "Count of the number of SOAM PDUs sent during this Measurement Interval";}
796 bit soam-pdus-received {description "Count of the number of SOAM PDUs received during this Measurement Interval";}
797 bit measured-stats-forward-measured-flr {description "Measure the Frame Loss Ratio in the forward direction calculated by this MEP from the last received SOAM PDU";}
798 bit measured-stats-backward-measured-flr {description "Measure the Frame Loss Ratio in the backward direction calculated by this MEP from the last received SOAM PDU";}
799
800 }
801 default "";
802
803// msea:not-changeable;
804
805 description
806 "A vector of bits that indicates the type of SOAM LM counters found in
807 the current-stats and history-stats that are enabled.
808
809 A present bit enables the specific SOAM LM counter. A not present
810 bit disables the SOAM LM counter.
811
812 If a particular SOAM LM counter is not supported the BIT value
813 is not present.
814
815 Not all SOAM LM counters are supported for all SOAM LM types. ";
816 reference
817 "MEF-SOAM-PM-MIB.mefSoamLmCfgMeasurementEnable";
818 }
819
820 leaf message-period {
821 type enumeration {
822 enum 1000ms {
823 description "The default 1000ms message period for LM";
824 }
825 enum 100ms {
826 description "100ms message period for LM";
827 }
828 enum 10ms {
829 description "10ms message period for LM";
830 }
831 enum 3ms {
832 description "3ms message period for LM";
833 }
834 }
835 default 1000ms;
836// msea:not-changeable;
837
838 description
839 "This object specifies the interval between Loss Measurement OAM message
840 transmission. For Loss Measurement monitoring applications the
841 default value is 1 sec.
842
843 This object is not applicable if measurement-type is set to
844 'ccm' and is ignored for that Loss Measurement Type.";
845 reference
846 "MEF-SOAM-PM-MIB.mefSoamLmCfgMessagePeriod";
847 }
848
849 leaf priority {
850 type msea:priority-type;
851 mandatory true;
852// msea:not-changeable;
853
854 must "count(/msea-cfm:mef-cfm/msea-cfm:maintenance-domain[msea-cfm:id = current()/../../../../../msea-cfm:id]/msea-cfm:maintenance-association[msea-cfm:id = current()/../../../../msea-cfm:id]/msea-cfm:maintenance-association-end-point[msea-cfm:mep-identifier=current()/../../../msea-cfm:mep-identifier]/msea-soam-pm:loss-measurements/msea-soam-pm:loss-measurement[msea-soam-pm:priority=current()]) <= 1" {
855 error-message "The priority of a Loss Measurement must be unique within its MEP";
856 error-app-tag "msea-soampm-must-05";
857 }
858
859 description
860 "This object specifies the priority of frames with Performance
861 Monitoring OAM message information.";
862 reference
863 "MEF-SOAM-PM-MIB.mefSoamLmCfgPriority";
864 }
865
866 leaf frame-size {
867 type uint32 {
868 range "64 .. 9600";
869 }
870 units bytes;
871 default 64;
872// msea:not-changeable;
873
874 description
875 "This object specifies the Loss Measurement frame size between 64 bytes
876 and the maximum transmission unit of the EVC.
877
878 The range of frame sizes from 64 through 2000 octets need to be
879 supported, and the range of frame sizes from 2001 through 9600
880 octets is suggested be supported.
881
882 The adjustment to the frame size of the standard frame size is
883 accomplished by the addition of a Data or Test TLV. A Data or
884 Test TLV is only added to the frame if the frame size is greater
885 than 64 bytes.";
886 reference
887 "MEF-SOAM-PM-MIB.mefSoamLmCfgFrameSize";
888 }
889
890 leaf measurement-interval {
891 type uint32 {
892 range "1..525600";
893 }
894 units minutes;
895 default 15;
896// msea:not-changeable;
897
898 description
899 "This object specifies the Measurement Interval for FLR statistics, in
900 minutes.
901
902 A Measurement Interval of 15 minutes needs to be supported,
903 other intervals may be supported.";
904 reference
905 "MEF-SOAM-PM-MIB.mefSoamLmCfgMeasurementInterval";
906 }
907
908 leaf number-intervals-stored {
909 type uint32 {
910 range "32";
911 }
912 default 32;
913
914 description
915 "This object specifies the number of completed measurement intervals to
916 store in the history statistic table.
917
918 At least 32 completed measurement intervals are to be
919 stored.";
920 reference
921 "MEF-SOAM-PM-MIB.mefSoamLmCfgNumIntervalsStored";
922 }
923
924 leaf number-intervals-returned {
925 type uint32 {
926 range "2..32";
927 }
928 default 32;
929
930 description
931 "This object specifies the number of completed measurement intervals to
932 return from the history statistic table.
933 The number stored on the device is fixed at 32";
934 }
935
936 leaf session-status {
937 type session-status-type;
938 config false;
939
940 description
941 "This object indicates the current status of the LM session. A value
942 of 'active' indicates the current LM session is active,
943 i.e. the current time lies between the start time and the
944 stop time, and enabled is true. A value of 'not-active'
945 indicates the current LM session is not active, i.e. it has
946 not started yet, has stopped upon reaching the stop time,
947 or is disabled.";
948 }
949
950 leaf measured-forward-flr {
951 type yang:gauge32 {
952 range "0..100000";
953 }
954 units milli-percent;
955 config false;
956
957 description
958 "This object contains the Frame Loss Ratio in the forward direction
959 calculated by this MEP from the last received SOAM PDU. The
960 FLR value is a ratio that is expressed as a percent with a
961 value of 0 (ratio 0.00) through 100000 (ratio 1.00).
962
963 Units are in milli-percent, where 1 indicates 0.001
964 per-cent.";
965 reference
966 "MEF-SOAM-PM-MIB.mefSoamLmMeasuredStatsForwardFlr";
967 }
968
969 leaf measured-backward-flr {
970 type yang:gauge32 {
971 range "0..100000";
972 }
973 units milli-percent;
974 config false;
975
976 description
977 "This object contains the Frame Loss Ratio in the backward direction
978 calculated by this MEP from the last received SOAM PDU. The
979 FLR value is a ratio that is expressed as a percent with a
980 value of 0 (ratio 0.00) through 100000 (ratio 1.00).
981
982 Units are in milli-percent, where 1 indicates 0.001
983 percent.";
984 reference
985 "MEF-SOAM-PM-MIB.mefSoamLmMeasuredStatsBackwardFlr";
986 }
987
988 container current-measurement-stats {
989 config false;
990
991 description
992 "This container contains the results for the current Measurement
993 Interval in a SOAM Loss Measurement session gathered during
994 the interval indicated by measurement-interval.";
995
996 leaf id {
997 type uint32;
998
999 description
1000 "The index for the current Measurement Interval for this PM
1001 session. This value will become the value for id of the
1002 history-measurement-stats list once the Measurement
1003 Interval is completed.";
1004 }
1005
1006 leaf start-time {
1007 type yang:date-and-time;
1008 mandatory true;
1009
1010 description
1011 "The time that the current Measurement Interval started.";
1012 }
1013
1014 leaf elapsed-time {
1015 type uint32 {
1016 range "0..2147483647";
1017 }
1018 units "0.01s";
1019 mandatory true;
1020
1021 description
1022 "The time that the current Measurement Interval has been running,
1023 in 0.01 seconds.";
1024 }
1025
1026 uses loss-measurement-stats-group;
1027 }
1028
1029 list history-measurement-stats {
1030 key id;
1031 config false;
1032 description
1033 "This list contains the results for history Measurement
1034 Intervals in a SOAM Loss Measurement session.";
1035
1036 leaf id {
1037 type uint32;
1038
1039 description
1040 "The index for the Measurement Interval within this
1041 PM session.";
1042 }
1043
1044 leaf end-time {
1045 type yang:date-and-time;
1046 mandatory true;
1047
1048 description
1049 "The time that the Measurement Interval ended.";
1050 }
1051
1052 leaf elapsed-time {
1053 type uint32 {
1054 range "0..2147483647";
1055 }
1056 mandatory true;
1057
1058 description
1059 "The length of time that the Measurement Interval ran for,
1060 in 0.01 seconds.";
1061 }
1062
1063 uses loss-measurement-stats-group;
1064 }
1065 }
1066 }
1067
1068 container delay-measurements {
1069 description
1070 "This container contains a collection of data definitions related to
1071 Delay Measurements. The measurements are persisted as config data
1072 with results being retrieved from the device as needed";
1073
1074 list delay-measurement {
1075 key dm-id;
1076 max-elements 16;
1077
1078 description
1079 "A list of Delay Measurements where each instance is
1080 uniquely identified by an id attribute.
1081 This includes configuration objects for the Delay Measurement
1082 function defined in [Y.1731] and [MEF SOAM PM IA].";
1083 reference
1084 "MEF-SOAM-PM-MIB.mefSoamDmCfgTable, [Y.1731], and [MEF SOAM PM IA].";
1085
1086 leaf dm-id {
1087 type uint8 {
1088 range 1..16;
1089 }
1090
1091 description
1092 "This object uniquely identifies a scheduled delay measurement.";
1093 }
1094
1095 must "count(/msea-cfm:mef-cfm/msea-cfm:maintenance-domain/msea-cfm:maintenance-association/msea-cfm:maintenance-association-end-point/msea-soam-pm:delay-measurement) <= 128" {
1096 error-message "The maximum number of DMs on the whole device must not exceed 128";
1097 error-app-tag "msea-soampm-must-06";
1098 }
1099
1100 uses remote-mep-group;
1101 uses measurement-timing-group;
1102
1103 leaf administrative-state {
1104 type boolean;
1105 default false;
1106
1107 description
1108 "The administrative state of the MEP. Setting to true starts this Delay Measurement";
1109 }
1110
1111 leaf measurement-type {
1112 type enumeration {
1113 enum dmm {
1114 description
1115 "DMM SOAM PDU generated, DMR responses received (one-way or two-way
1116 measurements).";
1117 }
1118 }
1119 default dmm;
1120
1121 description
1122 "This object indicates what type of Delay Measurement is to be
1123 performed.
1124
1125 The exact PDUs to use are specified by this object in
1126 combination with version.";
1127 }
1128
1129 leaf version {
1130 type enumeration {
1131 enum Y.1731-2011 {
1132 description
1133 "Indicates the PDU formats defined in Y.1731-2011.";
1134 }
1135 }
1136 default Y.1731-2011;
1137
1138 description
1139 "This object indicates the version of the PDUs used to perform Delay
1140 Measurement.
1141
1142 The exact PDUs to use are specified by this object in
1143 combination with measurement-type.";
1144 reference
1145 "[Y.1731]";
1146 }
1147
1148 leaf measurement-enable {
1149 type bits {
1150 bit soam-pdus-received {description "Count of the number of SOAM PDUs received";}
1151 bit frame-delay-two-way-bins {description "Capture the two-way frame delay in bins";}
1152 bit frame-delay-two-way-min {description "Capture the minimum two-way frame delay";}
1153 bit frame-delay-two-way-max {description "Capture the maximum two-way frame delay";}
1154 bit frame-delay-two-way-average {description "Calculate the average two-way frame delay";}
1155 bit inter-frame-delay-variation-two-way-bins {description "Capture the two-way inter-frame-delay-variation in bins";}
1156 bit inter-frame-delay-variation-two-way-min {description "Capture the minimum inter-frame-delay-variation frame delay";}
1157 bit inter-frame-delay-variation-two-way-max {description "Capture the maximum inter-frame-delay-variation frame delay";}
1158 bit inter-frame-delay-variation-two-way-average {description "Calculate the average inter-frame-delay-variation frame delay";}
1159 }
1160 default "";
1161// msea:not-changeable;
1162
1163 description
1164 "A vector of bits that indicates the type of SOAM DM counters that
1165 are enabled.
1166
1167 A present bit enables the specific SOAM DM counter.
1168
1169 A not present bit disables the SOAM DM counter.
1170
1171 If a particular SOAM DM counter is not supported the BIT value
1172 is not present.
1173
1174 Not all SOAM DM counters are supported for all SOAM DM types.";
1175 }
1176
1177 leaf message-period {
1178 type enumeration {
1179 enum 1000ms {
1180 description "1000ms message period for DM";
1181 }
1182 enum 100ms {
1183 description "100ms message period for DM";
1184 }
1185 enum 10ms {
1186 description "10ms message period for DM";
1187 }
1188 enum 3ms {
1189 description "3ms message period for DM";
1190 }
1191 }
1192 default 100ms;
1193// msea:not-changeable;
1194
1195 description
1196 "This object specifies the interval between Delay Measurement OAM
1197 message transmission. For Delay Measurement monitoring applications,
1198 the default value is 100ms.";
1199 }
1200
1201 leaf priority {
1202 type msea:priority-type;
1203 mandatory true;
1204// msea:not-changeable;
1205
1206 description
1207 "This object specifies the priority of frames with Performance
1208 Monitoring OAM message information.";
1209 }
1210
1211 leaf frame-size {
1212 type uint32 {
1213 range "64 .. 9600";
1214 }
1215 default 64;
1216// msea:not-changeable;
1217
1218 description
1219 "This object specifies the Delay Measurement frame size between 64 bytes
1220 and the maximum transmission unit of the EVC.
1221
1222 The range of frame sizes from 64 through 2000 octets need to be
1223 supported, and the range of frame sizes from 2001 through 9600
1224 octets is suggested to be supported.
1225
1226 The adjustment to the frame size of the standard frame size is
1227 accomplished by the addition of a Data or Test TLV. A Data or
1228 Test TLV is only added to the frame if the frame size is
1229 greater than 64 bytes.";
1230 }
1231
1232 leaf measurement-interval {
1233 type uint32 {
1234 range "1..1440";
1235 }
1236 units minutes;
1237 default 15;
1238// msea:not-changeable;
1239
1240 description
1241 "This object specifies a Measurement Interval in minutes.
1242
1243 A Measurement Interval 15 minutes needs to be supported, other
1244 intervals may be supported.";
1245 reference
1246 "MEF-SOAM-PM-MIB.mefSoamDmCfgMeasurementInterval";
1247 }
1248
1249 leaf number-intervals-stored {
1250 type uint32 {
1251 range "32";
1252 }
1253 default 32;
1254 description
1255 "This object specifies the number of completed measurement intervals to
1256 store in the history statistic table.
1257
1258 At least 32 completed measurement intervals are to be
1259 stored.";
1260 reference
1261 "MEF-SOAM-PM-MIB.mefSoamLmCfgNumIntervalsStored";
1262 }
1263
1264 leaf number-intervals-returned {
1265 type uint32 {
1266 range "2..32";
1267 }
1268 default 32;
1269
1270 description
1271 "This object specifies the number of completed measurement intervals to
1272 return from the history statistic table.
1273 The number of intervals stored is fixed at 32 on the device";
1274
1275 }
1276
1277 leaf session-status {
1278 type session-status-type;
1279 config false;
1280
1281 description
1282 "This object indicates the current status of the DM session. A value
1283 of 'active' indicates the current DM session is active,
1284 i.e. the current time lies between the start time and the
1285 stop time, and enabled is true. A value of 'not-active'
1286 indicates the current DM session is not active, i.e. it has
1287 not started yet, has stopped upon reaching the stop time,
1288 or is disabled.";
1289 }
1290
1291 leaf frame-delay-two-way {
1292 type yang:gauge32;
1293 units microseconds;
1294 config false;
1295
1296 description
1297 "This object contains the two-way frame delay calculated by this MEP
1298 from the last received SOAM PDU.
1299
1300 This object is undefined is measurement-type is
1301 dm1-transmitted or dm1-received.";
1302 reference
1303 "MEF-SOAM-PM-MIB.mefSoamDmMeasuredStatsFrameDelayTwoWay";
1304 }
1305
1306 leaf inter-frame-delay-variation-two-way {
1307 type yang:gauge32;
1308 units microseconds;
1309 config false;
1310
1311 description
1312 "This object contains the last two-way inter-frame delay interval
1313 calculated by this MEP.
1314
1315 The value of this object is undefined when measurement-type
1316 is dm1-transmitted or dm1-received.";
1317 reference
1318 "MEF-SOAM-PM-MIB.mefSoamDmMeasuredStatsIfdvTwoWay";
1319 }
1320
1321 container current-stats {
1322 config false;
1323
1324 description
1325 "This container contains the results for the current Measurement
1326 Interval in a SOAM Delay Measurement session gathered
1327 during the interval indicated by measurement-interval.";
1328
1329 leaf id {
1330 type uint32;
1331
1332 description
1333 "The index for the current Measurement Interval for this PM
1334 session. This value will become the value for id of the
1335 history-measurement-stats list once the Measurement
1336 Interval is completed.";
1337 }
1338
1339 leaf start-time {
1340 type yang:date-and-time;
1341 mandatory true;
1342
1343 description
1344 "The time that the current Measurement Interval started.";
1345 }
1346
1347 leaf elapsed-time {
1348 type uint32 {
1349 range "0..2147483647";
1350 }
1351 mandatory true;
1352
1353 description
1354 "The time that the current Measurement Interval has been running,
1355 in 0.01 seconds.";
1356 }
1357
1358 uses delay-measurement-stats-group;
1359 uses delay-measurement-bins-group;
1360 }
1361
1362 list history-stats {
1363 key id;
1364 config false;
1365 description
1366 "This list contains the results for history Measurement Intervals in
1367 a SOAM Delay Measurement session.";
1368
1369 leaf id {
1370 type uint32;
1371
1372 description
1373 "The identifier for the Measurement Interval within this
1374 PM session.";
1375 }
1376
1377 leaf end-time {
1378 type yang:date-and-time;
1379 mandatory true;
1380
1381 description
1382 "The time that the Measurement Interval ended.";
1383 }
1384
1385 leaf elapsed-time {
1386 type uint32 {
1387 range "0..2147483647";
1388 }
1389 mandatory true;
1390
1391 description
1392 "The length of time that the Measurement Interval ran for, in 0.01
1393 seconds.";
1394 }
1395
1396 uses delay-measurement-stats-group;
1397 uses delay-measurement-bins-group;
1398 }
1399 }
1400 }
1401 }
1402
1403 //
1404 // RPCs related to MEF SOAM PM
1405 //
1406
1407 rpc clear-loss-history-stats {
1408 description
1409 "Clear the Loss Measurement history list (history-availability-stats and
1410 history-measurement-stats) for a specific session. All instance
1411 data is deleted.";
1412
1413 input {
1414 uses msea-cfm:maintenance-association-end-point-reference {
1415 refine maintenance-domain {
1416 mandatory true;
1417 }
1418 refine maintenance-association {
1419 mandatory true;
1420 }
1421 refine maintenance-association-end-point {
1422 mandatory true;
1423 }
1424 }
1425
1426 leaf lm-id {
1427 type leafref {
1428 path "/msea-cfm:mef-cfm/msea-cfm:maintenance-domain/msea-cfm:maintenance-association/msea-cfm:maintenance-association-end-point/msea-soam-pm:loss-measurements/msea-soam-pm:loss-measurement/msea-soam-pm:lm-id";
1429 }
1430 mandatory true;
1431
1432 description
1433 "The LM ID of the loss measurement session of which the loss
1434 measurement history should be cleared";
1435 }
1436 }
1437 }
1438
1439
1440
1441
1442 rpc clear-delay-history-stats {
1443 description
1444 "Clear the Delay Measurement history list (history-stats) for a specific
1445 session. All instance data is deleted.";
1446
1447 input {
1448 uses msea-cfm:maintenance-association-end-point-reference { //Added to specify the MEP SC 10-Dec-15
1449 refine maintenance-domain {
1450 mandatory true;
1451 }
1452 refine maintenance-association {
1453 mandatory true;
1454 }
1455 refine maintenance-association-end-point {
1456 mandatory true;
1457 }
1458 }
1459
1460
1461 leaf dm-id {
1462 type leafref {
1463 path "/msea-cfm:mef-cfm/msea-cfm:maintenance-domain/msea-cfm:maintenance-association/msea-cfm:maintenance-association-end-point/msea-soam-pm:delay-measurements/msea-soam-pm:delay-measurement/msea-soam-pm:dm-id";
1464 }
1465 mandatory true;
1466
1467 description
1468 "The DM ID of the loss measurement session of which the loss
1469 measurement history should be cleared";
1470 }
1471 }
1472 }
1473
1474 //
1475 // Notifications related to MEF SOAM PM
1476 //
1477
1478}
1479