linux-osi-module-proc-csdb-sprintf-bug-20050423
[openafs.git] / doc / html / AdminReference / auarf201.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf200.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf202.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRKNFS" HREF="auarf002.htm#ToC_215">knfs</A></H2>
19 <A NAME="IDX5183"></A>
20 <A NAME="IDX5184"></A>
21 <A NAME="IDX5185"></A>
22 <A NAME="IDX5186"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Establishes basis for authenticated access to AFS from a non-supported NFS
25 client using the NFS/AFS Translator
26 <P><STRONG>Synopsis</STRONG>
27 <PRE><B>knfs -host</B> &lt;<VAR>host&nbsp;name</VAR>>  [<B>-id</B> &lt;<VAR>user&nbsp;ID&nbsp;(decimal)</VAR>>]
28      [<B>-sysname</B> &lt;<VAR>host's&nbsp;'@sys'&nbsp;value</VAR>>]  [<B>-unlog</B>]  [<B>-tokens</B>]  [<B>-help</B>]
29     
30 <B>knfs -ho</B> &lt;<VAR>host&nbsp;name</VAR>>  [<B>-i</B> &lt;<VAR>user&nbsp;ID (decimal)</VAR>>]  
31      [<B>-s</B> &lt;<VAR>host's&nbsp;'@sys'&nbsp;value</VAR>>]  [<B>-u</B>]  [<B>-t</B>]  [<B>-he</B>]
32 </PRE>
33 <P><STRONG>Description</STRONG>
34 <P>The <B>knfs</B> command creates an AFS credential structure on the
35 local machine, identifying it by a process authentication group (PAG) number
36 associated with the NFS client machine named by the <B>-hostname</B>
37 argument and by default with a local UID on the NFS client machine that
38 matches the issuer's local UID on the local machine. It places in
39 the credential structure the AFS tokens that the issuer has previously
40 obtained (by logging onto the local machine if an AFS-modified login utility
41 is installed, by issuing the <B>klog</B> command, or both). To
42 associate the credential structure with an NFS UID that does not match the
43 issuer's local UID, use the <B>-id</B> argument.
44 <P>Issue this command only on the NFS<SUP>(R)</SUP>/AFS translator machine that is
45 serving the NFS client machine, after obtaining AFS tokens on the translator
46 machine for every cell to which authenticated access is required. The
47 Cache Manager on the translator machine uses the tokens to obtain
48 authenticated AFS access for the designated user working on the NFS client
49 machine. This command is not effective if issued on an NFS client
50 machine.
51 <P>To enable the user on the NFS client machine to issue AFS commands, use the
52 <B>-sysname</B> argument to specify the NFS client machine's system
53 type, which can differ from the translator machine's. The NFS
54 client machine must be a system type for which AFS is supported.
55 <P>The <B>-unlog</B> flag discards the tokens in the credential structure,
56 but does not destroy the credential structure itself. The Cache Manager
57 on the translator machine retains the credential structure until the next
58 reboot, and uses it each time the issuer accesses AFS through the translator
59 machine. The credential structure only has tokens in it if the user
60 reissues the <B>knfs</B> command on the translator machine each time the
61 user logs into the NFS client machine.
62 <P>To display the tokens associated with the designated user on the NFS client
63 machine, include the <B>-tokens</B> flag.
64 <P>Users working on NFS client machines of system types for which AFS binaries
65 are available (and for which the cell has purchased a license) can use the
66 <B>klog</B> command rather than the <B>knfs</B> command.
67 <P><STRONG>Cautions</STRONG>
68 <P>If the translator machine's administrator has enabled UID checking by
69 issuing the <B>fs exportafs</B> command with the <B>-uidcheck on</B>
70 argument, it is not possible to use the <B>-id</B> argument to assign the
71 tokens to an NFS UID that differs from the issuer's local UID. In
72 this case, there is no point in including the <B>-id</B> argument, because
73 the only acceptable value (the issuer's local UID) is the value used when
74 the <B>-id</B> argument is omitted. Requiring matching UIDs is
75 effective only when users have the same local UID on the translator machine as
76 on NFS client machines. In that case, it guarantees that users assign
77 their tokens only to their own NFS sessions.
78 <P>This command does not make it possible for users working on non-supported
79 system types to issue AFS commands. This is possible only on NFS
80 clients of a system type for which AFS is available.
81 <P><STRONG>Options</STRONG>
82 <DL>
83 <P><DT><B>-host
84 </B><DD>Names the NFS client machine on which the issuer is to work.
85 Providing a fully-qualified hostname is best, but abbreviated forms are
86 possibly acceptable depending on the state of the cell's name server at
87 the time the command is issued.
88 <P><DT><B>-id
89 </B><DD>Specifies the local UID on the NFS client to which to assign the
90 tokens. The NFS client identifies file requests by the NFS UID, so
91 creating the association enables the Cache Manager on the translator machine
92 to use the appropriate tokens when filling the requests. If this
93 argument is omitted, the command interpreter uses an NFS UID that matches the
94 issuer's local UID on the translator machine (as returned by the
95 <B>getuid</B> function).
96 <P><DT><B>-sysname
97 </B><DD>Specifies the value that the local (translator) machine's remote
98 executor daemon substitutes for the <B>@sys</B> variable in pathnames when
99 executing AFS commands issued on the NFS client machine (which must be a
100 supported system type). If the NFS user's PATH environment
101 variable uses the <B>@sys</B> variable in the pathnames for directories
102 that house AFS binaries (as recommended), then setting this argument enables
103 NFS users to issue AFS commands by leading the remote executor daemon to
104 access the AFS binaries appropriate to the NFS client machine even if its
105 system type differs from the translator machine's.
106 <P><DT><B>-unlog
107 </B><DD>Discards the tokens stored in the credential structure identified by the
108 PAG associated with the <B>-host</B> argument and, optionally, the
109 <B>-id</B> argument.
110 <P><DT><B>-tokens
111 </B><DD>Displays the AFS tokens assigned to the designated user on the indicated
112 NFS client machine.
113 <P><DT><B>-help
114 </B><DD>Prints the online help for this command. All other valid options
115 are ignored.
116 </DL>
117 <P><STRONG>Output</STRONG>
118 <P>The following error message indicates that UID checking is enabled on the
119 translator machine and that the value provided for the <B>-id</B> argument
120 differs from the issuer's local UID.
121 <PRE>   
122    knfs: Translator in 'passwd sync' mode; remote uid must be the same as local uid
123 </PRE>
124 <P><STRONG>Examples</STRONG>
125 <P>The following example illustrates a typical use of this command. The
126 issuer <B>smith</B> is working on the machine
127 <B>nfscli1.abc.com</B> and has user ID <B>1020</B> on
128 that machine. The translator machine
129 <B>tx4.abc.com</B> uses an AFS-modified login utility, so
130 <B>smith</B> obtains tokens for the ABC Corporation cell automatically
131 upon login via the <B>telnet</B> program. She then issues the
132 <B>klog</B> command to obtain tokens as <B>admin</B> in the ABC
133 Corporation's test cell, <B>test.abc.com</B>, and the
134 <B>knfs</B> command to associate both tokens with the credential structure
135 identified by machine name <B>nfs-cli1</B> and user ID
136 <B>1020</B>. She breaks the connection to <B>tx4</B> and works
137 on <B>nfscli1</B>.
138 <PRE>   % <B>telnet tx4.abc.com</B>
139    . . .
140    login: <B>smith</B>
141    Password:
142    AFS(R) login
143    
144    % <B>klog admin -cell test.abc.com</B>
145    Password:
146    
147    % <B>knfs nfscli1.abc.com 1020</B>
148    
149    % <B>exit</B>
150    
151 </PRE>
152 <P>The following example shows user <B>smith</B> again connecting to the
153 machine <B>tx4</B> via the <B>telnet</B> program and discarding the
154 tokens.
155 <PRE>   % <B>telnet translator4.abc.com</B>
156    . . .
157    login: <B>smith</B>
158    Password:
159    AFS(R) login
160    
161    % <B>knfs nfscli1.abc.com 1020 -unlog</B>
162  
163    % <B>exit</B>
164 </PRE>
165 <P><STRONG>Privilege Required</STRONG>
166 <P>None
167 <P><STRONG>Related Information</STRONG>
168 <P><A HREF="auarf200.htm#HDRKLOG">klog</A>
169 <P><A HREF="auarf208.htm#HDRPAGSH">pagsh</A>
170 <P>
171 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf200.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf202.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
172 <!-- Begin Footer Records  ========================================== -->
173 <P><HR><B> 
174 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
175 </B> 
176 <!-- End Footer Records  ============================================ -->
177 <A NAME="Bot_Of_Page"></A>
178 </BODY></HTML>