afs-blacklist-initialize-volume-ptr-always-20080628
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf198.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf197.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="auarf199.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="HDRKASERVER" HREF="auarf002.htm#ToC_212">kaserver</A></H2>
19 <A NAME="IDX5170"></A>
20 <A NAME="IDX5171"></A>
21 <A NAME="IDX5172"></A>
22 <P><STRONG>Purpose</STRONG>
23 <P>Initializes the Authentication Server
24 <P><STRONG>Description</STRONG>
25 <PRE><B>kaserver</B> [<B>-noAuth</B>]  [<B>-fastKeys</B>]  [<B>-database</B> &lt;<VAR>dbpath</VAR>>] 
26          [<B>-localfiles</B> &lt;<VAR>lclpath</VAR>>]  [<B>-minhours</B> &lt;<VAR>n</VAR>>] 
27          [<B>-servers</B> &lt;<VAR>serverlist</VAR>>]  [<B>-enable_peer_stats</B>]  
28          [<B>-enable_process_stats</B>]  [<B>-help</B>]
29 </PRE>
30 <P>This command does not use the syntax conventions of the AFS command
31 suites. Provide the command name and all option names in full.
32 <P><STRONG>Description</STRONG>
33 <P>The <B>kaserver</B> command initializes the Authentication Server,
34 which runs on every database server machine. In the conventional
35 configuration, its binary file is located in the <B>/usr/afs/bin</B>
36 directory on a file server machine.
37 <P>The <B>kaserver</B> command is not normally issued at the command shell
38 prompt but rather placed into a file server machine&#39;s
39 <B>/usr/afs/local/BosConfig</B> file with the <B>bos create</B>
40 command. If it is ever issued at the command shell prompt, the issuer
41 must be logged onto a database server machine as the local superuser
42 <B>root</B>.
43 <P>As it initializes, the Authentication Server process creates the two files
44 that constitute the Authentication Database, <B>kaserver.DB0</B>
45 and <B>kaserver.DBSYS1</B>, in the <B>/usr/afs/db</B> directory
46 if they do not already exist. Use the commands in the <B>kas</B>
47 suite to administer the database.
48 <P>The Authentication Server is responsible for several aspects of AFS
49 security, including&#58;
50 <UL>
51 <P><LI>Maintenance of all AFS server encryption keys and user passwords in the
52 Authentication Database.
53 <P><LI>Creation of the tickets and tokens that users and servers use to establish
54 secure connections. Its Ticket Granting Service (TGS) component
55 performs this function.
56 </UL>
57 <P>The Authentication Server records a trace of its activity in the
58 <B>/usr/afs/logs/AuthLog</B> file. Use the <B>bos getlog</B>
59 command to display the contents of the file. Use the <B>kdb</B>
60 command to read the protected files associated with the <B>AuthLog</B>
61 file, <B>AuthLog.dir</B> and <B>AuthLog.pag</B>.
62 <P><STRONG>Options</STRONG>
63 <DL>
64 <P><DT><B>-noAuth
65 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
66 issuer. Thus, it establishes an unauthenticated connection between the
67 issuer and the Authentication Server. It is useful only when
68 authorization checking is disabled on the database server machine. In
69 normal circumstances, the Authentication Server allows only authorized
70 (privileged) users to issue commands that affect or contact the Authentication
71 Database and will refuse to perform such an action even if the
72 <B>-noAuth</B> flag is used.
73 <P><DT><B>-fastKeys
74 </B><DD>Is a test flag for use by the AFS Development staff; it serves no
75 functional purpose.
76 <P><DT><B>-database
77 </B><DD>Specifies the pathname of an alternate directory in which the
78 Authentication Database files reside. Provide the complete pathname,
79 ending in the base filename to which the <B>.DB0</B> and
80 <B>.DBSYS1</B> extensions are appended. For example, the
81 appropriate value for the default database files is
82 <B>/usr/afs/db/kaserver</B>.
83 <P>Provide the <B>-localfiles</B> argument along with this one;
84 otherwise, the <B>-localfiles</B> argument is also set to the value of
85 this argument, which is probably inappropriate.
86 <P><DT><B>-localfiles
87 </B><DD>Specifies the pathname of an alternate directory in which the auxiliary
88 Authentication Database file resides. Provide the complete pathname,
89 ending in the base filename to which the <B>auxdb</B> suffix is
90 appended. For example, the appropriate value for the default auxiliary
91 database file is <B>/usr/afs/local/kaserver</B>.
92 <P><DT><B>-minhours
93 </B><DD>Specifies the minimum number of hours that must pass between password
94 changes made by any regular user. System administrators (with the
95 <TT>ADMIN</TT> flag in their Authentication Database entry) can change
96 passwords as often as desired. Setting a minimum time between password
97 changes is not recommended.
98 <P><DT><B>-servers
99 </B><DD>Names each database server machine running an Authentication Server with
100 which the local Authentication Server is to synchronize its copy of the
101 Authentication Database , rather than with the machines listed in the local
102 <B>/usr/afs/etc/CellServDB</B> file.
103 <P><DT><B>-enable_peer_stats
104 </B><DD>Activates the collection of Rx statistics and allocates memory for their
105 storage. For each connection with a specific UDP port on another
106 machine, a separate record is kept for each type of RPC (FetchFile, GetStatus,
107 and so on) sent or received. To display or otherwise access the
108 records, use the Rx Monitoring API.
109 <P><DT><B>-enable_process_stats
110 </B><DD>Activates the collection of Rx statistics and allocates memory for their
111 storage. A separate record is kept for each type of RPC (FetchFile,
112 GetStatus, and so on) sent or received, aggregated over all connections to
113 other machines. To display or otherwise access the records, use the Rx
114 Monitoring API.
115 <P><DT><B>-help
116 </B><DD>Prints the online help for this command. All other valid options
117 are ignored.
118 </DL>
119 <P><STRONG>Examples</STRONG>
120 <P>The following <B>bos create</B> command creates a <B>kaserver</B>
121 process on <B>fs3.abc.com</B> (the command appears on two
122 lines here only for legibility)&#58;
123 <PRE>   % <B>bos create -server fs3.abc.com -instance kaserver</B> \
124                 <B>-type simple -cmd /usr/afs/bin/kaserver</B>
125 </PRE>
126 <P><STRONG>Privilege Required</STRONG>
127 <P>The issuer must be logged in as the superuser <B>root</B> on a file
128 server machine to issue the command at a command shell prompt. It is
129 conventional instead to create and start the process by issuing the <B>bos
130 create</B> command.
131 <P><STRONG>Related Information</STRONG>
132 <P><A HREF="auarf012.htm#HDRAUTHLOG">AuthLog</A>
133 <P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
134 <P><A HREF="auarf020.htm#HDRSV_CSDB">CellServDB (server version)</A>
135 <P><A HREF="auarf045.htm#HDRKASERVERDB">kaserver.DB0 and kaserver.DBSYS1</A>
136 <P><A HREF="auarf046.htm#HDRKASERVERAUXDB">kaserverauxdb</A>
137 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
138 <P><A HREF="auarf098.htm#HDRBOS_CREATE">bos create</A>
139 <P><A HREF="auarf102.htm#HDRBOS_GETLOG">bos getlog</A>
140 <P><A HREF="auarf181.htm#HDRKAS_INTRO">kas</A>
141 <P><A HREF="auarf199.htm#HDRKDB">kdb</A>
142 <P>
143 <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="auarf197.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="auarf199.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> 
144 <!-- Begin Footer Records  ========================================== -->
145 <P><HR><B> 
146 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
147 </B> 
148 <!-- End Footer Records  ============================================ -->
149 <A NAME="Bot_Of_Page"></A>
150 </BODY></HTML>