preludedb-admin - Man Page

tool to copy, move, delete, save or restore a prelude database


preludedb-admin copy|count|delete|load|move|optimize|save|update arguments


preludedb-admin can be used to copy, move, delete, save, update or restore a Prelude database, partly or in whole, while preserving IDMEF data consistency.

Mandatory arguments


Make a copy of a Prelude database to another database.


Count the number of events in a Prelude database.


Delete content of a Prelude database.


Load a Prelude database from a file.


Move content of a Prelude database to another database.


Optimize a Prelude database by deleting orphaned data.


Save a Prelude database to a file.


Update data in a Prelude database.

Running a command without providing arguments will display a detailed help.


Obtaining help on a specific command:

# preludedb-admin save
Usage  : save <alert|heartbeat> <database> <filename> [options]
Example: preludedb-admin save alert "type=mysql name=dbname user=prelude" outputfile

Save messages from <database> into [filename].
If no filename argument is provided, data will be written to standard output.

Database arguments:
  type  : Type of database (mysql/pgsql).
  name  : Name of the database.
  user  : User to access the database.
  pass  : Password to access the database.

Valid options:
  --offset <offset>               : Skip processing until 'offset' events.
  --count <count>                 : Process at most count events.
  --query-logging [filename]      : Log SQL query to the specified file.
  --criteria <criteria>           : Only process events matching criteria.
  --events-per-transaction        : Maximum number of event to process per transaction (default 1000).

Preludedb-admin can be useful to delete events from a prelude database :

preludedb-admin delete alert --criteria <criteria> "type=<mysql> name=<dbname> user=<prelude-user> pass=<pass>"

where criteria is an IDMEF criteria :

preludedb-admin delete alert --criteria "alert.classification.text == 'UDP packet dropped'" "type=mysql name=prelude user=prelude-user pass=prelude-pass"

This will delete all event with the classification text "UDP packet dropped" from the database.

See Also

The Prelude Handbook:

Prelude homepage:

Creating filter using IDMEF Criteria:

Prelude IDMEF Path:


To report a bug, please visit


This manpage was Written by Pierre Chifflier.


June 2012