Automation Knowledge Base

PS_PACKETLENGTH [sid] type min max

Explanation

The length distribution of the packets transmitted for a stream.

The length of the packets transmitted for a stream can be varied from packet to packet, according to a choice of distributions within a specified min..max range.

The length of each packet is reflected in the size of the payload portion of the packet, whereas the header has constant length.

Length variation complements, and is independent of, the content variation produced by header modifiers.

sid:

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

type:

coded integer, the kind of distribution:

  • FIXED (all packets have min size)
  • INCREMENTING (incrementing from min to max)
  • BUTTERFLY (min, max, min+1, max-1, min+2, max-2, etc)
  • RANDOM (random between min and max)
  • MIX (a mixture of sizes between 56 and 1518, average 464 bytes)

min:

integer, lower limit on the packet length.

max:

integer, upper limit on the packet length.

Summary

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

Example, set or get:

0/1 PS_PACKETLENGTH [5] BUTTERFLY 100 1500

PS_PAYLOAD [sid] type hexdata

Explanation

The payload content of the packets transmitted for a stream.

The payload portion of a packet starts after the header and continues up until the test payload or the frame checksum. The payload may vary in length and is filled with either an incrementing sequence of byte values or a repeated multi-byte pattern.

Length variation complements and is independent of the content variation produced by header modifiers.

sid:

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

type:

coded integer, the kind of payload content:

  • PATTERN (a pattern is repeated up through the packet)
  • INCREMENTING (bytes are incremented up through the packet)
  • PRBS (bytes are randomized from packet to packet)
  • RANDOM (a randomly generated pattern)

hexdata:

hex bytes, a pattern of bytes to be repeated. The maximum length of the pattern is 18 bytes. Only used if the type is set to PATTERN.

Summary

set and get, stream index, value types: B,H*

Example, set or get:

0/1 PS_PAYLOAD [5] PATTERN 0xAABB00FFEE

PS_EXTPAYLOAD [sid] hexdata

Explanation

This parameter controls the extended payload feature. The PS_PAYLOAD parameter described above only allow the user to specify an 18-byte pattern (when PS_PAYLOAD is set to PATTERN). The PS_EXTPAYLOAD parameter allow the definition of a much larger (up to MTU) payload buffer for each stream. The extended payload will be inserted immediately after the end of the protocol segment area.

The feature requires the P_PAYLOADMODE parameter on the parent port being set to EXTPL. This enables the feature for all streams on this port.

sid:

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

hexdata:

hex bytes, a pattern of bytes to be repeated.

Summary

set and get, stream index, value types: H*

Example, set or get:

0/1 PS_EXTPAYLOAD [5] 0x00112233445566778899AABBCCDDEEFF

PS_CDFOFFSET [sid] offset

Explanation

This parameter is part of the Custom Data Field (CDF) feature. The CDF offset for the stream is the location in the stream data packets where the various CDF data will be inserted. All fields for a given stream uses the same offset value.

The default value is zero (0) which means that the CDF data will be inserted at the very start of the packet, thus overwriting the packet protocol headers. If you want the CDF data to start immediately after the end of the packet protocol headers you will have to set the CDF field offset manually.

The feature requires that the P_PAYLOADMODE parameter on the parent port has been set to CDF. This enables the feature for all streams on this port.

sid:

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

offset:

integer, the location where the CDF data will be inserted.

Summary

set and get, stream index, value types: I

Example, set or get:

0/1 PS_CDFOFFSET [5] 14

PS_CDFCOUNT [sid] count

Explanation

This parameter is part of the Custom Data Field (CDF) feature. It controls the number of data fields available for each stream. You can set a different number of fields for each stream.

Changing the field count value to a larger value will leave all existing fields intact. Changing the field count value to a smaller value will remove all existing fields with an index larger than or equal to the new count.

The feature requires that the P_PAYLOADMODE parameter on the parent port has been set to CDF. This enables the feature for all streams on this port.

The feature requires that the P_PAYLOADMODE parameter on the parent port has been set to CDF. This enables the feature for all streams on this port.

sid:

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

count:

integer, the number of CDF data fields to allocate for the stream.

Summary

set and get, stream index, value types: I

Example, set or get:

0/1 PS_CDFCOUNT [5] 4

PS_CDFDATA [sid, cid] hexdata

Explanation

This parameter is part of the Custom Data Field (CDF) feature. It controls the actual field data for a single field. It is possible to define fields with different data lengths for each stream.

If the length of a data field exceeds (packet length – CDF offset) defined for the stream the field data will be truncated when transmitted.

The feature requires that the P_PAYLOADMODE parameter on the parent port has been set to CDF. This enables the feature for all streams on this port.

sid:

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

cid:

integer, the sub-index value for the data field.

hexdata:

hex bytes, a pattern of bytes to be used.

Summary

set and get, stream index, value types: H*

Example, set or get:

0/1 PS_CDFDATA [5] 0x1122334455667788