sequenceNumberUdf

sequenceNumberUdf - provides per-flow sequence numbers

SYNOPSIS

sequenceNumberUdf sub-command options

DESCRIPTION

SequenceNumberUdf is a new UDF field that provides per-flow sequence numbers. It knows what flow number is in a packet by pulling the flow number from an existing UDF 1-5. That existing UDF is known as the associated UDF.

The feature is enabled with the enable option.

STANDARD OPTIONS
enable
true/false

Enables/disables Sequence Number UDF function. (default = false)

byteOffset

The byte offset where the sequenceNumberUdf is placed. (default = 0)

associatedUdfID

The UDF that serves as the source for the flow number.( Note: The flow number is an input.) (default = 1)

associatedUdfBit
Position

Bit offset of the flow number within the associated Udf. The value ranges from 0-7 for TPM cards. (default = 0)

associatedUdfWidth

Width to use for the associated Udf. The value ranges from 1-31 for TPM cards and 1-32 for all other card types.

associatedUdfMin

The minimum value of the associated Udf. Must be less than assocatedUdfMax. (default = 0)

associatedUdfMax

The maximum value of the associated Udf. (default = 4294967295)
Limitation: maximum - minimum < 216 (48k for LM1000 series load modules) or maximum - minimum < 219 (512k for LSM10G series load modules)

COMMANDS

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

sequenceNumberUdf cget option

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

sequenceNumberUdf config option value

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

sequenceNumberUdf get chasID cardID portID

Gets the current configuration of the sequenceNumberUdf for port with id portID on card cardID, chassis chasID from its hardware. Note that stream get must be called before this sub-command. Call this command before calling sequenceNumberUdf cget option value to get the value of the configuration option. Specific errors are:

sequenceNumberUdf set chasID cardID portID

Sets the configuration of the sequenceNumberUdf in IxHAL for a port by reading the configuration option values set by the sequenceNumberUdf config option value command. Specific errors are:

sequenceNumberUdf setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

package req IxTclHal

set hostName woodstock

if {[ixConnectToChassis $hostName] } {

Trace "Error connecting to $hostName"

}

set chassId [chassis cget -id]

set portList [list]

set chassis [chassis cget -id]

set card 4

set port 1

set streamId 1

set portList [list [list $chassis $card $port]]

# Stream 1

stream setDefault

stream config -name "Stream $streamId"

stream config -enable $::true

stream config -framesize 100

stream config -frameSizeType $::sizeFixed

udf setDefault

udf config -enable $::true

udf config -offset 40

udf config -bitOffset 0

udf config -udfSize 8

udf config -initval 03

udf config -repeat 3

udf config -step 1

if {[udf set 1] } {

errorMsg "Error setting udf 1."

}

sequenceNumberUdf setDefault

sequenceNumberUdf config -enable $::true

sequenceNumberUdf config -byteOffset 42

sequenceNumberUdf config -associatedUdfID 1

sequenceNumberUdf config -associatedUdfBitPosition 0

sequenceNumberUdf config -associatedUdfWidth 4

sequenceNumberUdf config -associatedUdfMin 3

sequenceNumberUdf config -associatedUdfMax 5

if {[sequenceNumberUdf set $chassis $card $port] } {

errorMsg "Error setting sequenceNumberUdf on $chassis $card $port for stream $streamId."

}

if {[stream set $chassis $card $port $streamId] } {

errorMsg "Error setting stream on $chassis $card $port for stream $streamId."

}

ixWriteConfigToHardware portList

SEE ALSO

udf.