Automation Knowledge Base

PS_RATEFRACTION [sid] fraction

Explanation

The rate of the traffic transmitted for a stream expressed in millionths of the effective rate for the port.

The bandwidth consumption includes the inter-frame gap and is independent of the length of the packets generated for the stream. The sum of the bandwidth consumption for all the enabled streams must not exceed the effective rate for

the port.

Setting this parameter also instructs the Manager to attempt to keep the rate-percentage unchanged in case it has to cap stream rates. Getting it is only valid if the rate was last set using this parameter. sid: integer, the sub-index value of the stream definition.

fraction:

integer, stream rate expressed as a value between 0..1000000.

Summary

set and get, stream index, value type: I

Example, set:

0/1 PS_RATEFRACTION [5] 500000


PS_RATEPPS [sid] pps

Explanation

The rate of the traffic transmitted for a stream expressed in packets per second.

The bandwidth consumption is heavily dependent on the length of the packets generated for the stream, and also on the inter-frame gap for the port. The sum of the bandwidth consumption for all the enabled streams must not exceed the effective rate for

the port.

Setting this parameter also instructs the Manager to attempt to keep the packets-per-second unchanged in case it has to cap stream rates. Getting it is only valid if the rate was the last set using this parameter. sid: integer, the sub-index value of the stream definition.

pps:

integer, stream rate expressed as packets per second.

Summary

set and get, stream index, value type: I

Example, set or get:

0/1 PS_RATEPPS [5] 300000


PS_RATEL2BPS [sid] bps

Explanation

The rate of the traffic transmitted for a stream, expressed in units of bits-per-second at layer-2, thus including the Ethernet header but excluding the inter-frame gap. The bandwidth consumption is somewhat dependent on the length of the packets generated for the stream, and also on the inter-frame gap for the port.

The sum of the bandwidth consumption for all the enabled streams must not exceed the effective rate for the port. Setting this parameter also instructs the Manager to attempt to keep the layer-2 bps rate unchanged in case it has to cap stream rates. Getting it is only valid if the rate was the last set using this parameter.

sid:

integer, the sub-index value of the stream definition. bps: long integer, stream rate expressed as bits-per-second.

Summary

set and get, stream index, value type: L

Example, set:

0/1 PS_RATEL2BPS [5] 800000000


PS_RATE [sid]?

Explanation

Query the rate of the traffic transmitted for a stream in the manner it was last expressed. The response is one of PS_RATEFRACTION, PS_RATEPPS, or PS_RATEL2BPS.

This is the rate that is highlighted in the Manager, and the one it attempts to keep unchanged in case it has to cap stream rates.

sid:

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

Summary

get only, stream index.

Example, set:

0/1 PS_RATE [5] ?


PS_BURST [sid] size density

Explanation

The burstiness of the traffic transmitted for a stream, expressed in terms of the number of packets in each burst, and how densely they are packed together.

The burstiness does not affect the bandwidth consumed by the stream, only the spacing between the packets.

A density value of 100 means that the packets are packed tightly together, only spaced by the minimum inter-frame gap. A value of 0 means even, non-bursty, spacing. The exact spacing achieved depends on the other enabled streams of the port.

Note

For each stream, the burst size value may not exceed 500 packets. However, when the Port TX Mode is ”Burst”*, the maximum burst size value for each stream is 10000.

The density value is not used when Port TX Mode is ”Burst”*

sid:

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

size:

integer, the number of packets lumped together in a burst.

density:

integer, the percentage of the available spacing that is inserted between bursts.

Summary

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

Example, set or get:

0/1 PS_BURST [5] 4 50

*Feature requires software release 76 or higher


PS_BURSTGAP [sid] ipg ibg*

Explanation

In Burst tx mode this parameter defines the gap between packets in a burst (inter-packet gap) and the gap after a burst defined in one stream stops until a burst defined in the next stream starts (inter-burst gap).

Note

Only used when Port TX Mode is ”Burst”

sid:

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

ipg:

integer, Burst Inter Packet Gap (in bytes). 

ibg:

integer, Inter Burst Gap (in bytes). 

Summary

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

Example, set or get:

  • 0/1 PS_BURSTGAP [5] 20 500

*Feature requires software release 76 or higher


PS_PACKETLIMIT [sid] count

Explanation

Based on different port transmission mode, the meaning of this API is different.

When Port TX Mode is set to NORMAL, STRICT UNIFORM or BURST*: The number of packets that will be transmitted when traffic is started on a port. A value of 0 or -1 makes the stream transmit continuously.

sid:

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

count:

integer, the number of packets.

0 or -1 (disable packet limitation)

Summary

set and get, stream index, value type: I

Example, set or get:

  • P_TXMODE  NORMAL
  • PS_PACKETLIMIT [5] 25 

Explanation

When Port TX Mode is set to SEQUENTIAL: The number of sequential packets sent before switching to the next stream. The minimum value is 1. The port will transmit continuously until the user stops the traffic.

sid:

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

count:

integer, the number of packets. 1 or larger (minimum value since the port transmits at least 1 packet per stream per round)

Summary

set and get, stream index, value type: I

Example, set or get:

P_TXMODE  SEQUENTIAL

PS_PACKETLIMIT [0] 5

PS_PACKETLIMIT [1] 5

*Feature requires software release 76 or higher