1AUTOFS.CONF(5) File Formats Manual AUTOFS.CONF(5)
2
6 autofs.conf - autofs configuration
7
9 Configuration settings used by automount(8) may be changed in the con‐
10 figuration file /etc/autofs.conf.
11 This file contains two primary sections, autofs and amd.
13 Configuration entries may be present at the beginning of the configura‐
15 tion file without a section header and are implicitly included as part
16 of the autofs section.
17 Each section name is enclosed in square brackets with spaces between
19 the brackets and the section name. The amd section may be followed by
20 further sections, named by the top level mount point path, that contain
21 per mount configuration settings.
22
24 Configuration settings available are:
25 timeout
27 Sets the default mount timeout in seconds. The internal program
28 default is 10 minutes, but the default installed configuration
29 overrides this and sets the timeout to 5 minutes to be consis‐
30 tent with earlier autofs releases.
31 master_wait
33 Sets the default maximum number of retries (actaul iterations is
34 half this, each is delayed by 2 seconds before retrying) waiting
35 for the master map to become available if it cannot be read at
36 program start (program default 10, then continue). This can be
37 longer if the map source itself waits for availability (such as
38 sss).
39 negative_timeout
41 Set the default timeout for caching failed key lookups (program
42 default 60). If the equivalent command line option is given it
43 will override this setting.
44 positive_timeout
46 Set the default timeout for using cached map entries (program
47 default 120). If the equivalent command line option is given it
48 will override this setting.
49 mount_verbose
51 Use the verbose flag when spawning mount(8), and log some
52 process info about the requestor and its parent (program default
53 "no").
54 mount_wait
56 Set the default time to wait for a response from a spawned
57 mount(8) before sending it a SIGTERM. Note that we still need to
58 wait for the RPC layer to timeout before the sub-process exits
59 so this isn't ideal but it is the best we can do. The default is
60 to wait until mount(8) returns without intervention.
61 umount_wait
63 Set the default time to wait for a response from a spawned
64 umount(8) before sending it a SIGTERM. Note that we still need
65 to wait for the RPC layer to timeout before the sub-process ex‐
66 its so this isn't ideal but it is the best we can do.
67 browse_mode
69 Maps are browsable by default (program default "yes").
70 mount_nfs_default_protocol
72 Set the default protocol that mount.nfs(8) uses when performing
73 a mount (program default 3). Autofs needs to know the default
74 NFS protocol that mount.nfs(8) uses so it can do special case
75 handling for its availability probe for different NFS protocols.
76 Since we can't identify this default automatically we need to
77 set it in the autofs configuration.
78 append_options
80 Determine whether global options, given on the command line or
81 per mount in the master map, are appended to map entry options
82 or if the map entry options replace the global options (program
83 default "yes", append options).
84 logging
86 set default log level "none", "verbose" or "debug" (program de‐
87 fault "none").
88 force_standard_program_map_env
90 override the use of a prefix with standard environment variables
91 when a program map is executed. Since program maps are run as
92 the privileged user setting these standard environment variables
93 opens automount(8) to potential user privilege escalation when
94 the program map is written in a language that can load compo‐
95 nents from, for example, a user home directory (program default
96 "no").
97 map_hash_table_size
99 This configuration option may be used to change the number of
100 hash table slots (default 1024).
101 This configuration option affects the overhead of searching the
103 map entry cache for map entries when there are a large number of
104 entries. It affects the number of entries that must be looked
105 at to locate a map entry in the map entry cache. For example,
106 the default of 1024 and a direct map with 8000 entries would re‐
107 sult in each slot containing an average of 8 entries, which
108 should be acceptable.
109 However, if excessive CPU usage is observed during automount
111 lookups increasing this option can reduce the CPU overhead con‐
112 siderably because it reduces the length of the search chains.
113 Note that the number of entries in a map doesn't necessarily re‐
115 late to the number of entries used in the map entry cache.
116 There are two distinct cases where the map hash table can make a
118 significant difference, direct maps and indirect maps that use
119 the "browse" option.
120 For indirect maps that do not use the "browse" option entries
122 are added to the map entry cache at lookup so the number of ac‐
123 tive cache entries, in this case, is usually much less than the
124 number of entries in the map. In this last case it would be un‐
125 usual for the map entry cache to grow large enough to warrant
126 increasing the default before an event that cleans stale en‐
127 tries, a map re-read for example.
128 use_hostname_for_mounts
130 NFS mounts where the host name resolves to more than one IP ad‐
131 dress are probed for availability and to establish the order in
132 which mounts to them should be tried. To ensure that mount at‐
133 tempts are made only to hosts that are responding and are tried
134 in the order of hosts with the quickest response the IP address
135 of the host needs to be used for the mount.
136 If it is necessary to use the hostname given in the map entry
138 for the mount regardless, then set this option to "yes".
139 Be aware that if this is done there is no defense against the
141 host name resolving to one that isn't responding and while the
142 number of attempts at a successful mount will correspond to the
143 number of addresses the host name resolves to the order will
144 also not correspond to fastest responding hosts.
145 disable_not_found_message
147 The original request to add this log message needed it to be un‐
148 conditional. That produces, IMHO, unnecessary noise in the log
149 so a configuration option has been added to provide the ability
150 to turn it off. The default is "no" to maintain the current be‐
151 haviour.
152 use_ignore_mount_option
154 An option to enable the use of autofs pseudo option "disable".
155 This option is used as a hint to user space that the mount entry
156 should be ommitted from mount table listings. The default is
157 "no" to avoid unexpected changes in behaviour and so is an opt-
158 in setting.
159 sss_master_map_wait
161 Set the time to wait and retry if sssd is unable to read the
162 master map at program start. Program default is 0 (don't wait)
163 or 10 if sss supports returning EHSTDOWN when the provider isn't
164 available.
165 If the sss library supports returning EHOSTDOWN when the
167 provider is down then this value is how long to wait between re‐
168 tries reading the master map. When reading dependent maps or
169 looking up a map key this value is multiplied by the number of
170 retries that would be used when reading the master map.
171 use_mount_request_log_id
173 Set whether to use a mount request log id so that log entries
174 for specific mount requests can be easily identified in logs
175 that have multiple concurrent requests. Default is don't use
176 mount request log ids.
177 LDAP Configuration
179 Configuration settings available are:
180 ldap_timeout
182 Set the network response timeout (default 8). Set timeout value
183 for the synchronous API calls. The default is the LDAP library
184 default of an infinite timeout.
185 ldap_network_timeout
187 Set the network response timeout (default 8).
188 ldap_uri
190 A space separated list of server uris of the form
191 <proto>://<server>[/] where <proto> can be ldap or ldaps. The
192 option can be given multiple times. Map entries that include a
193 server name override this option and it is then not used. De‐
194 fault is an empty list in which case either the server given in
195 a map entry or the LDAP configured default is used. This uri
196 list is read at startup and whenever the daemon receives a HUP
197 signal.
198 This configuration option can also be used to request autofs
200 lookup SRV RRs for a domain of the form <proto>:///[<domain
201 dn>]. Note that a trailing "/" is not allowed when using this
202 form. If the domain dn is not specified the dns domain name (if
203 any) is used to construct the domain dn for the SRV RR lookup.
204 The server list returned from an SRV RR lookup is refreshed ac‐
205 cording to the minimum ttl found in the SRV RR records or after
206 one hour, whichever is less.
207 search_base
209 The base dn to use when searching for amap base dn. This entry
210 may be given multiple times and each will be checked for a map
211 base dn in the order they occur in the configuration. The search
212 base list is read at startup and whenever the daemon recieves a
213 HUP signal.
214 map_object_class
216 The map object class. In the nisMap schema this corresponds to
217 the class nisMap and in the automountMap schema it corresponds
218 to the class automountMap.
219 entry_object_class
221 The map entry object class. In the nisMap schema this corre‐
222 sponds to the class nisObject and in the automountMap schema it
223 corresponds to the class automount.
224 map_attribute
226 The attribute used to identify the name of the map to which this
227 entry belongs. In the nisMap schema this corresponds to the at‐
228 tribute nisMapName and in the automountMap schema it corresponds
229 to the attribute ou or automountMapName.
230 entry_attribute
232 The attribute used to identify a map key. In the nisMap schema
233 this corresponds to the attribute cn and in the automountMap
234 schema it corresponds to the attribute automountKey.
235 value_attribute
237 The attribute used to identify the value of the map entry. In
238 the nisMap schema this corresponds to the attribute nisMapEntry
239 and in the automountMap schema it corresponds to the attribute
240 automountInformation.
241 NOTE: It is essential that entries use class and attribute in a con‐
243 sistent manner for correct operation of autofs. For example mix‐
244 ing cn and automountKey attributes in automount schema will not
245 work as expected.
246 auth_conf_file
248 This configuration option may be used to specify an alternate
249 location for the ldap authentication configuration file. See
250 autofs_ldap_auth.conf(5) for more information.
251
253 A number of the amd configuration options are not used by autofs, some
254 because they are not relevant within autofs, some because they are done
255 differently in autofs and others that are not yet implemented.
256 Since mount_type is always autofs (because there's no user space NFS
258 server) the configuration entries relating to that aren't used. Also,
259 server availability is done differently within autofs so the options
260 that relate to the amd server monitoring sub-system are also not used.
261 These options are mount_type, auto_attrcache, portmap_program,
263 nfs_vers_ping, nfs_allow_any_interface, nfs_allow_insecure_port,
264 nfs_proto, nfs_retransmit_counter, nfs_retransmit_counter_udp, nfs_re‐
265 transmit_counter_tcp, nfs_retransmit_counter_toplvl, nfs_retry_inter‐
266 val, nfs_retry_interval_udp, nfs_retry_interval_tcp, nfs_retry_inter‐
267 val_toplvl and nfs_vers.
268 Other options that are not used within the autofs implementation:
270 log_file, truncate_log
272 sends its output to syslog so an alternate log file (or truncat‐
273 ing the log) can't be used.
274 print_pid
276 There's no corresponding option for this within autofs.
277 use_tcpwrappers, show_statfs_entries
279 There's no user space NFS server to control access to so this
280 option isn't relevant. The show_statfs_entries can't be imple‐
281 mented for the same reason.
282 debug_mtab_file
284 There's no user space NFS server and autofs avoids using file
285 based mtab whenever possible.
286 sun_map_syntax
288 Sun map format is handled by autofs itself.
289 plock, show_statfs_entries, preferred_amq_port
291 Are not supported by autofs.
292 ldap_cache_maxmem, ldap_cache_seconds
294 External ldap caching is not used by autofs.
295 ldap_proto_version
297 autofs always attempts to use the highest available ldap proto‐
298 col version.
299 cache_duration, map_reload_interval, map_options
301 The map entry cache is continually updated and stale entries
302 cleaned on re-load, which is done when map changes are detected
303 so these configuration entries are not used by autofs. An excep‐
304 tion to this is the case where the map is large. In this case it
305 may be necessary to read the whole map at startup even if brows‐
306 ing is not enabled. Adding the cache:=all option to map_options
307 can be used to for this.
308 localhost_address
310 This is not used within autofs. This configuration option was
311 only used in the amd user space server code and is not relevant
312 within autofs.
313 Options that are handled differently within autofs:
315 pid_file
317 To specify a pid file name a command line option must be used on
318 startup.
319 print_version
321 Program version and feature information is obtained by using the
322 automount command line option "-V".
323 debug_options , log_options
325 autofs has somewhat more limited logging and debug logging op‐
326 tions. When the log_options options is encountered it is con‐
327 verted to the nearest matching autofs logging option. Since the
328 configuration option debug_options would be handled the same way
329 it is ignored.
330 restart_mounts
332 This option has no sensible meaning within autofs because autofs
333 always tries to re-connect to existing mounts. While this has
334 its own set of problems not re-connecting to existing mounts al‐
335 ways results in a non-functional automount tree if mounts were
336 busy at the last shutdown (as is also the case with amd when us‐
337 ing mount_type autofs).
338 forced_unmounts
340 Detaching mounts often causes serious problems for users of ex‐
341 isting mounts. It is used by autofs in some cases, either at the
342 explicit request of the user (with a command line or init op‐
343 tion) and in some special cases during program operation but is
344 avoided whenever possible.
345 A number of configuration options are not yet implemented:
347 search_path
349 Always a little frustrating, the compiled in map location should
350 be used to locate maps but isn't in some cases. This requires
351 work within autofs itself and that will (obviously) include im‐
352 plementing this configuration option for the amd map parser as
353 well.
354 fully_qualified_hosts
356 Not yet implemented.
357 unmount_on_exit
359 Since autofs always tries to re-connect to mounts left mounted
360 from a previous shutdown this is a sensible option to implement
361 and that will be done.
362 browsable_dirs
364 Allow map keys to be shown in directory listings. This option
365 can have values of "yes" or "no". The default is "no". A varia‐
366 tion of this option, "browsable", can be used as a pseudo mount
367 option in type "auto" map entries to provide browsing function‐
368 ality in sub-mounts. The amd "browsable_dirs = full" option can‐
369 not be implemented within the current autofs framework and is
370 not supported.
371 exec_map_timeout
373 A timeout is not currently used for program maps but this might
374 be implemented in the future.
375 tag
377 The tag option is not implemented within autofs.
378 Supported options:
380 arch, karch, os, osver
382 These options default to what is returned from uname(2) and can
383 be overridden if required.
384 full_os
386 This option has no default and must be set in the configuration
387 if used in maps.
388 cluster
390 If not set defaults to the host domain name. This option corre‐
391 sponds to the HP_UX cluster name (according to the amd source)
392 and is probably not used in Linux but is set anyway.
393 vendor This option has a default value of "unknown", it must be set in
395 the configuration if used in maps.
396 auto_dir
398 Is the base name of the mount tree used for external mounts that
399 are sometimes needed by amd maps. Its default value is "/a".
400 map_type
402 Specifies the autofs map source, such as file, nis, ldap etc.
403 and has no default value set.
404 map_defaults
406 This option is used to override /defaults entries within maps
407 and can be used to provide different defaults on specific ma‐
408 chines without having to modify centrally managed maps. It is
409 empty by default.
410 search_path
412 Colon separated paths to search for maps that are not specified
413 as a full path.
414 dismount_interval
416 Is equivalent to the autofs timeout option. It is only possible
417 to use this with type "auto" mounts due to the way the autofs
418 kernel module performs expiry. It takes its default value from
419 the autofs internal default of 600 seconds.
420 autofs_use_lofs
422 If set to "yes" autofs will attempt to use bind mounts for type
423 "link" entries when possible (default is "yes").
424 nis_domain
426 Allows setting of a domain name other than the system default.
427 local_domain
429 Is used to override (or set) the host domain name.
430 normalize_hostnames
432 If set to "yes" then the contents of ${rhost} is translated in
433 its official host name.
434 domain_strip
436 If set to "yes" the domain name part of the host is stripped
437 when normalizing hostnames. This can be useful when using of the
438 same maps in a multiple domain environment.
439 normalize_slashes
441 This option is set to "yes" by default and will collapse multi‐
442 ple unescaped occurrences of "/" to a single "/".
443 selectors_in_defaults, selectors_on_default
445 This option has a default value of "no". If set to "yes" then
446 any defaults entry will be checked for selectors to determine
447 the values to be used. selectors_in_defaults is the preferred
448 option to use.
449 ldap_base
451 iThis option has no default value. It must be set to the base dn
452 that is used for queries if ldap is to be used as a map source.
453 ldap_hostports
455 This option has no default value set. It must be set to the URI
456 of the LDAP server to be used for lookups when ldap is used as a
457 map source. It may contain a comma or space separated list of
458 LDAP URIs.
459 hesiod_base
461 Sets the base name used for hesiod map sources.
462 linux_ufs_mount_type
464 This is an additional configuration option for the autofs amd
465 format parser implementation.
466 There's no simple way to determine what the system default
468 filesystem is and am-utils needs to be continually updated to do
469 this and can easily get it wrong ayway. So allow it to be set in
470 the configuration.
471
473 [ autofs ]
474 timeout = 300
475 browse_mode = no
476 [ amd ]
478 dismount_interval = 300
479 map_type = nis
480 autofs_use_lofs = no
481 [ /expamle/mount ]
483 dismount_interval = 60
484 map_type = file
485
487 automount(8), auto.master(5), autofs_ldap_auth.conf(5).
488
490 This manual page was written by Ian Kent <raven@themaw.net>.
491 23 Jan 2014 AUTOFS.CONF(5)