doc/xml/AdminReference/sect8/kadb_check.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="kadb_check8">
   3   <refmeta>
   4     <refentrytitle>kadb_check</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>kadb_check</refname>
   9     <refpurpose>Checks the integrity of the Authentication Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">kadb_check</emphasis> <emphasis role="bold">-database</emphasis> &lt;<emphasis>kadb file</emphasis>&gt; [<emphasis role="bold">-uheader</emphasis>] [<emphasis role="bold">-kheader</emphasis>]
  14         [<emphasis role="bold">-entries</emphasis>] [<emphasis role="bold">-verbose</emphasis>] [<emphasis role="bold">-rebuild</emphasis> &lt;<emphasis>out file</emphasis>&gt;] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16     <para><emphasis role="bold">kadb_check</emphasis> <emphasis role="bold">-d</emphasis> &lt;<emphasis>kadb file</emphasis>&gt; [<emphasis role="bold">-u</emphasis>] [<emphasis role="bold">-k</emphasis>] [<emphasis role="bold">-e</emphasis>] [<emphasis role="bold">-v</emphasis>]
  17         [<emphasis role="bold">-r</emphasis> &lt;<emphasis>out file</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>
  18
  19   </refsect1>
  20   <refsect1>
  21     <title>Description</title>
  22     <para>The <emphasis role="bold">kadb_check</emphasis> command checks the integrity of the Protection Database,
  23     reporting any errors or corruption it finds. If there are problems, do not
  24     issue any <emphasis role="bold">kas</emphasis> commands until the database is repaired.</para>
  25
  26   </refsect1>
  27   <refsect1>
  28     <title>Cautions</title>
  29     <para>The results can be unpredictable if the Authentication Server makes
  30     changes to the Authentication Database while this command is running. Use
  31     the <emphasis role="bold">bos shutdown</emphasis> command to shutdown the local <emphasis role="bold">kaserver</emphasis> process
  32     before running this command, or before creating a second copy of the
  33     <replaceable>kaserver.DB0</replaceable> file (with a different name) on which to run the command.</para>
  34
  35   </refsect1>
  36   <refsect1>
  37     <title>Options</title>
  38     <variablelist>
  39       <varlistentry>
  40         <term><emphasis role="bold">-database</emphasis> &lt;<emphasis>kadb file</emphasis>&gt;</term>
  41         <listitem>
  42           <para>Names the Authentication Database (copy of the <replaceable>kaserver.DB0</replaceable> file) to
  43           check. If the current working directory is not the location of the file,
  44           provide a pathname, either full or relative to the current working
  45           directory.</para>
  46
  47         </listitem>
  48       </varlistentry>
  49       <varlistentry>
  50         <term><emphasis role="bold">-uheader</emphasis></term>
  51         <listitem>
  52           <para>Displays information which Ubik maintains in the database's header.</para>
  53
  54         </listitem>
  55       </varlistentry>
  56       <varlistentry>
  57         <term><emphasis role="bold">-kheader</emphasis></term>
  58         <listitem>
  59           <para>Displays information which the Authentication Server maintains in the
  60           database's header.</para>
  61
  62         </listitem>
  63       </varlistentry>
  64       <varlistentry>
  65         <term><emphasis role="bold">-entries</emphasis></term>
  66         <listitem>
  67           <para>Outputs every entry in the database, providing information similar to that
  68           returned by the <emphasis role="bold">kas examine</emphasis> command.</para>
  69
  70         </listitem>
  71       </varlistentry>
  72       <varlistentry>
  73         <term><emphasis role="bold">-verbose</emphasis></term>
  74         <listitem>
  75           <para>Reports additional information about the database, including the number of
  76           free (allocated but unused) entries in the database.</para>
  77
  78         </listitem>
  79       </varlistentry>
  80       <varlistentry>
  81         <term><emphasis role="bold">-rebuild</emphasis> &lt;<emphasis>out file</emphasis>&gt;</term>
  82         <listitem>
  83           <para>Names the file in which to record a list of <emphasis role="bold">kas</emphasis> commands which, if
  84           issued in the command shell, recreate the current state of the database
  85           being verified. Partial pathnames are interpreted relative to the current
  86           working directory.</para>
  87
  88         </listitem>
  89       </varlistentry>
  90       <varlistentry>
  91         <term><emphasis role="bold">-help</emphasis></term>
  92         <listitem>
  93           <para>Prints the online help for this command. All other valid options are
  94           ignored.</para>
  95
  96         </listitem>
  97       </varlistentry>
  98     </variablelist>
  99   </refsect1>
 100   <refsect1>
 101     <title>Output</title>
 102     <para>If there are errors in the database, the output always reports them on the
 103     standard error stream. If any options other than <emphasis role="bold">-database</emphasis> or <emphasis role="bold">-help</emphasis>
 104     are provided, the output written to the standard output stream includes
 105     additional information as described for each option in <link linkend="OPTIONS">OPTIONS</link>.  The
 106     output is intended for debugging purposes and is meaningful to someone
 107     familiar with the internal structure of the Authentication Database.</para>
 108
 109   </refsect1>
 110   <refsect1>
 111     <title>Privilege Required</title>
 112     <para>The issuer must be logged in as the local superuser <computeroutput>root</computeroutput>.</para>
 113
 114   </refsect1>
 115   <refsect1>
 116     <title>See Also</title>
 117     <para><link linkend="kaserver_DB05">kaserver.DB0(5)</link>,
 118     <link linkend="bos_shutdown8">bos_shutdown(8)</link>,
 119     <link linkend="kas_examine8">kas_examine(8)</link>,
 120     <link linkend="kaserver8">kaserver(8)</link></para>
 121
 122   </refsect1>
 123   <refsect1>
 124     <title>Copyright</title>
 125     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 126
 127     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 128     converted from HTML to POD by software written by Chas Williams and Russ
 129     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 130
 131   </refsect1>
 132 </refentry>