doc/man-pages/pod8/kas_list.pod

   1 =head1 NAME
   2
   3 kas_list - Displays all entries in the Authentication Database
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<kas list> [B<-long>] [B<-showadmin>] [B<-showkey>]
  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 ls> [B<-l>] [B<-showa>] [B<-showk>]
  17     S<<< [B<-a> <I<admin principal to use for authentication>>] >>>
  18     S<<< [B<-p> <I<admin password>>] >>> S<<< [B<-c> <I<cell name>>] >>>
  19     S<<< [B<-se> <I<explicit list of authentication servers>>+] >>> [B<-n>] [B<-h>]
  20
  21 =for html
  22 </div>
  23
  24 =head1 DESCRIPTION
  25
  26 The B<kas list> command either displays all entries from the
  27 Authentication Database by name, or displays the full database entry for a
  28 defined set of entries, as determined by the flag provided:
  29
  30 =over 4
  31
  32 =item *
  33
  34 To display every entry in the Authentication Database in full, include the
  35 B<-long> flag.
  36
  37 =item *
  38
  39 To display only those entries in full that have the C<ADMIN> flag set,
  40 include the B<-showadmin> flag.
  41
  42 =item *
  43
  44 To list only the name of each Authentication Database entry, omit both the
  45 B<-long> and B<-showadmin> flags.
  46
  47 =back
  48
  49 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 octal
  51 digits, include the B<-showkey> flag with the B<-long> or B<-showadmin>
  52 flag.
  53
  54 =head1 OPTIONS
  55
  56 =over 4
  57
  58 =item B<-long>
  59
  60 Displays every Authentication Database entry in full. Provide this flag or
  61 the B<-showadmin> flag, or omit both to display just the name of every
  62 database entry.
  63
  64 =item B<-showadmin>
  65
  66 Displays in full only the Authentication Database entries that have the
  67 C<ADMIN> flag set. Provide this flag or the B<-long> flag, or omit both to
  68 display just the name of every database entry.
  69
  70 =item B<-showkey>
  71
  72 Displays the octal digits that constitute the key in each full
  73 entry. Provide either the B<-long> or B<-showadmin> flag along with this
  74 one.
  75
  76 =item B<-admin_username> <I<admin principal>>
  77
  78 Specifies the user identity under which to authenticate with the
  79 Authentication Server for execution of the command. For more details, see
  80 L<kas(8)>.
  81
  82 =item B<-password_for_admin> <I<admin password>>
  83
  84 Specifies the password of the command's issuer. If it is omitted (as
  85 recommended), the B<kas> command interpreter prompts for it and does not
  86 echo it visibly. For more details, see L<kas(8)>.
  87
  88 =item B<-cell> <I<cell name>>
  89
  90 Names the cell in which to run the command. For more details, see
  91 L<kas(8)>.
  92
  93 =item B<-servers> <I<authentication servers>>+
  94
  95 Names each machine running an Authentication Server with which to
  96 establish a connection. For more details, see L<kas(8)>.
  97
  98 =item B<-noauth>
  99
 100 Assigns the unprivileged identity C<anonymous> to the issuer. For more
 101 details, see L<kas(8)>.
 102
 103 =item B<-help>
 104
 105 Prints the online help for this command. All other valid options are
 106 ignored.
 107
 108 =back
 109
 110 =head1 OUTPUT
 111
 112 If neither the B<-long> or B<-showadmin> flag is provided, the output
 113 lists the name of each entry in the Authentication Database on its own
 114 line.
 115
 116 If the B<-long> flag is included, the output includes every Authentication
 117 Database entry in full. If the B<-showadmin> flag is included, the output
 118 includes in full only the Authentication Database entries that have the
 119 C<ADMIN> flag set. If the B<-showkey> is provided along with either one,
 120 the output includes the octal digits that constitute the encryption key in
 121 each entry.
 122
 123 A full Authentication Database entry includes the same information
 124 displayed by the B<kas examine> command; for details, see that command's
 125 reference page.
 126
 127 =head1 PRIVILEGE REQUIRED
 128
 129 The issuer must have the C<ADMIN> flag set on his or her Authentication
 130 Database entry.
 131
 132 =head1 SEE ALSO
 133
 134 L<kas(8)>,
 135 L<kas_examine(8)>
 136
 137 =head1 COPYRIGHT
 138
 139 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 140
 141 This documentation is covered by the IBM Public License Version 1.0.  It was
 142 converted from HTML to POD by software written by Chas Williams and Russ
 143 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.