oamLocalInformationTlv

oamLocalInformationTlv - implements one type of OAM Information TLV.

SYNOPSIS

oamLocalInformationTlv sub-command options

DESCRIPTION

The oamLocalInformationTlv command implements one type of OAM Information PDU. Local and remote information is used in the discovery process.

STANDARD OPTIONS
length

Read only. Set to 0. Indicates the length (in octets) of this TLV_tuple.

enableLinkEvents

true/false

Enable to interpret link events. (default = false)

enableOamPassive

Mode true/false

DTE configured in active (true) or passive mode. (default = false)

enableRemote

Loopback true/false

Enable OAM remote loopback mode. (default = false)

enableUnidirectional

true/false

OAM provides an OAM PDU-based mechanism to notify the remote DTE when one direction of a link is non-operational and therefore data transmission is disabled. The ability to operate a link in a unidirectional mode for diagnostic purposes supports failure detection and notification. (default = false)

enableVariable

Retrieval true/false

Enable variable retrieval (oamVariableRequest). (default = false)

maxPduSize

11-bit field which represents the largest OAM PDU, in octets, supported by the DTE. This value is compared to the remote's Maximum PDU Size and the smaller of the two is used. (default = 0)

multiplexerAction

Multiplexer function is responsible for passing frames received from the superior sublayer (for example, MAC client sublayer), OAMPDUs from the Control function and loopback frames from the Parser, to the subordinate sublayer (for example, MAC sublayer). (default = oamMultiplexerActionForward))

Option

Value

Usage

oamMultiplexerActionForward

0x00

(default) sends on the request over the wire

oamMultiplexerActionDiscard

0x01

discards the request

parserAction

Parser distinguishes among OAMPDUs, MAC client frames and loopback frames and passes each to the appropriate entity (Control, superior sublayer and Multiplexer, respectively). (default = oamParserActionForward))

Option

Value

Usage

oamParserActionForward

0x00

(default) lower layer forwards request to upper layer

oamParserActionLoopback

0x01

lower layer sends back request

oamParserActionDiscard

0x02

lower layer discards request

oamParserActionInvalid

0x03

parser action is invalid

revision

The current revision of the Information TLV. The value of this field shall start at zero and be incremented each time something in the Information TLV changes. (default = 0)

oamVersion

Read only. Set to 1.

oui

Organization unique identifier. 3 hex bytes. (default = '00 00 00')

vendorSpecific

Information

An unspecified list of hex bytes. May be used to differentiate a vendor's product models/versions. (default = '00 00 00 00')

COMMANDS

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

oamLocalInformationTlv setDefault

Sets to IxTclHal default values for all configuration options for this command.

EXAMPLES

See example code under oamHeader.

SEE ALSO

oamHeader, oamInformation, oamRemoteInformationTlv, oamOrganizationSpecificTlv.