Packet-o-matic

The XML-RPC interface allow easy configuration of packet-o-matic by remote applications. The arguments can be either strings (s/) or integers (i/). By default, packet-o-matic listens on TCP port 8080 and the path for the XML-RPC queries is /RPC2. If you did specify a password for the XML-RPC interface, the user will be 'admin'.

Here is the documentation of the currently implemented functions :

Returns all the core parameters and their values.
Arguments : none

Set a core parameters.
Arguments : s/name s/value

Get a list of all the conntrack modules loaded in packet-o-matic and their parameters.
Arguments : none

Get a list of the available conntrack modules.
Arguments : none

Set one parameter of a conntrack.
Arguments : s/conntrack_name s/param_name s/param_value

Load a new conntrack module.
Arguments : s/conntrack_name

Unload a conntrack module.
Arguments : s/conntrack_name

List currently loaded datastore modules and their parameters.
Arguments : none

List available datastore modules.
Arguments : none

Return all the datastores currently configured with their configuration.
Arguments : none

Add a datastore.
Arguments : s/datastore_type s/datastore_name

Remove a datastore.
Arguments : s/datastore_name

Start a datastore.
Arguments : s/datastore_name

Stop a datastore.
Arguments : s/datastore_name

Load a datastore module.
Arguments : s/datastore_type

Unload a datastore module.
Arguments : s/datastore_type

Set the value for a datastore parameter.
Arguments : s/datastore_name s/parameter_name s/value

Set the description of a datastore.
Arguments : s/datastore_name s/description

List all the datasets of a datastore.
Arguments : s/datastore_name

Destroy a dataset from a datastore.
Arguments : s/datastore_name s/dataset_name

Return the serial value for each component.
Arguments : none

Halt packet-o-matic.
Arguments : none

Set/unset the XML-RPC interface password.
Arguments : s/new_password or nothing to unset the password

Retrieve the logs from the system give last one that was seen.
Arguments : i/last_log_seen

Return packet-o-matic's version.
Arguments : none

Get the properties of the currently configured input.
Arguments : none

Start the currently configured input.
Arguments : none

Stop the currently configured input.
Arguments : none

Set the type of the input. For example, pcap or docsis.
Arguments : s/input_type

Set the mode of the input.
Arguments : s/input_mode

Set a parameter of the input.
Arguments : s/param_name s/param_value

Get a list of the input modules loaded in packet-o-matic as well as their modes and parameters.
Arguments : none

Get a list of the available input modules.
Arguments : none

Load an input given its name.
Arguments : s/input_name

Unload an input given its name.
Arguments : s/input_name

Get a list of all the helper modules loaded in packet-o-matic and their parameters.
Arguments : none

Get a list of the available helper modules.
Arguments : none

Set one parameter of a helper.
Arguments : s/helper_name s/param_name s/param_value

Load a new helper module.
Arguments : s/helper_name

Unload a helper module.
Arguments : s/helper_name

Get all the rules, their status and their unique ID.
Arguments : none

Add a new rule. This function returns the unique ID of the rule that was added.
Arguments : s/rule_string

Change a rule and returns its unique ID.
Arguments : i/rule_id s/rule_string

Change the description of a rule. If description is empty, it's removes it.
Arguments : i/rule_id s/description

Remove a rule and returns its unique ID.
Arguments : i/rule_id

Enable a rule and return its unique ID.
Arguments : i/rule_id

Disable a rule and return its unique ID.
Arguments : i/rule_id

Get a list of all the match modules loaded in packet-o-matic and their parameters.
Arguments : none

Get a list of the available match modules.
Arguments : none

Load a new match module.
Arguments : s/match_name

Unload a helper module.
Arguments : s/match_name

Get a list of the target modules loaded in packet-o-matic as well as their modes and parameters.
Arguments : none

Get a list of the available target modules.
Arguments : none

Return all the targets of a rule give the rule UID.
Arguments : i/rule_id

Start a target.
Arguments : i/rule_id i/target_id

Stop a target.
Arguments : i/rule_id i/target_id

Add a target to a rule.
Arguments : i/rule_id s/target_name

Remove a target from a rule.
Arguments : i/rule_id i/target_id

Set the mode of a target.
Arguments : i/rule_id i/target_id s/mode_name

Set a parameter of a target.
Arguments : i/rule_id i/target_id s/param_name s/param_value

Load a target module into the system.
Arguments : s/target_name

Unload a target from the system.
Arguments : s/target_name

List all the XML-RPC methods available.
Arguments : none

Provide help for a XML-RPC method.
Arguments : s/method

Provide signature of a XML-RPC method.
Arguments : s/method