org.onosproject.incubator.net.l2monitoring.soam.loss

Interface LossMeasurementCreate

All Superinterfaces:

MeasurementCreateBase

All Known Subinterfaces:

LossMeasurementEntry

All Known Implementing Classes:

DefaultLmCreate, DefaultLmEntry

public interface LossMeasurementCreate
extends MeasurementCreateBase

Object to support creation of Loss Measurement tests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LossMeasurementCreate.CounterOption Options for Counters that may be enabled.
static interface	LossMeasurementCreate.LmCreateBuilder Builder for LossMeasurementCreate.
static class	LossMeasurementCreate.LmType Enumerated set of Loss Measurement types.

Nested classes/interfaces inherited from interface org.onosproject.incubator.net.l2monitoring.soam.MeasurementCreateBase

MeasurementCreateBase.MeasCreateBaseBuilder, MeasurementCreateBase.SessionType

Method Summary

Modifier and Type	Method and Description
MilliPct	availabilityFlrThreshold() Specifies a configurable availability threshold to be used in evaluating the availability/unavailability status of an availability indicator per MEF 10.2.1.
java.time.Duration	availabilityMeasurementInterval() This object specifies the availability measurement interval.
java.lang.Integer	availabilityNumberConsecutiveFlrMeasurements() Specifies a configurable number of consecutive loss measurement PDUs.
java.lang.Short	availabilityNumberConsecutiveHighFlr() Specifies a configurable number of consecutive availability indicators.
java.lang.Short	availabilityNumberConsecutiveIntervals() Specifies a configurable number of consecutive availability indicators to be used to determine a change in the availability status as indicated by MEF 10.2.1.
java.util.Collection<LossMeasurementCreate.CounterOption>	countersEnabled() A vector of bits that indicates the type of SOAM LM counters found.
LossMeasurementCreate.LmType	lmCfgType() The type of Loss Measurement that will be performed.
java.util.Collection<LossMeasurementThreshold>	lossMeasurementThreshold() The list of Loss Measurement configuration threshold values for LM Performance Monitoring.

Methods inherited from interface org.onosproject.incubator.net.l2monitoring.soam.MeasurementCreateBase

alignMeasurementIntervals, alignMeasurementOffset, dataPattern, frameSize, measurementInterval, messagePeriod, numberIntervalsStored, priority, remoteMepId, sessionType, startTime, stopTime, testTlvIncluded, testTlvPattern, version

Method Detail

lmCfgType

LossMeasurementCreate.LmType lmCfgType()

The type of Loss Measurement that will be performed.

Returns:

A loss Measurement type

countersEnabled

java.util.Collection<LossMeasurementCreate.CounterOption> countersEnabled()

A vector of bits that indicates the type of SOAM LM counters found. in the current-stats and history-stats that are enabled. A present bit enables the specific SOAM LM counter. A not present bit disables the SOAM LM counter. If a particular SOAM LM counter is not supported the BIT value is not present. Not all SOAM LM counters are supported for all SOAM LM types.

Returns:

A collection of bit options

availabilityMeasurementInterval

java.time.Duration availabilityMeasurementInterval()

This object specifies the availability measurement interval. A measurement interval of 15 minutes is to be supported, other intervals can be supported

Returns:

A java Duration

availabilityNumberConsecutiveFlrMeasurements

java.lang.Integer availabilityNumberConsecutiveFlrMeasurements()

Specifies a configurable number of consecutive loss measurement PDUs. to be used in evaluating the availability/unavailability status of each availability indicator per MEF 10.2.1. Loss Measurement PDUs (LMMs, CCMs or SLMs) are sent regularly with a period defined by message-period. Therefore, this object, when multiplied by message-period, is equivalent to the Availability parameter of 'delta_t' as specified by MEF 10.2.1. If the measurement-type is lmm or ccm, this object defines the number of LMM or CCM PDUs transmitted during each 'delta_t' period. The Availability flr for a given 'delta_t' can be calculated based on the counters in the last LMM/R or CCM during this 'delta_t' and the last LMM/R or CCM in the previous 'delta_t'. If the measurement-type is slm, this object defines the number of SLM PDUs transmitted during each 'delta_t' period. The Availability flr for a given 'delta_t' is calculated based on the number of those SLM PDUs that are lost. If the measurement-type is lmm or ccm, the number range of 1 through 10 must be supported. The number range of 10 through 1000000 may be supported, but is not mandatory. If the measurement-type is slm, the number range of 10 through 100 must be supported. The number range of 100 through 1000000 may be supported, but is not mandatory

Returns:

number of consecutive loss measurement PDUs

availabilityFlrThreshold

MilliPct availabilityFlrThreshold()

Specifies a configurable availability threshold to be used in evaluating the availability/unavailability status of an availability indicator per MEF 10.2.1. The availability threshold range of 0.00 (0) through 1.00 (100000) is supported. This parameter is equivalent to the Availability parameter of 'C' as specified by MEF 10.2.1.

Returns:

Units are in milli-percent, where 1 indicates 0.001 percent

availabilityNumberConsecutiveIntervals

java.lang.Short availabilityNumberConsecutiveIntervals()

Specifies a configurable number of consecutive availability indicators to be used to determine a change in the availability status as indicated by MEF 10.2.1. This parameter is equivalent to the Availability parameter of 'n' as specified by MEF 10.2.1. The number range of 1 through 10 must be supported. The number range of 1 through 1000 may be supported, but is not mandatory

Returns:

number of consecutive availability indicators

availabilityNumberConsecutiveHighFlr

java.lang.Short availabilityNumberConsecutiveHighFlr()

Specifies a configurable number of consecutive availability indicators. to be used for assessing CHLI. This parameter is equivalent to the Resilency parameter of 'p' as specified by MEF 10.2.1. Availability-consecutive-high-flr must be strictly less than availability-number-consecutive-intervals. If not, the count of high loss intervals over time, and the count of consecutive high loss levels, is disabled. The number range of 1 through 10 must be supported. The number range of 1 through 1000 may be supported, but is not mandatory

Returns:

number of consecutive availability indicators

lossMeasurementThreshold

java.util.Collection<LossMeasurementThreshold> lossMeasurementThreshold()

The list of Loss Measurement configuration threshold values for LM Performance Monitoring. The main purpose of the threshold configuration list is to configure threshold alarm notifications indicating that a specific performance metric is not being met

Returns:

A collection of Loss Measurement Thresholds