oamEventNotification

oamEventNotification - the OAM PDU type Event Notification.

SYNOPSIS

oamEventNotification sub-command options

DESCRIPTION

The oamEventNotification command implements the OAM PDU type Event Notification.

The TLVs connected to this command include: Errored Symbol Period, Errored Frame, Errored Frame Period, Errored Frame Seconds Summary, and Organization Specific.

STANDARD OPTIONS
currentTlvType

Read only. (default = oamEventNotificationEndOfTlv)

Predefined options include:

Option

Value

Usage

oamEventNotificationEndOfTlv

0x00

(default) End of TLV Marker

oamEventNotificationSymbol

0x01

Errored Symbol Period Event

oamEventNotificationFrame

0x02

Errored Frame Event

oamEventNotificationFramePeriod

0x03

Errored Frame Period Event

oamEventNotificationSummary

0x04

Errored Frame Seconds Summary Event

oamEventNotificationOrgSpecific

0xFE

Organization Specific Event

sequenceNumber

The OAM client increments the Sequence Number for each unique Event Notification OAMPDU formed by the OAM client. A particular Event Notification OAMPDU may be sent multiple times with the same sequence number. Upon receiving an Event Notification OAMPDU, the OAM client compares the Sequence Number with the last received Sequence Number. If equal, the current event is a duplicate and is ignored by the OAM client. (default = 0)

COMMANDS

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

oamEventNotification addTlv tlvType

Adds a TLV to OAM Event Notification PDU with TLV type (see currentTlvType, above).

oamEventNotification delTlv tlvIndex

Deletes a TLV from OAM Event Notification with specific Index.

oamEventNotification setTlv tlvIndex

Sets the configuration of the TLV with the specified Index.

oamEventNotification getTlv tlvIndex

Gets the configuration of the TLV with the specified Index.

oamEventNotification getFirstTlv

Gets the first TLV from the list of OAM Event Notification PDUs.

oamEventNotification getNextTlv

Gets the next TLV from the list.

oamEventNotification clearAllTlvs

Clears all TLVs for the Event Notification PDU.

EXAMPLES

See example code under oamHeader.

SEE ALSO

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