1SYSTEMD.MOUNT(5) systemd.mount SYSTEMD.MOUNT(5)
2
6 systemd.mount - Mount unit configuration
7
9 mount.mount
10
12 A unit configuration file whose name ends in ".mount" encodes
13 information about a file system mount point controlled and supervised
14 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 mount specific
20 configuration options are configured in the [Mount] section.
21 Additional options are listed in systemd.exec(5), which define the
23 execution environment the mount(8) binary is executed in, and in
24 systemd.kill(5), which define the way the processes are terminated, and
25 in systemd.resource-control(5), which configure resource control
26 settings for the processes of the service. Note that the User= and
27 Group= options are not particularly useful for mount units specifying a
28 "Type=" option or using configuration not specified in /etc/fstab;
29 mount(8) will refuse options that are not listed in /etc/fstab if it is
30 not run as UID 0.
31 Mount units must be named after the mount point directories they
33 control. Example: the mount point /home/lennart must be configured in a
34 unit file home-lennart.mount. For details about the escaping logic used
35 to convert a file system path to a unit name, see systemd.unit(5).
36 Optionally, a mount unit may be accompanied by an automount unit, to
38 allow on-demand or parallelized mounting. See systemd.automount(5).
39 If a mount point is beneath another mount point in the file system
41 hierarchy, a dependency between both units is created automatically.
42 Mount points created at runtime (independently of unit files or
44 /etc/fstab) will be monitored by systemd and appear like any other
45 mount unit in systemd. See /proc/self/mountinfo description in proc(5).
46 Some file systems have special semantics as API file systems for
48 kernel-to-userspace and userspace-to-userpace interfaces. Some of them
49 may not be changed via mount units, and cannot be disabled. For a
50 longer discussion see API File Systems[1].
51
53 Mount units may either be configured via unit files, or via /etc/fstab
54 (see fstab(5) for details). Mounts listed in /etc/fstab will be
55 converted into native units dynamically at boot and when the
56 configuration of the system manager is reloaded. In general,
57 configuring mount points through /etc/fstab is the preferred approach.
58 See systemd-fstab-generator(8) for details about the conversion.
59 When reading /etc/fstab a few special mount options are understood by
61 systemd which influence how dependencies are created for mount points.
62 systemd will create a dependency of type Wants or Requires (see option
63 nofail below), from either local-fs.target or remote-fs.target,
64 depending whether the file system is local or remote.
65 x-systemd.requires=
67 Configures a Requires= and an After= dependency between the created
68 mount unit and another systemd unit, such as a device or mount
69 unit. The argument should be a unit name, or an absolute path to a
70 device node or mount point. This option may be specified more than
71 once. This option is particularly useful for mount point
72 declarations that need an additional device to be around (such as
73 an external journal device for journal file systems) or an
74 additional mount to be in place (such as an overlay file system
75 that merges multiple mount points). See After= and Requires= in
76 systemd.unit(5) for details.
77 x-systemd.requires-mounts-for=
79 Configures a RequiresMountsFor= dependency between the created
80 mount unit and other mount units. The argument must be an absolute
81 path. This option may be specified more than once. See
82 RequiresMountsFor= in systemd.unit(5) for details.
83 x-systemd.automount
85 An automount unit will be created for the file system. See
86 systemd.automount(5) for details.
87 x-systemd.idle-timeout=
89 Configures the idleness timeout of the automount unit. See
90 TimeoutIdleSec= in systemd.automount(5) for details.
91 x-systemd.device-timeout=
93 Configure how long systemd should wait for a device to show up
94 before giving up on an entry from /etc/fstab. Specify a time in
95 seconds or explicitly append a unit as "s", "min", "h", "ms".
96 Note that this option can only be used in /etc/fstab, and will be
98 ignored when part of Options= setting in a unit file.
99 _netdev
101 Normally the file system type is used to determine if a mount is a
102 "network mount", i.e. if it should only be started after the
103 network is available. Using this option overrides this detection
104 and specifies that the mount requires network.
105 Network mount units are ordered between remote-fs-pre.target and
107 remote-fs.target, instead of local-fs-pre.target and
108 local-fs.target. They also pull in network-online.target and are
109 ordered after it and network.target.
110 noauto, auto
112 With noauto, this mount will not be added as a dependency for
113 local-fs.target or remote-fs.target. This means that it will not be
114 mounted automatically during boot, unless it is pulled in by some
115 other unit. Option auto has the opposite meaning and is the
116 default.
117 nofail
119 With nofail this mount will be only wanted, not required, by
120 local-fs.target or remote-fs.target. This means that the boot will
121 continue even if this mount point is not mounted successfully.
122 x-initrd.mount
124 An additional filesystem to be mounted in the initramfs. See
125 initrd-fs.target description in systemd.special(7).
126 If a mount point is configured in both /etc/fstab and a unit file that
128 is stored below /usr, the former will take precedence. If the unit file
129 is stored below /etc, it will take precedence. This means: native unit
130 files take precedence over traditional configuration files, but this is
131 superseded by the rule that configuration in /etc will always take
132 precedence over configuration in /usr.
133
135 Mount files must include a [Mount] section, which carries information
136 about the file system mount points it supervises. A number of options
137 that may be used in this section are shared with other unit types.
138 These options are documented in systemd.exec(5) and systemd.kill(5).
139 The options specific to the [Mount] section of mount units are the
140 following:
141 What=
143 Takes an absolute path of a device node, file or other resource to
144 mount. See mount(8) for details. If this refers to a device node, a
145 dependency on the respective device unit is automatically created.
146 (See systemd.device(5) for more information.) This option is
147 mandatory.
148 Where=
150 Takes an absolute path of a directory of the mount point. If the
151 mount point does not exist at the time of mounting, it is created.
152 This string must be reflected in the unit filename. (See above.)
153 This option is mandatory.
154 Type=
156 Takes a string for the file system type. See mount(8) for details.
157 This setting is optional.
158 Options=
160 Mount options to use when mounting. This takes a comma-separated
161 list of options. This setting is optional.
162 SloppyOptions=
164 Takes a boolean argument. If true, parsing of the options specified
165 in Options= is relaxed, and unknown mount options are tolerated.
166 This corresponds with mount(8)'s -s switch. Defaults to off.
167 LazyUnmount=
169 Takes a boolean argument. If true, detach the filesystem from the
170 filesystem hierarchy at time of the unmount operation, and clean up
171 all references to the filesystem as soon as they are not busy
172 anymore. This corresponds with umount(8)'s -l switch. Defaults to
173 off.
174 DirectoryMode=
176 Directories of mount points (and any parent directories) are
177 automatically created if needed. This option specifies the file
178 system access mode used when creating these directories. Takes an
179 access mode in octal notation. Defaults to 0755.
180 TimeoutSec=
182 Configures the time to wait for the mount command to finish. If a
183 command does not exit within the configured time, the mount will be
184 considered failed and be shut down again. All commands still
185 running will be terminated forcibly via SIGTERM, and after another
186 delay of this time with SIGKILL. (See KillMode= in
187 systemd.kill(5).) Takes a unit-less value in seconds, or a time
188 span value such as "5min 20s". Pass 0 to disable the timeout logic.
189 The default value is set from the manager configuration file's
190 DefaultTimeoutStart= variable.
191 Check systemd.exec(5) and systemd.kill(5) for more settings.
193
195 systemd(1), systemctl(1), systemd.unit(5), systemd.exec(5),
196 systemd.kill(5), systemd.resource-control(5), systemd.service(5),
197 systemd.device(5), proc(5), mount(8), systemd-fstab-generator(8),
198 systemd.directives(7)
199
201 1. API File Systems
202 http://www.freedesktop.org/wiki/Software/systemd/APIFileSystems
203systemd 219 SYSTEMD.MOUNT(5)