2 .\" Copyright (c) 1997-2014 Erez Zadok
3 .\" Copyright (c) 1990 Jan-Simon Pendry
4 .\" Copyright (c) 1990 Imperial College of Science, Technology & Medicine
5 .\" Copyright (c) 1990 The Regents of the University of California.
6 .\" All rights reserved.
8 .\" This code is derived from software contributed to Berkeley by
9 .\" Jan-Simon Pendry at Imperial College, London.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .\" File: am-utils/scripts/amd.conf.5
51 This configuration file is obsolete.
52 Users are advised to use
59 file is the configuration file for
61 as part of the am-utils suite.
66 contains runtime configuration information for the
70 The file consists of sections and parameters.
71 A section begins with the
72 name of the section in square brackets and continues until the next section
73 begins or the end of the file is reached.
74 Sections contain parameters of the
76 .Dq Ar name No = Ar value .
78 The file is line-based \[em] that is, each newline-terminated line represents
79 either a comment, a section name or a parameter.
83 Section, parameter names and their values are case sensitive.
85 Only the first equals sign in a parameter is significant.
87 or after the first equals sign is discarded.
89 internal whitespace in section and parameter names is irrelevant.
91 and trailing whitespace in a parameter value is discarded.
93 whitespace within a parameter value is not allowed, unless the whole
94 parameter value is quoted with double quotes as in
95 .Dq Ar name No = Qq Li "some\ value" .
97 Any line beginning with a pound sign (#) is ignored, as are lines containing
100 The values following the equals sign in parameters are all either a string
101 (no quotes needed if string does not include spaces) or a boolean, which may
104 Case is significant in all values.
106 cache timeouts are numeric.
108 .Ss "The [global] section"
109 Parameters in this section either apply to
111 as a whole, or to all other
112 regular map sections which follow.
113 There should be only one global section
114 defined in one configuration file.
116 It is highly recommended that this section be specified first in the
118 If it is not, then regular map sections which precede
119 it will not use global values defined later.
120 .Ss "Regular [/map] sections"
121 Parameters in regular (non-global) sections apply to a single map entry.
122 For example, if the map section
124 is defined, then all parameters following it will be applied to the
127 -managed mount point.
129 .Ss "Parameters common to all sections"
130 These parameters can be specified either in the global or a map specific
132 Entries specified in a map-specific section override the default
133 value or one defined in the global section.
134 If such a common parameter is
135 specified only in the global section, it is applicable to all regular map
136 sections that follow.
138 .It Va browsable_dirs Pq string, default=no
143 top-level mount points will be browsable to
146 This means you could run for example
148 and see what keys are available to mount in that directory.
154 entry, wildcard entries, and those with a
156 in them are not included.
159 to this option, all but
162 Note that if you run a command which will attempt to
164 the entries, such as often done by
169 will attempt to mount
172 This is often called a
174 .It Va map_defaults Pq string, default no empty
175 This option sets a string to be used as the map's /defaults entry,
176 overriding any /defaults specified in the map.
177 This allows local users to
178 override map defaults without modifying maps globally.
179 .It Va map_options Pq string, default no options
180 This option is the same as specifying map options on the command line to
183 .Dq Li "cache:=all" .
184 .It Va map_type Pq string, default search all map types
187 will initialize the map only for the type given.
189 useful to avoid the default map search type used by
192 and can have undesired side-effects such as initializing
198 .Bl -tag -width ".Cm nisplus" -compact
204 Hesiod name service from MIT
206 Lightweight Directory Access Protocol
208 (New) dbm style hash files
210 Network Information Services (version 2)
212 Network Information Services Plus (version 3)
218 .It Va mount_type Pq string, default=nfs
221 mount types default to
228 map mount points, for the local host it is running on.
233 will be an autofs server for those mount points.
234 .It Va autofs_use_lofs Pq string, default=yes
239 will use lofs-type (loopback) mounts
240 for type:=link mounts.
241 This has the advantage of mounting in place, and
242 users get to the see the same pathname that they chdir'ed into.
248 will use symlinks instead: that code is more
249 tested, but negates autofs's big advantage of in-place mounts.
250 .It Va search_path Pq string, default no search path
251 This provides a (colon-delimited) search path for file maps.
253 path, sites can allow for local map customizations and overrides, and can
255 distributed maps in several locations as needed.
256 .It Va selectors_in_defaults Pq boolean, default=no
259 then the /defaults entry of maps will search for and process any
260 selectors before setting defaults for all other keys in that map.
262 when you want to set different options for a complete map based on some
264 For example, you may want to better the NFS performance over
265 slow slip-based networks as follows:
268 wire==slip-net;opts:=intr,rsize=1024,wsize=1024 \\
269 wire!=slip-net;opts:=intr,rsize=8192,wsize=8192
271 Deprecated form: selectors_on_default
273 .BR sun_map_syntax " (boolean, default=no)"
274 If "yes," then Amd will parse the map according to the Sun Automount syntax.
276 .\" **************************************************************************
278 .Ss "Parameters applicable to the global section only"
281 .It Va arch Pq string, default to compiled in value
286 Allows you to override the value of the
290 .It Va auto_attrcache Pq numeric, default=0
291 Specify in seconds (or units of 0.1 seconds, depending on the OS), what is
292 the (kernel-side) NFS attribute cache timeout for
296 A value of 0 is supposed to turn off attribute caching, meaning
299 will be consulted via a kernel-RPC each time someone stat()'s
300 the mount point (which could be abused as a denial-of-service attack).
301 Warning: some OSs are incapable of turning off the NFS attribute cache
305 may not work reliably under heavy load.
309 document in the Am-utils distribution for more details.
310 .It Va auto_dir Pq string, default= Ns Pa /a
315 This sets the private directory where
318 sub-directories for its real mount points.
319 .It Va cache_duration Pq numeric, default=300
324 Sets the duration in seconds that looked-up or mounted map
325 entries remain in the cache.
326 .It Va cluster Pq string, default no cluster
331 Specifies the alternate
334 .It Va debug_mtab_file Pq string, default= Ns Pa /tmp/mnttab
335 Path to mtab file that is used by
337 to store a list of mounted
338 file systems during debug-mtab mode.
339 This option only applies
340 to systems that store mtab information on disk.
341 .It Va debug_options Pq string, default no debug options
346 Specify any debugging options for
350 am-utils was configured for debugging using the
355 option, as well as all other options, can be turned on via
356 .Fl Fl enable-debug Ns = Ns Cm mem .
357 Otherwise debugging options are ignored.
359 comma delimited, and can be preceded by the string
363 You can get the list of supported debugging options by running
367 .Bl -tag -width ".Cm xdrtrace" -compact
369 all options (excludes hrtime and mtab)
371 "sensible" default options (all--excluding hrtime, mtab, and xdrtrace)
382 print high resolution time stamps (only if syslog(3) is not used)
384 info service specific debugging
387 trace memory allocations
392 \fBreaddir\fR show browsable_dirs progress
396 full debug options plus mtab,nodaemon,nofork,noamq
398 trace protocol and NFS mount arguments
401 .BR dismount_interval " (numeric, default=120)"
403 .It Va dismount_interval Pq numeric, default=120
408 Specify, in seconds, the time between attempts to dismount
409 file systems that have exceeded their cached times.
410 .It Va domain_strip Pq boolean, default=yes
414 name part referred to by ${rhost} is stripped off.
416 useful to keep logs and smaller.
420 part is left changed.
421 This is useful when using multiple domains with
422 the same maps (as you may have hosts whose domain-stripped name is
424 .It Va exec_map_timeout Pq numeric, default=10
425 The timeout in seconds that
427 will wait for an executable map program before an answer is returned from
428 that program (or script).
429 This value should be set to as small as possible
430 while still allowing normal replies to be returned before the timer expires,
431 because during the time that the executable map program is queried,
433 is essentially waiting and is thus not responding to any other queries.
434 .It Va forced_unmounts Pq boolean, default=no
437 and the client OS supports forced or lazy unmounts, then
439 will attempt to use them if it gets any of three serious error conditions
440 when trying to unmount an existing mount point or mount on top of one:
445 This could be useful to recover from serious conditions such as hardware
446 failure of mounted disks, or NFS servers which are down permanently, were
447 migrated, or changed their IP address.
452 are forcibly unmounted using this option, which is useful to recover
455 .It Va full_os Pq string, default to compiled in value
456 The full name of the operating system, along with its version.
458 to override the compiled-in full name and version of the operating system.
459 Useful when the compiled-in name is not desired.
460 For example, the full
461 operating system name on Linux comes up as
463 but you can override it to
465 .It Va fully_qualified_hosts Pq string, default=no
469 will perform RPC authentication using fully-qualified host names.
471 necessary for some systems, and especially when performing cross-domain
473 For this function to work, the
475 variable ${hostd} is used, requiring that ${domain} not be null.
476 .It Va hesiod_base Pq string, default=automount
477 Specify the base name for hesiod maps.
478 .It Va karch Pq string, default to karch of the system
483 Allows you to override the kernel-architecture of your
485 Useful for example on Sun (Sparc) machines, where you can build one
487 binary and run it on multiple machines, yet you want each one to get
490 variable set (for example, sun4c, sun4m, sun4u, etc.)
496 to figure out the kernel architecture of
498 .It Va ldap_base Pq string, default not set
499 Specify the base name for LDAP.
500 This often includes LDAP-specific
501 values such as country and organization.
502 .It Va ldap_cache_maxmem Pq numeric, default=131072
503 Specify the maximum memory
505 should use to cache LDAP entries.
506 .It Va ldap_cache_seconds Pq numeric, default=0
507 Specify the number of seconds to keep entries in the cache.
508 .It Va ldap_hostports Pq string, default not set
509 Specify the LDAP host and port values.
510 .It Va ldap_proto_version Pq numeric, default=2
511 Specify the version of the LDAP protocol to use.
512 .It Va local_domain Pq string, default no sub-domain
517 Specify the local domain name.
518 If this option is not given
519 the domain name is determined from the hostname by removing the first
520 component of the fully-qualified host name.
521 .It Va localhost_address Pq string, default to localhost or 127.0.0.1
522 Specify the name or IP address for
524 to use when connecting the sockets
525 for the local NFS server and the RPC server.
526 This defaults to 127.0.0.1 or
527 whatever the host reports as its local address.
528 This parameter is useful on
529 hosts with multiple addresses where you want to force
533 .It Va log_file Pq string, default= Ns Pa /dev/stderr
538 Specify a file name to log
545 will send its events to the standard error file descriptor.
550 will record its events with the system logger
552 The default syslog facility used is
555 wish to change it, append its name to the log file name, delimited by a
563 will log messages via
567 facility (if it exists on the system).
568 .It Va log_options Pq string, default no logging options
573 Specify any logging options for
576 delimited, and can be preceded by the string
578 to negate their meaning.
581 logging option is only available if am-utils was configured with
582 .Fl Fl enable-debug .
583 You can get the list of supported debugging and logging
588 .Bl -tag -width ".Cm warning" -compact
592 default messages (fatal,error,user,warning,info)
596 non-fatal system errors (cannot be turned off)
598 fatal errors (cannot be turned off)
604 additional statistical information
606 non-fatal user errors
609 \fBwarning\fR warnings
613 .It Va map_reload_interval Pq numeric, default=3600
614 The number of seconds that
616 will wait before it checks to see if any maps
617 have changed at their source (NIS servers, LDAP servers, files, etc.).
619 will reload only those maps that have changed.
620 .It Va nfs_allow_any_interface Pq string, default=no
623 accepts local NFS packets only from 127.0.0.1.
629 will accept local NFS packets from any
630 local interface; this is useful on hosts that may have multiple interfaces
631 where the system is forced to send all outgoing packets (even those bound to
632 the same host) via an address other than 127.0.0.1.
633 .It Va nfs_allow_insecure_port Pq string, default=no
636 will refuse requests coming from unprivileged ports (i.e.\&
637 ports >= 1024 on Unix systems), so that only privileged users and the kernel
638 can send NFS requests to it.
639 However, some kernels (certain versions of
640 Darwin, MacOS X, and Linux) have bugs that cause them to use unprivileged
641 ports in certain situations, which causes
643 to stop dead in its tracks.
644 This parameter allows
646 to operate normally even on such systems, at the
647 expense of a slight decrease in the security of its operations.
650 .Dq Li "ignoring request from foo:1234, port not reserved"
653 log, try enabling this parameter and give it another go.
654 .It Va nfs_proto Pq string, default to trying version tcp then udp
657 tries TCP and then UDP.
658 This option forces the overall
660 protocol used to TCP or UDP.
661 It overrides what is in the
666 is compiled with NFSv3 support that may not be stable.
668 this option you can turn off the complete usage of NFSv3 dynamically
669 (without having to recompile
671 until such time as NFSv3 support is
673 .It Va nfs_retransmit_counter Pq numeric, default=11
678 .Fl t Ar timeout.retransmit
681 Specifies the number of NFS retransmissions that the kernel will use to
684 .It Va nfs_retransmit_counter_udp Pq numeric, default=11
686 .Va nfs_retransmit_counter
687 option, but for all UDP mounts only.
688 .It Va nfs_retransmit_counter_tcp Pq numeric, default=11
690 .Va nfs_retransmit_counter
691 option, but for all TCP mounts only.
692 .It Va nfs_retransmit_counter_toplvl Pq numeric, default=11
694 .Va nfs_retransmit_counter
697 top-level UDP mounts.
698 .It Va nfs_retry_interval Pq numeric, default=8
703 .Fl t Ar timeout.retransmit
710 of seconds, between NFS/RPC retries (for UDP and TCP).
711 This is the value that the kernel will use to
716 relies on the kernel RPC retransmit mechanism to trigger mount retries.
718 .Va nfs_retransmit_counter
720 .Va nfs_retry_interval
721 parameters change the overall retry interval.
722 Too long an interval gives
723 poor interactive response; too short an interval causes excessive retries.
724 .It Va nfs_retry_interval_udp Pq numeric, default=8
726 .Va nfs_retry_interval
727 option, but for all UDP mounts only.
728 .It Va nfs_retry_interval_tcp Pq numeric, default=8
730 .It nfs_retry_interval
731 option, but for all TCP mounts only.
732 .It Va nfs_retry_interval_toplvl Pq numeric, default=8
734 .It nfs_retry_interval
737 top-level UDP mounts.
738 .It Va nfs_vers Pq numeric, default to trying version 3 then 2
741 tries version 3 and then version 2.
742 This option forces the
745 protocol used to version 3 or 2.
746 It overrides what is in the
748 maps, and is useful when
750 is compiled with NFSv3 support that may not
752 With this option you can turn off the complete usage of NFSv3
753 dynamically (without having to recompile
755 until such time as NFSv3
756 support is desired again.
757 .It Va nis_domain Pq string, default to local Tn NIS domain name
762 Specify an alternative
764 domain from which to fetch the
767 The default is the system domain name.
768 This option is ignored if
770 support is not available.
771 .It Va normalize_hostnames Pq boolean, default=no
778 then the name referred to by
780 is normalized relative to the host database before being used.
782 to translate aliases into
785 .It Va normalize_slashes Pq boolean, default=yes
790 will condense all multiple
792 (slash) characters into
793 one and remove all trailing slashes.
799 strings that may contain repeated or trailing slashes.
801 sometimes useful with SMB mounts, which often require multiple slash
802 characters in pathnames.
803 .It Va os Pq string, default to compiled in value
808 Allows you to override the compiled-in name of the operating
810 Useful when the built-in name is not desired for backward
811 compatibility reasons.
812 For example, if the build in name is
814 you can override it to
816 and use older maps which were written with the
818 .It Va osver Pq string, default to compiled in value
823 Overrides the compiled-in version number of the operating
825 Useful when the built in version is not desired for backward
826 compatibility reasons.
827 For example, if the build in version is
829 you can override it to
831 and use older maps that were written with
833 .It Va pid_file Pq string, default= Ns Pa /dev/stdout
834 Specify a file to store the process ID of the running daemon into.
838 will print its process ID onto the standard output.
843 Note that the PID of a running
846 also be retrieved via
848 This file is used only if the
851 .It Va plock Pq boolean, default=yes
858 lock the running executable pages of
863 performance, systems that support the
870 This way there is less chance that
871 the operating system will schedule, page out, and swap the
876 performance, at the cost of reserving the
879 process (making it unavailable for other processes).
880 .It Va portmap_program Pq numeric, default=300019
881 Specify an alternate Port-mapper RPC program number, other than the official
883 This is useful when running multiple
891 mode, without affecting the primary
894 For safety reasons, the alternate program numbers that
895 can be specified must be in the range 300019-300029, inclusive.
901 which can be used to specify an alternate program number of an
906 can fully control any number of
908 processes running on the same host.
909 .It Va preferred_amq_port Pq numeric, default=0
910 Specify an alternate Port-mapper RPC port number for
914 This is used for both UDP and TCP.
915 Setting this value to 0 (or
916 not defining it) will cause
918 to select an arbitrary port number.
921 RPC service port to a specific number is useful in firewalled or NAT'ed
922 environments, where you need to know which port
925 .It Va print_pid Pq boolean, default=no
933 will print its process ID upon starting.
934 .It Va print_version Pq boolean, default=no
939 but the version prints and
945 will print its version information string, which includes some
946 configuration and compilation values.
947 .It Va restart_mounts Pq boolean, default=no
955 will scan the mount table to determine which file systems are currently
957 Whenever one of these would have been auto-mounted,
960 .It Va show_statfs_entries Pq boolean, default=no
963 then all maps which are browsable will also show the number of
964 entries (keys) they have when
967 (This is accomplished by returning
968 non-zero values to the
971 .It Va truncate_log Pq boolean, default=no
974 then the log file (if it is a regular file), will be truncated
976 .It Va unmount_on_exit Pq boolean, default=no
981 will attempt to unmount all file systems which it knows
988 mounted file systems intact.
991 does not know about file systems mounted before it starts up,
997 .It Va use_tcpwrappers Pq boolean, default=yes
1002 will use the tcpd/libwrap tcpwrappers library
1003 (if available) to control
1007 .Pa /etc/hosts.allow
1011 .It Va vendor Pq string, default to compiled in value
1012 The name of the vendor of the operating system.
1013 Overrides the compiled-in
1015 Useful when the compiled-in name is not desired.
1017 most Intel based systems set the vendor name to
1019 but you can set it to
1022 .Ss "Parameters applicable to regular map sections"
1024 .It Va map_name Pq string, must be specified
1025 Name of the map where the keys are located.
1026 .It Va tag Pq string, default no tag
1027 Each map entry in the configuration file can be tagged.
1029 specified, that map section will always be processed by
1034 will process the map if the
1038 and the value given to that command-line option
1039 matches that in the map section.
1044 configuration I use daily.
1046 # GLOBAL OPTIONS SECTION
1048 normalize_hostnames = no
1050 restart_mounts = yes
1052 log_file = /var/log/amd
1054 #debug_options = all
1056 selectors_in_defaults = yes
1057 # config.guess picks up "sunos5" and I don't want to edit my maps yet
1059 # if you print_version after setting up "os", it will show it.
1062 search_path = /etc/amdmaps:/usr/lib/amd:/usr/local/AMD/lib
1063 browsable_dirs = yes
1065 # DEFINE AN AMD MOUNT POINT
1079 map_name = amd.import
1083 map_name = amd.tftpboot
1086 .Xr hosts_access 5 ,
1097 .%B "Linux NFS and Automounter Administration"
1098 .%O ISBN 0-7821-2739-8
1103 .Pa http://www.am-utils.org/
1105 .%T Amd \- The 4.4 BSD Automounter
1110 utility first appeared in
1113 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
1114 Computer Science Department, Stony Brook University, Stony Brook, New York, USA.
1116 Other authors and contributors to am-utils are listed in the
1118 file distributed with am-utils.
projects / FreeBSD / FreeBSD.git / blob