pom:command_reference
Differences
This shows you the differences between two versions of the page.
Next revisionBoth sides next revision | |||
pom:command_reference [2012/10/12 08:57] – external edit 127.0.0.1 | pom:command_reference [2012/10/24 09:41] – bJpWjoRvUNWLfFyN 77.104.227.62 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Command reference ===== | + | Internal site search rorpets are one of the most powerful features in GA for ecommerce merchants. But I don' |
- | + | ||
- | ==== General commands ==== | + | |
- | + | ||
- | === config write [filename] === | + | |
- | Write the current configuration. You can optionally specify a different file name. | + | |
- | + | ||
- | === debug cli set < | + | |
- | Set the debug level of the management console (CLI). | + | |
- | + | ||
- | === debug cli show === | + | |
- | Display the current debug level. | + | |
- | + | ||
- | === debug console set < | + | |
- | 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 < | + | |
- | 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' | + | |
- | + | ||
- | === version show === | + | |
- | Display packet-o-matic' | + | |
- | + | ||
- | + | ||
- | ==== Input commands ==== | + | |
- | + | ||
- | === input load < | + | |
- | Load an input module. You should not be using this as the right module will be loaded automatically. | + | |
- | + | ||
- | === input mode set < | + | |
- | Change the mode of the current input. The input must be stopped to change it's mode. | + | |
- | + | ||
- | === input parameter reset < | + | |
- | Reset the parameter value to its initial value. | + | |
- | + | ||
- | === input parameter set < | + | |
- | 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 < | + | |
- | Change the type of the input. The corresponding input module will be loaded automatically. | + | |
- | + | ||
- | === input unload < | + | |
- | Unload an input module. You should not be using this. | + | |
- | + | ||
- | + | ||
- | ==== Rule commands ==== | + | |
- | + | ||
- | === rule add < | + | |
- | Add a rule. The rule being added is disabled by default. | + | |
- | + | ||
- | === rule description set < | + | |
- | Set the description of a rule. | + | |
- | + | ||
- | === rule description unset < | + | |
- | Unset the description of a rule. | + | |
- | + | ||
- | === rule disable < | + | |
- | 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 < | + | |
- | Enable a rule to start processing matching packets. | + | |
- | + | ||
- | === rule remove < | + | |
- | Remove a rule and remove all the targets associated to this rule. | + | |
- | + | ||
- | === rule set < | + | |
- | 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/ | + | |
- | + | ||
- | + | ||
- | ==== Target commands ==== | + | |
- | + | ||
- | === target add < | + | |
- | Add a target to a rule. The target is stopped by default. | + | |
- | + | ||
- | === target description set < | + | |
- | Set the description of a target. | + | |
- | + | ||
- | === target description unset < | + | |
- | Unset the description of a target. | + | |
- | + | ||
- | === target load < | + | |
- | Load a target module. You should not be using this as target modules will be loaded when needed. | + | |
- | + | ||
- | === target mode set < | + | |
- | Change the mode of a target. The target must be stopped | + | |
- | + | ||
- | === target parameter reset < | + | |
- | Reset a target parameter to its default value. | + | |
- | + | ||
- | === target parameter set < | + | |
- | Change | + | |
- | + | ||
- | === target remove < | + | |
- | 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 < | + | |
- | Start a specific target. | + | |
- | + | ||
- | === target stop < | + | |
- | 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 < | + | |
- | Unload a target module from the system. You should not be using this. | + | |
- | + | ||
- | + | ||
- | ==== Datastore commands ==== | + | |
- | + | ||
- | === datastore add < | + | |
- | Add a datastore in the current configuration. | + | |
- | + | ||
- | === datastore description set < | + | |
- | Set the description of a datastore. | + | |
- | + | ||
- | === datastore description unset < | + | |
- | Unset the description of a datastore. | + | |
- | + | ||
- | === datastore load < | + | |
- | Load a datastore module. You should not be using this as it's usally done automatically. | + | |
- | + | ||
- | === datastore parameter reset < | + | |
- | Reset a datastore parameter to its default value. | + | |
- | + | ||
- | === datastore parameter set < | + | |
- | Set the parameter of a datastore. The datastore must be stopped to change a parameter. | + | |
- | + | ||
- | === datastore remove < | + | |
- | Remove a datastore from the configuration. | + | |
- | + | ||
- | === datastore show === | + | |
- | Show currently configured datastore, their status and parameters. | + | |
- | + | ||
- | === datastore start < | + | |
- | Start a specific datastore. | + | |
- | + | ||
- | === datastore stop < | + | |
- | Stop a specific datastore. | + | |
- | + | ||
- | === datastore unload < | + | |
- | Remove a datastore module. You should not be using this. | + | |
- | + | ||
- | + | ||
- | ==== Core parameters commands ==== | + | |
- | + | ||
- | === core parameter set < | + | |
- | 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 < | + | |
- | 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 < | + | |
- | Reset a conntrack parameter to its default value. | + | |
- | + | ||
- | === conntrack parameter set < | + | |
- | 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 < | + | |
- | Unload a conntrack. **You should | + | |
- | + | ||
- | + | ||
- | ==== Helper commands ==== | + | |
- | + | ||
- | === helper load < | + | |
- | 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 < | + | |
- | Reset a helper parameter to its default value. | + | |
- | + | ||
- | === helper parameter set < | + | |
- | Change the value of a helper' | + | |
- | + | ||
- | === helper unload < | + | |
- | Unload a helper and release all the memory it was using. | + | |
- | + | ||
- | + | ||
- | ==== Match commands ==== | + | |
- | + | ||
- | === match load < | + | |
- | Load a match module. You should not be using this as modules are automaticaly loaded. | + | |
- | + | ||
- | === match unload < | + | |
- | Unload a match module. You should not be using this. | + | |
- | + | ||
- | + | ||
- | ==== Ptype commands ==== | + | |
- | + | ||
- | === ptype load < | + | |
- | Load a ptype module. You should not be using this. | + | |
- | + | ||
- | === ptype unload < | + | |
- | Unload a ptype module. You should not be using this. | + | |
- | + |
pom/command_reference.txt · Last modified: 2020/05/26 21:59 by 127.0.0.1