2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"systemd-mount"
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>systemd-mount
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>systemd-mount
</refentrytitle>
16 <manvolnum>1</manvolnum>
20 <refname>systemd-mount
</refname>
21 <refname>systemd-umount
</refname>
22 <refpurpose>Establish and destroy transient mount or auto-mount points
</refpurpose>
27 <command>systemd-mount
</command>
28 <arg choice=
"opt" rep=
"repeat"><replaceable>OPTIONS
</replaceable></arg>
29 <arg choice=
"plain"><replaceable>WHAT
</replaceable></arg>
30 <arg choice=
"opt"><replaceable>WHERE
</replaceable></arg>
33 <command>systemd-mount
</command>
34 <arg choice=
"opt" rep=
"repeat"><replaceable>OPTIONS
</replaceable></arg>
35 <arg choice=
"plain"><option>--list
</option></arg>
38 <command>systemd-mount
</command>
39 <arg choice=
"opt" rep=
"repeat"><replaceable>OPTIONS
</replaceable></arg>
40 <arg choice=
"plain"><option>--umount
</option></arg>
41 <arg choice=
"plain" rep=
"repeat"><replaceable>WHAT|WHERE
</replaceable></arg>
46 <title>Description
</title>
48 <para><command>systemd-mount
</command> may be used to create and start a transient
<filename>.mount
</filename> or
49 <filename>.automount
</filename> unit of the file system
<replaceable>WHAT
</replaceable> on the mount point
50 <replaceable>WHERE
</replaceable>.
</para>
52 <para>In many ways,
<command>systemd-mount
</command> is similar to the lower-level
53 <citerefentry project='man-pages'
><refentrytitle>mount
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
54 command, however instead of executing the mount operation directly and immediately,
55 <command>systemd-mount
</command> schedules it through the service manager job queue, so that it may pull
56 in further dependencies (such as parent mounts, or a file system checker to execute a priori), and may
57 make use of the auto-mounting logic.
</para>
59 <para>The command takes either one or two arguments. If only one argument is specified it should refer to
60 a block device or regular file containing a file system (e.g.
<literal>/dev/sdb1
</literal> or
61 <literal>/path/to/disk.img
</literal>). The block device or image file is then probed for a file system
62 label and other metadata, and is mounted to a directory below
<filename>/run/media/system/
</filename>
63 whose name is generated from the file system label. In this mode the block device or image file must
64 exist at the time of invocation of the command, so that it may be probed. If the device is found to be a
65 removable block device (e.g. a USB stick), an automount point is created instead of a regular mount point
66 (i.e. the
<option>--automount=
</option> option is implied, see below).
</para>
68 <para>If two arguments are specified, the first indicates the mount source (the
69 <replaceable>WHAT
</replaceable>) and the second indicates the path to mount it on (the
70 <replaceable>WHERE
</replaceable>). In this mode no probing of the source is attempted, and a backing
71 device node doesn't have to exist. However, if this mode is combined with
<option>--discover
</option>,
72 device node probing for additional metadata is enabled, and – much like in the single-argument case
73 discussed above – the specified device has to exist at the time of invocation of the command.
</para>
75 <para>Use the
<option>--list
</option> command to show a terse table of all local, known block devices with file
76 systems that may be mounted with this command.
</para>
78 <para><command>systemd-umount
</command> can be used to unmount a mount or automount point. It is the same
79 as
<command>systemd-mount
</command> <option>--umount
</option>.
</para>
83 <title>Options
</title>
85 <para>The following options are understood:
</para>
90 <term><option>--no-block
</option></term>
93 <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
94 be verified, enqueued and
<command>systemd-mount
</command> will wait until the mount or automount unit's
95 start-up is completed. By passing this argument, it is only verified and enqueued.
</para>
100 <term><option>-l
</option></term>
101 <term><option>--full
</option></term>
104 <para>Do not ellipsize the output when
<option>--list
</option> is specified.
</para>
108 <xi:include href=
"standard-options.xml" xpointer=
"no-pager"/>
109 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
110 <xi:include href=
"standard-options.xml" xpointer=
"no-ask-password"/>
113 <term><option>--quiet
</option></term>
114 <term><option>-q
</option></term>
116 <listitem><para>Suppresses additional informational output while running.
</para></listitem>
120 <term><option>--discover
</option></term>
122 <listitem><para>Enable probing of the mount source. This switch is implied if a single argument is specified on
123 the command line. If passed, additional metadata is read from the device to enhance the unit to create. For
124 example, a descriptive string for the transient units is generated from the file system label and device
125 model. Moreover if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
126 mount unit is created, with a short idle timeout, in order to ensure the file-system is placed in a clean
127 state quickly after each access.
</para></listitem>
131 <term><option>--type=
</option></term>
132 <term><option>-t
</option></term>
134 <listitem><para>Specifies the file system type to mount (e.g.
<literal>vfat
</literal> or
135 <literal>ext4
</literal>). If omitted or set to
<literal>auto
</literal>, the file system type is
136 determined automatically.
</para></listitem>
140 <term><option>--options=
</option></term>
141 <term><option>-o
</option></term>
143 <listitem><para>Additional mount options for the mount point.
</para></listitem>
147 <term><option>--owner=
<replaceable>USER
</replaceable></option></term>
149 <listitem><para>Let the specified user
<replaceable>USER
</replaceable> own the mounted file system.
150 This is done by appending
<option>uid=
</option> and
<option>gid=
</option> options to the list
151 of mount options. Only certain file systems support this option.
</para></listitem>
155 <term><option>--fsck=
</option></term>
157 <listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
158 immediately before the mount operation. In the automount case (see
<option>--automount=
</option> below) the
159 check will be run the moment the first access to the device is made, which might slightly delay the
160 access.
</para></listitem>
164 <term><option>--description=
</option></term>
166 <listitem><para>Provide a description for the mount or automount unit. See
<varname>Description=
</varname> in
167 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
172 <term><option>--property=
</option></term>
173 <term><option>-p
</option></term>
175 <listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
176 format as
<citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
177 <command>set-property
</command> command.
</para>
182 <term><option>--automount=
</option></term>
184 <listitem><para>Takes a boolean argument. Controls whether to create an automount point or a regular mount
185 point. If true an automount point is created that is backed by the actual file system at the time of first
186 access. If false a plain mount point is created that is backed by the actual file system immediately. Automount
187 points have the benefit that the file system stays unmounted and hence in clean state until it is first
188 accessed. In automount mode the
<option>--timeout-idle-sec=
</option> switch (see below) may be used to ensure
189 the mount point is unmounted automatically after the last access and an idle period passed.
</para>
191 <para>If this switch is not specified it defaults to false. If not specified and
<option>--discover
</option> is
192 used (or only a single argument passed, which implies
<option>--discover
</option>, see above), and the file
193 system block device is detected to be removable, it is set to true, in order to increase the chance that the
194 file system is in a fully clean state if the device is unplugged abruptly.
</para></listitem>
198 <term><option>-A
</option></term>
200 <listitem><para>Equivalent to
<option>--automount=yes
</option>.
</para></listitem>
204 <term><option>--timeout-idle-sec=
</option></term>
206 <listitem><para>Takes a time value that controls the idle timeout in automount mode. If set to
207 <literal>infinity
</literal> (the default) no automatic unmounts are done. Otherwise the file system backing the
208 automount point is detached after the last access and the idle timeout passed. See
209 <citerefentry><refentrytitle>systemd.time
</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on
210 the time syntax supported. This option has no effect if only a regular mount is established, and automounting
213 <para>Note that if
<option>--discover
</option> is used (or only a single argument passed, which implies
214 <option>--discover
</option>, see above), and the file system block device is detected to be removable,
215 <option>--timeout-idle-sec=
1s
</option> is implied.
</para></listitem>
219 <term><option>--automount-property=
</option></term>
221 <listitem><para>Similar to
<option>--property=
</option>, but applies additional properties to the automount
222 unit created, instead of the mount unit.
</para></listitem>
226 <term><option>--bind-device
</option></term>
228 <listitem><para>This option only has an effect in automount mode,
229 and controls whether the automount unit shall be bound to the backing device's lifetime. If set, the
230 automount unit will be stopped automatically when the backing device vanishes. By default the automount unit
231 stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
232 in case of non-device mounts, such as network or virtual file system mounts.
</para>
234 <para>Note that if
<option>--discover
</option> is used (or only a single argument passed, which implies
235 <option>--discover
</option>, see above), and the file system block device is detected to be removable, this
236 option is implied.
</para></listitem>
240 <term><option>--list
</option></term>
242 <listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
243 containing file systems that may be mounted with
<literal>systemd-mount
</literal>, along with useful metadata
244 such as labels, etc.
</para></listitem>
248 <term><option>-u
</option></term>
249 <term><option>--umount
</option></term>
251 <listitem><para>Stop the mount and automount units corresponding to the specified mount points
252 <replaceable>WHERE
</replaceable> or the devices
<replaceable>WHAT
</replaceable>.
253 <command>systemd-mount
</command> with this option or
<command>systemd-umount
</command> can take multiple arguments
254 which can be mount points, devices,
<filename>/etc/fstab
</filename> style node names, or backing files
255 corresponding to loop devices, like
256 <command>systemd-mount --umount /path/to/umount /dev/sda1 UUID=xxxxxx-xxxx LABEL=xxxxx /path/to/disk.img
</command>.
257 Note that when
<option>-H
</option> or
<option>-M
</option> is specified, only absolute paths to mount points are
258 supported.
</para></listitem>
262 <term><option>-G
</option></term>
263 <term><option>--collect
</option></term>
265 <listitem><para>Unload the transient unit after it completed, even if it failed. Normally, without this option,
266 all mount units that mount and failed are kept in memory until the user explicitly resets their failure state with
267 <command>systemctl reset-failed
</command> or an equivalent command. On the other hand, units that stopped
268 successfully are unloaded immediately. If this option is turned on the
"garbage collection" of units is more
269 aggressive, and unloads units regardless if they exited successfully or failed. This option is a shortcut for
270 <command>--property=CollectMode=inactive-or-failed
</command>, see the explanation for
271 <varname>CollectMode=
</varname> in
272 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry> for further
273 information.
</para></listitem>
276 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
277 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
278 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
279 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
281 <xi:include href=
"standard-options.xml" xpointer=
"help" />
282 <xi:include href=
"standard-options.xml" xpointer=
"version" />
288 <title>Exit status
</title>
290 <para>On success,
0 is returned, a non-zero failure
291 code otherwise.
</para>
295 <title>The udev Database
</title>
297 <para>If
<option>--discover
</option> is used,
<command>systemd-mount
</command> honors a couple of additional udev
298 properties of block devices:
</para>
300 <variablelist class='udev-directives'
>
302 <term><varname>SYSTEMD_MOUNT_OPTIONS=
</varname></term>
304 <listitem><para>The mount options to use, if
<option>--options=
</option> is not used.
</para></listitem>
308 <term><varname>SYSTEMD_MOUNT_WHERE=
</varname></term>
310 <listitem><para>The file system path to place the mount point at, instead of the automatically generated
311 one.
</para></listitem>
317 <title>Example
</title>
319 <para>Use a udev rule like the following to automatically mount all USB storage plugged in:
</para>
321 <programlisting>ACTION==
"add", SUBSYSTEMS==
"usb", SUBSYSTEM==
"block", ENV{ID_FS_USAGE}==
"filesystem", \
322 RUN{program}+=
"/usr/bin/systemd-mount --no-block --automount=yes --collect $devnode"</programlisting>
326 <title>See Also
</title>
328 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
329 <citerefentry project='man-pages'
><refentrytitle>mount
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
330 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
331 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
332 <citerefentry><refentrytitle>systemd.mount
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
333 <citerefentry><refentrytitle>systemd.automount
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
334 <citerefentry><refentrytitle>systemd-run
</refentrytitle><manvolnum>1</manvolnum></citerefentry>