traffic-generator

---

tool/traffic-generator

Type: Settings Directory

Argument	Type	Description
test-id	num
measure-out-of-order	bool
latency-distribution-max	time
stats-samples-to-keep	num

Read-only Argument	Type	Description
running	bool
latency-distribution-samples	num
latency-distribution-measure-interval	string

tool/traffic-generator/inject

Type: Command

Argument	Type	Description
interface	iface_enum
data	string
priority ( unset )	num

tool/traffic-generator/inject-pcap

Type: Command

Argument	Type	Description
interface	iface_enum
pcap-file	file
speed-multiplier	num
loop	bool

Read-only Argument	Type	Description
iteration	num
tx-packets	num
tx-bytes	num

tool/traffic-generator/packet-template

Type: Directory

Argument	Type	Description
name	string
header-stack	multi { enum (mac | vlan | ip | udp | raw | ipv6 | tcp) { mac:1, vlan:2, ip:3, udp:4, raw:5, ipv6:6, tcp:7 } }
port	enum
interface	iface_enum
mac-src	multi { array-id, array-id, composite { , } { , } }
mac-dst	multi { array-id, array-id, composite { , } { , } }
mac-protocol	multi { alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } }
vlan-priority	multi { num [ .. 7] }
vlan-id	multi { num [ .. 4095] }
vlan-protocol	multi { alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } }
ip-dscp	multi { num [ .. 255] }
ip-id	multi { num [ .. 65535] }
ip-frag-off	multi { num [ .. 65535] }
ip-ttl	multi { num [ .. 255] }
ip-src	multi { array-id, array-id, ipRange }
ip-dst	multi { array-id, array-id, ipRange }
ip-protocol	multi { enum () { } }
ip-gateway	ipAddr
udp-src-port	multi { array-id, array-id, range [ .. 65535] }
udp-dst-port	multi { array-id, array-id, range [ .. 65535] }
udp-checksum	multi { array-id, num [ .. 65535] }
raw-header	multi { string }
ipv6-src	multi { array-id, array-id, ip6Prefix }
ipv6-dst	multi { array-id, array-id, ip6Prefix }
ipv6-next-header	multi { enum () { } }
ipv6-gateway	ip6Addr
ipv6-traffic-class	multi { num [ .. 255] }
ipv6-flow-label	multi { num [ .. 0xfffff] }
ipv6-hop-limit	multi { num [ .. 255] }
tcp-src-port	multi { array-id, array-id, range [ .. 65535] }
tcp-dst-port	multi { array-id, array-id, range [ .. 65535] }
tcp-syn	multi { array-id, array-id, range }
tcp-ack	multi { array-id, array-id, range }
tcp-data-offset	multi { num [ .. 15] }
tcp-flags	multi { ubit (fin, syn, rst, psh, ack, urg, ece, cwr, ns, res0, res1, res2) { fin, syn, rst, psh, ack, urg, ece, cwr, ns, res0, res1, res2 } }
tcp-window-size	multi { num [ .. 65535] }
tcp-urgent-pointer	multi { num [ .. 65535] }
data	enum (uninitialized | random | specific-byte | incrementing)
data-byte	num
random-byte-offsets-and-masks	multi { array-id, array-id, composite { , } { , } }
random-ranges	object { super { num [ .. 256] , :enum (8 | 16 | 32) { 8:8, 16:16, 32:32 } , :range } { num [ .. 256] , :enum (8 | 16 | 32) { 8:8, 16:16, 32:32 } , :range } }
special-footer	bool
compute-checksum-from-offset	num

Read-only Argument	Type	Description
assumed-port	enum (none)
assumed-interface	iface_enum
assumed-mac-src	multi { macAddr }
assumed-mac-dst	multi { macAddr }
assumed-mac-protocol	multi { alt { enum () { } , num } { enum () { } , num } }
assumed-vlan-priority	multi { num }
assumed-vlan-id	multi { num }
assumed-vlan-protocol	multi { alt { enum () { } , num } { enum () { } , num } }
assumed-ip-dscp	multi { num }
assumed-ip-id	multi { num }
assumed-ip-frag-off	multi { num }
assumed-ip-ttl	multi { num }
assumed-ip-src	multi { ipAddr }
assumed-ip-dst	multi { ipAddr }
assumed-ip-protocol	multi { enum () { } }
assumed-udp-src-port	multi { num }
assumed-udp-dst-port	multi { num }
assumed-udp-checksum	multi { num }
assumed-raw-header	multi { string }
assumed-ipv6-src	multi { ip6Addr }
assumed-ipv6-dst	multi { ip6Addr }
assumed-ipv6-next-header	multi { enum () { } }
assumed-ipv6-traffic-class	multi { num }
assumed-ipv6-flow-label	multi { num }
assumed-ipv6-hop-limit	multi { num }
assumed-tcp-src-port	multi { num }
assumed-tcp-dst-port	multi { num }
assumed-tcp-syn	multi { num }
assumed-tcp-ack	multi { num }
assumed-tcp-data-offset	multi { num }
assumed-tcp-flags	multi { num }
assumed-tcp-window-size	multi { num }
assumed-tcp-urgent-pointer	multi { num }

