man/systemd-mount.xml

   1 <?xml version='1.0'?>
   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+ -->
   5
   6 <refentry id="systemd-mount"
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-mount</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-mount</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-mount</refname>
  21     <refname>systemd-umount</refname>
  22     <refpurpose>Establish and destroy transient mount or auto-mount points</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <cmdsynopsis>
  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>
  31     </cmdsynopsis>
  32     <cmdsynopsis>
  33       <command>systemd-mount</command>
  34       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  35       <arg choice="plain"><option>--list</option></arg>
  36     </cmdsynopsis>
  37     <cmdsynopsis>
  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>
  42     </cmdsynopsis>
  43   </refsynopsisdiv>
  44
  45   <refsect1>
  46     <title>Description</title>
  47
  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>
  51
  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> command, however instead
  54     of executing the mount operation directly and immediately, <command>systemd-mount</command> schedules it through
  55     the service manager job queue, so that it may pull in further dependencies (such as parent mounts, or a file system
  56     checker to execute a priori), and may make use of the auto-mounting logic.</para>
  57
  58     <para>The command takes either one or two arguments. If only one argument is specified it should refer to
  59     a block device or regular file containing a file system (e.g. <literal>/dev/sdb1</literal> or
  60     <literal>/path/to/disk.img</literal>). The block device or image file is then probed for a file system
  61     label and other metadata, and is mounted to a directory below <filename>/run/media/system/</filename>
  62     whose name is generated from the file system label. In this mode the block device or image file must
  63     exist at the time of invocation of the command, so that it may be probed. If the device is found to be a
  64     removable block device (e.g. a USB stick) an automount point instead of a regular mount point is created
  65     (i.e. the <option>--automount=</option> option is implied, see below).</para>
  66
  67     <para>If two arguments are specified the first indicates the mount source (the <replaceable>WHAT</replaceable>) and
  68     the second indicates the path to mount it on (the <replaceable>WHERE</replaceable>). In this mode no probing of the
  69     source is attempted, and a backing device node doesn't have to exist yet. However, if this mode is combined with
  70     <option>--discover</option>, device node probing for additional metadata is enabled, and – much like in the
  71     single-argument case discussed above – the specified device has to exist at the time of invocation of the
  72     command.</para>
  73
  74     <para>Use the <option>--list</option> command to show a terse table of all local, known block devices with file
  75     systems that may be mounted with this command.</para>
  76
  77     <para><command>systemd-umount</command> can be used to unmount a mount or automount point. It is the same
  78     as <command>systemd-mount</command> <option>--umount</option>.</para>
  79   </refsect1>
  80
  81   <refsect1>
  82     <title>Options</title>
  83
  84     <para>The following options are understood:</para>
  85
  86     <variablelist>
  87
  88       <varlistentry>
  89         <term><option>--no-block</option></term>
  90
  91         <listitem>
  92           <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
  93           be verified, enqueued and <command>systemd-mount</command> will wait until the mount or automount unit's
  94           start-up is completed. By passing this argument, it is only verified and enqueued.</para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <xi:include href="standard-options.xml" xpointer="no-pager"/>
  99       <xi:include href="standard-options.xml" xpointer="no-ask-password"/>
 100
 101       <varlistentry>
 102         <term><option>--quiet</option></term>
 103         <term><option>-q</option></term>
 104
 105         <listitem><para>Suppresses additional informational output while running.</para></listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><option>--discover</option></term>
 110
 111         <listitem><para>Enable probing of the mount source. This switch is implied if a single argument is specified on
 112         the command line. If passed, additional metadata is read from the device to enhance the unit to create. For
 113         example, a descriptive string for the transient units is generated from the file system label and device
 114         model. Moreover if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
 115         mount unit is created, with a short idle timeout, in order to ensure the file-system is placed in a clean
 116         state quickly after each access.</para></listitem>
 117       </varlistentry>
 118
 119       <varlistentry>
 120         <term><option>--type=</option></term>
 121         <term><option>-t</option></term>
 122
 123         <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal>, <literal>ext4</literal>,
 124         …). If omitted (or set to <literal>auto</literal>) the file system is determined automatically.</para></listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term><option>--options=</option></term>
 129         <term><option>-o</option></term>
 130
 131         <listitem><para>Additional mount options for the mount point.</para></listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term><option>--owner=<replaceable>USER</replaceable></option></term>
 136
 137         <listitem><para>Let the specified user <replaceable>USER</replaceable> own the mounted file system.
 138         This is done by appending <option>uid=</option> and <option>gid=</option> options to the list
 139         of mount options. Only certain file systems support this option.</para></listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term><option>--fsck=</option></term>
 144
 145         <listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
 146         immediately before the mount operation. In the automount case (see <option>--automount=</option> below) the
 147         check will be run the moment the first access to the device is made, which might slightly delay the
 148         access.</para></listitem>
 149       </varlistentry>
 150
 151       <varlistentry>
 152         <term><option>--description=</option></term>
 153
 154         <listitem><para>Provide a description for the mount or automount unit. See <varname>Description=</varname> in
 155         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 156         </para></listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term><option>--property=</option></term>
 161         <term><option>-p</option></term>
 162
 163         <listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
 164         format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
 165         <command>set-property</command> command.</para>
 166         </listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term><option>--automount=</option></term>
 171
 172         <listitem><para>Takes a boolean argument. Controls whether to create an automount point or a regular mount
 173         point. If true an automount point is created that is backed by the actual file system at the time of first
 174         access. If false a plain mount point is created that is backed by the actual file system immediately. Automount
 175         points have the benefit that the file system stays unmounted and hence in clean state until it is first
 176         accessed. In automount mode the <option>--timeout-idle-sec=</option> switch (see below) may be used to ensure
 177         the mount point is unmounted automatically after the last access and an idle period passed.</para>
 178
 179         <para>If this switch is not specified it defaults to false. If not specified and <option>--discover</option> is
 180         used (or only a single argument passed, which implies <option>--discover</option>, see above), and the file
 181         system block device is detected to be removable, it is set to true, in order to increase the chance that the
 182         file system is in a fully clean state if the device is unplugged abruptly.</para></listitem>
 183       </varlistentry>
 184
 185       <varlistentry>
 186         <term><option>-A</option></term>
 187
 188         <listitem><para>Equivalent to <option>--automount=yes</option>.</para></listitem>
 189       </varlistentry>
 190
 191       <varlistentry>
 192         <term><option>--timeout-idle-sec=</option></term>
 193
 194         <listitem><para>Takes a time value that controls the idle timeout in automount mode. If set to
 195         <literal>infinity</literal> (the default) no automatic unmounts are done. Otherwise the file system backing the
 196         automount point is detached after the last access and the idle timeout passed. See
 197         <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on
 198         the time syntax supported. This option has no effect if only a regular mount is established, and automounting
 199         is not used.</para>
 200
 201         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 202         <option>--discover</option>, see above), and the file system block device is detected to be removable,
 203         <option>--timeout-idle-sec=1s</option> is implied.</para></listitem>
 204       </varlistentry>
 205
 206       <varlistentry>
 207         <term><option>--automount-property=</option></term>
 208
 209         <listitem><para>Similar to <option>--property=</option>, but applies additional properties to the automount
 210         unit created, instead of the mount unit.</para></listitem>
 211       </varlistentry>
 212
 213       <varlistentry>
 214         <term><option>--bind-device</option></term>
 215
 216         <listitem><para>This option only has an effect in automount mode,
 217         and controls whether the automount unit shall be bound to the backing device's lifetime. If set, the
 218         automount point will be removed automatically when the backing device vanishes. By default the automount point
 219         stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
 220         in case of non-device mounts, such as network or virtual file system mounts.</para>
 221
 222         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 223         <option>--discover</option>, see above), and the file system block device is detected to be removable, this
 224         option is implied.</para></listitem>
 225       </varlistentry>
 226
 227       <varlistentry>
 228         <term><option>--list</option></term>
 229
 230         <listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
 231         containing file systems that may be mounted with <literal>systemd-mount</literal>, along with useful metadata
 232         such as labels, etc.</para></listitem>
 233       </varlistentry>
 234
 235       <varlistentry>
 236         <term><option>-u</option></term>
 237         <term><option>--umount</option></term>
 238
 239         <listitem><para>Stop the mount and automount units corresponding to the specified mount points
 240         <replaceable>WHERE</replaceable> or the devices <replaceable>WHAT</replaceable>.
 241         <command>systemd-mount</command> with this option or <command>systemd-umount</command> can take multiple arguments
 242         which can be mount points, devices, <filename>/etc/fstab</filename> style node names, or backing files
 243         corresponding to loop devices, like
 244         <command>systemd-mount --umount /path/to/umount /dev/sda1 UUID=xxxxxx-xxxx LABEL=xxxxx /path/to/disk.img</command>.
 245         Note that when <option>-H</option> or <option>-M</option> is specified, only absolute paths to mount points are
 246         supported.</para></listitem>
 247       </varlistentry>
 248
 249       <varlistentry>
 250         <term><option>-G</option></term>
 251         <term><option>--collect</option></term>
 252
 253         <listitem><para>Unload the transient unit after it completed, even if it failed. Normally, without this option,
 254         all mount units that mount and failed are kept in memory until the user explicitly resets their failure state with
 255         <command>systemctl reset-failed</command> or an equivalent command. On the other hand, units that stopped
 256         successfully are unloaded immediately. If this option is turned on the "garbage collection" of units is more
 257         aggressive, and unloads units regardless if they exited successfully or failed. This option is a shortcut for
 258         <command>--property=CollectMode=inactive-or-failed</command>, see the explanation for
 259         <varname>CollectMode=</varname> in
 260         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for further
 261         information.</para></listitem>
 262       </varlistentry>
 263
 264       <xi:include href="user-system-options.xml" xpointer="user" />
 265       <xi:include href="user-system-options.xml" xpointer="system" />
 266       <xi:include href="user-system-options.xml" xpointer="host" />
 267       <xi:include href="user-system-options.xml" xpointer="machine" />
 268
 269       <xi:include href="standard-options.xml" xpointer="help" />
 270       <xi:include href="standard-options.xml" xpointer="version" />
 271     </variablelist>
 272
 273   </refsect1>
 274
 275   <refsect1>
 276     <title>Exit status</title>
 277
 278     <para>On success, 0 is returned, a non-zero failure
 279     code otherwise.</para>
 280   </refsect1>
 281
 282   <refsect1>
 283     <title>The udev Database</title>
 284
 285     <para>If <option>--discover</option> is used, <command>systemd-mount</command> honors a couple of additional udev
 286     properties of block devices:</para>
 287
 288     <variablelist class='udev-directives'>
 289       <varlistentry>
 290         <term><varname>SYSTEMD_MOUNT_OPTIONS=</varname></term>
 291
 292         <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para></listitem>
 293       </varlistentry>
 294
 295       <varlistentry>
 296         <term><varname>SYSTEMD_MOUNT_WHERE=</varname></term>
 297
 298         <listitem><para>The file system path to place the mount point at, instead of the automatically generated
 299         one.</para></listitem>
 300       </varlistentry>
 301     </variablelist>
 302   </refsect1>
 303
 304   <refsect1>
 305     <title>Example</title>
 306
 307     <para>Use a udev rule like the following to automatically mount all USB storage plugged in:</para>
 308
 309     <programlisting>ACTION=="add", SUBSYSTEMS=="usb", SUBSYSTEM=="block", ENV{ID_FS_USAGE}=="filesystem", \
 310         RUN{program}+="/usr/bin/systemd-mount --no-block --automount=yes --collect $devnode"</programlisting>
 311   </refsect1>
 312
 313   <refsect1>
 314     <title>See Also</title>
 315     <para>
 316       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 317       <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 318       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 319       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 320       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 321       <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 322       <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 323     </para>
 324   </refsect1>
 325
 326 </refentry>