oamSummaryTlv

oamSummaryTlv - implements one type of OAM Event Notification PDU.

SYNOPSIS

oamSummaryTlv sub-command options

DESCRIPTION

The oamSummaryTlv command implements one type of OAM Event Notification PDU.

The Errored Frame Seconds Summary Event TLV counts the number of errored frame seconds that occurred during the specified period. The period is specified by a time interval. This event is generated if the number of errored frame seconds is equal to or greater than the specified threshold for that period. An errored frame second is a one second interval wherein at least one frame error was detected.

This event is generated at the end of the event window rather than when the threshold is crossed.

STANDARD OPTIONS
length

Read only. Set to 18 (0x12). This one-octet field indicates the length (in octets) of this TLV_tuple.

frameSeconds

This two-octet field indicates the number of errored frame seconds in the period, encoded as a 16-bit unsigned integer. (default = 0)

timestamp

This two-octet field indicates the time reference when the event was generated, in terms of 100 ms intervals, encoded as a 16-bit unsigned integer. (default = 0)

window

This two-octet field indicates the duration of the period in terms of 100 ms intervals, encoded as a 16-bit unsigned integer. (default = 0)

Lower bound: 10 seconds

Upper bound: 900 seconds

threshold

This two-octet field indicates the number of errored frame seconds in the period is required to be equal to or greater than in order for the event to be generated, encoded as a 16-bit unsigned integer. (default = 0)

Lower bound: zero errored seconds

Upper bound: unspecified

errorRunningTotal

This four-octet field indicates the sum of errored frame seconds that have been detected since the OAM sublayer was reset. (default = 0)

eventRunningTotal

This four-octet field indicates the number of Errored Frame Seconds Summary Event TLVs that have been generated since the OAM sublayer was reset, encoded as a 32-bit unsigned integer. (default = 0)

COMMANDS

The oamSummaryTlv command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.

oamSummaryTlv setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See example code under oamHeader.

SEE ALSO

oamHeader, oamEventNotification, oamOrganizationSpecificTlv, oamLocalInformationTlv, oamRemoteInformationTlv, oamSymbolPeriodTlv, oamFrameTlv, oamFramePeriodTlv.