4b74b7ea8952d7ce3dc385fd1d81b859100d07bf
[openafs.git] / src / man / kas_list.1
1 kas list                   AFS Commands                kas list
2
3
4 NAME
5
6    kas   list -- list   all   entries  in  the  Authentication
7
8                        Database.
9
10
11    kas list  [-admin_username <admin principal to use for
12    authentication>]
13    [-password_for_admin <admin password>]  [-cell <cell name>]
14            [-servers <explicit list of authentication
15            +
16    servers> ]
17    [-noauth]  [-help]
18
19 ACCEPTABLE ABBREVIATIONS/ALIASES
20
21    kas ls  [-a <admin principal to use for authentication>]
22    [-p <admin password>]  [-c <cell name>]
23                                                 +
24    [-s <explicit list of authentication servers> ]  [-n]  [-h]
25
26 DESCRIPTION
27
28    Lists the names of all the entries  (server  and  individual
29    user) in the Authentication Database.
30
31 ARGUMENTS
32
33    -admin_username   specifies  the  user  name under which the
34                      issuer wishes to perform the command.   If
35                      the   issuer  does  not  provide  it,  the
36                      current identity is used.  See section 4.3
37                      in  the Reference Manual for more details.
38                      -password_for_admin
39                      specifies  the  issuer's  password.   Note
40                      that provided here the password is visible
41                      on  the  screen.    If the issuer does not
42                      provide it, it will be  prompted  for  and
43                      not be visible on the screen.  See section
44                      4.3  in  the  Reference  Manual  for  more
45                      details.  -cell
46                      specifies the cell in  which  to  run  the
47                      command,  if  not  the  local  cell.   See
48                      section 4.3 in the  Reference  Manual  for
49                      more details.  -servers
50                      specifies the database  server  machine(s)
51                      with which to establish a connection.  See
52                      section 4.3 in the  Reference  Manual  for
53                      more details.  -noauth
54                      establishes an unauthenticated  connection
55                      between  the  Authentication  Servers  and
56                      issuer, whom they assign the  unprivileged
57                      identity  anonymous rather than attempting
58                      mutual authentication.  See section 4.3 in
59                      the  Reference  Manual  for  more details.
60                      -help
61                      prints  the  online help for this command.
62                      Do not  provide  any  other  arguments  or
63                      flags  with  this one.  See section 4.3 in
64                      the Reference Manual for more details.
65
66
67
68 OUTPUT
69
70    Each entry appears on its own line.  Some entries have  been
71    created  by  the  Authentication Server for its own internal
72    use (for instance, AuthServer.Admin).
73
74 EXAMPLE
75
76    The following example is for the cell small.edu,  which  has
77    five   users   in   it   (the  other  entries  are  for  the
78    Authentication Server's internal use).
79
80    % kas list  AuthServer.Admin  krbtgt.SMALL.EDU  afs  admin
81    pat   smith  jones   terry
82
83 PRIVILEGE REQUIRED
84
85    Issuer  must  have  the  ADMIN  flag  set  in  his  or   her
86    Authentication Database entry.
87
88 MORE INFORMATION