Automation Knowledge Base

PS_MODIFIERCOUNT [sid] count

Explanation

The number of standard 16-bit modifiers active on the packet header of a stream. Each modifier is specified using PS_MODIFIER.

sid:

integer, the sub-index value of the stream definition.

count:

integer, the number of modifiers for the stream.

Summary

set and get, stream index, value type: I

Example, set or get:

0/1 PS_MODIFIERCOUNT [5] 1

PS_MODIFIER [sid,mid] pos mask act rep

Explanation

A packet modifier for a stream header. The headers of each packet transmitted for the stream will be varied according to the modifier specification.

This parameter requires two sub-indices, one for the stream and one for the modifier.

A modifier is positioned at a fixed place in the header, selects a number of consecutive bits starting from that position, and applies an action to those bits in each packet. Packets can be repeated so that a certain number of identical packets are transmitted before applying the next modification.

sid:

integer, the sub-index value of the stream definition.

mid:

integer, the sub-index value of the modifier.

pos:

integer, the byte position from the start of the packet.

mask:

four hex bytes, the mask specifying which bits to affect.

act:

coded integer, which action to perform on the affected bits:

  • INC (increment)
  • DEC (decrement)
  • RANDOM (random)

rep:

integer, how many times to repeat each packet.

Summary

set and get, stream index, modifier index, value types: I,HHHH,I,I

Example, set or get:

0/1 PS_MODIFIER [5,0] 6 0x0FC00000 RANDOM 1

PS_MODIFIERRANGE [sid,mid] min step max

Explanation

Range specification for a packet modifier for a stream header, specifying which values the modifier should take on.

This applies only to incrementing and decrementing modifiers; random modifiers always produce every possible bit pattern.

The range is specified as three values: mix, step, and max, where max must be equal to min plus a multiple of step. Note that when “decrement” is specified in PS_MODIFIER as the action, the value sequence will begin with the max value instead of the min value and decrement from there: {max, max-1, max-2, …., min, max, max-1…}.

sid:

integer, the sub-index value of the stream definition.

mid:

integer, the sub-index value of the modifier.

min:

integer, the minimum modifier value.

step:

integer, the increment between modifier values.

max:

integer, the maximum modifier value.

Summary

set and get, stream index, modifier index, value types: I,I,I

Example, set and get:

0/1 PS_MODIFIERRANGE [5,0] 100 10 200

PS_MODIFIEREXTCOUNT [sid] count

Explanation

The number of extended 24-bit modifiers active on the packet header of a stream. Each modifier is specified using PS_MODIFIEREXT.

Notes:

The extended modifier feature works for 40G/100G ports only.

This feature requires Xena server version 375 or higher.

sid:

integer, the sub-index value of the stream definition.

count:

integer, the number of modifiers for the stream.

Summary

set and get, stream index, value type: I

Example, set:

0/1 PS_MODIFIEREXTCOUNT [5] 1

PS_MODIFIEREXT [sid,mid] pos mask act rep

Explanation

An extended packet modifier for a stream header. The headers of each packet transmitted for the stream will be varied according to the modifier specification. The modifier acts on 24 bits and takes up the space for two 16-bit modifiers to do this.

This parameter requires two sub-indices, one for the stream and one for the modifier.

A modifier is positioned at a fixed place in the header, selects a number of consecutive bits starting from that position, and applies an action to those bits in each packet. Packets can be repeated so that a certain number of identical packets are transmitted before applying the next modification.

Notes:

The extended modifier feature works for 40G/100G ports only.

This feature requires Xena server version 375 or higher.

sid:

integer, the sub-index value of the stream definition.

mid:

integer, the sub-index value of the modifier.

pos:

integer, the byte position from the start of the packet. Cannot be < 1 !

mask:

four hex bytes, the mask specifying which bits to affect.

act:

coded integer, which action to perform on the affected bits:

  • INC (increment) – Note: This is the only value supported for now.

rep:

integer, how many times to repeat each packet. Note: For now the only value supported is 1.

Summary

set and get, stream index, modifier index, value types: I,HHHHHHHH,I,I

Example, set or get:

0/1 PS_MODIFIEREXT [5,0] 6 0xFFFFFF00 INC 1

PS_MODIFIEREXTRANGE [sid,mid] min step max

Explanation

Range specification for an extended packet modifier for a stream header, specifying which values the modifier should take on.

This applies only to incrementing and decrementing modifiers; random modifiers always produce every possible bit pattern.

The range is specified as a three values: mix, step, and max, where max must be equal to min plus a multiple of step. Note that when “decrement” is specified in PS_MODIFIEREXT as the action, the value sequence will begin with the max value instead of the min value and decrement from there: {max, max-1, max-2, …., min, max, max-1…}.

sid:

integer, the sub-index value of the stream definition.

mid:

integer, the sub-index value of the modifier.

min:

iinteger, the minimum modifier value.

step:

integer, the increment between modifier values.

max:

integer, the maximum modifier value.

rep:

integer, how many times to repeat each packet. Note: For now the only value supported is 1.

Summary

set and get, stream index, modifier index, value types: I,I,I

Example, set or get:

0/1 PS_MODIFIEREXTRANGE [5,0] 100 10 200