Table of Contents
Command reference
General commands
config write [filename]
Write the current configuration. You can optionally specify a different file name.
debug cli set <off,0-5>
Set the debug level of the management console (CLI).
debug cli show
Display the current debug level.
debug console set <off,0-5>
Set the debugging level of the program console (stdout).
exit
Exit the console.
halt
Stop the program.
?
Display a list of all the available commands with a short help.
license show
Show the license of the program. This programs is under the GPL license.
password cli set <password>
Set the password to connect to the telnet session.
password cli unset
Unset the password to connect to the CLI. This means that you won't be prompted for password when connecting via telnet.
version show
Display packet-o-matic's version.
Input commands
input load <input>
Load an input module. You should not be using this as the right module will be loaded automatically.
input mode set <mode>
Change the mode of the current input. The input must be stopped to change it's mode.
input parameter reset <parameter>
Reset the parameter value to its initial value.
input parameter set <parameter> <value>
Change a parameter value for the current input. The input must be stopped to change this.
input show
Display the current input and its parameters.
input start
Start the configured input.
input stop
Stop the input.
input type set <type>
Change the type of the input. The corresponding input module will be loaded automatically.
input unload <input>
Unload an input module. You should not be using this.
Rule commands
rule add <rule>
Add a rule. The rule being added is disabled by default.
rule description set <rule_id> <descr>
Set the description of a rule.
rule description unset <rule_id>
Unset the description of a rule.
rule disable <rule_id>
Disable a rule. If a rule is disabled, the connections that are currently being tracked by the targets of this rule are still being processed.
rule enable <rule_id>
Enable a rule to start processing matching packets.
rule remove <rule_id>
Remove a rule and remove all the targets associated to this rule.
rule set <rule_id> <rule>
Change a rule. The effect is immediate. It can be changed without disabling the rule.
rule show [tree | flat]
Show all the rules that are in the system. By default it shows all the rules in a tree. Rules in the flat format can be copy/pasted and modified to change the rule.
Target commands
target add <rule_id> <target>
Add a target to a rule. The target is stopped by default.
target description set <rule_id> <target_id> <descr>
Set the description of a target.
target description unset <rule_id> <target_id>
Unset the description of a target.
target load <target>
Load a target module. You should not be using this as target modules will be loaded when needed.
target mode set <rule_id> <target_id> <mode>
Change the mode of a target. The target must be stopped for this.
target parameter reset <rule_id> <target_id> <parameter>
Reset a target parameter to its default value.
target parameter set <rule_id> <target_id> <parameter> <value>
Change the parameter value for a parameter.
target remove <rule_id> <target_id>
Remove a target from a rule. The target is stopped and removed.
target show
Display the targets of each rules and their parameters.
target start <rule_id> <target_id>
Start a specific target.
target stop <rule_id> <target_id>
Stop a specific target. Most of the time, it closes all the files the target was using and release most of the memory allocated for it.
target unload <target>
Unload a target module from the system. You should not be using this.
Datastore commands
datastore add <datastore_type> <datastore_name>
Add a datastore in the current configuration.
datastore description set <datastore_name>
Set the description of a datastore.
datastore description unset <datastore_name>
Unset the description of a datastore.
datastore load <datastore_type>
Load a datastore module. You should not be using this as it's usally done automatically.
datastore parameter reset <datastore_name> <parameter>
Reset a datastore parameter to its default value.
datastore parameter set <datastore_name> <parameter> <value>
Set the parameter of a datastore. The datastore must be stopped to change a parameter.
datastore remove <datastore_name>
Remove a datastore from the configuration.
datastore show
Show currently configured datastore, their status and parameters.
datastore start <datastore_name>
Start a specific datastore.
datastore stop <datastore_name>
Stop a specific datastore.
datastore unload <datastore>
Remove a datastore module. You should not be using this.
Core parameters commands
core parameter set <parameter> <value>
Change a core parameter. Here are the currently implemented parameter :
- autosave_config_on_exit
If set to yes, the configuration will be saved automatically when you exit packet-o-matic. Default : yes.
- match_autoload_helper
Each time a match is loaded in the system, the corresponding helper will be loaded as well if found. Default : yes.
- quit_on_input_error
If an input error occurs, stop packet-o-matic. This is useful when reading from pcap file and to have pom exit at the end. Default : no.
- ringbuffer_size
This specifies the number of packets to store in the ringbuffer. More packets means more memory used. Less packets means more likely to have packet dropped if the input is a live input. Default : 10000.
core parameter show
Show the core parameters and their value.
Conntracks commands
conntrack load <conntrack>
Load a conntrack module. The conntrack will be used for new connections. This may invalidate existing conntracks ! Use only if you know what you are doing.
conntrack parameter reset <conntrack> <parameter>
Reset a conntrack parameter to its default value.
conntrack parameter set <conntrack> <parameter> <value>
Change the parameter of a connection tracking module. Make sure you know what you are doing before changing this.
conntrack show
Show the currently loaded connection tracking modules and their parameters.
conntrack unload <conntrack>
Unload a conntrack. You should not use this unless you know what you are doing. This will break existing conntracks.
Helper commands
helper load <helper>
Load a helper module. The helper is immediately being used for all the packets being processed.
helper show
Show currently loaded helpers and their parameter value.
helper parameter reset <helper> <parameter>
Reset a helper parameter to its default value.
helper parameter set <helper> <parameter> <value>
Change the value of a helper's parameter.
helper unload <helper>
Unload a helper and release all the memory it was using.
Match commands
match load <match>
Load a match module. You should not be using this as modules are automaticaly loaded.
match unload <match>
Unload a match module. You should not be using this.
Ptype commands
ptype load <ptype>
Load a ptype module. You should not be using this.
ptype unload <ptype>
Unload a ptype module. You should not be using this.