oamFramePeriodTlv

oamFramePeriodTlv - implements one type of OAM Event Notification PDU.

SYNOPSIS

oamFramePeriodTlv sub-command options

DESCRIPTION

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

The Errored Frame Period Event TLV counts the number of errored frames detected during the specified period. The period is specified by a number of received frames. This event is generated if the errored frame count is greater than or equal to the specified threshold for that period (for example, if the errored frame count is greater than or equal to 10 for the last 1,000,000 frames received). This event is generated at the end of the event window rather than when the threshold is crossed.

STANDARD OPTIONS
length

Read only. This one-octet field set to 286 (0x1C). Indicates the length (in octets) of this TLV_tuple.

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 four-octet field indicates the duration of the period, in terms of frames, encoded as a 32-bit unsigned integer. (default = 0)

Lower bound: the number of minFrameSize frames that can be received in 100 ms on the underlying physical layer.

Upper bound: the number of minFrameSize frames that can be received in one minute on the underlying physical layer.

frames

This four-octet field indicates the number of detected errored frames in the period, encoded as a 32-bit unsigned integer. (default = 0)

threshold

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

Lower bound: zero symbol errors.

Upper bound: unspecified.

errorRunningTotal

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

eventRunningTotal

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

COMMANDS

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

oamFramePeriodTlv setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See example code under oamHeader.

SEE ALSO

oamHeader, oamEventNotification, oamSymbolPeriodTlv, oamEventOrgTlv, oamFrameTlv, oamSummaryTlv, oamOrganizationSpecificTlv.