community.general/rst/modules/mount.rst

.. _mount:

mount
`````

The mount module controls active and configured mount points (fstab).

+--------------------+----------+---------+----------------------------------------------------------------------------+
| parameter          | required | default | comments                                                                   |
+====================+==========+=========+============================================================================+
| name               | yes      |         | path to the mountpoint, ex: /mnt/foo                                       |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| src                | yes      |         | device to be mounted                                                       |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| fstype             | yes      |         | fstype                                                                     |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| opts               | no       |         | mount options (see fstab docs)                                             |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| dump               | no       |         | dump (see fstab docs)                                                      |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| passno             | no       |         | passno (see fstab docs)                                                    |
+--------------------+----------+---------+----------------------------------------------------------------------------+
| state              | yes      |         | 'present', 'absent', 'mounted', or 'unmounted'.  If mounted/unmounted,     |
|                    |          |         | the device will be actively mounted or unmounted as well as just           |
|                    |          |         | configured in fstab.  'absent', and 'present' only deal with fstab.        |
+--------------------+----------+---------+----------------------------------------------------------------------------+