tool/traffic-generator/port

Type: Directory

Flag	Name	Description
X	disabled	disabled
I	invalid	invalid
D	dynamic	dynamic

Argument	Type	Description
name	string
interface ( mandatory )	iface_enum

Read-only Argument	Type	Description
first-header	enum (mac | vlan | ip | udp | raw | ipv6 | tcp)

tool/traffic-generator/quick

Type: Command

Argument	Type	Description
entries-to-show	num
test-id	num
measure-out-of-order	bool
cpu-core	multi { array-id, array-id, range [0 .. 255] }
stream	multi { enum }
port	multi { enum }
interface	multi { iface_enum }
id	multi { num [0 .. 255] }
packet-size	multi { array-id, array-id, range [1 .. 65535] }
pps	multi { num }
mbps	multi { num }
tx-template	multi { enum }
packet-count	multi { num }

Read-only Argument	Type	Description
seq	enum (TOT)
id	enum (TOT)
tx-packet	num
tx-rate	num
rx-packet	num
rx-rate	num
rx-ooo	num
rx-bad-csum	num
lost-packet	num
lost-rate	num
lost-ratio	string
lat-min	string
lat-avg	string
lat-max	string
jitter	string

tool/traffic-generator/raw-packet-template

Type: Directory

Flag	Name	Description
D	dynamic	dynamic

Argument	Type	Description
name	string
port	enum
header	string
data	enum (uninitialized | random | specific-byte | incrementing)
data-byte	num
random-byte-offsets-and-masks	multi { array-id, array-id, composite { , } { , } }
random-ranges	object { super { num [ .. 256] , :enum (8 | 16 | 32) { 8:8, 16:16, 32:32 } , :range } { num [ .. 256] , :enum (8 | 16 | 32) { 8:8, 16:16, 32:32 } , :range } }
ip-header-offset	multi { num [ .. 65535] }
ipv6-header-offset	multi { num [ .. 65535] }
udp-header-offset	multi { num [ .. 65535] }
udp-compute-checksum	multi { bool }
tcp-header-offset	multi { num [ .. 65535] }
special-footer	bool
compute-checksum-from-offset	num

Read-only Argument	Type	Description
header-length	num

tool/traffic-generator/start

Type: Command

Argument	Type	Description
test-id	num
measure-out-of-order	bool
cpu-core	multi { array-id, array-id, range [0 .. 255] }
stream	multi { enum }
port	multi { enum }
interface	multi { iface_enum }
id	multi { num [0 .. 255] }
packet-size	multi { array-id, array-id, range [1 .. 65535] }
pps	multi { num }
mbps	multi { num }
tx-template	multi { enum }
packet-count	multi { num }

tool/traffic-generator/stats

Type: Directory

tool/traffic-generator/stats/latency-distribution

Type: Directory

Argument	Type	Description
stream-id	num
port	enum
seq	range

Read-only Argument	Type	Description
latency	string
count	num
share	num
graph	meter

tool/traffic-generator/stats/port

Type: Directory

Read-only Argument	Type	Description
seq	enum (TOT)
port	composite { , }
rx-unk-packet	num
rx-unk-byte	num
rx-unk-rate	num
tx-packet	num
tx-byte	num
tx-rate	num
rx-packet	num
rx-byte	num
rx-rate	num
rx-ooo	num
rx-bad-csum	num
lost-packet	num
lost-byte	num
lost-rate	num
lost-ratio	string
lat-min	string
lat-avg	string
lat-max	string
jitter	string

tool/traffic-generator/stats/raw

Type: Directory

Read-only Argument	Type	Description
seq	enum (TOT)
port	composite { , }
id	enum (TOT)
tx-packet	num
tx-byte	num
tx-rate	num
rx-packet	num
rx-byte	num
rx-rate	num
rx-ooo	num
rx-bad-csum	num
lost-packet	num
lost-byte	num
lost-rate	num
lost-ratio	string
lat-min	string
lat-avg	string
lat-max	string
jitter	string

tool/traffic-generator/stats/stream

Type: Directory

Read-only Argument	Type	Description
seq	enum (TOT)
id	enum (TOT)
tx-packet	num
tx-byte	num
tx-rate	num
rx-packet	num
rx-byte	num
rx-rate	num
rx-ooo	num
rx-bad-csum	num
lost-packet	num
lost-byte	num
lost-rate	num
lost-ratio	string
lat-min	string
lat-avg	string
lat-max	string
jitter	string

tool/traffic-generator/stop

Type: Command

tool/traffic-generator/stream

Type: Directory

Flag	Name	Description
X	disabled	disabled
I	invalid	invalid

Argument	Type	Description
name	string
port	enum
id	num
packet-size	range
pps	num
mbps	num
packet-count	num
cpu-core	range
tx-template ( mandatory )	enum

Read-only Argument	Type	Description
default-port	enum