doc/xml/AdminReference/sect8/kas_list.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="kas_list8">
   3   <refmeta>
   4     <refentrytitle>kas list</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>kas list</refname>
   9     <refpurpose>Displays all entries in the Authentication Database</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">kas list</emphasis> [<emphasis role="bold">-long</emphasis>] [<emphasis role="bold">-showadmin</emphasis>] [<emphasis role="bold">-showkey</emphasis>]
  14         [<emphasis role="bold">-admin_username</emphasis> &lt;<emphasis>admin principal to use for authentication</emphasis>&gt;]
  15         [<emphasis role="bold">-password_for_admin</emphasis> &lt;<emphasis>admin password</emphasis>&gt;] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  16         [<emphasis role="bold">-servers</emphasis> &lt;<emphasis>explicit list of authentication servers</emphasis>&gt;+]
  17         [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  18
  19     <para><emphasis role="bold">kas ls</emphasis> [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-showa</emphasis>] [<emphasis role="bold">-showk</emphasis>]
  20         [<emphasis role="bold">-a</emphasis> &lt;<emphasis>admin principal to use for authentication</emphasis>&gt;]
  21         [<emphasis role="bold">-p</emphasis> &lt;<emphasis>admin password</emphasis>&gt;] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  22         [<emphasis role="bold">-se</emphasis> &lt;<emphasis>explicit list of authentication servers</emphasis>&gt;+] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  23
  24   </refsect1>
  25   <refsect1>
  26     <title>Description</title>
  27     <para>The <emphasis role="bold">kas list</emphasis> command either displays all entries from the
  28     Authentication Database by name, or displays the full database entry for a
  29     defined set of entries, as determined by the flag provided:</para>
  30
  31     <itemizedlist>
  32       <listitem>
  33         <para>To display every entry in the Authentication Database in full, include the
  34         <emphasis role="bold">-long</emphasis> flag.</para>
  35
  36       </listitem>
  37       <listitem>
  38         <para>To display only those entries in full that have the <computeroutput>ADMIN</computeroutput> flag set,
  39         include the <emphasis role="bold">-showadmin</emphasis> flag.</para>
  40
  41       </listitem>
  42       <listitem>
  43         <para>To list only the name of each Authentication Database entry, omit both the
  44         <emphasis role="bold">-long</emphasis> and <emphasis role="bold">-showadmin</emphasis> flags.</para>
  45
  46       </listitem>
  47     </itemizedlist>
  48     <para>By default, full entries include a checksum for the encryption key, rather
  49     than the actual octal digits that constitute the key. To display the octal
  50     digits, include the <emphasis role="bold">-showkey</emphasis> flag with the <emphasis role="bold">-long</emphasis> or <emphasis role="bold">-showadmin</emphasis>
  51     flag.</para>
  52
  53   </refsect1>
  54   <refsect1>
  55     <title>Options</title>
  56     <variablelist>
  57       <varlistentry>
  58         <term><emphasis role="bold">-long</emphasis></term>
  59         <listitem>
  60           <para>Displays every Authentication Database entry in full. Provide this flag or
  61           the <emphasis role="bold">-showadmin</emphasis> flag, or omit both to display just the name of every
  62           database entry.</para>
  63
  64         </listitem>
  65       </varlistentry>
  66       <varlistentry>
  67         <term><emphasis role="bold">-showadmin</emphasis></term>
  68         <listitem>
  69           <para>Displays in full only the Authentication Database entries that have the
  70           <computeroutput>ADMIN</computeroutput> flag set. Provide this flag or the <emphasis role="bold">-long</emphasis> flag, or omit both to
  71           display just the name of every database entry.</para>
  72
  73         </listitem>
  74       </varlistentry>
  75       <varlistentry>
  76         <term><emphasis role="bold">-showkey</emphasis></term>
  77         <listitem>
  78           <para>Displays the octal digits that constitute the key in each full
  79           entry. Provide either the <emphasis role="bold">-long</emphasis> or <emphasis role="bold">-showadmin</emphasis> flag along with this
  80           one.</para>
  81
  82         </listitem>
  83       </varlistentry>
  84       <varlistentry>
  85         <term><emphasis role="bold">-admin_username</emphasis> &lt;<emphasis>admin principal</emphasis>&gt;</term>
  86         <listitem>
  87           <para>Specifies the user identity under which to authenticate with the
  88           Authentication Server for execution of the command. For more details, see
  89           <link linkend="kas8">kas(8)</link>.</para>
  90
  91         </listitem>
  92       </varlistentry>
  93       <varlistentry>
  94         <term><emphasis role="bold">-password_for_admin</emphasis> &lt;<emphasis>admin password</emphasis>&gt;</term>
  95         <listitem>
  96           <para>Specifies the password of the command's issuer. If it is omitted (as
  97           recommended), the <emphasis role="bold">kas</emphasis> command interpreter prompts for it and does not
  98           echo it visibly. For more details, see <link linkend="kas8">kas(8)</link>.</para>
  99
 100         </listitem>
 101       </varlistentry>
 102       <varlistentry>
 103         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
 104         <listitem>
 105           <para>Names the cell in which to run the command. For more details, see
 106           <link linkend="kas8">kas(8)</link>.</para>
 107
 108         </listitem>
 109       </varlistentry>
 110       <varlistentry>
 111         <term><emphasis role="bold">-servers</emphasis> &lt;<emphasis>authentication servers</emphasis>&gt;+</term>
 112         <listitem>
 113           <para>Names each machine running an Authentication Server with which to
 114           establish a connection. For more details, see <link linkend="kas8">kas(8)</link>.</para>
 115
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term><emphasis role="bold">-noauth</emphasis></term>
 120         <listitem>
 121           <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. For more
 122           details, see <link linkend="kas8">kas(8)</link>.</para>
 123
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><emphasis role="bold">-help</emphasis></term>
 128         <listitem>
 129           <para>Prints the online help for this command. All other valid options are
 130           ignored.</para>
 131
 132         </listitem>
 133       </varlistentry>
 134     </variablelist>
 135   </refsect1>
 136   <refsect1>
 137     <title>Output</title>
 138     <para>If neither the <emphasis role="bold">-long</emphasis> or <emphasis role="bold">-showadmin</emphasis> flag is provided, the output
 139     lists the name of each entry in the Authentication Database on its own
 140     line.</para>
 141
 142     <para>If the <emphasis role="bold">-long</emphasis> flag is included, the output includes every Authentication
 143     Database entry in full. If the <emphasis role="bold">-showadmin</emphasis> flag is included, the output
 144     includes in full only the Authentication Database entries that have the
 145     <computeroutput>ADMIN</computeroutput> flag set. If the <emphasis role="bold">-showkey</emphasis> is provided along with either one,
 146     the output includes the octal digits that constitute the encryption key in
 147     each entry.</para>
 148
 149     <para>A full Authentication Database entry includes the same information
 150     displayed by the <emphasis role="bold">kas examine</emphasis> command; for details, see that command's
 151     reference page.</para>
 152
 153   </refsect1>
 154   <refsect1>
 155     <title>Privilege Required</title>
 156     <para>The issuer must have the <computeroutput>ADMIN</computeroutput> flag set on his or her Authentication
 157     Database entry.</para>
 158
 159   </refsect1>
 160   <refsect1>
 161     <title>See Also</title>
 162     <para><link linkend="kas8">kas(8)</link>,
 163     <link linkend="kas_examine8">kas_examine(8)</link></para>
 164
 165   </refsect1>
 166   <refsect1>
 167     <title>Copyright</title>
 168     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 169
 170     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 171     converted from HTML to POD by software written by Chas Williams and Russ
 172     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 173
 174   </refsect1>
 175 </refentry>