Initial IBM OpenAFS 1.0 tree
[openafs.git] / src / WINNT / doc / install / Documentation / en_US / html / CmdRef / auarf195.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="auarf194.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="auarf196.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_STATISTICS" HREF="auarf002.htm#ToC_209">kas statistics</A></H2>
19 <A NAME="IDX5155"></A>
20 <A NAME="IDX5156"></A>
21 <A NAME="IDX5157"></A>
22 <A NAME="IDX5158"></A>
23 <A NAME="IDX5159"></A>
24 <A NAME="IDX5160"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Displays statistics from an Authentication Server process
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>kas statistics</B> [<B>-admin_username</B> &lt;<VAR>admin&nbsp;principal&nbsp;to&nbsp;use&nbsp;for&nbsp;authentication</VAR>>]
29                [<B>-password_for_admin</B> &lt;<VAR>admin&nbsp;password</VAR>>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>] 
30                [<B>-servers</B> &lt;<VAR>explicit&nbsp;list&nbsp;of&nbsp;authentication&nbsp;servers</VAR>><SUP>+</SUP>]
31                [<B>-noauth</B>]  [<B>-help</B>]
32    
33 <B>kas sta</B> [<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>-s</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 statistics</B> command displays statistics from the
39 Authentication Server running on one of the cell&#39;s database server
40 machines. Use the <B>-servers</B> argument to name a specific
41 machine, or the command interpreter chooses one at random from all the
42 database server machines with which it has established connections.
43 <P><STRONG>Cautions</STRONG>
44 <P>The <B>-servers</B> argument is not available in interactive mode,
45 making it impossible to specify a certain machine.
46 <P><STRONG>Options</STRONG>
47 <DL>
48 <P><DT><B>-admin_username
49 </B><DD>Specifies the user identity under which to authenticate with the
50 Authentication Server for execution of the command. For more details,
51 see the introductory <B>kas</B> reference page.
52 <P><DT><B>-password_for_admin
53 </B><DD>Specifies the password of the command&#39;s issuer. If it is
54 omitted (as recommended), the <B>kas</B> command interpreter prompts for
55 it and does not echo it visibly. For more details, see the introductory
56 <B>kas</B> reference page.
57 <P><DT><B>-cell
58 </B><DD>Names the cell in which to run the command. For more details, see
59 the introductory <B>kas</B> reference page.
60 <P><DT><B>-servers
61 </B><DD>Names each machine running an Authentication Server with which to
62 establish a connection. For more details, see the introductory
63 <B>kas</B> reference page.
64 <P><DT><B>-noauth
65 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
66 issuer. For more details, see the introductory <B>kas</B> reference
67 page.
68 <P><DT><B>-help
69 </B><DD>Prints the online help for this command. All other valid options
70 are ignored.
71 </DL>
72 <P><STRONG>Output</STRONG>
73 <P>The information in the output includes&#58;
74 <UL>
75 <P><LI>The number of allocation and freeing operations the Authentication Server
76 has performed, and how many password change requests it has processed.
77 <P><LI>An indication of its hash table use.
78 <P><LI>The server machine&#39;s IP address in hexadecimal and the date when the
79 current instance of the Authentication Server started.
80 <P><LI>The number of requests and aborted requests for various services&#58;
81 authentication, ticket granting, password setting, entry listing, and so
82 on.
83 <P><LI>The amount of CPU time that the Authentication Server has used to process
84 requests since it started. The amount is not accurate on all system
85 types, however.
86 <P><LI>The number of entries in the Authentication Database that are marked with
87 the <TT>ADMIN</TT> flag.
88 </UL>
89 <P><STRONG>Examples</STRONG>
90 <P>In the following example, an administrator using the <B>admin</B>
91 account gathers statistics from the Authentication Server running on the
92 machine <B>fs1.abc.com</B>.
93 <PRE>   % <B>kas statistics -servers fs1.abc.com</B>
94    56 allocs, 46 frees, 0 password changes
95    Hash table utilization = 0.100000%
96    From host bfff21a7 started at Tue Mar 23 12&#58;42&#58;02 1999&#58;
97      of 88 requests for Authenticate, 18 were aborted.
98      of 14 requests for GetTicket, 0 were aborted.
99      of 4 requests for CreateUser, 1 were aborted.
100      of 12 requests for SetFields, 4 were aborted.
101      of 3 requests for DeleteUser, 0 were aborted.
102      of 23 requests for GetEntry, 4 were aborted.
103      of 18 requests for ListEntry, 0 were aborted.
104      of 2 requests for GetStats, 1 were aborted.
105      of 2 requests for GetRandomKey, 0 were aborted.
106    Used 6.015 seconds of CPU time.
107    3 admin accounts
108    
109 </PRE>
110 <P><STRONG>Privilege Required</STRONG>
111 <P>The issuer must have the <TT>ADMIN</TT> flag set on his or her
112 Authentication Database entry.
113 <P><STRONG>Related Information</STRONG>
114 <P><A HREF="auarf181.htm#HDRKAS_INTRO">kas</A>
115 <P>
116 <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="auarf194.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="auarf196.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> 
117 <!-- Begin Footer Records  ========================================== -->
118 <P><HR><B> 
119 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
120 </B> 
121 <!-- End Footer Records  ============================================ -->
122 <A NAME="Bot_Of_Page"></A>
123 </BODY></HTML>