doc/man-pages/pod8/kas_statistics.pod

   1 =head1 NAME
   2
   3 kas statistics - Displays statistics from an Authentication Server process
   4
   5 =head1 SYNOPSIS
   6
   7 B<kas statistics>
   8     [B<-admin_username> <I<admin principal to use for authentication>>]
   9     [B<-password_for_admin> <I<admin password>>] [B<-cell> <I<cell name>>]
  10     [B<-servers> <I<explicit list of authentication servers>>+]
  11     [B<-noauth>] [B<-help>]
  12
  13 B<kas sta> [B<-a> <I<admin principal to use for authentication>>]
  14     [B<-p> <I<admin password>>]  [B<-c> <I<cell name>>]
  15     [B<-s> <I<explicit list of authentication servers>>+] [B<-n>] [B<-h>]
  16
  17 =head1 DESCRIPTION
  18
  19 The B<kas statistics> command displays statistics from the Authentication
  20 Server running on one of the cell's database server machines. Use the
  21 B<-servers> argument to name a specific machine, or the command
  22 interpreter chooses one at random from all the database server machines
  23 with which it has established connections.
  24
  25 =head1 CAUTIONS
  26
  27 The B<-servers> argument is not available in interactive mode, making it
  28 impossible to specify a certain machine.
  29
  30 =head1 OPTIONS
  31
  32 =over 4
  33
  34 =item B<-admin_username> <I<admin principal>>
  35
  36 Specifies the user identity under which to authenticate with the
  37 Authentication Server for execution of the command. For more details, see
  38 L<kas(8)>.
  39
  40 =item B<-password_for_admin> <I<admin password>>
  41
  42 Specifies the password of the command's issuer. If it is omitted (as
  43 recommended), the B<kas> command interpreter prompts for it and does not
  44 echo it visibly. For more details, see L<kas(8)>.
  45
  46 =item B<-cell> <I<cell name>>
  47
  48 Names the cell in which to run the command. For more details, see
  49 L<kas(8)>.
  50
  51 =item B<-servers> <I<authentication servers>>+
  52
  53 Names each machine running an Authentication Server with which to
  54 establish a connection. For more details, see L<kas(8)>.
  55
  56 =item B<-noauth>
  57
  58 Assigns the unprivileged identity C<anonymous> to the issuer. For more
  59 details, see L<kas(8)>.
  60
  61 =item B<-help>
  62
  63 Prints the online help for this command. All other valid options are
  64 ignored.
  65
  66 =back
  67
  68 =head1 OUTPUT
  69
  70 The information in the output includes:
  71
  72 =over 4
  73
  74 =item *
  75
  76 The number of allocation and freeing operations the Authentication Server
  77 has performed, and how many password change requests it has processed.
  78
  79 =item *
  80
  81 An indication of its hash table use.
  82
  83 =item *
  84
  85 The server machine's IP address in hexadecimal and the date when the
  86 current instance of the Authentication Server started.
  87
  88 =item *
  89
  90 The number of requests and aborted requests for various services:
  91 authentication, ticket granting, password setting, entry listing, and so
  92 on.
  93
  94 =item *
  95
  96 The amount of CPU time that the Authentication Server has used to process
  97 requests since it started. The amount is not accurate on all system types,
  98 however.
  99
 100 =item *
 101
 102 The number of entries in the Authentication Database that are marked with
 103 the C<ADMIN> flag.
 104
 105 =back
 106
 107 =head1 EXAMPLES
 108
 109 In the following example, an administrator using the admin account gathers
 110 statistics from the Authentication Server running on the machine
 111 C<fs1.abc.com>.
 112
 113    % kas statistics -servers fs1.abc.com
 114    56 allocs, 46 frees, 0 password changes
 115    Hash table utilization = 0.100000%
 116    From host bfff21a7 started at Tue Mar 23 12:42:02 1999:
 117      of 88 requests for Authenticate, 18 were aborted.
 118      of 14 requests for GetTicket, 0 were aborted.
 119      of 4 requests for CreateUser, 1 were aborted.
 120      of 12 requests for SetFields, 4 were aborted.
 121      of 3 requests for DeleteUser, 0 were aborted.
 122      of 23 requests for GetEntry, 4 were aborted.
 123      of 18 requests for ListEntry, 0 were aborted.
 124      of 2 requests for GetStats, 1 were aborted.
 125      of 2 requests for GetRandomKey, 0 were aborted.
 126    Used 6.015 seconds of CPU time.
 127    3 admin accounts
 128
 129 =head1 PRIVILEGE REQUIRED
 130
 131 The issuer must have the C<ADMIN> flag set on his or her Authentication
 132 Database entry.
 133
 134 =head1 SEE ALSO
 135
 136 L<kas(8)>
 137
 138 =head1 COPYRIGHT
 139
 140 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 141
 142 This documentation is covered by the IBM Public License Version 1.0.  It was
 143 converted from HTML to POD by software written by Chas Williams and Russ
 144 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.