Skip to main content

trisulctl_probe Command Reference

The trisulctl_probe allow you to co-ordinate , manage, and run commands across all the nodes in the domain

General Commands​

CommandDescriptionExample
helpDisplays help messageshelp
quitExit trisulctl toolquit
aliascreate shortcuts for CLIhelp alias
machineidget hub machineid for licensingmachineid
checklicensevalidate a license filechecklicense /usr/local/etc/trisul-hub/LicenseKey.txt
logview log files across nodes and contextslog default@probe0 level=1 log=ns tail lastrun

Domain Commands​

CommandDescriptionExample
start domainstart the domain processesstart domain
stop domainstop the domain processesstop domain
list domainsdomain cert and nodes found on systemlist domains
list nodeslist all the nodes active in domainlist nodes
list probeslist and test all probes found on local nodelist probes
helloget a hello message from all nodeshello probe0
relocate contextmove context storage to different disk volumerelocate context domain0 probe0 default
changeuser domainChange the user.group for an entire domain nodechangeuser domain0 trisul
create probecreate new probe cert/key and request permission from hub admincreate probe
install domaininstall a new domain using the certificate file given by admin
install probeinstall a new probe using the certificate file given by hub
install contextinstall a new context inside the probeinstall context probe-id context-name

Context Commands​

CommandDescriptionExample
info contextshow context status, leave context blank to show all contextsinfo context default
start contextstart specified context, you can also use context@node formatstart context default
start context default@probe0
stop contextstop context or connected contextstop context default
stop context default@probe0
create contextCreate a new context with name contextcreate context context1
create context context1@probe0
delete contextDelete the contextdelete context context1
delete context context1@probe0
reset contextClear the data (keep the configuration) for the specified contextreset context default
reset context default@probe0
show configshow context configuration, socket informationshow config default
set configset context config parameterset config default runmode=online_rxring
set config default@probe0 profile=profile_west

Probe Commands​

CommandDescriptionExample
createramfscreate a ramfs filesystem for use with File Extractioncreateramfs probe0 default
importpcapimport a pcap file or dir into specified context (or default)importpcap /tmp/sample.pcap context=offline
importpcap_idssame as importpcap but runs a 2nd pass over pcaps using snort/suricataimportpcap_ids /tmp/sample.pcap context=offline

Developer commands​

CommandDescriptionExample
list lualist all the Lua scripts discovered in context and probelist lua context@probe
testbench runstart the testbench in a debug mode, use this to test your Lua scriptstestbench run /tmp/sample.pcap
testbench guidgenerate a new GUIDtestbench guid