1SYSTEMD.AUTOMOUNT(5) systemd.automount SYSTEMD.AUTOMOUNT(5)
2
6 systemd.automount - Automount unit configuration
7
9 automount.automount
10
12 A unit configuration file whose name ends in ".automount" encodes
13 information about a file system automount point controlled and
14 supervised by systemd.
15 This man page lists the configuration options specific to this unit
17 type. See systemd.unit(5) for the common options of all unit
18 configuration files. The common configuration items are configured in
19 the generic "[Unit]" and "[Install]" sections. The automount specific
20 configuration options are configured in the "[Automount]" section.
21 Automount units must be named after the automount directories they
23 control. Example: the automount point /home/lennart must be configured
24 in a unit file home-lennart.automount. For details about the escaping
25 logic used to convert a file system path to a unit name see
26 systemd.unit(5). Note that automount units cannot be templated, nor is
27 it possible to add multiple names to an automount unit by creating
28 additional symlinks to its unit file.
29 For each automount unit file a matching mount unit file (see
31 systemd.mount(5) for details) must exist which is activated when the
32 automount path is accessed. Example: if an automount unit
33 home-lennart.automount is active and the user accesses /home/lennart
34 the mount unit home-lennart.mount will be activated.
35 Automount units may be used to implement on-demand mounting as well as
37 parallelized mounting of file systems.
38
40 Implicit Dependencies
41 The following dependencies are implicitly added:
42 · If an automount unit is beneath another mount unit in the file
44 system hierarchy, both a requirement and an ordering dependency
45 between both units are created automatically.
46 · An implicit Before= dependency is created between an automount unit
48 and the mount unit it activates.
49 Default Dependencies
51 The following dependencies are added unless DefaultDependencies=no is
52 set:
53 · Automount units acquire automatic Before= and Conflicts= on
55 umount.target in order to be stopped during shutdown.
56
58 Automount units may either be configured via unit files, or via
59 /etc/fstab (see fstab(5) for details).
60 For details how systemd parses /etc/fstab see systemd.mount(5).
62 If an automount point is configured in both /etc/fstab and a unit file,
64 the configuration in the latter takes precedence.
65
67 Automount files must include an [Automount] section, which carries
68 information about the file system automount points it supervises. The
69 options specific to the [Automount] section of automount units are the
70 following:
71 Where=
73 Takes an absolute path of a directory of the automount point. If
74 the automount point does not exist at time that the automount point
75 is installed, it is created. This string must be reflected in the
76 unit filename. (See above.) This option is mandatory.
77 DirectoryMode=
79 Directories of automount points (and any parent directories) are
80 automatically created if needed. This option specifies the file
81 system access mode used when creating these directories. Takes an
82 access mode in octal notation. Defaults to 0755.
83 TimeoutIdleSec=
85 Configures an idle timeout. Once the mount has been idle for the
86 specified time, systemd will attempt to unmount. Takes a unit-less
87 value in seconds, or a time span value such as "5min 20s". Pass 0
88 to disable the timeout logic. The timeout is disabled by default.
89
91 systemd(1), systemctl(1), systemd.unit(5), systemd.mount(5), mount(8),
92 automount(8), systemd.directives(7)
93systemd 245 SYSTEMD.AUTOMOUNT(5)