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 time to wait for the master map to
34 become available if it cannot be read at program start (program
35 default 10, wait for 10 seconds then continue).
36 negative_timeout
38 Set the default timeout for caching failed key lookups (program
39 default 60). If the equivalent command line option is given it
40 will override this setting.
41 mount_wait
43 Set the default time to wait for a response from a spawned
44 mount(8) before sending it a SIGTERM. Note that we still need to
45 wait for the RPC layer to timeout before the sub-process exits
46 so this isn't ideal but it is the best we can do. The default is
47 to wait until mount(8) returns without intervention.
48 umount_wait
50 Set the default time to wait for a response from a spawned
51 umount(8) before sending it a SIGTERM. Note that we still need
52 to wait for the RPC layer to timeout before the sub-process
53 exits so this isn't ideal but it is the best we can do.
54 browse_mode
56 Maps are browsable by default (program default "yes").
57 mount_nfs_default_protocol
59 Set the default protocol that mount.nfs(8) uses when performing
60 a mount (program default 3). Autofs needs to know the default
61 NFS protocol that mount.nfs(8) uses so it can do special case
62 handling for its availability probe for different NFS protocols.
63 Since we can't identify this default automatically we need to
64 set it in the autofs configuration.
65 append_options
67 Determine whether global options, given on the command line or
68 per mount in the master map, are appended to map entry options
69 or if the map entry options replace the global options (program
70 default "yes", append options).
71 logging
73 set default log level "none", "verbose" or "debug" (program
74 default "none").
75 force_standard_program_map_env
77 override the use of a prefix with standard environment variables
78 when a program map is executed. Since program maps are run as
79 the privileded user setting these standard environment variables
80 opens automount(8) to potential user privilege escalation when
81 the program map is written in a language that can load compo‐
82 nents from, for example, a user home directory (program default
83 "no").
84 map_hash_table_size
86 This configuration option may be used to change the number of
87 hash table slots (default 1024).
88 This configuration option affects the overhead of searching the
90 map entry cache for map entries when there are a large number of
91 entries. It affects the number of entries that must be looked
92 at to locate a map entry in the map entry cache. For example,
93 the default of 1024 and a direct map with 8000 entries would
94 result in each slot containing an average of 8 entries, which
95 should be acceptable.
96 However, if excessive CPU usage is observed during automount
98 lookups increasing this option can reduce the CPU overhead con‐
99 siderably becuase it reduces the length of the search chains.
100 Note that the number of entries in a map doesn't necessarily
102 relate to the number of entries used in the map entry cache.
103 There are three distinct cases, direct maps and indirect maps
105 that use the "browse" option must be read in their entirity at
106 program start so, in these two cases the map size does retate
107 directly to the map entry cache size.
108 For indirect maps that do not use the "browse" option entries
110 are added to the map entry cache at lookup so the number of
111 active cache entries, in this case, is usually much less than
112 the number of entries in the map. In this last case it would be
113 unusual for the map entry cache to grow large enough to warrant
114 increasing the default before an event that cleans stale
115 entries, a map re-read for example.
116 use_hostname_for_mounts
118 NFS mounts where the host name resolves to more than one IP
119 address are probed for availability and to establish the order
120 in which mounts to them should be tried. To ensure that mount
121 attempts are made only to hosts that are responding and are
122 tried in the order of hosts with the quickest response the IP
123 address of the host needs to be used for the mount.
124 If it is necessary to use the hostname given in the map entry
126 for the mount regardless, then set this option to "yes".
127 Be aware that if this is done there is no defense against the
129 host name resolving to one that isn't responding and while the
130 number of attempts at a successful mount will correspond to the
131 number of addresses the host name resolves to the order will
132 also not correspond to fastest responding hosts.
133 disable_not_found_message
135 The original request to add this log message needed it to be
136 unconditional. That produces, IMHO, unnecessary noise in the
137 log so a configuration option has been added to provide the
138 ability to turn it off. The default is "no" to maintain the cur‐
139 rent behaviour.
140 sss_master_map_wait
142 Set the time to wait and retry if sssd returns "no such entry"
143 when starting up. When sssd is starting up it can sometimes
144 return "no such entry" for a short time until it has read in the
145 LDAP map information. Default is 0 seconds, don't wait.
146 use_mount_request_log_id
148 Set whether to use a mount request log id so that log entries
149 for specific mount requests can be easily identified in logs
150 that have multiple conncurrent requests. Default is don't use
151 mount request log ids.
152 LDAP Configuration
154 Configuration settings available are:
155 ldap_timeout
157 Set the network response timeout (default 8). Set timeout value
158 for the synchronous API calls. The default is the LDAP library
159 default of an infinite timeout.
160 ldap_network_timeout
162 Set the network response timeout (default 8).
163 ldap_uri
165 A space separated list of server uris of the form
166 <proto>://<server>[/] where <proto> can be ldap or ldaps. The
167 option can be given multiple times. Map entries that include a
168 server name override this option and it is then not used.
169 Default is an empty list in which case either the server given
170 in a map entry or the LDAP configured default is used. This uri
171 list is read at startup and whenever the daemon receives a HUP
172 signal.
173 This configuration option can also be used to request autofs
175 lookup SRV RRs for a domain of the form <proto>:///[<domain
176 dn>]. Note that a trailing "/" is not allowed when using this
177 form. If the domain dn is not specified the dns domain name (if
178 any) is used to construct the domain dn for the SRV RR lookup.
179 The server list returned from an SRV RR lookup is refreshed
180 according to the minimum ttl found in the SRV RR records or
181 after one hour, whichever is less.
182 search_base
184 The base dn to use when searching for amap base dn. This entry
185 may be given multiple times and each will be checked for a map
186 base dn in the order they occur in the configuration. The search
187 base list is read at startup and whenever the daemon recieves a
188 HUP signal.
189 map_object_class
191 The map object class. In the nisMap schema this corresponds to
192 the class nisMap and in the automountMap schema it corresponds
193 to the class automountMap.
194 entry_object_class
196 The map entry object class. In the nisMap schema this corre‐
197 sponds to the class nisObject and in the automountMap schema it
198 corresponds to the class automount.
199 map_attribute
201 The attribute used to identify the name of the map to which this
202 entry belongs. In the nisMap schema this corresponds to the
203 attribute nisMapName and in the automountMap schema it corre‐
204 sponds to the attribute ou or automountMapName.
205 entry_attribute
207 The attribute used to identify a map key. In the nisMap schema
208 this corresponds to the attribute cn and in the automountMap
209 schema it corresponds to the attribute automountKey.
210 value_attribute
212 The attribute used to identify the value of the map entry. In
213 the nisMap schema this corresponds to the attribute nisMapEntry
214 and in the automountMap schema it corresponds to the attribute
215 automountInformation.
216 NOTE: It is essential that entries use class and attribute in a con‐
218 sistent manner for correct operation of autofs. For example mix‐
219 ing cn and automountKey attributes in automount schema will not
220 work as expected.
221 auth_conf_file
223 This configuration option may be used to specify an alternate
224 location for the ldap authentication configuration file. See
225 autofs_ldap_auth.conf(5) for more information.
226
228 A number of the amd configuration options are not used by autofs, some
229 because they are not relevant within autofs, some because they are done
230 differently in autofs and others that are not yet implemented.
231 Since mount_type is always autofs (because there's no user space NFS
233 server) the configuration entries relating to that aren't used. Also,
234 server availability is done differently within autofs so the options
235 that relate to the amd server monitoring sub-system are also not used.
236 These options are mount_type, auto_attrcache, portmap_program,
238 nfs_vers_ping, nfs_allow_any_interface, nfs_allow_insecure_port,
239 nfs_proto, nfs_retransmit_counter, nfs_retransmit_counter_udp,
240 nfs_retransmit_counter_tcp, nfs_retransmit_counter_toplvl,
241 nfs_retry_interval, nfs_retry_interval_udp, nfs_retry_interval_tcp,
242 nfs_retry_interval_toplvl and nfs_vers.
243 Other options that are not used within the autofs implementation:
245 log_file, truncate_log
247 sends its output to syslog so an alternate log file (or truncat‐
248 ing the log) can't be used.
249 print_pid
251 There's no corresponding option for this within autofs.
252 use_tcpwrappers, show_statfs_entries
254 There's no user space NFS server to control access to so this
255 option isn't relevant. The show_statfs_entries can't be imple‐
256 mented for the same reason.
257 debug_mtab_file
259 There's no user space NFS server and autofs avoids using file
260 based mtab whenever possible.
261 sun_map_syntax
263 Sun map format is handled by autofs itself.
264 plock, show_statfs_entries, preferred_amq_port
266 Are not supported by autofs.
267 ldap_cache_maxmem, ldap_cache_seconds
269 External ldap caching is not used by autofs.
270 ldap_proto_version
272 autofs always attempts to use the highest available ldap proto‐
273 col version.
274 cache_duration, map_reload_interval, map_options
276 The map entry cache is continually updated and stale entries
277 cleaned on re-load, which is done when map changes are detected
278 so these configuration entries are not used by autofs. An excep‐
279 tion to this is the case where the map is large. In this case it
280 may be necessary to read the whole map at startup even if brows‐
281 ing is is not enabled. Adding the cache:=all option to
282 map_options can be used to for this.
283 localhost_address
285 This is not used within autofs. This configuration option was
286 only used in the amd user space server code and is not relevant
287 within autofs.
288 Options that are handled differently within autofs:
290 pid_file
292 To specify a pid file name a command line option must be used on
293 startup.
294 print_version
296 Program version and feature information is obtained by using the
297 automount command line option "-V".
298 debug_options , log_options
300 autofs has somewhat more limited logging and debug logging
301 options. When the log_options options is encountered it is con‐
302 verted to the nearest matching autofs logging option. Since the
303 configuration option debug_options would be handled the same way
304 it is ignored.
305 restart_mounts
307 This option has no sensible meaning within autofs because autofs
308 always tries to re-connect to existing mounts. While this has
309 its own set of problems not re-connecting to existing mounts
310 always results in a non-functional automount tree if mounts were
311 busy at the last shutdown (as is also the case with amd when
312 using mount_type autofs).
313 forced_unmounts
315 Detaching mounts often causes serious problems for users of
316 existing mounts. It is used by autofs in some cases, either at
317 the explicit request of the user (with a command line or init
318 option) and in some special cases during program operation but
319 is avoided whenever possible.
320 A number of configuration options are not yet implemented:
322 search_path
324 Always a little frustrating, the compiled in map location should
325 be used to locate maps but isn't in some cases. This requires
326 work within autofs itself and that will (obviously) include
327 implementing this configuration option for the amd map parser as
328 well.
329 fully_qualified_hosts
331 Not yet implemented.
332 unmount_on_exit
334 Since autofs always tries to re-connect to mounts left mounted
335 from a previous shutdown this is a sensible option to implement
336 and that will be done.
337 browsable_dirs
339 Allow map keys to be shown in directory listings. This option
340 can have values of "yes" or "no". The default is "no". A varia‐
341 tion of this option, "browsable", can be used as a pseudo mount
342 option in type "auto" map entries to provide provide browsing
343 funtionality in sub-mounts. The amd "browsable_dirs = full"
344 option cannot be implemented within the current autofs framework
345 and is not supported.
346 exec_map_timeout
348 A timeout is not currently used for for program maps, might be
349 implemented.
350 tag
352 The tag option is not implemented within autofs.
353 Supported options:
355 arch, karch, os, osver
357 These options default to what is returned from uname(2) and can
358 be overridden if required.
359 full_os
361 This option has no default and must be set in the configuration
362 if used in maps.
363 cluster
365 If not set defaults to the host domain name. This option corre‐
366 sponds to the HP_UX cluster name (according to the amd source)
367 and is probably not used in Linux but is set anyway.
368 vendor This option has a default value of "unknown", it must be set in
370 the configuration if used in maps.
371 auto_dir
373 Is the base name of the mount tree used for external mounts that
374 are sometimes needed by amd maps. Its default value is "/a".
375 map_type
377 Specifies the autofs map source, such as file, nis, ldap etc.
378 and has no default value set.
379 map_defaults
381 This option is used to override /defaults entries within maps
382 and can be used to provide different defaults on specific
383 machines without having to modify centrally managed maps. It is
384 empty by default.
385 search_path
387 Colon separated paths to search for maps that are not specified
388 as a full path.
389 dismount_interval
391 Is equivalent to the autofs timeout option. It is only possible
392 to use this with type "auto" mounts due to the way the autofs
393 kernel module performs expiry. It takes its default value from
394 the autofs internal default of 600 seconds.
395 autofs_use_lofs
397 If set to "yes" autofs will attempt to use bind mounts for type
398 "link" entries when possible (default is "yes").
399 nis_domain
401 Allows setting of a domain name other than the system default.
402 local_domain
404 Is used to override (or set) the host domain name.
405 normalize_hostnames
407 If set to "yes" then the contents of ${rhost} is translated in
408 its official host name.
409 domain_strip
411 If set to "yes" the domain name part of the host is strippped
412 when normalizing hostnames. This can be useful when using of the
413 same maps in a multiple domain environment.
414 normalize_slashes
416 This option is set to "yes" by default and will collapse multi‐
417 ple unescaped occurrences of "/" to a single "/".
418 selectors_in_defaults, selectors_on_default
420 This option has a default value of "no". If set to "yes" then
421 any defaults entry will be checked for selectors to determine
422 the values to be used. selectors_in_defaults is the preferred
423 option to use.
424 ldap_base
426 iThis option has no default value. It must be set to the base dn
427 that is used for queries if ldap is to be used as a map source.
428 ldap_hostports
430 This option has no default value set. It must be set to the URI
431 of the LDAP server to be used for lookups wheni ldap is used a
432 map source. It may contain a comma or space separated list of
433 LDAP URIs.
434 hesiod_base
436 Sets the base name used for hesiod map sources.
437 linux_ufs_mount_type
439 This is an additional configuration option for the autofs amd
440 format parser implementation.
441 There's no simple way to determine what the system default
443 filesystem is and am-utils needs to be continually updated to do
444 this and can easily get it wrong ayway. So allow it to be set in
445 the configuration.
446
448 [ autofs ]
449 timeout = 300
450 browse_mode = no
451 [ amd ]
453 dismount_interval = 300
454 map_type = nis
455 autofs_use_lofs = no
456 [ /expamle/mount ]
458 dismount_interval = 60
459 map_type = file
460
462 automount(8), auto.master(5), autofs_ldap_auth.conf(5).
463
465 This manual page was written by Ian Kent <raven@themaw.net>.
466 23 Jan 2014 AUTOFS.CONF(5)