Documentation

mount - Control active and configured mount points

Synopsis

This module controls active and configured mount points in /etc/fstab.

Options

parameter required default choices comments
dump
no
    dump (see fstab(5)), Note that if nulled, state=present will cease to work and duplicate entries will be made with subsequent runs.
    fstab
    no /etc/fstab
      file to use instead of /etc/fstab. You shouldn't use that option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment.
      fstype
      yes
        file-system type
        name
        yes
          path to the mount point, eg: /mnt/files
          opts
          no
            mount options (see fstab(5))
            passno
            no
              passno (see fstab(5)), Note that if nulled, state=present will cease to work and duplicate entries will be made with subsequent runs.
              src
              yes
                device to be mounted on name.
                state
                yes
                • present
                • absent
                • mounted
                • unmounted
                If mounted or unmounted, the device will be actively mounted or unmounted as needed and appropriately configured in fstab.
                absent and present only deal with fstab but will not affect current mounting.
                If specifying mounted and the mount point is not present, the mount point will be created. Similarly.
                Specifying absent will remove the mount point directory.

                Examples

                # Mount DVD read-only
                - mount: name=/mnt/dvd src=/dev/sr0 fstype=iso9660 opts=ro state=present
                
                # Mount up device by label
                - mount: name=/srv/disk src='LABEL=SOME_LABEL' fstype=ext4 state=present
                
                # Mount up device by UUID
                - mount: name=/home src='UUID=b3e48f45-f933-4c8e-a700-22a159ec9077' fstype=xfs opts=noatime state=present
                

                This is a Core Module

                For more information on what this means please read Core Modules

                For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.