sniffer

---

tool/sniffer

Type: Settings Directory

Argument	Type	Description
only-headers	bool
memory-limit	num
memory-scroll	bool
file-name	file_enum
file-limit	num
streaming-enabled	bool
streaming-server	composite_arg { , }
max-packet-size	num
filter-stream	bool
filter-interface	obj_arg { interface_enum }
filter-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
filter-src-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
filter-dst-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
filter-mac-protocol	obj_arg { super { ! , alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } } { ! , alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } } }
filter-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
filter-src-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
filter-dst-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
filter-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
filter-src-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
filter-dst-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
filter-ip-protocol	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
filter-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
filter-src-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
filter-dst-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
filter-vlan	obj_arg { super { ! , num [ .. 4095] } { ! , num [ .. 4095] } }
filter-cpu	obj_arg { super { ! , num } { ! , num } }
filter-size	obj_arg { super { ! , range_arg [0 .. 65535] } { ! , range_arg [0 .. 65535] } }
filter-direction	enum (any | tx | rx)
filter-operator-between-entries	enum (or | and)
quick-rows	num
quick-show-frame	bool

Read-only Argument	Type	Description
running	bool

tool/sniffer/start

Type: Command

Argument	Type	Description
interface	obj_arg { interface_enum }
mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
src-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
dst-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
mac-protocol	obj_arg { super { ! , alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } } { ! , alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } } }
ip-protocol	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
src-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
dst-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
src-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
dst-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
src-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
dst-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
vlan-id	obj_arg { super { ! , num [ .. 4095] } { ! , num [ .. 4095] } }
direction	enum (any | tx | rx)
operator-between-entries	enum (or | and)
cpu	obj_arg { super { ! , num } { ! , num } }
size	obj_arg { super { ! , range_arg [0 .. 65535] } { ! , range_arg [0 .. 65535] } }

tool/sniffer/stop

Type: Command

tool/sniffer/save

Type: Command

Argument	Type	Description
file-name	file_enum

tool/sniffer/packet

Type: Directory

Read-only Argument	Type	Description
time	num
num	num
direction	enum (rx | tx)
src-mac	macAddr
dst-mac	macAddr
vlan	obj_arg { composite_arg { , } { , } }
interface	interface_enum
src-address	composite_arg { , }
dst-address	composite_arg { , }
protocol	enum ()
ip-protocol	enum (ip)
size	num
cpu	num
ip-packet-size	num
ip-header-size	num
dscp	num
ecn	num
identification	num
fragment-offset	num
ttl	num
tcp-flags	multi_arg { array-id, enum (fin | syn | rst | psh | ack | urg | ece | cwr) { fin:0, syn:1, rst:2, psh:3, ack:4, urg:5, ece:6, cwr:7 } }
data	string

tool/sniffer/protocol

Type: Directory

Read-only Argument	Type	Description
protocol	enum ()
ip-protocol	enum (ip)
port	enum ()
packets	num
bytes	num
share	num

tool/sniffer/host

Type: Directory

Read-only Argument	Type	Description
address	ipAddr
rate	composite_arg { , }
peak-rate	composite_arg { , }
total	composite_arg { , }

tool/sniffer/connection

Type: Directory

Flag	Name	Description
A	active	active

Read-only Argument	Type	Description
src-address	composite_arg { , }
dst-address	composite_arg { , }
bytes	composite_arg { , }
resends	composite_arg { , }
mss	composite_arg { , }

tool/sniffer/quick

Type: Command

Argument	Type	Description
rows	num
show-frame	bool
interface	obj_arg { interface_enum }
mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
src-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
dst-mac-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
mac-protocol	obj_arg { super { ! , alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } } { ! , alt { enum () { } , num [ .. 65535] } { enum () { } , num [ .. 65535] } } }
ip-protocol	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
src-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
dst-ip-address	obj_arg { super { ! , composite_arg { , } { , } } { ! , composite_arg { , } { , } } }
ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
src-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
dst-ipv6-address	obj_arg { super { ! , ip6_prefix_arg } { ! , ip6_prefix_arg } }
port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
src-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
dst-port	obj_arg { super { ! , enum () { } } { ! , enum () { } } }
vlan-id	obj_arg { super { ! , num [ .. 4095] } { ! , num [ .. 4095] } }
direction	enum (any | tx | rx)
operator-between-entries	enum (or | and)
cpu	obj_arg { super { ! , num } { ! , num } }
size	obj_arg { super { ! , range_arg [0 .. 65535] } { ! , range_arg [0 .. 65535] } }

Read-only Argument	Type	Description
interface	interface_enum
time	num
num	num
dir	enum (<- | ->)
src-mac	macAddr
dst-mac	macAddr
vlan	composite_arg { , }
src-address	composite_arg { , }
dst-address	composite_arg { , }
protocol	composite_arg { , }
size	num
cpu	num
fp	bool
raw	string
dscp	num
ecn	num
fragment-offset	num
identification	num
ip-header-size	num
ip-packet-size	num
tcp-flags	super { multi_arg { array-id, enum (fin | syn | rst | psh | ack | urg | ece | cwr) { fin:0, syn:1, rst:2, psh:3, ack:4, urg:5, ece:6, cwr:7 } } { array-id, enum (fin | syn | rst | psh | ack | urg | ece | cwr) { fin:0, syn:1, rst:2, psh:3, ack:4, urg:5, ece:6, cwr:7 } } }
ttl	num