oamSymbolPeriodTlv
oamSymbolPeriodTlv - implements one type of OAM Event Notification PDU.
SYNOPSIS
oamSymbolPeriodTlv sub-command options
DESCRIPTION
The oamSymbolPeriodTlv command implements one type of OAM Event Notification PDU. It counts the number of symbol errors that occurred during the specified period. The period is specified by the number of symbols that can be received in a time interval on the underlying physical layer. This event is generated if the symbol error count is equal to or greater than the specified threshold for that period
STANDARD OPTIONS
length
Read only. This one-octet field set to 40 (0x28) Indicates the length (in octets) of this TLV_tuple.
symbols
This eight-octet field indicates the number of symbol errors in the period, , encoded as a 64-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 eight-octet field indicates the number of symbols in the period, encoded as a 64-bit unsigned integer. (default = 0)
Lower bound: the number of symbols in one second for the underlying physical layer.
Upper bound: the number of symbols in one minute for the underlying physical layer.
threshold
This eight-octet field indicates the number of errored symbols in the period is required to be equal to or greater than in order for the event to be generated, encoded as a 64-bit unsigned integer. (default = 0)
Lower bound: zero symbol errors.
Upper bound: unspecified.
errorRunningTotal
This eight-octet field indicates the sum of symbol errors since the OAM sublayer was reset. (default = 0)
eventRunningTotal
This four-octet field indicates the number of Errored Symbol Period Event TLVs that have been generated since the OAM sublayer was reset, encoded as a 32-bit unsigned integer. (default = 0)
COMMANDS
The oamSymbolPeriodTlv command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
oamSymbolPeriodTlv setDefault
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See example code under oamHeader.
SEE ALSO
oamHeader, oamEventNotification, oamOrganizationSpecificTlv, oamLocalInformationTlv, oamRemoteInformationTlv, oamFrameTlv, oamFramePeriodTlv.