1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright (c) 2020 Balazs Scheidler <bazsi77@gmail.com>
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
As an additional exemption you are allowed to compile & link against the
OpenSSL libraries as published by the OpenSSL project. See the file
COPYING for details.
-->
<reference xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<productname/>
<title>The persist-tool tool manual page</title>
</info>
<refentry xml:id="persist-tool.1">
<refmeta>
<refentrytitle>persist-tool</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="version">4.8</refmiscinfo>
<refmiscinfo class="source"/>
</refmeta>
<refnamediv>
<refname>persist-tool</refname>
<refpurpose>Display the content of the persist file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis><command>persist-tool</command>
<arg>command</arg>
<arg>options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection xml:id="persist-tool-mandescription">
<title>Description</title>
<para>NOTE: The persist-tool application is distributed with the syslog-ng system logging application, and is usually part of the syslog-ng package. The latest version of the syslog-ng application is available at the <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://www.balabit.com/log-management">official syslog-ng website</link>.</para>
<para>This manual page is only an abstract, for the complete documentation of syslog-ng, see the <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://www.balabit.com/support/documentation/"><command>The syslog-ng Administrator Guide</command></link>.</para>
<para>The <command>persist-tool</command> application is a utility that can be used to dump the content of the persist file, and manipulate its content.</para>
<warning>
<para>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.</para>
</warning>
<note>
<para>Limitations:</para>
<itemizedlist>
<listitem>
<para>The persist-state functions can be used only with syslog-ng PE 5 LTS style persist file (SLP4). Older persist files are not supported.</para>
</listitem>
<listitem>
<para>Wildcard characters are not supported in file/directory names.</para>
</listitem>
</itemizedlist>
</note>
</refsection>
<refsection xml:id="persist-tool-dump">
<title>The dump command</title>
<cmdsynopsis><command>dump</command>
<arg>options</arg>
<arg>persist_file</arg>
</cmdsynopsis>
<para>Use the <command>dump</command> command to print the current content of the persist file in JSON format to the console.</para>
<para>The <command>dump</command> command has the following options:</para>
<variablelist>
<varlistentry>
<term><command>--help</command> or <command>-?</command>
</term>
<listitem>
<para>Display a brief help message.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Example: <synopsis>persist-tool dump /opt/syslog-ng/var/syslog-ng.persist</synopsis></para>
<para>The output looks like:</para>
<synopsis>
run_id = { "value": "00 00 00 00 0C 00 00 00 " }
host_id = { "value": "00 00 00 00 5F 49 2F 01 " }</synopsis>
</refsection>
<refsection xml:id="persist-tool-add">
<title>The add command</title>
<cmdsynopsis><command>add</command>
<arg>options</arg>
<arg>input_file</arg>
</cmdsynopsis>
<para>Use the <command>add</command> command to add or modify a specified state-entry in the persist file. The state-entry should be in the same format as the <command>dump</command> 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.</para>
<para>To use the <command>add</command> command: use <command>persist-tool dump</command> to print the content of the current persist file, and redirect it to a file. Edit the content of this file. Use <command>persist-tool add</command> with this file to modify the persist.</para>
<para>The <command>add</command> command has the following options:</para>
<variablelist>
<varlistentry>
<term><command>--help</command> or <command>-?</command>
</term>
<listitem>
<para>Display a brief help message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--output-dir=<directory></command> or <command>-o</command>
</term>
<listitem>
<para>Required parameter. The directory where the persist file is located at. The name of the persist file stored in this directory must be <filename>syslog-ng.persist</filename>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Example:<synopsis>/opt/syslog-ng/bin/persist-tool add dump_persist -o .</synopsis></para>
<para>The valid output looks like:</para>
<synopsis>log_reader_curpos(Application) OK
affile_sd_curpos(/var/aaa.txt) OK</synopsis>
<para>The invalid output looks like:</para>
<synopsis>log_reader_curpos(Application) OK
wrong
FAILED (error: Invalid entry syntax)
affile_sd_curpos(/var/aaa.txt) OK</synopsis>
</refsection>
<refsection>
<title>Files</title>
<para><filename>/opt/syslog-ng/bin/persist-tool</filename></para>
</refsection>
<refsection>
<title>See also</title>
<para><link linkend="syslog-ng.conf.5"> <command>syslog-ng.conf</command>(5)</link></para>
<para><link linkend="syslog-ng.8"> <command>syslog-ng</command>(8)</link></para>
<note version="5.0">
<para>For the detailed documentation of see <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://www.balabit.com/documents/syslog-ng-ose-latest-guides/en/syslog-ng-ose-guide-admin/html/index.html"><command>The 4.8 Administrator Guide</command></link></para>
<para>If you experience any problems or need help with syslog-ng, visit the <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://lists.balabit.hu/mailman/listinfo/syslog-ng"><command>syslog-ng mailing list</command></link>.</para>
<para>For news and notifications about of syslog-ng, visit the <link xmlns:ns1="http://www.w3.org/1999/xlink" ns1:href="https://syslog-ng.org/blogs/"><command>syslog-ng blogs</command></link>.</para>
</note>
</refsection>
<refsection version="5.0">
<title>Author</title>
<para>This manual page was written by the Balabit Documentation Team <documentation@balabit.com>.</para>
</refsection>
<refsection version="5.0">
<title>Copyright</title>
</refsection>
</refentry>
</reference>
|
