From: Thomas Markwalder <tmark@isc.org>
Date: Wed, 27 May 2015 11:22:16 +0000 (-0400)
Subject: [3803] Updated kea guide and kea-admin man pages for lease-dump
X-Git-Tag: trac3732a_base~17^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3db718e2fd550311b85e41b84aa57ad5e0ad93da;p=thirdparty%2Fkea.git

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

diff --git a/doc/guide/admin.xml b/doc/guide/admin.xml
index 704f76e34f..30753d3d82 100644
--- a/doc/guide/admin.xml
+++ b/doc/guide/admin.xml
@@ -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
diff --git a/src/bin/admin/kea-admin.xml b/src/bin/admin/kea-admin.xml
index e08c190954..24a4ba18cb 100644
--- a/src/bin/admin/kea-admin.xml
+++ b/src/bin/admin/kea-admin.xml
@@ -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>