kaauxdb-fix-silly-comment-substitution-20010711
[openafs.git] / doc / html / AdminReference / auarf189.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf188.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf190.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRKAS_LIST" HREF="auarf002.htm#ToC_203">kas list</A></H2>
19 <A NAME="IDX5112"></A>
20 <A NAME="IDX5113"></A>
21 <A NAME="IDX5114"></A>
22 <A NAME="IDX5115"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Displays all entries in the Authentication Database
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>kas list</B> [<B>-long</B>]  [<B>-showadmin</B>]  [<B>-showkey</B>]
27          [<B>-admin_username</B> &lt;<VAR>admin&nbsp;principal&nbsp;to&nbsp;use&nbsp;for&nbsp;authentication</VAR>>] 
28          [<B>-password_for_admin</B> &lt;<VAR>admin&nbsp;password</VAR>>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>] 
29          [<B>-servers</B> &lt;<VAR>explicit&nbsp;list&nbsp;of&nbsp;authentication&nbsp;servers</VAR>><SUP>+</SUP>]
30          [<B>-noauth</B>]  [<B>-help</B>]
31    
32 <B>kas ls</B> [<B>-l</B>]  [<B>-showa</B>]   [<B>-showk</B>]
33        [<B>-a</B> &lt;<VAR>admin&nbsp;principal&nbsp;to&nbsp;use&nbsp;for&nbsp;authentication</VAR>>] 
34        [<B>-p</B> &lt;<VAR>admin&nbsp;password</VAR>>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>] 
35        [<B>-se</B> &lt;<VAR>explicit&nbsp;list&nbsp;of&nbsp;authentication&nbsp;servers</VAR>><SUP>+</SUP>]  [<B>-n</B>]  [<B>-h</B>] 
36 </PRE>
37 <P><STRONG>Description</STRONG>
38 <P>The <B>kas list</B> command either displays all entries from the
39 Authentication Database by name, or displays the full database entry for a
40 defined set of entries, as determined by the flag provided:
41 <UL>
42 <P><LI>To display every entry in the Authentication Database in full, include the
43 <B>-long</B> flag.
44 <P><LI>To display only those entries in full that have the <TT>ADMIN</TT> flag
45 set, include the <B>-showadmin</B> flag.
46 <P><LI>To list only the name of each Authentication Database entry, omit both the
47 <B>-long</B> and <B>-showadmin</B> flags.
48 </UL>
49 <P>By default, full entries include a checksum for the encryption key, rather
50 than the actual octal digits that constitute the key. To display the
51 octal digits, include the <B>-showkey</B> flag with the <B>-long</B>
52 or <B>-showadmin</B> flag.
53 <P><STRONG>Options</STRONG>
54 <DL>
55 <P><DT><B>-long
56 </B><DD>Displays every Authentication Database entry in full. Provide this
57 flag or the <B>-showadmin</B> flag, or omit both to display just the name
58 of every database entry.
59 <P><DT><B>-showadmin
60 </B><DD>Displays in full only the Authentication Database entries that have the
61 <TT>ADMIN</TT> flag set. Provide this flag or the <B>-long</B>
62 flag, or omit both to display just the name of every database entry.
63 <P><DT><B>-showkey
64 </B><DD>Displays the octal digits that constitute the key in each full
65 entry. Provide either the <B>-long</B> or <B>-showadmin</B>
66 flag along with this one.
67 <P><DT><B>-admin_username
68 </B><DD>Specifies the user identity under which to authenticate with the
69 Authentication Server for execution of the command. For more details,
70 see the introductory <B>kas</B> reference page.
71 <P><DT><B>-password_for_admin
72 </B><DD>Specifies the password of the command's issuer. If it is
73 omitted (as recommended), the <B>kas</B> command interpreter prompts for
74 it and does not echo it visibly. For more details, see the introductory
75 <B>kas</B> reference page.
76 <P><DT><B>-cell
77 </B><DD>Names the cell in which to run the command. For more details, see
78 the introductory <B>kas</B> reference page.
79 <P><DT><B>-servers
80 </B><DD>Names each machine running an Authentication Server with which to
81 establish a connection. For more details, see the introductory
82 <B>kas</B> reference page.
83 <P><DT><B>-noauth
84 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
85 issuer. For more details, see the introductory <B>kas</B> reference
86 page.
87 <P><DT><B>-help
88 </B><DD>Prints the online help for this command. All other valid options
89 are ignored.
90 </DL>
91 <P><STRONG>Output</STRONG>
92 <P>If neither the <B>-long</B> or <B>-showadmin</B> flag is provided,
93 the output lists the name of each entry in the Authentication Database on its
94 own line.
95 <P>If the <B>-long</B> flag is included, the output includes every
96 Authentication Database entry in full. If the <B>-showadmin</B>
97 flag is included, the output includes in full only the Authentication Database
98 entries that have the <TT>ADMIN</TT> flag set. If the
99 <B>-showkey</B> is provided along with either one, the output includes the
100 octal digits that constitute the encryption key in each entry.
101 <P>A full Authentication Database entry includes the same information
102 displayed by the <B>kas examine</B> command; for details, see that
103 command's reference page.
104 <P><STRONG>Privilege Required</STRONG>
105 <P>The issuer must have the <TT>ADMIN</TT> flag set on his or her
106 Authentication Database entry.
107 <P><STRONG>Related Information</STRONG>
108 <P><A HREF="auarf181.htm#HDRKAS_INTRO">kas</A>
109 <P><A HREF="auarf185.htm#HDRKAS_EXAMINE">kas examine</A>
110 <P>
111 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf188.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf190.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
112 <!-- Begin Footer Records  ========================================== -->
113 <P><HR><B> 
114 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
115 </B> 
116 <!-- End Footer Records  ============================================ -->
117 <A NAME="Bot_Of_Page"></A>
118 </BODY></HTML>