doc/man-pages/pod/kas_list.pod

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