1AUTOFS.CONF(23 Jan 2014) AUTOFS.CONF(23 Jan 2014)
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 Specify the default protocol used by mount.nfs(8) (program
60 default 3). Since we can't identify this default automatically
61 we need to set it in the autofs configuration.
62 append_options
64 Determine whether global options, given on the command line or
65 per mount in the master map, are appended to map entry options
66 or if the map entry options replace the global options (program
67 default "yes", append options).
68 logging
70 set default log level "none", "verbose" or "debug" (program
71 default "none").
72 force_standard_program_map_env
74 override the use of a prefix with standard environment variables
75 when a program map is executed. Since program maps are run as
76 the privileded user setting these standard environment variables
77 opens automount(8) to potential user privilege escalation when
78 the program map is written in a language that can load compo‐
79 nents from, for example, a user home directory (program default
80 "no").
81 map_hash_table_size
83 This configuration option may be used to change the number of
84 hash table slots (default 1024).
85 This configuration option affects the overhead of searching the
87 map entry cache for map entries when there are a large number of
88 entries. It affects the number of entries that must be looked
89 at to locate a map entry in the map entry cache. For example,
90 the default of 1024 and a direct map with 8000 entries would
91 result in each slot containing an average of 8 entries, which
92 should be acceptable.
93 However, if excessive CPU usage is observed during automount
95 lookups increasing this option can reduce the CPU overhead con‐
96 siderably becuase it reduces the length of the search chains.
97 Note that the number of entries in a map doesn't necessarily
99 relate to the number of entries used in the map entry cache.
100 There are three distinct cases, direct maps and indirect maps
102 that use the "browse" option must be read in their entirity at
103 program start so, in these two cases the map size does retate
104 directly to the map entry cache size.
105 For indirect maps that do not use the "browse" option entries
107 are added to the map entry cache at lookup so the number of
108 active cache entries, in this case, is usually much less than
109 the number of entries in the map. In this last case it would be
110 unusual for the map entry cache to grow large enough to warrant
111 increasing the default before an event that cleans stale
112 entries, a map re-read for example.
113 use_hostname_for_mounts
115 NFS mounts where the host name resolves to more than one IP
116 address are probed for availability and to establish the order
117 in which mounts to them should be tried. To ensure that mount
118 attempts are made only to hosts that are responding and are
119 tried in the order of hosts with the quickest response the IP
120 address of the host needs to be used for the mount.
121 If it is necessary to use the hostname given in the map entry
123 for the mount regardless, then set this option to "yes".
124 Be aware that if this is done there is no defense against the
126 host name resolving to one that isn't responding and while the
127 number of attempts at a successful mount will correspond to the
128 number of addresses the host name resolves to the order will
129 also not correspond to fastest responding hosts.
130 sss_master_map_wait
132 Set the time to wait and retry if sssd returns "no such entry"
133 when starting up. When sssd is starting up it can sometimes
134 return "no such entry" for a short time until it has read in the
135 LDAP map information. Default is 0 seconds, don't wait.
136 LDAP Configuration
138 Configuration settings available are:
139 ldap_timeout
141 Set the network response timeout (default 8). Set timeout value
142 for the synchronous API calls. The default is the LDAP library
143 default of an infinite timeout.
144 ldap_network_timeout
146 Set the network response timeout (default 8).
147 ldap_uri
149 A space seperated list of server uris of the form
150 <proto>://<server>[/] where <proto> can be ldap or ldaps. The
151 option can be given multiple times. Map entries that include a
152 server name override this option and it is then not used.
153 Default is an empty list in which case either the server given
154 in a map entry or the LDAP configured default is used. This uri
155 list is read at startup and whenever the daemon receives a HUP
156 signal.
157 This configuration option can also be used to request autofs
159 lookup SRV RRs for a domain of the form <proto>:///[<domain
160 dn>]. Note that a trailing "/" is not allowed when using this
161 form. If the domain dn is not specified the dns domain name (if
162 any) is used to construct the domain dn for the SRV RR lookup.
163 The server list returned from an SRV RR lookup is refreshed
164 according to the minimum ttl found in the SRV RR records or
165 after one hour, whichever is less.
166 search_base
168 The base dn to use when searching for amap base dn. This entry
169 may be given multiple times and each will be checked for a map
170 base dn in the order they occur in the configuration. The search
171 base list is read at startup and whenever the daemon recieves a
172 HUP signal.
173 map_object_class
175 The map object class. In the nisMap schema this corresponds to
176 the class nisMap and in the automountMap schema it corresponds
177 to the class automountMap.
178 entry_object_class
180 The map entry object class. In the nisMap schema this corre‐
181 sponds to the class nisObject and in the automountMap schema it
182 corresponds to the class automount.
183 map_attribute
185 The attribute used to identify the name of the map to which this
186 entry belongs. In the nisMap schema this corresponds to the
187 attribute nisMapName and in the automountMap schema it corre‐
188 sponds to the attribute ou or automountMapName.
189 entry_attribute
191 The attribute used to identify a map key. In the nisMap schema
192 this corresponds to the attribute cn and in the automountMap
193 schema it corresponds to the attribute automountKey.
194 value_attribute
196 The attribute used to identify the value of the map entry. In
197 the nisMap schema this corresponds to the attribute nisMapEntry
198 and in the automountMap schema it corresponds to the attribute
199 automountInformation.
200 NOTE: It is essential that entries use class and attribute in a con‐
202 sistent manner for correct operation of autofs. For example mix‐
203 ing cn and automountKey attributes in automount schema will not
204 work as expected.
205 auth_conf_file
207 This configuration option may be used to specify an alternate
208 location for the ldap authentication configuration file. See
209 autofs_ldap_auth.conf(5) for more information.
210
212 A number of the amd configuration options are not used by autofs, some
213 because they are not relevant within autofs, some because they are done
214 differently in autofs and others that are not yet implemented.
215 Since mount_type is always autofs (because there's no user space NFS
217 server) the configuration entries relating to that aren't used. Also,
218 server availability is done differently within autofs so the options
219 that relate to the amd server monitoring sub-system are also not used.
220 These options are mount_type, auto_attrcache, portmap_program,
222 nfs_vers_ping, nfs_allow_any_interface, nfs_allow_insecure_port,
223 nfs_proto, nfs_retransmit_counter, nfs_retransmit_counter_udp,
224 nfs_retransmit_counter_tcp, nfs_retransmit_counter_toplvl,
225 nfs_retry_interval, nfs_retry_interval_udp, nfs_retry_interval_tcp,
226 nfs_retry_interval_toplvl and nfs_vers.
227 Other options that are not used within the autofs implementation:
229 log_file, truncate_log
231 sends its output to syslog so an alternate log file (or truncat‐
232 ing the log) can't be used.
233 print_pid
235 There's no corresponding option for this within autofs.
236 use_tcpwrappers, show_statfs_entries
238 There's no user space NFS server to control access to so this
239 option isn't relevant. The show_statfs_entries can't be imple‐
240 mented for the same reason.
241 debug_mtab_file
243 There's no user space NFS server and autofs avoids using file
244 based mtab whenever possible.
245 sun_map_syntax
247 Sun map format is handled by autofs itself.
248 plock, show_statfs_entries, preferred_amq_port
250 Are not supported by autofs.
251 ldap_cache_maxmem, ldap_cache_seconds
253 External ldap caching is not used by autofs.
254 ldap_proto_version
256 autofs always attempts to use the highest available ldap proto‐
257 col version.
258 cache_duration, map_reload_interval, map_options
260 The map entry cache is continually updated and stale entries
261 cleaned on re-load, which is done when map changes aredetected
262 so these configuration entries are not used by autofs.
263 localhost_address
265 This is not used within autofs. This configuration option was
266 only used in the amd user space server code and is not relevant
267 within autofs.
268 Options that are handled differently within autofs:
270 pid_file
272 To specify a pid file name a command line option must be used on
273 startup.
274 print_version
276 Program version and feature information is obtained by using the
277 automount command line option "-V".
278 debug_options , log_options
280 autofs has somewhat more limited logging and debug logging
281 options. When the log_options options is encountered it is con‐
282 verted to the nearest matching autofs logging option. Since the
283 configuration option debug_options would be handled the same way
284 it is ignored.
285 restart_mounts
287 This option has no sensible meaning within autofs because autofs
288 always tries to re-connect to existing mounts. While this has
289 its own set of problems not re-connecting to existing mounts
290 always results in a non-functional automount tree if mounts were
291 busy at the last shutdown (as is also the case with amd when
292 using mount_type autofs).
293 forced_unmounts
295 Detaching mounts often causes serious problems for users of
296 existing mounts. It is used by autofs in some cases, either at
297 the explicit request of the user (with a command line or init
298 option) and in some special cases during program operation but
299 is avoided whenever possible.
300 A number of configuration options are not yet implemented:
302 search_path
304 Always a little frustrating, the compiled in map location should
305 be used to locate maps but isn't in some cases. This requires
306 work within autofs itself and that will (obviously) include
307 implementing this configuration option for the amd map parser as
308 well.
309 fully_qualified_hosts
311 Not yet implemented.
312 unmount_on_exit
314 Since autofs always tries to re-connect to mounts left mounted
315 from a previous shutdown this is a sensible option to implement
316 and that will be done.
317 browsable_dirs
319 Not yet implemented.
320 exec_map_timeout
322 A timeout is not currently used for for program maps, might be
323 implemented.
324 tag
326 The tag option is not implemented within autofs.
327 Supported options:
329 arch, karch, os, osver
331 These options default to what is returned from uname(2) and can
332 be overridden if required.
333 full_os
335 This option has no default and must be set in the configuration
336 if used in maps.
337 cluster
339 If not set defaults to the host domain name. This option corre‐
340 sponds to the HP_UX cluster name (according to the amd source)
341 and is probably not used in Linux but is set anyway.
342 vendor This option has a default value of "unknown", it must be set in
344 the configuration if used in maps.
345 auto_dir
347 Is the base name of the mount tree used for external mounts that
348 are sometimes needed by amd maps. Its default value is "/a".
349 map_type
351 Specifies the autofs map source, such as file, nis, ldap etc.
352 and has no default value set.
353 map_defaults
355 This option is used to override /defaults entries within maps
356 and can be used to provide different defaults on specific
357 machines without having to modify centrally managed maps. It is
358 empty by default.
359 search_path
361 Colon seperated paths to search for maps that are not specified
362 as a full path.
363 dismount_interval
365 Is equivalent to the autofs timeout option. It is only possible
366 to use this with type "auto" mounts due to the way the autofs
367 kernel module performs expiry. It takes its default value from
368 the autofs internal defaulti of 600 seconds.
369 autofs_use_lofs
371 If set to "yes" autofs will attempt to use bind mounts for type
372 "auto" when possible.
373 nis_domain
375 Allows setting of a domain name other than the system default.
376 local_domain
378 Is used to override (or set) the host domain name.
379 normalize_hostnames
381 If set to "yes" then the contents of ${rhost} is translated in
382 its official host name.
383 domain_strip
385 If set to "yes" the domain name part of the host is strippped
386 when normalizing hostnames. This can be useful when using of the
387 same maps in a multiple domain environment.
388 normalize_slashes
390 This option is set to "yes" by default and will collapse multi‐
391 ple unescaped occurrences of "/" to a single "/".
392 selectors_in_defaults, selectors_on_default
394 This option has a default value of "no". If set to "yes" then
395 any defaults entry will be checked for selectors to determine
396 the values to be used. selectors_in_defaults is the preferred
397 option to use.
398 ldap_base
400 iThis option has no default value. It must be set to the base dn
401 that is used for queries if ldap is to be used as a map source.
402 ldap_hostports
404 This option has no default value set. It must be set to the URI
405 of the LDAP server to be used for lookups wheni ldap is used a
406 map source. It may contain a comma or space seperated list of
407 LDAP URIs.
408 hesiod_base
410 Sets the base name used for hesiod map sources.
411 linux_ufs_mount_type
413 This is an aditional configuration option for the autofs amd
414 format parser implementation.
415 There's no simple way to determine what the system default
417 filesystem is and am-utils needs to be continually updated to do
418 this and can easily get it wrong ayway. So allow it to be set in
419 the configuration.
420
422 [ autofs ]
423 timeout = 300
424 browse_mode = no
425 [ amd ]
427 dismount_interval = 300
428 map_type = nis
429 autofs_use_lofs = no
430 [ /expamle/mount ]
432 dismount_interval = 60
433 map_type = file
434
436 automount(8), auto.master(5), autofs_ldap_auth.conf(5)
437
439 This manual page was written by Ian Kent <raven@themaw.net>.
440 AUTOFS.CONF(23 Jan 2014)