1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)exports.5 8.3 (Berkeley) 3/29/95
36 .Nd define remote mount points for
44 file specifies remote mount points for the
46 mount protocol per the
48 server specification; see
49 .%T "Network File System Protocol Specification" ,
50 RFC1094, Appendix A and
51 .%T "NFS: Network File System Version 3 Specification" ,
55 (other than comment lines that begin with a #)
56 specifies the mount point(s) and export flags within one local server
57 file system or the NFSv4 tree root for one or more hosts.
58 A long line may be split over several lines by ending all but the
59 last line with a backslash
61 A host may be specified only once for each local file or the NFSv4 tree root on the
62 server and there may be only one default entry for each server
63 file system that applies to all other hosts.
64 The latter exports the file system to the
67 be used only when the file system contains public information.
70 the first field(s) specify the directory path(s) within a server file system
71 that can be mounted on by the corresponding client(s).
72 There are three forms of this specification.
73 The first is to list all mount points as absolute
74 directory paths separated by whitespace.
75 This list of directory paths should be considered an
76 .Dq administrative control ,
77 since it is only enforced by the
79 daemon and not the kernel.
80 As such, it only applies to NFSv2 and NFSv3 mounts and only
81 with respect to the client's use of the mount protocol.
82 The second is to specify the pathname of the root of the file system
86 this form allows the host(s) to mount at any point within the file system,
87 including regular files if the
91 Because NFSv4 does not use the mount protocol,
93 .Dq administrative controls
94 are not applied and all directories within this server
95 file system are mountable via NFSv4 even if the
97 flag has not been specified.
98 The third form has the string ``V4:'' followed by a single absolute path
99 name, to specify the NFSv4 tree root.
100 This line does not export any file system, but simply marks where the root
101 of the server's directory tree is for NFSv4 clients.
102 The exported file systems for NFSv4 are specified via the other lines
105 file in the same way as for NFSv2 and NFSv3.
106 The pathnames must not have any symbolic links in them and should not have
112 Mount points for a file system may appear on multiple lines each with
113 different sets of hosts and export options.
115 The second component of a line specifies how the file system is to be
116 exported to the host set.
117 The option flags specify whether the file system
118 is exported read-only or read-write and how the client UID is mapped to
119 user credentials on the server.
120 For the NFSv4 tree root, the only option that can be specified in this
124 Export options are specified as follows:
127 .Fl maproot Li = Sy user
129 The credential of the specified user is used for remote access by root.
130 The credential includes all the groups to which the user is a member
131 on the local machine (see
133 The user may be specified by name or number.
136 .Fl maproot Li = Sy user:group1:group2:...
138 The colon separated list is used to specify the precise credential
139 to be used for remote access by root.
140 The elements of the list may be either names or numbers.
141 Note that user: should be used to distinguish a credential containing
142 no groups from a complete credential for that user.
145 .Fl mapall Li = Sy user
149 .Fl mapall Li = Sy user:group1:group2:...
151 specifies a mapping for all client UIDs (including root)
152 using the same semantics as
159 in an effort to be backward compatible with older export file formats.
165 options, remote accesses by root will result in using a credential of -2:-2.
166 All other users will be mapped to their remote credential.
170 remote access by root will be mapped to that credential instead of -2:-2.
174 all users (including root) will be mapped to that credential in
178 .Fl sec Li = Sy flavor1:flavor2...
180 specifies a colon separated list of acceptable security flavors to be
181 used for remote access.
182 Supported security flavors are sys, krb5, krb5i and krb5p.
183 If multiple flavors are listed, they should be ordered with the most
184 preferred flavor first.
185 If this option is not present,
186 the default security flavor list of just sys is used.
190 option specifies that the file system should be exported read-only
191 (default read/write).
196 in an effort to be backward compatible with older export file formats.
199 exports strictly according to the spec (RFC 2054 and RFC 2055) can
203 However, this flag in itself allows r/w access to all files in
204 the file system, not requiring reserved ports and not remapping UIDs.
206 is only provided to conform to the spec, and should normally not be used.
215 .Fl mapall No = Sy nobody
219 Note that only one file system can be
221 exported on a server.
225 .Fl index No = Pa file
227 option can be used to specify a file whose handle will be returned if
228 a directory is looked up using the public filehandle
230 This is to mimic the behavior of URLs.
233 option is specified, a directory filehandle will be returned as usual.
236 option only makes sense in combination with the
244 option will inhibit some of the syslog diagnostics for bad lines in
246 This can be useful to avoid annoying error messages for known possible
251 The third component of a line specifies the host set to which the line applies.
252 The set may be specified in three ways.
253 The first way is to list the host name(s) separated by white space.
256 addresses may be used in place of names.)
257 The second way is to specify a
263 The third way is to specify an Internet subnetwork using a network and
264 network mask that is defined as the set of all hosts with addresses within
266 This latter approach requires less overhead within the
267 kernel and is recommended for cases where the export line refers to a
268 large number of clients within an administrative subnet.
270 The first two cases are specified by simply listing the name(s) separated
272 All names are checked to see if they are
275 first and are assumed to be hostnames otherwise.
276 Using the full domain specification for a hostname can normally
277 circumvent the problem of a host that has the same name as a netgroup.
278 The third case is specified by the flag
280 .Fl network Li = Sy netname Op Li / Ar prefixlength
284 .Fl mask No = Sy netmask .
286 The netmask may be specified either by attaching a
290 option, or by using a separate
293 If the mask is not specified, it will default to the mask for that network
294 class (A, B or C; see
300 Scoped IPv6 address must carry scope identifier as documented in
310 For the third form which specifies the NFSv4 tree root, the directory path
311 specifies the location within the server's file system tree which is the
312 root of the NFSv4 tree.
313 There can only be one NFSv4 root directory per server.
314 As such, all entries of this form must specify the same directory path.
315 For file systems other than ZFS,
316 this location can be any directory and does not
317 need to be within an exported file system. If it is not in an exported
318 file system, a very limited set of operations are permitted, so that an
319 NFSv4 client can traverse the tree to an exported file system.
320 Although parts of the NFSv4 tree can be non-exported, the entire NFSv4 tree
321 must consist of local file systems capable of being exported via NFS.
322 All ZFS file systems in the subtree below the NFSv4 tree root must be
324 NFSv4 does not use the mount protocol and does permit clients to cross server
325 mount point boundaries, although not all clients are capable of crossing the
330 option on these line(s) specifies what security flavors may be used for
331 NFSv4 operations that do not use file handles. Since these operations
332 (SetClientID, SetClientIDConfirm, Renew, DelegPurge and ReleaseLockOnwer)
333 allocate/modify state in the server, it is possible to restrict some clients to
334 the use of the krb5[ip] security flavors, via this option.
338 This third form is meaningless for NFSv2 and NFSv3 and is ignored for them.
342 utility can be made to re-read the
344 file by sending it a hangup signal as follows:
345 .Bd -literal -offset indent
346 /etc/rc.d/mountd reload
353 output to see whether
355 logged any parsing errors in the
359 .Bl -tag -width /etc/exports -compact
361 the default remote mount-point file
364 .Bd -literal -offset indent
365 /usr /usr/local -maproot=0:10 friends
366 /usr -maproot=daemon grumpy.cis.uoguelph.ca 131.104.48.16
367 /usr -ro -mapall=nobody
368 /u -maproot=bin: -network 131.104.48 -mask 255.255.255.0
369 /a -network 192.168.0/24
370 /a -network 3ffe:1ce1:1:fe80::/64
371 /u2 -maproot=root friends
372 /u2 -alldirs -network cis-net -mask cis-mask
373 /cdrom -alldirs,quiet,ro -network 192.168.33.0 -mask 255.255.255.0
376 V4: / -sec=krb5:krb5i:krb5p -network 131.104.48 -mask 255.255.255.0
377 V4: / -sec=sys:krb5:krb5i:krb5p grumpy.cis.uoguelph.ca
385 local file system mount points, the above example specifies the following:
387 The file system rooted at
391 where friends is specified in the netgroup file
392 with users mapped to their remote credentials and
393 root mapped to UID 0 and group 10.
394 It is exported read-write and the hosts in
403 .Em grumpy.cis.uoguelph.ca
404 with users mapped to their remote credentials and
405 root mapped to the user and groups associated with
407 it is exported to the rest of the world as read-only with
408 all users mapped to the user and groups associated with
411 The file system rooted at
413 is exported to all hosts on the subnetwork
415 with root mapped to the UID for
417 and with no group access.
419 The file system rooted at
421 is exported to the hosts in
423 with root mapped to UID and groups
426 it is exported to all hosts on network
428 allowing mounts at any
429 directory within /u2.
431 The file system rooted at
433 is exported to the network 192.168.0.0, with a netmask of 255.255.255.0.
434 However, the netmask length in the entry for
436 is not specified through a
438 option, but through the
442 The file system rooted at
444 is also exported to the IPv6 network
445 .Li 3ffe:1ce1:1:fe80::
446 address, using the upper 64 bits as the prefix.
447 Note that, unlike with IPv4 network addresses, the specified network
448 address must be complete, and not just contain the upper bits.
449 With IPv6 addresses, the
451 option must not be used.
453 The file system rooted at
455 will be exported read-only to the entire network 192.168.33.0/24, including
456 all its subdirectories.
459 is the conventional mountpoint for a CD-ROM device, this export will
460 fail if no CD-ROM medium is currently mounted there since that line
461 would then attempt to export a subdirectory of the root file system
464 option which is not allowed.
467 option will then suppress the error message for this condition that
468 would normally be syslogged.
469 As soon as an actual CD-ROM is going to be mounted,
473 about this situation, and the
475 file system will be exported as intended.
476 Note that without using the
478 option, the export would always succeed.
479 While there is no CD-ROM medium mounted under
481 it would export the (normally empty) directory
483 of the root file system instead.
485 The file system rooted at
487 will be exported using Kerberos 5 authentication and will require
488 integrity protected messages for all accesses.
489 The file system rooted at
491 will also be exported using Kerberos 5 authentication and all messages
492 used to access it will be encrypted.
494 For the experimental server, the NFSv4 tree is rooted at ``/'',
495 and any client within the 131.104.48 subnet is permitted to perform NFSv4 state
496 operations on the server, so long as valid Kerberos credentials are provided.
497 The machine grumpy.cis.uoguelph.ca is permitted to perform NFSv4 state
498 operations on the server using AUTH_SYS credentials, as well as Kerberos ones.
506 The export options are tied to the local mount points in the kernel and
507 must be non-contradictory for any exported subdirectory of the local
509 It is recommended that all exported directories within the same server
510 file system be specified on adjacent lines going down the tree.
511 You cannot specify a hostname that is also the name of a netgroup.
512 Specifying the full domain specification for a hostname can normally
513 circumvent the problem.