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