1SYSTEMD.AUTOMOUNT(5)           systemd.automount          SYSTEMD.AUTOMOUNT(5)
2
3
4

NAME

6       systemd.automount - Automount unit configuration
7

SYNOPSIS

9       automount.automount
10

DESCRIPTION

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
16       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
22       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
30       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
36       Automount units may be used to implement on-demand mounting as well as
37       parallelized mounting of file systems.
38
39       Note that automount units are separate from the mount itself, so you
40       should not set After= or Requires= for mount dependencies here. For
41       example, you should not set After=network-online.target or similar on
42       network filesystems. Doing so may result in an ordering cycle.
43
44       Note that automount support on Linux is privileged, automount units are
45       hence only available in the system service manager (and root's user
46       service manager), but not in unprivileged user's service manager.
47

AUTOMATIC DEPENDENCIES

49   Implicit Dependencies
50       The following dependencies are implicitly added:
51
52       •   If an automount unit is beneath another mount unit in the file
53           system hierarchy, both a requirement and an ordering dependency
54           between both units are created automatically.
55
56       •   An implicit Before= dependency is created between an automount unit
57           and the mount unit it activates.
58
59   Default Dependencies
60       The following dependencies are added unless DefaultDependencies=no is
61       set:
62
63       •   Automount units acquire automatic Before= and Conflicts= on
64           umount.target in order to be stopped during shutdown.
65
66       •   Automount units automatically gain an After= dependency on
67           local-fs-pre.target, and a Before= dependency on local-fs.target.
68

FSTAB

70       Automount units may either be configured via unit files, or via
71       /etc/fstab (see fstab(5) for details).
72
73       For details how systemd parses /etc/fstab see systemd.mount(5).
74
75       If an automount point is configured in both /etc/fstab and a unit file,
76       the configuration in the latter takes precedence.
77

OPTIONS

79       Automount files must include an [Automount] section, which carries
80       information about the file system automount points it supervises. The
81       options specific to the [Automount] section of automount units are the
82       following:
83
84       Where=
85           Takes an absolute path of a directory of the automount point. If
86           the automount point does not exist at time that the automount point
87           is installed, it is created. This string must be reflected in the
88           unit filename. (See above.) This option is mandatory.
89
90       DirectoryMode=
91           Directories of automount points (and any parent directories) are
92           automatically created if needed. This option specifies the file
93           system access mode used when creating these directories. Takes an
94           access mode in octal notation. Defaults to 0755.
95
96       TimeoutIdleSec=
97           Configures an idle timeout. Once the mount has been idle for the
98           specified time, systemd will attempt to unmount. Takes a unit-less
99           value in seconds, or a time span value such as "5min 20s". Pass 0
100           to disable the timeout logic. The timeout is disabled by default.
101

SEE ALSO

103       systemd(1), systemctl(1), systemd.unit(5), systemd.mount(5), mount(8),
104       automount(8), systemd.directives(7)
105
106
107
108systemd 249                                               SYSTEMD.AUTOMOUNT(5)
Impressum