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
boot
(added in 2.2)
no True
  • yes
  • no
Determines if the filesystem should be mounted on boot.
Only applies to Solaris systems.
dump
no
Dump (see fstab(5)). Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
Has no effect on Solaris systems.
fstab
no /etc/fstab (/etc/vfstab on Solaris)
File to use instead of /etc/fstab. You shouldn't use this option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment. OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem.
fstype
no
Filesystem type. Required when state is present or mounted.
opts
no
Mount options (see fstab(5), or vfstab(4) on Solaris).
passno
no
Passno (see fstab(5)). Note that if set to null and state set to present, it will cease to work and duplicate entries will be made with subsequent runs.
Deprecated on Solaris systems.
path
yes
Path to the mount point (e.g. /mnt/files).
Before 2.3 this option was only usable as dest, destfile and name.

aliases: name
src
no
Device to be mounted on path. Required when state set to present or mounted.
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

# Before 2.3, option 'name' was used instead of 'path'
- name: Mount DVD read-only
  mount:
    path: /mnt/dvd
    src: /dev/sr0
    fstype: iso9660
    opts: ro
    state: present

- name: Mount up device by label
  mount:
    path: /srv/disk
    src: LABEL=SOME_LABEL
    fstype: ext4
    state: present

- name: Mount up device by UUID
  mount:
    path: /home
    src: UUID=b3e48f45-f933-4c8e-a700-22a159ec9077
    fstype: xfs
    opts: noatime
    state: present

Notes

Note

  • As of Ansible 2.3, the name option has been changed to path as default, but name still works as well.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is maintained by those with core commit privileges

For more information on what this means please read Module Support

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