pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / kas_interactive.pod
1 =head1 NAME
2
3 kas interactive - Enters interactive mode
4
5 =head1 SYNOPSIS
6
7 kas interactive [B<-admin_username> I<admin principal to use for authentication>]
8 [B<-password_for_admin> I<admin password>]  [B<-cell> I<cell name>]
9 [B<-servers> I<explicit list of authentication servers> ...]
10 [B<-noauth>]  [B<-help>]
11
12 kas i [B<-a> I<admin principal to use for authentication>]
13 [B<-p> I<admin password>]  [B<-c> I<cell name>]
14 [B<-s> I<explicit list of authentication servers> ...]  [B<-n>]  [B<-h>]
15
16 =head1 DESCRIPTION
17
18 The C<kas interactive> command establishes an interactive session for the
19 issuer of the command. By default, the command interpreter establishes
20 an authenticated connection for the user logged into the local file
21 system with all of the Authentication Servers listed in the local
22 B</usr/vice/etc/CellServDB> file for the cell named in the local
23 B</usr/vice/etc/ThisCell> file. To specify an alternate identity, cell
24 name, or list of Authentication Servers, include the B<-admin_username>,
25 B<-cell>, or B<-servers> arguments respectively. Interactive mode lasts for
26 six hours unless the maximum ticket lifetime for the issuer or the
27 Authentication Server's Ticket Granting Service is shorter.
28
29 There are two other ways to enter interactive mode, in addition to the
30 C<kas interactive> command:
31
32 =over
33
34 =item 1.
35
36 Type the C<kas> command at the shell prompt without any operation
37 code. If appropriate, include one or more of the B<-admin_username>,
38 B<-password_for_admin>, B<-cell>, and B<-servers> arguments.
39
40 =item 2.
41
42 Type the C<kas> command followed by a user name and cell name,
43 separated by an @ sign (for example: C<kas admin@abc.com>), to
44 establish a connection under the specified identity with the
45 Authentication Servers listed in the local
46 B</usr/vice/etc/CellServDB> file for the indicated cell. If
47 appropriate, provide the B<-servers> argument to specify an alternate
48 list of Authentication Server machines that belong to the
49 indicated cell.
50
51 =back
52
53 There are several consequences of entering interactive mode:
54
55 =over
56
57 =item *
58
59 The ka> prompt replaces the system (shell) prompt. When typing
60 commands at this prompt, provide only the operation code (omit the
61 command suite name, C<kas>).
62
63 =item *
64
65 The command interpreter does not prompt for the issuer's password.
66
67 The issuer's identity and password, the relevant cell, and the set
68 of Authentication Server machines specified when entering
69 interactive mode apply to all commands issued during the session.
70 They cannot be changed without leaving the session, except by
71 using the C<(kas) noauthentication> command to replace the current
72 authenticated connections with unauthenticated ones. The
73 B<-admin_username>, B<-password_for_admin>, B<-cell>, and B<-servers>
74 arguments are ignored if provided on a command issued during
75 interactive mode.
76
77 =back
78
79 To establish an unauthenticated connection to the Authentication
80 Server, include the B<-noauth> flag or provide an incorrect password.
81 Unless authorization checking is disabled on each Authentication
82 Server machine involved, however, it is not possible to perform any
83 privileged operations within such a session.
84
85 To end the current authenticated connection and establish an
86 unauthenticated one, issue the C<(kas) noauthentication> command. To
87 leave interactive mode and return to the regular shell prompt, issue
88 the C<(kas) quit> command.
89
90 =head1 OPTIONS
91
92 =over 4
93
94 =item B<-admin_username> I<admin principal to use for authentication>
95
96 Specifies the user identity under which to authenticate with
97 the Authentication Server for execution of the command. For
98 more details, see the introductory L<kas(1)> reference page.
99
100 =item B<-password_for_admin> I<admin password>
101
102 Specifies the password of the command's issuer. If it is
103 omitted (as recommended), the C<kas> command interpreter prompts
104 for it and does not echo it visibly. For more details, see the
105 introductory L<kas(1)> reference page.
106
107 =item B<-cell> I<cell name>
108
109 Names the cell in which to run the command. For more details,
110 see the introductory L<kas(1)> reference page.
111
112 =item B<-servers> I<explicit list of authentication servers> ...
113
114 Names each machine running an Authentication Server with which
115 to establish a connection. For more details, see the
116 introductory L<kas(1)> reference page.
117
118 =item B<-noauth>
119
120 Assigns the unprivileged identity B<anonymous> to the issuer. For
121 more details, see the introductory L<kas(1)> reference page.
122
123 =item B<-help>
124
125 Prints the online help for this command. All other valid
126 options are ignored.
127
128 =back
129
130 =head1 EXAMPLES
131
132 The following example shows a user entering interactive mode as the
133 privileged user B<admin>.
134
135 B<    kas interactive admin>
136    Password for admin: admin_password
137    ka>
138
139 =head1 PRIVILEGE REQUIRED
140
141 None
142
143 =head1 COPYRIGHT
144
145 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
146
147 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
148 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
149 Stanford Linear Accelerator Center, a department of Stanford University.
150
151 =head1 SEE ALSO
152
153 L<kas(1)>,
154 L<kas_noauthentication(1)>,
155 L<kas_quit(1)>
156
157 =cut