1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH AUTOMOUNT 1M "Mar 28, 2008"
8 .SH NAME
9 automount \- install automatic mount points
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/usr/sbin/automount\fR [\fB-t\fR \fIduration\fR] [\fB-v\fR]
14 .fi
15
16 .SH DESCRIPTION
17 .sp
18 .LP
19 The \fBautomount\fR utility installs \fBautofs\fR mount points and associates
20 an automount map with each mount point. It starts the \fBautomountd\fR(1M)
21 daemon if it finds any non-trivial entries in either local or distributed
22 automount maps and if the daemon is not already running. The \fBautofs\fR file
23 system monitors attempts to access directories within it and notifies the
24 \fBautomountd\fR(1M) daemon. The daemon uses the map to locate a file system,
25 which it then mounts at the point of reference within the \fBautofs\fR file
26 system. A map can be assigned to an \fBautofs\fR mount using an entry in the
27 \fB/etc/auto_master\fR map or a direct map.
124
125 .SH USAGE
126 .SS "Map Entry Format"
127 .sp
128 .LP
129 A simple map entry (mapping) takes the form:
130 .sp
131 .in +2
132 .nf
133 key [ -\fImount-options\fR ] \fIlocation\fR .\|.\|.
134 .fi
135 .in -2
136 .sp
137
138 .sp
139 .LP
140 where \fBkey\fR is the full pathname of the directory to mount when used in a
141 direct map, or the simple name of a subdirectory in an indirect map.
142 \fImount-options\fR is a comma-separated list of \fBmount\fR options, and
143 \fIlocation\fR specifies a file system from which the directory may be mounted.
144 In the case of a simple \fBNFS\fR mount, the options that can be used are as
145 specified in \fBmount_nfs\fR(1M), and \fIlocation\fR takes the form:
146 .sp
147 .in +2
148 .nf
149 \fIhost\fR\fB:\|\fR\fIpathname\fR
150 .fi
151 .in -2
152 .sp
153
154 .sp
155 .LP
156 \fIhost\fR is the name of the host from which to mount the file system, and
157 \fIpathname\fR is the absolute pathname of the directory to mount.
158 .sp
159 .LP
160 Options to other file systems are documented on the other \fBmount_*\fR
161 reference manual pages, for example, \fBmount_cachefs\fR(1M).
162 .SS "Replicated File Systems"
163 .sp
164 .LP
165 Multiple \fIlocation\fR fields can be specified for replicated \fBNFS\fR file
166 systems, in which case \fBautomount\fR and the kernel will each try to use that
167 information to increase availability. If the read-only flag is set in the map
168 entry, \fBautomountd\fR mounts a list of locations that the kernel may use,
169 sorted by several criteria. Only locations available at mount time will be
170 mounted, and thus be available to the kernel. When a server does not respond,
171 the kernel will switch to an alternate server. The sort ordering of
172 \fBautomount\fR is used to determine how the next server is chosen. If the
173 read-only flag is not set, \fBautomount\fR will mount the best single location,
174 chosen by the same sort ordering, and new servers will only be chosen when an
175 unmount has been possible, and a remount is done. Servers on the same local
176 subnet are given the strongest preference, and servers on the local net are
177 given the second strongest preference. Among servers equally far away, response
178 times will determine the order if no weighting factors (see below) are used.
179 .sp
180 .LP
181 If the list includes server locations using both the \fBNFS\fR Version 2
386 .fi
387 .in -2
388 .sp
389
390 .sp
391 .LP
392 or to perform an \fBautofs\fR mount:
393 .sp
394 .in +2
395 .nf
396 \fBsrc\fR \fB-fstype\fR\fB=autofs auto_src\fR
397 .fi
398 .in -2
399 .sp
400
401 .sp
402 .LP
403 Use this procedure only if you are not using Volume Manager.
404 .sp
405 .LP
406 Mounts using CacheFS are most useful when applied to an entire map as map
407 defaults. The following entry in the master map describes cached home directory
408 mounts. It assumes the default location of the cache directory, \fB/cache\fR.
409 .sp
410 .in +2
411 .nf
412 \fB/home auto_home\fR \fB-fstype\fR \fB=cachefs,backfstype=nfs\fR
413 .fi
414 .in -2
415 .sp
416
417 .sp
418 .LP
419 See the \fBNOTES\fR section for information on option inheritance.
420 .SS "Indirect Maps"
421 .sp
422 .LP
423 An indirect map allows you to specify mappings for the subdirectories you wish
424 to mount under the \fBdirectory\fR indicated on the command line. In an
425 indirect map, each \fBkey\fR consists of a simple name that refers to one or
426 more file systems that are to be mounted as needed.
427 .SS "Direct Maps"
428 .sp
429 .LP
430 Entries in a direct map are associated directly with \fBautofs\fR mount points.
431 Each \fIkey\fR is the full pathname of an \fBautofs\fR mount point. The direct
432 map as a whole is not associated with any single directory.
433 .sp
434 .LP
435 Direct maps are distinguished from indirect maps by the \fB/-\fR key. For
436 example:
437 .sp
438 .in +2
614 \fB\fB/etc/default/autofs\fR\fR
615 .ad
616 .RS 23n
617 Supplies default values for parameters for \fBautomount\fR and
618 \fBautomountd\fR. See \fBautofs\fR(4).
619 .RE
620
621 .sp
622 .ne 2
623 .na
624 \fB\fB/etc/nsswitch.conf\fR\fR
625 .ad
626 .RS 23n
627 Name service switch configuration file. See \fBnsswitch.conf\fR(4).
628 .RE
629
630 .SH SEE ALSO
631 .sp
632 .LP
633 \fBisainfo\fR(1), \fBls\fR(1), \fBsvcs\fR(1), \fBuname\fR(1),
634 \fBautomountd\fR(1M), \fBmount\fR(1M), \fBmount_cachefs\fR( 1M),
635 \fBmount_nfs\fR(1M), \fBsvcadm\fR(1M), \fBautofs\fR(4), \fBattributes\fR(5),
636 \fBnfssec\fR(5), \fBsmf\fR(5)
637 .sp
638 .LP
639 \fI\fR
640 .SH NOTES
641 .sp
642 .LP
643 \fBautofs\fR mount points must not be hierarchically related. \fBautomount\fR
644 does not allow an \fBautofs\fR mount point to be created within another
645 \fBautofs\fR mount.
646 .sp
647 .LP
648 Since each direct map entry results in a new \fBautofs\fR mount such maps
649 should be kept short.
650 .sp
651 .LP
652 Entries in both direct and indirect maps can be modified at any time. The new
653 information is used when \fBautomountd\fR next uses the map entry to do a
654 mount.
655 .sp
|
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
4 .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved.
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH AUTOMOUNT 1M "Sep 8, 2015"
9 .SH NAME
10 automount \- install automatic mount points
11 .SH SYNOPSIS
12 .LP
13 .nf
14 \fB/usr/sbin/automount\fR [\fB-t\fR \fIduration\fR] [\fB-v\fR]
15 .fi
16
17 .SH DESCRIPTION
18 .sp
19 .LP
20 The \fBautomount\fR utility installs \fBautofs\fR mount points and associates
21 an automount map with each mount point. It starts the \fBautomountd\fR(1M)
22 daemon if it finds any non-trivial entries in either local or distributed
23 automount maps and if the daemon is not already running. The \fBautofs\fR file
24 system monitors attempts to access directories within it and notifies the
25 \fBautomountd\fR(1M) daemon. The daemon uses the map to locate a file system,
26 which it then mounts at the point of reference within the \fBautofs\fR file
27 system. A map can be assigned to an \fBautofs\fR mount using an entry in the
28 \fB/etc/auto_master\fR map or a direct map.
125
126 .SH USAGE
127 .SS "Map Entry Format"
128 .sp
129 .LP
130 A simple map entry (mapping) takes the form:
131 .sp
132 .in +2
133 .nf
134 key [ -\fImount-options\fR ] \fIlocation\fR .\|.\|.
135 .fi
136 .in -2
137 .sp
138
139 .sp
140 .LP
141 where \fBkey\fR is the full pathname of the directory to mount when used in a
142 direct map, or the simple name of a subdirectory in an indirect map.
143 \fImount-options\fR is a comma-separated list of \fBmount\fR options, and
144 \fIlocation\fR specifies a file system from which the directory may be mounted.
145 In the case of a simple \fBNFS\fR mount, the options that can be used are
146 specified in \fBmount_nfs\fR(1M), and \fIlocation\fR takes the form:
147 .sp
148 .in +2
149 .nf
150 \fIhost\fR\fB:\|\fR\fIpathname\fR
151 .fi
152 .in -2
153 .sp
154
155 .sp
156 .LP
157 \fIhost\fR is the name of the host from which to mount the file system, and
158 \fIpathname\fR is the absolute pathname of the directory to mount.
159 .sp
160 .LP
161 Options to other file systems are documented in the other \fBmount_*\fR
162 reference manual pages.
163 .SS "Replicated File Systems"
164 .sp
165 .LP
166 Multiple \fIlocation\fR fields can be specified for replicated \fBNFS\fR file
167 systems, in which case \fBautomount\fR and the kernel will each try to use that
168 information to increase availability. If the read-only flag is set in the map
169 entry, \fBautomountd\fR mounts a list of locations that the kernel may use,
170 sorted by several criteria. Only locations available at mount time will be
171 mounted, and thus be available to the kernel. When a server does not respond,
172 the kernel will switch to an alternate server. The sort ordering of
173 \fBautomount\fR is used to determine how the next server is chosen. If the
174 read-only flag is not set, \fBautomount\fR will mount the best single location,
175 chosen by the same sort ordering, and new servers will only be chosen when an
176 unmount has been possible, and a remount is done. Servers on the same local
177 subnet are given the strongest preference, and servers on the local net are
178 given the second strongest preference. Among servers equally far away, response
179 times will determine the order if no weighting factors (see below) are used.
180 .sp
181 .LP
182 If the list includes server locations using both the \fBNFS\fR Version 2
387 .fi
388 .in -2
389 .sp
390
391 .sp
392 .LP
393 or to perform an \fBautofs\fR mount:
394 .sp
395 .in +2
396 .nf
397 \fBsrc\fR \fB-fstype\fR\fB=autofs auto_src\fR
398 .fi
399 .in -2
400 .sp
401
402 .sp
403 .LP
404 Use this procedure only if you are not using Volume Manager.
405 .sp
406 .LP
407 See the \fBNOTES\fR section for information on option inheritance.
408 .SS "Indirect Maps"
409 .sp
410 .LP
411 An indirect map allows you to specify mappings for the subdirectories you wish
412 to mount under the \fBdirectory\fR indicated on the command line. In an
413 indirect map, each \fBkey\fR consists of a simple name that refers to one or
414 more file systems that are to be mounted as needed.
415 .SS "Direct Maps"
416 .sp
417 .LP
418 Entries in a direct map are associated directly with \fBautofs\fR mount points.
419 Each \fIkey\fR is the full pathname of an \fBautofs\fR mount point. The direct
420 map as a whole is not associated with any single directory.
421 .sp
422 .LP
423 Direct maps are distinguished from indirect maps by the \fB/-\fR key. For
424 example:
425 .sp
426 .in +2
602 \fB\fB/etc/default/autofs\fR\fR
603 .ad
604 .RS 23n
605 Supplies default values for parameters for \fBautomount\fR and
606 \fBautomountd\fR. See \fBautofs\fR(4).
607 .RE
608
609 .sp
610 .ne 2
611 .na
612 \fB\fB/etc/nsswitch.conf\fR\fR
613 .ad
614 .RS 23n
615 Name service switch configuration file. See \fBnsswitch.conf\fR(4).
616 .RE
617
618 .SH SEE ALSO
619 .sp
620 .LP
621 \fBisainfo\fR(1), \fBls\fR(1), \fBsvcs\fR(1), \fBuname\fR(1),
622 \fBautomountd\fR(1M), \fBmount\fR(1M), \fBmount_nfs\fR(1M),
623 \fBsvcadm\fR(1M), \fBautofs\fR(4), \fBattributes\fR(5),
624 \fBnfssec\fR(5), \fBsmf\fR(5)
625 .sp
626 .LP
627 \fI\fR
628 .SH NOTES
629 .sp
630 .LP
631 \fBautofs\fR mount points must not be hierarchically related. \fBautomount\fR
632 does not allow an \fBautofs\fR mount point to be created within another
633 \fBautofs\fR mount.
634 .sp
635 .LP
636 Since each direct map entry results in a new \fBautofs\fR mount such maps
637 should be kept short.
638 .sp
639 .LP
640 Entries in both direct and indirect maps can be modified at any time. The new
641 information is used when \fBautomountd\fR next uses the map entry to do a
642 mount.
643 .sp
|