FreeBSD Manual Pages
persist-tool(1) The persist-tool manual page persist-tool(1) NAME persist-tool --- {{ site.product.short_name }} configuration file Synopsis persist-tool [command] [options] Description This manual page is only an abstract. The persist-tool application is a utility that can be used to dump the content of the persist file, and manipulate its content. [](/assets/images/caution.png) CAUTION: Persist-tool is a special tool for syslog-ng experts. Do use the tool unless you know exactly what you are doing. Misconfiguring it will result in irrecoverable damage to the persist file, without any warning. Limitations: * The persist-state functions can be used only with SLP4 or newer persist files. Older persist files are not supported. * Wild- card characters are not supported in file and directory names. The dump command dump [options] [persist_file] Use the dump command to print the current content of the persist file in JSON format to the console. The dump command has the following options: * --help or -? Display a brief help message. Example: persist-tool dump persist-tool dump /usr/local/var/syslog-ng.persist A valid output is the following: run_id = { "value": "00 00 00 00 0C 00 00 00 " } host_id = { "value": "00 00 00 00 5F 49 2F 01 " } The add command add [options] [input_file] Use the add command to add or modify a specified state-entry in the persist file. The state-entry should be in the same format as the dump command displays it. If the given state-entry already exists, it will be updated. Otherwise, a new value will be added. If the given persist state is invalid, it will be skipped. To use the add command: use persist-tool dump to print the content of the current persist file, and redirect it to a file. Edit the content of this file. Use persist-tool add with this file to modify the per- sist. The add command has the following options: * --help or -? Display a brief help message. • --output-dir=<directory> or -o Required parameter. The directory where the persist file is lo- cated at. The name of the persist file stored in this directory must be syslog-ng.persist. • --persist-name=<filename> or -p Optional parameter. The name of the persist file to generate. Default value: syslog-ng.persist. Example: add dump_persist /usr/local/bin/persist-tool add dump_persist -o . A valid output is the following: log_reader_curpos(Application) OK affile_sd_curpos(/var/aaa.txt) OK An invalid output is the following: log_reader_curpos(Application) OK wrong FAILED (error: Invalid entry syntax) affile_sd_curpos(/var/aaa.txt) OK Files /usr/local/bin/persist-tool See also The syslog-ng.conf manual page The syslog-ng OSE manual page 4.9.0 03 September 2025 persist-tool(1)
NAME | Synopsis | Description | The dump command | The add command | Files | See also
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=persist-tool&sektion=1&manpath=FreeBSD+Ports+15.0>