atmOamTrace

atmOamTrace - configure ATM OAM messages to be transmitted

SYNOPSIS

atmOamTrace sub-command options

DESCRIPTION

The atmOamTrace command is used to retrieve ATM OAM messages. These are collected for any OAM message in which the enableTrace option was set to true when atmOam add was called.

Messages are collected into a circular buffer of maxNumTrace messages in size. Newest entries replace oldest entries as necessary. The get chassis card port sub-command is used to retrieve all of the message. The other get commands are used to look at particular entries.

STANDARD OPTIONS
cellInformation

Read-only. Cell information for the trace cell.

functionType

Read-only. The OAM function type.

Option

Value

Usage

atmOamAis

0

AIS.

atmOamRdi

1

RDI.

atmOamFaultMgmtCC

2

Fault Management CC.

atmOamFaultMgmtLB

3

Fault Management LB.

atmOamActDeactCC

4

Activate - Deactivate.

maxNumTrace

The maximum number of traces to be stored in the in-memory buffer. The buffer is used in a circular manner, with the most recent traces overwriting the oldest entries. (default = 256)

numTrace

Read-only. The number of trace messages currently in the list.

timeStamp

Read-only. The timestamp of the trace message, in the format:

YYYY/MM/DD HH: MM: SS.SSS

traceString

Read-only. The trace message as a complete string.

txRxType

Read-only. An indication of whether the trace is from a transmission or reception.

Option

Value

Usage

atmOamTraceTx

0

Transmit

atmOamTraceRx

1

Receive

vci

Read-only. The VCI value from the trace message.

vpi

Read-only. The VPI value from the trace message.

COMMANDS

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

atmOamTrace cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the atmOamTrace command.

atmOamTrace config option value

Modify the configuration options of the atmOamTrace. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for atmOamTrace.

atmOamTrace clear

Removes all trace messages from the list.

atmOamTrace get chasID cardID portID

atmOamTrace get traceIndex

In the first form, the trace list is retrieved. The first trace message is unpacked into the options of this command. Specific errors are:

In the second form, the trace message at traceIndex is accessed and unpacked into the options of this command. The first message has a traceIndex of 0. A call to getNext accesses the message following traceIndex. Specific errors are:

atmOamTrace get First

Accesses the first trace message in the list, whose values can be found in the STANDARD OPTIONS for this command. Specific errors are:

atmOamTrace get Next

Accesses the next trace message in the list, whose values can be found in the STANDARD OPTIONS for this command.Specific errors are:

atmOamTrace set chasID cardID portID

Sets the configuration of the atmOamTrace in IxHAL for the port indicated. Specific errors are:

atmOamTrace set Default

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See examples under atmOam

SEE ALSO

atmOam, atmOamActDeact, atmOamAis, atmOamFaultManagementCC, atmOamFaultManagementLB, atmOamRdi, atmPort