Commit 3db718e2 authored by Thomas Markwalder's avatar Thomas Markwalder
Browse files

[3803] Updated kea guide and kea-admin man pages for lease-dump

parent c5430032
......@@ -90,6 +90,15 @@
upgrading Kea.
</simpara>
</listitem>
<listitem>
<simpara>
<command>lease-dump</command> &mdash;
Dumps the contents of the lease database (for MySQL or PostgreSQL
backends) to CSV text file. The first line of the file contains
the column names.
</simpara>
</listitem>
</itemizedlist>
<command>backend</command> specifies the backend type. Currently
......
......@@ -49,6 +49,8 @@
<arg><option>-p <replaceable class="parameter">database password</replaceable></option></arg>
<arg><option>-n <replaceable class="parameter">database name</replaceable></option></arg>
<arg><option>-d <replaceable class="parameter">scripts directory</replaceable></option></arg>
<arg><option>-4 | -6</option></arg>
<arg><option>-o <replaceable class="parameter">output file</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
......@@ -56,7 +58,7 @@
<title>DESCRIPTION</title>
<para>
kea-admin is a shell script which offers database maintenance. In particular,
it features database initialization, database version checking and
it features database initialization, database version checking and
database schema upgrade.
</para>
</refsect1>
......@@ -99,6 +101,16 @@
</varlistentry>
</variablelist>
<varlistentry>
<term>lease-dump</term>
<listitem>
<para>Dumps the contents of the lease database (MySQL and PostgreSQL
backends) to text file. The content of the file consists of comma-separated-values
(CSV) where each line in the file contains all of the values for a single lease.
The first line of file is a header line containing the column names.</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
......@@ -153,6 +165,33 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o|--output <replaceable class="parameter">output_file</replaceable></option></term>
<listitem>
<para>
Required for lease-dump, Specifies the file to which the lease data will be dumped.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-4</option></term>
<listitem>
<para>
Directs kea-admin to lease-dump the DHCPv4 leases. Incompatible with the -6 option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-6</option></term>
<listitem>
<para>
Directs kea-admin to lease-dump the DHCPv6 leases. Incompatible with the -4 option.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment