ad2a14da875a95bf4a16b509d8384fec21d5d0d5
[nfs-utils.git] / utils / mount / nfs.man
1 .\"@(#)nfs.5"
2 .TH NFS 5 "2 November 2007"
3 .SH NAME
4 nfs \- fstab format and options for the
5 .B nfs
6 and
7 .B nfs4
8 file systems
9 .SH SYNOPSIS
10 .I /etc/fstab
11 .SH DESCRIPTION
12 NFS is an Internet Standard protocol
13 created by Sun Microsystems in 1984. NFS was developed
14 to allow file sharing between systems residing
15 on a local area network.
16 The Linux NFS client supports three versions
17 of the NFS protocol:
18 NFS version 2 [RFC1094],
19 NFS version 3 [RFC1813],
20 and NFS version 4 [RFC3530].
21 .P
22 The
23 .BR mount (8)
24 command attaches a file system to the system's
25 name space hierarchy at a given mount point.
26 The
27 .I /etc/fstab
28 file describes how
29 .BR mount (8)
30 should assemble a system's file name hierarchy
31 from various independent file systems 
32 (including file systems exported by NFS servers).
33 Each line in the
34 .I /etc/fstab
35 file describes a single file system, its mount point,
36 and a set of default mount options for that mount point.
37 .P
38 For NFS file system mounts, a line in the
39 .I /etc/fstab
40 file specifies the server name,
41 the path name of the exported server directory to mount,
42 the local directory that is the mount point,
43 the type of file system that is being mounted,
44 and a list of mount options that control
45 the way the filesystem is mounted and
46 how the NFS client behaves when accessing
47 files on this mount point.
48 The fifth and sixth fields on each line are not used
49 by NFS, thus conventionally each contain the digit zero. For example:
50 .P
51 .SP
52 .NF
53 .TA 2.5i +0.75i +0.75i +1.0i
54         server:path     /mountpoint     fstype  option,option,...       0 0
55 .FI
56 .P
57 The server's hostname and export pathname
58 are separated by a colon, while
59 the mount options are separated by commas. The remaining fields 
60 are separated by blanks or tabs.
61 The server's hostname can be an unqualified hostname,
62 a fully qualified domain name,
63 or a dotted quad IPv4 address.
64 The
65 .I fstype
66 field contains either "nfs" (for version 2 or version 3 NFS mounts)
67 or "nfs4" (for NFS version 4 mounts).
68 The
69 .B nfs
70 and
71 .B nfs4
72 file system types share similar mount options,
73 which are described below. 
74 .SH "MOUNT OPTIONS"
75 Refer to 
76 .BR mount (8)
77 for a description of generic mount options
78 available for all file systems. If you do not need to 
79 specify any mount options, use the generic option 
80 .B defaults
81 in
82 .IR /etc/fstab .
83
84 .DT
85 .SS "Valid options for either the nfs or nfs4 file system type"
86 These options are valid to use when mounting either
87 .B nfs
88 or
89 .B nfs4
90 file system types.
91 They imply the same behavior
92 and have the same default for both file system types.
93 .TP 1.5i
94 .BR soft " / " hard
95 Determines the recovery behavior of the NFS client
96 after an NFS request times out.
97 If neither option is specified (or if the
98 .B hard
99 option is specified), NFS requests are retried indefinitely.
100 If the
101 .B soft
102 option is specified, then the NFS client fails an NFS request
103 after 
104 .B retrans
105 retransmissions have been sent,
106 causing the NFS client to return an error
107 to the calling application.
108 .IP
109 .I NB:
110 A so-called "soft" timeout can cause
111 silent data corruption in certain cases. As such, use the
112 .B soft
113 option only when client responsiveness
114 is more important than data integrity.
115 Using NFS over TCP or increasing the value of the
116 .B retrans
117 option may mitigate some of the risks of using the
118 .B soft
119 option.
120 .TP 1.5i
121 .BI timeo= n
122 The time (in tenths of a second) the NFS client waits for a 
123 response before it retries an NFS request. If this 
124 option is not specified, requests are retried every
125 60 seconds for NFS over TCP.
126 The NFS client does not perform any kind of timeout backoff
127 for NFS over TCP.
128 .IP
129 However, for NFS over UDP, the client uses an adaptive
130 algorithm to estimate an appropriate timeout value for frequently used
131 request types (such as READ and WRITE requests), but uses the 
132 .B timeo
133 setting for infrequently used request types (such as FSINFO requests).
134 If the
135 .B timeo
136 option is not specified,
137 infrequently used request types are retried after 1.1 seconds.
138 After each retransmission, the NFS client doubles the timeout for
139 that request,
140 up to a maximum timeout length of 60 seconds.
141 .TP 1.5i
142 .BI retrans= n
143 The number of times the NFS client retries a request before
144 it attempts further recovery action. If the 
145 .B retrans
146 option is not specified, the NFS client tries each request 
147 three times.
148 .IP
149 The NFS client generates a "server not responding" message
150 after 
151 .B retrans
152 retries, then attempts further recovery (depending on whether the
153 .B hard
154 mount option is in effect).
155 .TP 1.5i
156 .BI rsize= n
157 The maximum number of bytes in each network READ request
158 that the NFS client can receive when reading data from a file
159 on an NFS server.
160 The actual data payload size of each NFS READ request is equal to
161 or smaller than the
162 .B rsize
163 setting. The largest read payload supported by the Linux NFS client
164 is 1,048,576 bytes (one megabyte).
165 .IP
166 The
167 .B rsize
168 value is a positive integral multiple of 1024.
169 Specified 
170 .B rsize
171 values lower than 1024 are replaced with 4096; values larger than
172 1048576 are replaced with 1048576. If a specified value is within the supported
173 range but not a multiple of 1024, it is rounded down to the nearest 
174 multiple of 1024.
175 .IP
176 If an
177 .B rsize
178 value is not specified, or if the specified 
179 .B rsize 
180 value is larger than the maximum that either client or server can support,
181 the client and server negotiate the largest
182 .B rsize
183 value that they can both support. 
184 .IP
185 The
186 .B rsize
187 mount option as specified on the
188 .BR mount (8)
189 command line appears in the
190 .I /etc/mtab
191 file. However, the effective
192 .B rsize
193 value negotiated by the client and server is reported in the
194 .I /proc/mounts
195 file.
196 .TP 1.5i
197 .BI wsize= n
198 The maximum number of bytes per network WRITE request
199 that the NFS client can send when writing data to a file
200 on an NFS server. The actual data payload size of each 
201 NFS WRITE request is equal to
202 or smaller than the
203 .B wsize
204 setting. The largest write payload supported by the Linux NFS client
205 is 1,048,576 bytes (one megabyte).
206 .IP
207 Similar to
208 .B rsize
209 , the
210 .B wsize 
211 value is a positive integral multiple of 1024.
212 Specified 
213 .B wsize
214 values lower than 1024 are replaced with 4096; values larger than
215 1048576 are replaced with 1048576. If a specified value is within the supported
216 range but not a multiple of 1024, it is rounded down to the nearest 
217 multiple of 1024.
218 .IP
219 If a
220 .B wsize
221 value is not specified, or if the specified 
222 .B wsize 
223 value is larger than the maximum that either client or server can support,
224 the client and server negotiate the largest
225 .B wsize
226 value that they can both support.
227 .IP
228 The
229 .B wsize
230 mount option as specified on the
231 .BR mount (8)
232 command line appears in the
233 .I /etc/mtab
234 file. However, the effective
235 .B wsize
236 value negotiated by the client and server is reported in the
237 .I /proc/mounts
238 file. 
239 .TP 1.5i
240 .BR ac " / " noac
241 Selects whether the client may cache file attributes. If neither  
242 option is specified (or if 
243 .B ac
244 is specified), the client caches file  
245 attributes.  
246 .IP
247 To improve performance, NFS clients cache file  
248 attributes. Every few seconds, an NFS client checks the server's version of each  
249 file's attributes for updates.  Changes that occur on the server in  
250 those small intervals remain undetected until the client checks the  
251 server again. The 
252 .B noac
253 option prevents clients from caching file  
254 attributes so that applications can more quickly detect file changes  
255 on the server.
256 .IP
257 In addition to preventing the client from caching file attributes,  
258 the 
259 .B noac
260 option forces application writes to become synchronous so  
261 that local changes to a file become visible on the server  
262 immediately.  That way, other clients can quickly detect recent  
263 writes when they check the file's attributes.
264 .IP
265 Using the
266 .B noac
267 option provides greater cache coherence among NFS clients
268 accessing the same files,
269 but it extracts a significant performance penalty.
270 As such, judicious use of file locking is encouraged instead.
271 The DATA AND METADATA COHERENCE section contains a detailed discussion
272 of these trade-offs.
273 .TP 1.5i
274 .BI acregmin= n
275 The minimum time (in seconds) that the NFS client caches
276 attributes of a regular file before it requests
277 fresh attribute information from a server.
278 If this option is not specified, the NFS client uses
279 a 3-second minimum.
280 .TP 1.5i
281 .BI acregmax= n
282 The maximum time (in seconds) that the NFS client caches
283 attributes of a regular file before it requests
284 fresh attribute information from a server.
285 If this option is not specified, the NFS client uses
286 a 60-second maximum.
287 .TP 1.5i
288 .BI acdirmin= n
289 The minimum time (in seconds) that the NFS client caches
290 attributes of a directory before it requests
291 fresh attribute information from a server.
292 If this option is not specified, the NFS client uses
293 a 30-second minimum.
294 .TP 1.5i
295 .BI acdirmax= n
296 The maximum time (in seconds) that the NFS client caches
297 attributes of a directory before it requests
298 fresh attribute information from a server.
299 If this option is not specified, the NFS client uses
300 a 60-second maximum.
301 .TP 1.5i
302 .BI actimeo= n
303 Using
304 .B actimeo
305 sets all of
306 .BR acregmin ,
307 .BR acregmax ,
308 .BR acdirmin ,
309 and
310 .B acdirmax
311 to the same value.
312 If this option is not specified, the NFS client uses
313 the defaults for each of these options listed above.
314 .TP 1.5i
315 .BR bg " / " fg
316 Determines how the
317 .BR mount (8)
318 command behaves if an attempt to mount an export fails.
319 The
320 .B fg
321 option causes
322 .BR mount (8)
323 to exit with an error status if any part of the mount request
324 times out or fails outright.
325 This is called a "foreground" mount,
326 and is the default behavior if neither the
327 .B fg
328 nor
329 .B bg
330 mount option is specified.
331 .IP
332 If the
333 .B bg
334 option is specified, a timeout or failure causes the
335 .BR mount (8)
336 command to fork a child which continues to attempt
337 to mount the export.
338 The parent immediately returns with a zero exit code.
339 This is known as a "background" mount.
340 .IP
341 If the local mount point directory is missing, the
342 .BR mount (8)
343 command acts as if the mount request timed out.
344 This permits nested NFS mounts specified in
345 .I /etc/fstab
346 to proceed in any order during system initialization,
347 even if some NFS servers are not yet available.
348 Alternatively these issues can be addressed
349 using an automounter (refer to
350 .BR automount (8)
351 for details).
352 .TP 1.5i
353 .BI retry= n
354 The number of minutes that the
355 .BR mount (8)
356 command retries an NFS mount operation
357 in the foreground or background before giving up.
358 If this option is not specified, the default value for foreground mounts
359 is 2 minutes, and the default value for background mounts is 10000 minutes (80 minutes shy of one week).
360 .TP 1.5i
361 .BI sec= mode
362 The RPCGSS security flavor to use for accessing files on this mount point.
363 If the
364 .B sec
365 option is not specified, or if
366 .B sec=sys
367 is specified, the NFS client uses the AUTH_SYS security flavor
368 for all NFS requests on this mount point.
369 Valid security flavors are
370 .BR none ,
371 .BR sys ,
372 .BR krb5 ,
373 .BR krb5i ,
374 .BR krb5p ,
375 .BR lkey ,
376 .BR lkeyi ,
377 .BR lkeyp ,
378 .BR spkm ,
379 .BR spkmi ,
380 and
381 .BR spkmp .
382 Refer to the SECURITY CONSIDERATIONS section for details.
383 .TP 1.5i
384 .BR sharecache " / " nosharecache
385 Determines how the client's data cache and attribute cache are shared
386 when mounting the same export more than once concurrently.  Using the  
387 same cache reduces memory requirements on the client and presents  
388 identical file contents to applications when the same remote file is  
389 accessed via different mount points.
390 .IP
391 If neither option is specified, or if the 
392 .B sharecache
393 option is  
394 specified, then a single cache is used for all mount points that  
395 access the same export.  If the 
396 .B nosharecache
397 option is specified,  
398 then that mount point gets a unique cache.  Note that when data and  
399 attribute caches are shared, the mount options from the first mount  
400 point take effect for subsequent concurrent mounts of the same export.
401 .IP
402 As of kernel 2.6.18, the behavior specified by
403 .B nosharecache
404 is legacy caching behavior. This
405 is considered a data risk since multiple cached copies
406 of the same file on the same client can become out of sync
407 following a local update of one of the copies.
408 .TP 1.5i
409 .BR resvport " / " noresvport
410 Specifies whether the NFS client should use a privileged source port
411 when communicating with an NFS server for this mount point.
412 If this option is not specified, or the
413 .B resvport
414 option is specified, the NFS client uses a privileged source port.
415 If the
416 .B noresvport
417 option is specified, the NFS client uses a non-privileged source port.
418 This option is supported in kernels 2.6.28 and later.
419 .IP
420 Using non-privileged source ports helps increase the maximum number of
421 NFS mount points allowed on a client, but NFS servers must be configured
422 to allow clients to connect via non-privileged source ports.
423 .IP
424 Refer to the SECURITY CONSIDERATIONS section for important details.
425 .SS "Valid options for the nfs file system type"
426 Use these options, along with the options in the above subsection,
427 for mounting the
428 .B nfs
429 file system type.
430 .TP 1.5i
431 .BI proto= transport
432 The transport the NFS client uses
433 to transmit requests to the NFS server for this mount point.
434 .I transport
435 can be either
436 .B udp
437 or
438 .BR tcp .
439 Each transport uses different default
440 .B retrans
441 and
442 .B timeo
443 settings; refer to the description of these two mount options for details.
444 .IP
445 In addition to controlling how the NFS client transmits requests to
446 the server, this mount option also controls how the
447 .BR mount (8)
448 command communicates with the server's rpcbind and mountd services.
449 Specifying 
450 .B proto=tcp
451 forces all traffic from the 
452 .BR mount (8)
453 command and the NFS client to use TCP.
454 Specifying
455 .B proto=udp
456 forces all traffic types to use UDP.
457 .IP
458 If the
459 .B proto
460 mount option is not specified, the
461 .BR mount (8)
462 command discovers which protocols the server supports
463 and chooses an appropriate transport for each service.
464 Refer to the TRANSPORT METHODS section for more details.
465 .TP 1.5i
466 .B udp
467 The
468 .B udp
469 option is an alternative to specifying
470 .BR proto=udp.
471 It is included for compatibility with other operating systems.
472 .TP 1.5i
473 .B tcp
474 The
475 .B tcp
476 option is an alternative to specifying
477 .BR proto=tcp.
478 It is included for compatibility with other operating systems.
479 .TP 1.5i
480 .BI port= n
481 The numeric value of the server's NFS service port.
482 If the server's NFS service is not available on the specified port,
483 the mount request fails.
484 .IP
485 If this option is not specified, or if the specified port value is 0,
486 then the NFS client uses the NFS service port number
487 advertised by the server's rpcbind service.
488 The mount request fails if the server's rpcbind service is not available,
489 the server's NFS service is not registered with its rpcbind service,
490 or the server's NFS service is not available on the advertised port.
491 .TP 1.5i
492 .BI mountport= n
493 The numeric value of the server's mountd port.
494 If the server's mountd service is not available on the specified port,
495 the mount request fails.
496 .IP
497 If this option is not specified,
498 or if the specified port value is 0, then the
499 .BR mount (8)
500 command uses the mountd service port number
501 advertised by the server's rpcbind service.
502 The mount request fails if the server's rpcbind service is not available,
503 the server's mountd service is not registered with its rpcbind service,
504 or the server's mountd service is not available on the advertised port.
505 .IP
506 This option can be used when mounting an NFS server
507 through a firewall that blocks the rpcbind protocol.
508 .TP 1.5i
509 .BI mountproto= transport
510 The transport the NFS client uses
511 to transmit requests to the NFS server's mountd service when performing
512 this mount request, and when later unmounting this mount point.
513 .I transport
514 can be either
515 .B udp
516 or
517 .BR tcp .
518 .IP
519 This option can be used when mounting an NFS server
520 through a firewall that blocks a particular transport.
521 When used in combination with the
522 .B proto
523 option, different transports for mountd requests and NFS requests
524 can be specified.
525 If the server's mountd service is not available via the specified
526 transport, the mount request fails.
527 Refer to the TRANSPORT METHODS section for more on how the
528 .B mountproto
529 mount option interacts with the
530 .B proto
531 mount option.
532 .TP 1.5i
533 .BI mounthost= name
534 The hostname of the host running mountd.
535 If this option is not specified, the
536 .BR mount (8)
537 command assumes that the mountd service runs
538 on the same host as the NFS service.
539 .TP 1.5i
540 .BI mountvers= n
541 The RPC version number used to contact the server's mountd.
542 If this option is not specified, the client uses a version number
543 appropriate to the requested NFS version.
544 This option is useful when multiple NFS services
545 are running on the same remote server host.
546 .TP 1.5i
547 .BI namlen= n
548 The maximum length of a pathname component on this mount.
549 If this option is not specified, the maximum length is negotiated
550 with the server. In most cases, this maximum length is 255 characters.
551 .IP
552 Some early versions of NFS did not support this negotiation.
553 Using this option ensures that
554 .BR pathconf (3)
555 reports the proper maximum component length to applications
556 in such cases.
557 .TP 1.5i
558 .BI nfsvers= n
559 The NFS protocol version number used to contact the server's NFS service.
560 The Linux client supports version 2 and version 3 of the NFS protocol
561 when using the file system type
562 .BR nfs .
563 If the server does not support the requested version,
564 the mount request fails.
565 If this option is not specified, the client attempts to use version 3,
566 but negotiates the NFS version with the server if version 3 support
567 is not available.
568 .TP 1.5i
569 .BI vers= n
570 This option is an alternative to the
571 .B nfsvers
572 option.
573 It is included for compatibility with other operating systems.
574 .TP 1.5i
575 .BR lock " / " nolock
576 Selects whether to use the NLM sideband protocol to lock files on the server.
577 If neither option is specified (or if 
578 .B lock 
579 is specified), NLM locking is used for this mount point. 
580 When using the
581 .B nolock
582 option, applications can lock files,
583 but such locks provide exclusion only against other applications
584 running on the same client.
585 Remote applications are not affected by these locks.
586 .IP
587 NLM locking must be disabled with the
588 .B nolock
589 option when using NFS to mount
590 .I /var
591 because
592 .I /var
593 contains files used by the NLM implementation on Linux.
594 Using the
595 .B nolock
596 option is also required when mounting exports on NFS servers
597 that do not support the NLM protocol.
598 .TP 1.5i
599 .BR intr " / " nointr
600 Selects whether to allow signals to interrupt file operations
601 on this mount point. If neither option 
602 is specified (or if 
603 .B nointr
604 is specified),
605 signals do not interrupt NFS file operations. If
606 .B intr 
607 is specified, system calls return EINTR if an in-progress NFS operation is interrupted by 
608 a signal.
609 .IP
610 Using the
611 .B intr
612 option is preferred to using the
613 .B soft
614 option because it is significantly less likely to result in data corruption.
615 .TP 1.5i
616 .BR cto " / " nocto
617 Selects whether to use close-to-open cache coherence semantics.
618 If neither option is specified (or if 
619 .B cto
620 is specified), the client uses close-to-open
621 cache coherence semantics. If the 
622 .B nocto 
623 option is specified, the client uses a non-standard heuristic to determine when
624 files on the server have changed. 
625 .IP
626 Using the
627 .B nocto
628 option may improve performance for read-only mounts,
629 but should be used only if the data on the server changes only occasionally.
630 The DATA AND METADATA COHERENCE section discusses the behavior
631 of this option in more detail.
632 .TP 1.5i
633 .BR acl " / " noacl
634 Selects whether to use the NFSACL sideband protocol on this mount point.
635 The NFSACL sideband protocol is a proprietary protocol
636 implemented in Solaris that manages Access Control Lists. NFSACL was never 
637 made a standard part of the NFS protocol specification.
638 .IP
639 If neither 
640 .B acl
641 nor 
642 .B noacl 
643 option is specified,
644 the NFS client negotiates with the server
645 to see if the NFSACL protocol is supported,
646 and uses it if the server supports it.
647 Disabling the NFSACL sideband protocol may be necessary
648 if the negotiation causes problems on the client or server.
649 Refer to the SECURITY CONSIDERATIONS section for more details.
650 .TP 1.5i
651 .BR rdirplus " / " nordirplus
652 Selects whether to use NFS version 3 READDIRPLUS requests.
653 If this option is not specified, the NFS client uses READDIRPLUS requests
654 on NFS version 3 mounts to read small directories.
655 Some applications perform better if the client uses only READDIR requests
656 for all directories.  
657 .SS "Valid options for the nfs4 file system type"
658 Use these options, along with the options in the first subsection above,
659 for mounting the
660 .B nfs4
661 file system type.
662 .TP 1.5i
663 .BI proto= transport
664 The transport the NFS client uses
665 to transmit requests to the NFS server for this mount point.
666 .I transport
667 can be either
668 .B udp
669 or
670 .BR tcp .
671 All NFS version 4 servers are required to support TCP,
672 so if this mount option is not specified, the NFS version 4 client 
673 uses the TCP transport protocol. 
674 Refer to the TRANSPORT METHODS section for more details.
675 .TP 1.5i
676 .BI port= n
677 The numeric value of the server's NFS service port.
678 If the server's NFS service is not available on the specified port,
679 the mount request fails.
680 .IP
681 If this mount option is not specified,
682 the NFS client uses the standard NFS port number of 2049
683 without first checking the server's rpcbind service.
684 This allows an NFS version 4 client to contact an NFS version 4
685 server through a firewall that may block rpcbind requests.
686 .IP
687 If the specified port value is 0,
688 then the NFS client uses the NFS service port number
689 advertised by the server's rpcbind service.
690 The mount request fails if the server's rpcbind service is not available,
691 the server's NFS service is not registered with its rpcbind service,
692 or the server's NFS service is not available on the advertised port.
693 .TP 1.5i
694 .BR intr " / " nointr
695 Selects whether to allow signals to interrupt file operations
696 on this mount point. If neither option is specified (or if 
697 .B intr 
698 is specified), system calls return EINTR if an in-progress NFS operation  
699 is interrupted by a signal.  If 
700 .B nointr
701 is specified, signals do not  
702 interrupt NFS operations.
703 .IP
704 Using the
705 .B intr
706 option is preferred to using the
707 .B soft
708 option because it is significantly less likely to result in data corruption.
709 .TP 1.5i
710 .BR cto " / " nocto
711 Selects whether to use close-to-open cache coherence semantics
712 for NFS directories on this mount point.
713 If neither
714 .B cto
715 nor
716 .B nocto 
717 is specified,
718 the default is to use close-to-open cache coherence
719 semantics for directories.
720 .IP
721 File data caching behavior is not affected by this option.
722 The DATA AND METADATA COHERENCE section discusses
723 the behavior of this option in more detail.
724 .TP 1.5i
725 .BI clientaddr= n.n.n.n
726 Specifies  a  single  IPv4  address  (in dotted-quad form) 
727 that the NFS client advertises to allow servers 
728 to perform NFS version 4 callback requests against 
729 files on this mount point. If  the  server is unable to 
730 establish callback connections to clients, performance 
731 may degrade, or accesses to files may temporarily hang.
732 .IP
733 If this option is not specified, the
734 .BR mount (8)
735 command attempts to discover an appropriate callback address automatically.
736 The automatic discovery process is not perfect, however.
737 In the presence of multiple client network interfaces,
738 special routing policies,
739 or atypical network topologies,
740 the exact address to use for callbacks may be nontrivial to determine. 
741 .SH EXAMPLES
742 To mount an export using NFS version 2,
743 use the
744 .B nfs
745 file system type and specify the
746 .B nfsvers=2
747 mount option.
748 To mount using NFS version 3,
749 use the
750 .B nfs
751 file system type and specify the
752 .B nfsvers=3
753 mount option.
754 To mount using NFS version 4,
755 use the
756 .B nfs4
757 file system type.
758 The
759 .B nfsvers
760 mount option is not supported for the
761 .B nfs4
762 file system type.
763 .P
764 The following example from an
765 .I /etc/fstab
766 file causes the mount command to negotiate
767 reasonable defaults for NFS behavior.
768 .P
769 .NF
770 .TA 2.5i +0.7i +0.7i +.7i
771         server:/export  /mnt    nfs     defaults        0 0
772 .FI
773 .P
774 Here is an example from an /etc/fstab file for an NFS version 2 mount over UDP.
775 .P
776 .NF
777 .TA 2.5i +0.7i +0.7i +.7i
778         server:/export  /mnt    nfs     nfsvers=2,proto=udp     0 0
779 .FI
780 .P
781 Try this example to mount using NFS version 4 over TCP
782 with Kerberos 5 mutual authentication.
783 .P
784 .NF
785 .TA 2.5i +0.7i +0.7i +.7i
786         server:/export  /mnt    nfs4    sec=krb5        0 0
787 .FI
788 .P
789 This example can be used to mount /usr over NFS.
790 .P
791 .NF
792 .TA 2.5i +0.7i +0.7i +.7i
793         server:/export  /usr    nfs     ro,nolock,nocto,actimeo=3600    0 0
794 .FI
795 .SH "TRANSPORT METHODS"
796 NFS clients send requests to NFS servers via
797 Remote Procedure Calls, or
798 .IR RPCs .
799 The RPC client discovers remote service endpoints automatically,
800 handles per-request authentication,
801 adjusts request parameters for different byte endianness on client and server,
802 and retransmits requests that may have been lost by the network or server.
803 RPC requests and replies flow over a network transport.
804 .P
805 In most cases, the
806 .BR mount (8)
807 command, NFS client, and NFS server
808 can automatically negotiate proper transport
809 and data transfer size settings for a mount point.
810 In some cases, however, it pays to specify
811 these settings explicitly using mount options.
812 .P
813 Traditionally, NFS clients used the UDP transport exclusively for  
814 transmitting requests to servers.  Though its implementation is  
815 simple, NFS over UDP has many limitations that prevent smooth  
816 operation and good performance in some common deployment  
817 environments.  Even an insignificant packet loss rate results in the  
818 loss of whole NFS requests; as such, retransmit timeouts are usually  
819 in the subsecond range to allow clients to recover quickly from  
820 dropped requests, but this can result in extraneous network traffic  
821 and server load.
822 .P
823 However, UDP can be quite effective in specialized settings where  
824 the network’s MTU is large relative to NFS’s data transfer size (such  
825 as network environments that enable jumbo Ethernet frames).  In such  
826 environments, trimming the 
827 .B rsize 
828 and 
829 .B wsize 
830 settings so that each  
831 NFS read or write request fits in just a few network frames (or even  
832 in  a single  frame) is advised.  This reduces the probability that  
833 the loss of a single MTU-sized network frame results in the loss of  
834 an entire large read or write request.
835 .P
836 TCP is the default transport protocol used for all modern NFS 
837 implementations.  It performs well in almost every conceivable
838 network environment and provides excellent guarantees against data 
839 corruption caused by network unreliability.  TCP is often a  
840 requirement for mounting a server through a network firewall.
841 .P
842 Under normal circumstances, networks drop packets much more
843 frequently than NFS servers drop requests.  As such, an aggressive
844 retransmit timeout  setting for NFS over TCP is unnecessary. Typical
845 timeout settings for NFS over TCP are between one and ten minutes.
846 After  the client exhausts its retransmits (the value of the
847 .B retrans
848 mount option), it assumes a network partition has occurred,
849 and attempts to reconnect to the server on a fresh socket. Since
850 TCP itself makes network data transfer reliable, 
851 .B rsize
852 and 
853 .B wsize
854 can safely be allowed to default to the largest values supported by  
855 both client and server, independent of the network's MTU size.
856 .SS "Using the mountproto mount option"
857 This section applies only to NFS version 2 and version 3 mounts
858 since NFS version 4 does not use a separate protocol for mount
859 requests.
860 .P
861 The Linux NFS client can use a different transport for
862 contacting an NFS server's rpcbind service, its mountd service,
863 its Network Lock Manager (NLM) service, and its NFS service.
864 The exact transports employed by the Linux NFS client for
865 each mount point depends on the settings of the transport
866 mount options, which include
867 .BR proto ,
868 .BR mountproto ,
869 .BR udp ", and " tcp .
870 .P
871 The client sends Network Status Manager (NSM) notifications
872 via UDP no matter what transport options are specified, but
873 listens for server NSM notifications on both UDP and TCP.
874 The NFS Access Control List (NFSACL) protocol shares the same
875 transport as the main NFS service.
876 .P
877 If no transport options are specified, the Linux NFS client
878 uses UDP to contact the server's mountd service, and TCP to
879 contact its NLM and NFS services by default.
880 .P
881 If the server does not support these transports for these services, the
882 .BR mount (8)
883 command attempts to discover what the server supports, and then retries
884 the mount request once using the discovered transports.
885 If the server does not advertise any transport supported by the client
886 or is misconfigured, the mount request fails.
887 If the
888 .B bg
889 option is in effect, the mount command backgrounds itself and continues
890 to attempt the specified mount request.
891 .P
892 When the
893 .B proto
894 option, the
895 .B udp
896 option, or the
897 .B tcp
898 option is specified but the
899 .B mountproto
900 option is not, the specified transport is used to contact
901 both the server's mountd service and for the NLM and NFS services.
902 .P
903 If the
904 .B mountproto
905 option is specified but none of the
906 .BR proto ", " udp " or " tcp
907 options are specified, then the specified transport is used for the
908 initial mountd request, but the mount command attempts to discover
909 what the server supports for the NFS protocol, preferring TCP if
910 both transports are supported.
911 .P
912 If both the
913 .BR mountproto " and " proto
914 (or
915 .BR udp " or " tcp )
916 options are specified, then the transport specified by the
917 .B mountproto
918 option is used for the initial mountd request, and the transport
919 specified by the
920 .B proto
921 option (or the
922 .BR udp " or " tcp " options)"
923 is used for NFS, no matter what order these options appear.
924 No automatic service discovery is performed if these options are
925 specified.
926 .P
927 If any of the
928 .BR proto ", " udp ", " tcp ", "
929 or
930 .B mountproto
931 options are specified more than once on the same mount command line,
932 then the value of the rightmost instance of each of these options
933 takes effect.
934 .SH "DATA AND METADATA COHERENCE"
935 Some modern cluster file systems provide
936 perfect cache coherence among their clients.
937 Perfect cache coherence among disparate NFS clients
938 is expensive to achieve, especially on wide area networks.
939 As such, NFS settles for weaker cache coherence that 
940 satisfies the requirements of most file sharing types. Normally, 
941 file sharing is completely sequential:
942 first client A opens a file, writes something to it, then closes it;
943 then client B opens the same file, and reads the changes.
944 .DT
945 .SS "Close-to-open cache consistency"
946 When an application opens a file stored on an NFS server,
947 the NFS client checks that it still exists on the server
948 and is permitted to the opener by sending a GETATTR or ACCESS request.
949 When the application closes the file,
950 the NFS client writes back any pending changes
951 to the file so that the next opener can view the changes.
952 This also gives the NFS client an opportunity to report
953 any server write errors to the application
954 via the return code from
955 .BR close (2).
956 The behavior of checking at open time and flushing at close time
957 is referred to as close-to-open cache consistency.
958 .SS "Weak cache consistency"
959 There are still opportunities for a client's data cache
960 to contain stale data.
961 The NFS version 3 protocol introduced "weak cache consistency"
962 (also known as WCC) which provides a way of efficiently checking
963 a file's attributes before and after a single request.
964 This allows a client to help identify changes
965 that could have been made by other clients.
966 .P
967 When a client is using many concurrent operations
968 that update the same file at the same time
969 (for example, during asynchronous write behind),
970 it is still difficult to tell whether it was
971 that client's updates or some other client's updates
972 that altered the file.
973 .SS "Attribute caching"
974 Use the 
975 .B noac
976 mount option to achieve attribute cache coherence
977 among multiple clients.
978 Almost every file system operation checks
979 file attribute information.
980 The client keeps this information cached
981 for a period of time to reduce network and server load.
982 When
983 .B noac
984 is in effect, a client's file attribute cache is disabled,
985 so each operation that needs to check a file's attributes
986 is forced to go back to the server.
987 This permits a client to see changes to a file very quickly,
988 at the cost of many extra network operations.
989 .P
990 Be careful not to confuse the
991 .B noac
992 option with "no data caching."
993 The
994 .B noac
995 mount option prevents the client from caching file metadata,
996 but there are still races that may result in data cache incoherence
997 between client and server.
998 .P
999 The NFS protocol is not designed to support
1000 true cluster file system cache coherence
1001 without some type of application serialization.
1002 If absolute cache coherence among clients is required,
1003 applications should use file locking. Alternatively, applications 
1004 can also open their files with the O_DIRECT flag
1005 to disable data caching entirely.
1006 .SS "The sync mount option"
1007 The NFS client treats the
1008 .B sync
1009 mount option differently than some other file systems
1010 (refer to 
1011 .BR mount (8)
1012 for a description of the generic
1013 .B sync
1014 and
1015 .B async
1016 mount options).
1017 If neither
1018 .B sync
1019 nor
1020 .B async
1021 is specified (or if the 
1022 .B async 
1023 option is specified),
1024 the NFS client delays sending application
1025 writes to the server
1026 until any of these events occur: 
1027 .IP
1028 Memory pressure forces reclamation of system memory resources.
1029 .IP
1030 An application flushes file data explicitly with 
1031 .BR sync (2),
1032 .BR msync (2),
1033 or
1034 .BR fsync (3).
1035 .IP
1036 An application closes a file with
1037 .BR close (2).
1038 .IP
1039 The file is locked/unlocked via
1040 .BR fcntl (2).
1041 .P
1042 In other words, under normal circumstances,
1043 data written by an application may not immediately appear
1044 on the server that hosts the file.
1045 .P
1046 If the
1047 .B sync
1048 option is specified on a mount point,
1049 any system call that writes data to files on that mount point
1050 causes that data to be flushed to the server
1051 before the system call returns control to user space.
1052 This provides greater data cache coherence among clients,
1053 but at a significant performance cost.
1054 .P
1055 Applications can use the O_SYNC open flag to force application
1056 writes to individual files to go to the server immediately without
1057 the use of the
1058 .B sync 
1059 mount option.
1060 .SS "Using file locks with NFS"
1061 The Network Lock Manager protocol is a separate sideband protocol
1062 used to manage file locks in NFS version 2 and version 3.
1063 To support lock recovery after a client or server reboot,
1064 a second sideband protocol --
1065 known as the Network Status Manager protocol --
1066 is also required.
1067 In NFS version 4,
1068 file locking is supported directly in the main NFS protocol,
1069 and the NLM and NSM sideband protocols are not used.
1070 .P
1071 In most cases, NLM and NSM services are started automatically,
1072 and no extra configuration is required.
1073 Configure all NFS clients with fully-qualified domain names
1074 to ensure that NFS servers can find clients to notify them of server reboots.
1075 .P
1076 NLM supports advisory file locks only.
1077 To lock NFS files, use
1078 .BR fcntl (2)
1079 with the F_GETLK and F_SETLK commands.
1080 The NFS client converts file locks obtained via
1081 .BR flock (2)
1082 to advisory locks.
1083 .P
1084 When mounting servers that do not support the NLM protocol,
1085 or when mounting an NFS server through a firewall
1086 that blocks the NLM service port,
1087 specify the
1088 .B nolock
1089 mount option. NLM locking must be disabled with the
1090 .B nolock
1091 option when using NFS to mount
1092 .I /var
1093 because 
1094 .I /var 
1095 contains files used by the NLM implementation on Linux.
1096 .P
1097 Specifying the
1098 .B nolock
1099 option may also be advised to improve the performance
1100 of a proprietary application which runs on a single client
1101 and uses file locks extensively. 
1102 .SS "NFS version 4 caching features"
1103 The data and metadata caching behavior of NFS version 4
1104 clients is similar to that of earlier versions.
1105 However, NFS version 4 adds two features that improve
1106 cache behavior:
1107 .I change attributes
1108 and
1109 .IR "file delegation" .
1110 .P
1111 The
1112 .I change attribute
1113 is a new part of NFS file and directory metadata
1114 which tracks data changes.
1115 It replaces the use of a file's modification
1116 and change time stamps
1117 as a way for clients to validate the content
1118 of their caches.
1119 Change attributes are independent of the time stamp
1120 resolution on either the server or client, however.
1121 .P
1122 A
1123 .I file delegation
1124 is a contract between an NFS version 4 client
1125 and server that allows the client to treat a file temporarily
1126 as if no other client is accessing it.
1127 The server promises to notify the client (via a callback request) if another client
1128 attempts to access that file.
1129 Once a file has been delegated to a client, the client can
1130 cache that file's data and metadata aggressively without
1131 contacting the server.
1132 .P
1133 File delegations come in two flavors:
1134 .I read
1135 and
1136 .IR write .
1137 A
1138 .I read
1139 delegation means that the server notifies the client
1140 about any other clients that want to write to the file.
1141 A
1142 .I write
1143 delegation means that the client gets notified about
1144 either read or write accessors.
1145 .P
1146 Servers grant file delegations when a file is opened,
1147 and can recall delegations at any time when another
1148 client wants access to the file that conflicts with
1149 any delegations already granted.
1150 Delegations on directories are not supported.
1151 .P
1152 In order to support delegation callback, the server
1153 checks the network return path to the client during
1154 the client's initial contact with the server.
1155 If contact with the client cannot be established,
1156 the server simply does not grant any delegations to
1157 that client.
1158 .SH "SECURITY CONSIDERATIONS"
1159 NFS servers control access to file data,
1160 but they depend on their RPC implementation
1161 to provide authentication of NFS requests.
1162 Traditional NFS access control mimics
1163 the standard mode bit access control provided in local file systems.
1164 Traditional RPC authentication uses a number
1165 to represent each user
1166 (usually the user's own uid),
1167 a number to represent the user's group (the user's gid),
1168 and a set of up to 16 auxiliary group numbers
1169 to represent other groups of which the user may be a member.
1170 .P
1171 Typically, file data and user ID values appear unencrypted
1172 (i.e. "in the clear") on the network.
1173 Moreover, NFS versions 2 and 3 use
1174 separate sideband protocols for mounting,
1175 locking and unlocking files,
1176 and reporting system status of clients and servers.
1177 These auxiliary protocols use no authentication.
1178 .P
1179 In addition to combining these sideband protocols with the main NFS protocol,
1180 NFS version 4 introduces more advanced forms of access control,
1181 authentication, and in-transit data protection.
1182 The NFS version 4 specification mandates NFSv4 ACLs,
1183 RPCGSS authentication, and RPCGSS security flavors
1184 that provide per-RPC integrity checking and encryption.
1185 Because NFS version 4 combines the  
1186 function of the sideband protocols into the main NFS protocol,
1187 the new security features apply to all NFS version 4 operations
1188 including mounting, file locking, and so on.
1189 RPCGSS authentication can also be used with NFS versions 2 and 3,
1190 but does not protect their sideband protocols.
1191 .P
1192 The
1193 .B sec
1194 mount option specifies the RPCGSS security mode
1195 that is in effect on a given NFS mount point.
1196 Specifying
1197 .B sec=krb5
1198 provides cryptographic proof of a user's identity in each RPC request.
1199 This provides strong verification of the identity of users 
1200 accessing data on the server.
1201 Note that additional configuration besides adding this mount option
1202 is required in order to enable Kerberos security.
1203 Refer to the 
1204 .BR rpc.gssd (8)
1205 man page for details.
1206 .P
1207 Two additional flavors of Kerberos security are supported:
1208 .B krb5i
1209 and
1210 .BR krb5p .
1211 The
1212 .B krb5i
1213 security flavor provides a cryptographically strong guarantee
1214 that the data in each RPC request has not been tampered with.
1215 The
1216 .B krb5p
1217 security flavor encrypts every RPC request
1218 to prevent data exposure during network transit; however,
1219 expect some performance impact
1220 when using integrity checking or encryption.
1221 Similar support for other forms of cryptographic security (such as lipkey and SPKM3)
1222 is also available.
1223 .P
1224 The NFS version 4 protocol allows
1225 clients and servers to negotiate among multiple security flavors
1226 during mount processing.
1227 However, Linux does not yet implement such negotiation.
1228 The Linux client specifies a single security flavor at mount time
1229 which remains in effect for the lifetime of the mount.
1230 If the server does not support this flavor,
1231 the initial mount request is rejected by the server.
1232 .SS "Using non-privileged source ports"
1233 NFS clients usually communicate with NFS servers via network sockets.
1234 Each end of a socket is assigned a port value, which is simply a number
1235 between 1 and 65535 that distinguishes socket endpoints at the same
1236 IP address.
1237 A socket is uniquely defined by a tuple that includes the transport
1238 protocol (TCP or UDP) and the port values and IP addresses of both
1239 endpoints.
1240 .P
1241 The NFS client can choose any source port value for its sockets,
1242 but usually chooses a
1243 .I privileged
1244 port.
1245 A privileged port is a port value less than 1024.
1246 Only a process with root privileges may create a socket
1247 with a privileged source port.
1248 .P
1249 The exact range of privileged source ports that can be chosen is
1250 set by a pair of sysctls to avoid choosing a well-known port, such as
1251 the port used by ssh.
1252 This means the number of source ports available for the NFS client,
1253 and therefore the number of socket connections that can be used
1254 at the same time,
1255 is practically limited to only a few hundred.
1256 .P
1257 As described above, the traditional default NFS authentication scheme,
1258 known as AUTH_SYS, relies on sending local UID and GID numbers to identify
1259 users making NFS requests.
1260 An NFS server assumes that if a connection comes from a privileged port,
1261 the UID and GID numbers in the NFS requests on this connection have been
1262 verified by the client's kernel or some other local authority.
1263 This is an easy system to spoof, but on a trusted physical network between
1264 trusted hosts, it is entirely adequate.
1265 .P
1266 Roughly speaking, one socket is used for each NFS mount point.
1267 If a client could use non-privileged source ports as well,
1268 the number of sockets allowed,
1269 and thus the maximum number of concurrent mount points,
1270 would be much larger.
1271 .P
1272 Using non-privileged source ports may compromise server security somewhat,
1273 since any user on AUTH_SYS mount points can now pretend to be any other
1274 when making NFS requests.
1275 Thus NFS servers do not support this by default.
1276 They explicitly allow it usually via an export option.
1277 .P
1278 To retain good security while allowing as many mount points as possible,
1279 it is best to allow non-privileged client connections only if the server
1280 and client both require strong authentication, such as Kerberos.
1281 .SS "Mounting through a firewall"
1282 A firewall may reside between an NFS client and server,
1283 or the client or server may block some of its own ports via IP
1284 filter rules.
1285 It is still possible to mount an NFS server through a firewall,
1286 though some of the
1287 .BR mount (8)
1288 command's automatic service endpoint discovery mechanisms may not work; this 
1289 requires you to provide specific endpoint details via NFS mount options.
1290 .P
1291 NFS servers normally run a portmapper or rpcbind daemon to advertise
1292 their service endpoints to clients. Clients use the rpcbind daemon to determine: 
1293 .IP
1294 What network port each RPC-based service is using
1295 .IP
1296 What transport protocols each RPC-based service supports 
1297 .P
1298 The rpcbind daemon uses a well-known port number (111) to help clients find a service endpoint.
1299 Although NFS often uses a standard port number (2049),
1300 auxiliary services such as the NLM service can choose
1301 any unused port number at random.
1302 .P
1303 Common firewall configurations block the well-known rpcbind port.
1304 In the absense of an rpcbind service,
1305 the server administrator fixes the port number
1306 of NFS-related services so that the firewall
1307 can allow access to specific NFS service ports.
1308 Client administrators then specify the port number
1309 for the mountd service via the
1310 .BR mount (8)
1311 command's
1312 .B mountport
1313 option.
1314 It may also be necessary to enforce the use of TCP or UDP
1315 if the firewall blocks one of those transports.
1316 .SS "NFS Access Control Lists"
1317 Solaris allows NFS version 3 clients direct access
1318 to POSIX Access Control Lists stored in its local file systems.
1319 This proprietary sideband protocol, known as NFSACL,
1320 provides richer access control than mode bits.
1321 Linux implements this protocol
1322 for compatibility with the Solaris NFS implementation.
1323 The NFSACL protocol never became a standard part
1324 of the NFS version 3 specification, however.
1325 .P
1326 The NFS version 4 specification mandates a new version
1327 of Access Control Lists that are semantically richer than POSIX ACLs.
1328 NFS version 4 ACLs are not fully compatible with POSIX ACLs; as such, 
1329 some translation between the two is required
1330 in an environment that mixes POSIX ACLs and NFS version 4. 
1331 .SH FILES
1332 .TP 1.5i
1333 .I /etc/fstab
1334 file system table
1335 .SH BUGS
1336 The generic
1337 .B remount
1338 option is not fully supported.
1339 Generic options, such as
1340 .BR rw " and " ro
1341 can be modified using the
1342 .B remount
1343 option,
1344 but NFS-specific options are not all supported.
1345 The underlying transport or NFS version
1346 cannot be changed by a remount, for example.
1347 Performing a remount on an NFS file system mounted with the
1348 .B noac
1349 option may have unintended consequences.
1350 The
1351 .B noac
1352 option is a mixture of a generic option,
1353 .BR sync ,
1354 and an NFS-specific option
1355 .BR actimeo=0 .
1356 .P
1357 Before 2.4.7, the Linux NFS client did not support NFS over TCP.
1358 .P
1359 Before 2.4.20, the Linux NFS client used a heuristic
1360 to determine whether cached file data was still valid
1361 rather than using the standard close-to-open cache coherency method
1362 described above.
1363 .P
1364 Starting with 2.4.22, the Linux NFS client employs
1365 a Van Jacobsen-based RTT estimator to determine retransmit
1366 timeout values when using NFS over UDP.
1367 .P
1368 Before 2.6.0, the Linux NFS client did not support NFS version 4.
1369 .P
1370 Before 2.6.8, the Linux NFS client used only synchronous reads and writes
1371 when the
1372 .BR rsize " and " wsize
1373 settings were smaller than the system's page size.
1374 .P
1375 The Linux NFS client does not yet support
1376 certain optional features of the NFS version 4 protocol,
1377 such as security negotiation, server referrals, and named attributes.
1378 .SH "SEE ALSO"
1379 .BR fstab (5),
1380 .BR mount (8),
1381 .BR umount (8),
1382 .BR mount.nfs (5),
1383 .BR umount.nfs (5),
1384 .BR exports (5),
1385 .BR nfsd (8),
1386 .BR sm-notify (8),
1387 .BR rpc.statd (8),
1388 .BR rpc.idmapd (8),
1389 .BR rpc.gssd (8),
1390 .BR rpc.svcgssd (8),
1391 .BR kerberos (1)
1392 .sp
1393 RFC 768 for the UDP specification.
1394 .br
1395 RFC 793 for the TCP specification.
1396 .br
1397 RFC 1094 for the NFS version 2 specification.
1398 .br
1399 RFC 1813 for the NFS version 3 specification.
1400 .br
1401 RFC 1832 for the XDR specification.
1402 .br
1403 RFC 1833 for the RPC bind specification.
1404 .br
1405 RFC 2203 for the RPCSEC GSS API protocol specification.
1406 .br
1407 RFC 3530 for the NFS version 4 specification.