xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / UserGuide / a3632.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Using the NFS/AFS Translator</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
9 REL="HOME"
10 TITLE="AFS User Guide"
11 HREF="book1.html"><LINK
12 REL="PREVIOUS"
13 TITLE="Troubleshooting"
14 HREF="c3402.html"><LINK
15 REL="NEXT"
16 TITLE="AFS Command Syntax and Online Help"
17 HREF="a3812.html"></HEAD
18 ><BODY
19 CLASS="appendix"
20 BGCOLOR="#FFFFFF"
21 TEXT="#000000"
22 LINK="#0000FF"
23 VLINK="#840084"
24 ALINK="#0000FF"
25 ><DIV
26 CLASS="NAVHEADER"
27 ><TABLE
28 SUMMARY="Header navigation table"
29 WIDTH="100%"
30 BORDER="0"
31 CELLPADDING="0"
32 CELLSPACING="0"
33 ><TR
34 ><TH
35 COLSPAN="3"
36 ALIGN="center"
37 >AFS User Guide: Version 3.6</TH
38 ></TR
39 ><TR
40 ><TD
41 WIDTH="10%"
42 ALIGN="left"
43 VALIGN="bottom"
44 ><A
45 HREF="c3402.html"
46 ACCESSKEY="P"
47 >Prev</A
48 ></TD
49 ><TD
50 WIDTH="80%"
51 ALIGN="center"
52 VALIGN="bottom"
53 ></TD
54 ><TD
55 WIDTH="10%"
56 ALIGN="right"
57 VALIGN="bottom"
58 ><A
59 HREF="a3812.html"
60 ACCESSKEY="N"
61 >Next</A
62 ></TD
63 ></TR
64 ></TABLE
65 ><HR
66 ALIGN="LEFT"
67 WIDTH="100%"></DIV
68 ><DIV
69 CLASS="appendix"
70 ><H1
71 ><A
72 NAME="HDRWQ80"
73 ></A
74 >Appendix A. Using the NFS/AFS Translator</H1
75 ><P
76 >&#13;
77  
78
79  
80
81  
82
83  Some
84     cells use the Network File System (NFS) in addition to AFS. If you work on an NFS client machine, your system
85     administrator can configure it to access the AFS filespace through a program called the <SPAN
86 CLASS="emphasis"
87 ><I
88 CLASS="emphasis"
89 >NFS/AFS
90     Translator</I
91 ></SPAN
92 ><SUP
93 >TM</SUP
94 >. If you have an AFS account, you can access AFS as an
95     authenticated user while working on your NFS client machine. Otherwise, you access AFS as the
96     <SPAN
97 CLASS="bold"
98 ><B
99 CLASS="emphasis"
100 >anonymous</B
101 ></SPAN
102 > user.</P
103 ><DIV
104 CLASS="note"
105 ><BLOCKQUOTE
106 CLASS="note"
107 ><P
108 ><B
109 >Note: </B
110 >Acceptable NFS/AFS Translator performance requires that NFS is functioning correctly.</P
111 ></BLOCKQUOTE
112 ></DIV
113 ><DIV
114 CLASS="sect1"
115 ><H1
116 CLASS="sect1"
117 ><A
118 NAME="HDRWQ81"
119 >Requirements for Using the NFS/AFS Translator</A
120 ></H1
121 ><P
122 >&#13;
123  
124
125  For you to use the NFS/AFS Translator, your system
126     administrator must configure the following types of machines as indicated:</P
127 ><UL
128 ><LI
129 ><P
130 >An <SPAN
131 CLASS="emphasis"
132 ><I
133 CLASS="emphasis"
134 >NFS/AFS translator machine</I
135 ></SPAN
136 > is an AFS client machine that also acts as an
137       NFS server machine. Its Cache Manager acts as the surrogate Cache Manager for your NFS client machine. Ask your
138       system administrator which translator machines you can use.</P
139 ></LI
140 ><LI
141 ><P
142 >Your NFS client machine must have an NFS mount to a translator machine. Most often, your system
143       administrator mounts the translator machine's <SPAN
144 CLASS="bold"
145 ><B
146 CLASS="emphasis"
147 >/afs</B
148 ></SPAN
149 > directory and names the mount
150       <SPAN
151 CLASS="bold"
152 ><B
153 CLASS="emphasis"
154 >/afs</B
155 ></SPAN
156 > as well. This enables you to access the entire AFS filespace using standard
157       AFS pathnames. It is also possible to create mounts directly to subdirectories of
158       <SPAN
159 CLASS="bold"
160 ><B
161 CLASS="emphasis"
162 >/afs</B
163 ></SPAN
164 >, and to give NFS mounts different names on the NFS client
165       machine.</P
166 ></LI
167 ></UL
168 ><P
169 >Your access to AFS is much more extensive if you have an AFS user account. If you do not, the AFS servers
170     recognize you as the <SPAN
171 CLASS="bold"
172 ><B
173 CLASS="emphasis"
174 >anonymous</B
175 ></SPAN
176 > user and only grant you the access available to
177     members of the <SPAN
178 CLASS="bold"
179 ><B
180 CLASS="emphasis"
181 >system:anyuser</B
182 ></SPAN
183 > group.</P
184 ><P
185 >If your NFS client machine uses an operating system that AFS supports, your system administrator can
186     configure it to enable you to issue many AFS commands on the machine. Ask him or her about the configuration and
187     which commands you can issue.</P
188 ></DIV
189 ><DIV
190 CLASS="sect1"
191 ><H1
192 CLASS="sect1"
193 ><A
194 NAME="Header_160"
195 >Accessing AFS via the Translator</A
196 ></H1
197 ><P
198 >If you do not have an AFS account or choose not to access AFS as an authenticated user, then all you do to
199     access AFS is provide the pathname of the relevant file. Its ACL must grant the necessary permissions to the
200     <SPAN
201 CLASS="bold"
202 ><B
203 CLASS="emphasis"
204 >system:anyuser</B
205 ></SPAN
206 > group.</P
207 ><P
208 >If you have an AFS account and want to access AFS as an authenticated user, the best method depends on
209     whether your NFS machine is a supported type. If it is, use the instructions in <A
210 HREF="a3632.html#HDRWQ82"
211 >To
212     Authenticate on a Supported Operating System</A
213 >. If it is not a supported type, use the instructions in
214     <A
215 HREF="a3632.html#HDRWQ83"
216 >To Authenticate on an Unsupported Operating System</A
217 >.</P
218 ><DIV
219 CLASS="sect2"
220 ><H2
221 CLASS="sect2"
222 ><A
223 NAME="HDRWQ82"
224 >To Authenticate on a Supported Operating System</A
225 ></H2
226 ><OL
227 TYPE="1"
228 ><LI
229 ><P
230 >Log into the NFS client machine using your NFS username.</P
231 ></LI
232 ><LI
233 ><P
234 >&#13;        Issue the <SPAN
235 CLASS="bold"
236 ><B
237 CLASS="emphasis"
238 >klog</B
239 ></SPAN
240 > command. For complete instructions, see
241         <A
242 HREF="c569.html#HDRWQ29"
243 >To Authenticate with AFS</A
244 >. 
245 <PRE
246 CLASS="programlisting"
247 >&#13;   % <SPAN
248 CLASS="bold"
249 ><B
250 CLASS="emphasis"
251 >klog -setpag</B
252 ></SPAN
253 >
254 </PRE
255 >
256       </P
257 ></LI
258 ></OL
259 ></DIV
260 ><DIV
261 CLASS="sect2"
262 ><H2
263 CLASS="sect2"
264 ><A
265 NAME="HDRWQ83"
266 >To Authenticate on an Unsupported Operating System</A
267 ></H2
268 ><OL
269 TYPE="1"
270 ><LI
271 ><P
272 >Log onto the NFS client machine using your NFS username.</P
273 ></LI
274 ><LI
275 ><P
276 ><A
277 NAME="LINFS-TELNET"
278 ></A
279 >Establish a connection to the NFS/AFS translator machine you are
280       using (for example, using the <SPAN
281 CLASS="bold"
282 ><B
283 CLASS="emphasis"
284 >telnet</B
285 ></SPAN
286 > utility) and log onto it using your AFS
287       username (which is normally the same as your NFS username).</P
288 ></LI
289 ><LI
290 ><P
291 >&#13;        If the NFS/AFS translator machine uses an AFS-modified login utility, then you obtained AFS tokens in Step
292         <A
293 HREF="a3632.html#LINFS-TELNET"
294 >2</A
295 >. To check, issue the <SPAN
296 CLASS="bold"
297 ><B
298 CLASS="emphasis"
299 >tokens</B
300 ></SPAN
301 > command,
302         which is described fully in <A
303 HREF="c569.html#HDRWQ30"
304 >To Display Your Tokens</A
305 >. 
306 <PRE
307 CLASS="programlisting"
308 >&#13;   % <SPAN
309 CLASS="bold"
310 ><B
311 CLASS="emphasis"
312 >tokens</B
313 ></SPAN
314 >
315 </PRE
316 >
317         If you do not have tokens, issue the <SPAN
318 CLASS="bold"
319 ><B
320 CLASS="emphasis"
321 >klog</B
322 ></SPAN
323 > command, which is described fully in
324         <A
325 HREF="c569.html#HDRWQ29"
326 >To Authenticate with AFS</A
327 >. 
328 <PRE
329 CLASS="programlisting"
330 >&#13;   % <SPAN
331 CLASS="bold"
332 ><B
333 CLASS="emphasis"
334 >klog -setpag</B
335 ></SPAN
336 >
337 </PRE
338 >
339       </P
340 ></LI
341 ><LI
342 ><P
343 >&#13;        <A
344 NAME="LINFS-KNFS"
345 ></A
346 >Issue the <SPAN
347 CLASS="bold"
348 ><B
349 CLASS="emphasis"
350 >knfs</B
351 ></SPAN
352 > command to associate your AFS tokens
353         with your UNIX UID on the NFS client machine where you are working. This enables the Cache Manager on the
354         translator machine to use the tokens properly when you access AFS from the NFS client machine. 
355         </P
356 ><P
357 >If your NFS client machine is a system type for which AFS defines a system name, it can make sense
358         to add the <SPAN
359 CLASS="bold"
360 ><B
361 CLASS="emphasis"
362 >-sysname</B
363 ></SPAN
364 > argument. This argument helps the Cache Manager access
365         binaries specific to your NFS client machine, if your system administrator has used the
366         <SPAN
367 CLASS="emphasis"
368 ><I
369 CLASS="emphasis"
370 >@sys</I
371 ></SPAN
372 > variable in pathnames. Ask your system administrator if this argument is useful for
373         you. 
374
375  
376
377 </P
378 ><PRE
379 CLASS="programlisting"
380 >&#13;   % <SPAN
381 CLASS="bold"
382 ><B
383 CLASS="emphasis"
384 >knfs</B
385 ></SPAN
386 > &#60;<VAR
387 CLASS="replaceable"
388 >host name</VAR
389 >&#62; [&#60;<VAR
390 CLASS="replaceable"
391 >user ID (decimal)</VAR
392 >&#62;]  \
393           [<SPAN
394 CLASS="bold"
395 ><B
396 CLASS="emphasis"
397 >-sysname</B
398 ></SPAN
399 > &#60;<VAR
400 CLASS="replaceable"
401 >host's '@sys' value</VAR
402 >&#62;]
403 </PRE
404 ><P
405 >where</P
406 ><DIV
407 CLASS="variablelist"
408 ><DL
409 ><DT
410 ><SPAN
411 CLASS="bold"
412 ><B
413 CLASS="emphasis"
414 ><VAR
415 CLASS="replaceable"
416 >host name</VAR
417 ></B
418 ></SPAN
419 ></DT
420 ><DD
421 ><P
422 >Specifies the fully-qualified hostname of your NFS client machine (such as
423           <SPAN
424 CLASS="bold"
425 ><B
426 CLASS="emphasis"
427 >nfs52.abc.com</B
428 ></SPAN
429 >).</P
430 ></DD
431 ><DT
432 ><SPAN
433 CLASS="bold"
434 ><B
435 CLASS="emphasis"
436 ><VAR
437 CLASS="replaceable"
438 >user ID</VAR
439 ></B
440 ></SPAN
441 ></DT
442 ><DD
443 ><P
444 >Specifies your UNIX UID or equivalent (not your username) on the NFS client machine. If your
445           system administrator has followed the conventional practice, then your UNIX and AFS UIDs are the same. If you
446           do not know your local UID on the NFS machine, ask your system administrator for assistance. Your system
447           administrator can also explain the issues you need to be aware of if your two UIDs do not match, or if you
448           omit this argument.</P
449 ></DD
450 ><DT
451 ><SPAN
452 CLASS="bold"
453 ><B
454 CLASS="emphasis"
455 >-sysname</B
456 ></SPAN
457 ></DT
458 ><DD
459 ><P
460 >Specifies your NFS client machine's system type name.</P
461 ></DD
462 ></DL
463 ></DIV
464 ></LI
465 ><LI
466 ><P
467 ><A
468 NAME="LINFS-LOGOUT"
469 ></A
470 >(<SPAN
471 CLASS="bold"
472 ><B
473 CLASS="emphasis"
474 >Optional</B
475 ></SPAN
476 >) Log out from the
477       translator machine, but do not unauthenticate.</P
478 ></LI
479 ><LI
480 ><P
481 >Work on the NFS client machine, accessing AFS as necessary.</P
482 ></LI
483 ><LI
484 ><P
485 >&#13;        When you are finished accessing AFS, issue the <SPAN
486 CLASS="bold"
487 ><B
488 CLASS="emphasis"
489 >knfs</B
490 ></SPAN
491 > command on the translator
492         machine again. Provide the same <VAR
493 CLASS="replaceable"
494 >host name</VAR
495 > and <VAR
496 CLASS="replaceable"
497 >user ID</VAR
498 >
499         arguments as in Step <A
500 HREF="a3632.html#LINFS-KNFS"
501 >4</A
502 >, and add the <SPAN
503 CLASS="bold"
504 ><B
505 CLASS="emphasis"
506 >-unlog</B
507 ></SPAN
508 >
509         flag to destroy your tokens. If you logged out from the translator machine in Step
510         <A
511 HREF="a3632.html#LINFS-LOGOUT"
512 >5</A
513 >, then you must first reestablish a connection to the translator machine
514         as in Step <A
515 HREF="a3632.html#LINFS-TELNET"
516 >2</A
517 >. 
518 <PRE
519 CLASS="programlisting"
520 >&#13;   % <SPAN
521 CLASS="bold"
522 ><B
523 CLASS="emphasis"
524 >knfs</B
525 ></SPAN
526 > &#60;<VAR
527 CLASS="replaceable"
528 >host name</VAR
529 >&#62; [&#60;<VAR
530 CLASS="replaceable"
531 >user ID (decimal)</VAR
532 >&#62;] <SPAN
533 CLASS="bold"
534 ><B
535 CLASS="emphasis"
536 >-unlog</B
537 ></SPAN
538 >
539 </PRE
540 >
541       </P
542 ></LI
543 ></OL
544 ></DIV
545 ></DIV
546 ><DIV
547 CLASS="sect1"
548 ><H1
549 CLASS="sect1"
550 ><A
551 NAME="HDRWQ84"
552 >Troubleshooting the NFS/AFS Translator</A
553 ></H1
554 ><P
555 >Acceptable performance by the NFS/AFS translator depends for the most part on NFS. Sometimes, problems that
556     appear to be AFS file server outages, broken connections, or inaccessible files are actually caused by NFS
557     outages.</P
558 ><P
559 >This section describes some common problems and their possible causes. If other problems arise, contact your
560     system administrator, who can ask the AFS Product Support group for assistance if necessary.</P
561 ><DIV
562 CLASS="note"
563 ><BLOCKQUOTE
564 CLASS="note"
565 ><P
566 ><B
567 >Note: </B
568 >To avoid degrading AFS performance, the Cache Manager on the translator machine does not immediately
569         send changes made on NFS client machines to the File Server. Instead, it checks every 60 seconds for such
570         changes and sends them then. It can take longer for changes made on an NFS client machine to be saved than for
571         changes made on an AFS client machine. The save operation must complete before the changes are visible on NFS
572         client machines that are using a different translator machine or on AFS client machines.</P
573 ></BLOCKQUOTE
574 ></DIV
575 ><DIV
576 CLASS="sect2"
577 ><H2
578 CLASS="sect2"
579 ><A
580 NAME="HDRWQ85"
581 >Your NFS Client Machine is Frozen</A
582 ></H2
583 ><P
584 >If your system administrator has used the recommended options when creating an NFS mount to an NFS/AFS
585     translator machine, then the mount is both <SPAN
586 CLASS="emphasis"
587 ><I
588 CLASS="emphasis"
589 >hard</I
590 ></SPAN
591 > and <SPAN
592 CLASS="emphasis"
593 ><I
594 CLASS="emphasis"
595 >interruptible</I
596 ></SPAN
597 >:</P
598 ><UL
599 ><LI
600 ><P
601 >A hard mount means that the NFS client retries its requests if it does not receive a response
602       within the expected time frame. This is useful because requests have to pass through both the NFS and AFS client
603       software, which can sometimes take longer than the NFS client expects. However, it means that if the NFS/AFS
604       translator machine actually becomes inaccessible, your NFS client machine can become inoperative
605       (<SPAN
606 CLASS="emphasis"
607 ><I
608 CLASS="emphasis"
609 >freeze</I
610 ></SPAN
611 > or <SPAN
612 CLASS="emphasis"
613 ><I
614 CLASS="emphasis"
615 >hang</I
616 ></SPAN
617 >).</P
618 ></LI
619 ><LI
620 ><P
621 >If the NFS mount is interruptible, then in the case of an NFS/AFS translator machine outage you
622       can press &#60;<SPAN
623 CLASS="bold"
624 ><B
625 CLASS="emphasis"
626 >Ctrl-c</B
627 ></SPAN
628 >&#62; or another interrupt signal to halt the NFS client's
629       repeated attempts to access AFS. You can then continue to work locally, or can NFS-mount another translator
630       machine. If the NFS mount is not interruptible, you must actually remove the mount to the inaccessible translator
631       machine.</P
632 ></LI
633 ></UL
634 ></DIV
635 ><DIV
636 CLASS="sect2"
637 ><H2
638 CLASS="sect2"
639 ><A
640 NAME="Header_165"
641 >NFS/AFS Translator Reboots</A
642 ></H2
643 ><P
644 >If you have authenticated to AFS and your translator machine reboots, you must issue the
645     <SPAN
646 CLASS="bold"
647 ><B
648 CLASS="emphasis"
649 >klog</B
650 ></SPAN
651 > command (and <SPAN
652 CLASS="bold"
653 ><B
654 CLASS="emphasis"
655 >knfs</B
656 ></SPAN
657 > command, if appropriate)
658     to reauthenticate. If you used the <SPAN
659 CLASS="bold"
660 ><B
661 CLASS="emphasis"
662 >knfs</B
663 ></SPAN
664 > command's
665     <SPAN
666 CLASS="bold"
667 ><B
668 CLASS="emphasis"
669 >-sysname</B
670 ></SPAN
671 > argument to define your NFS client machine's system name, use it
672     again.</P
673 ></DIV
674 ><DIV
675 CLASS="sect2"
676 ><H2
677 CLASS="sect2"
678 ><A
679 NAME="Header_166"
680 >System Error Messages</A
681 ></H2
682 ><P
683 >This section explains possible meanings for NFS error messages you receive while accessing AFS
684     filespace.</P
685 ><P
686 ><SAMP
687 CLASS="computeroutput"
688 >stale NFS client</SAMP
689 ></P
690 ><P
691 ><SAMP
692 CLASS="computeroutput"
693 >Getpwd: can't read</SAMP
694 ></P
695 ><P
696 >Both messages possibly means that your translator machine was rebooted and cannot determine the pathname to
697     the current working directory. To reestablish the path, change directory and specify the complete pathname starting
698     with <SPAN
699 CLASS="bold"
700 ><B
701 CLASS="emphasis"
702 >/afs</B
703 ></SPAN
704 >.</P
705 ><P
706 ><SAMP
707 CLASS="computeroutput"
708 >NFS server <VAR
709 CLASS="replaceable"
710 >translator_machine</VAR
711 > is not responding still
712     trying</SAMP
713 >.</P
714 ><P
715 >The NFS client is not getting a response from the NFS/AFS translator machine. If the NFS mount to the
716     translator machine is a hard mount, your NFS client continues retrying the request until it gets a response (see
717     <A
718 HREF="a3632.html#HDRWQ85"
719 >Your NFS Client Machine is Frozen</A
720 >). If the NFS mount to the translator machine is a
721     soft mount, the NFS client stops retrying after a certain number of attempts (three by default).</P
722 ></DIV
723 ></DIV
724 ></DIV
725 ><DIV
726 CLASS="NAVFOOTER"
727 ><HR
728 ALIGN="LEFT"
729 WIDTH="100%"><TABLE
730 SUMMARY="Footer navigation table"
731 WIDTH="100%"
732 BORDER="0"
733 CELLPADDING="0"
734 CELLSPACING="0"
735 ><TR
736 ><TD
737 WIDTH="33%"
738 ALIGN="left"
739 VALIGN="top"
740 ><A
741 HREF="c3402.html"
742 ACCESSKEY="P"
743 >Prev</A
744 ></TD
745 ><TD
746 WIDTH="34%"
747 ALIGN="center"
748 VALIGN="top"
749 ><A
750 HREF="book1.html"
751 ACCESSKEY="H"
752 >Home</A
753 ></TD
754 ><TD
755 WIDTH="33%"
756 ALIGN="right"
757 VALIGN="top"
758 ><A
759 HREF="a3812.html"
760 ACCESSKEY="N"
761 >Next</A
762 ></TD
763 ></TR
764 ><TR
765 ><TD
766 WIDTH="33%"
767 ALIGN="left"
768 VALIGN="top"
769 >Troubleshooting</TD
770 ><TD
771 WIDTH="34%"
772 ALIGN="center"
773 VALIGN="top"
774 >&nbsp;</TD
775 ><TD
776 WIDTH="33%"
777 ALIGN="right"
778 VALIGN="top"
779 >AFS Command Syntax and Online Help</TD
780 ></TR
781 ></TABLE
782 ></DIV
783 ></BODY
784 ></HTML
785 >