ansible.builtin.mount (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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,noauto
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Unmount a mounted volume
  mount:
    path: /tmp/mnt-pnt
    state: unmounted

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Mount and bind a volume
  mount:
    path: /system/new_volume/boot
    src: /boot
    opts: bind
    state: mounted
    fstype: none

Inputs

    
src:
    description:
    - Device to be mounted on I(path).
    - Required when I(state) set to C(present) or C(mounted).
    type: path

boot:
    default: true
    description:
    - Determines if the filesystem should be mounted on boot.
    - Only applies to Solaris systems.
    type: bool
    version_added: '2.2'
    version_added_collection: ansible.builtin

dump:
    default: 0
    description:
    - Dump (see fstab(5)).
    - Note that if set to C(null) and I(state) set to C(present), it will cease to work
      and duplicate entries will be made with subsequent runs.
    - Has no effect on Solaris systems.
    type: str

opts:
    description:
    - Mount options (see fstab(5), or vfstab(4) on Solaris).
    type: str

path:
    aliases:
    - name
    description:
    - Path to the mount point (e.g. C(/mnt/files)).
    - Before Ansible 2.3 this option was only usable as I(dest), I(destfile) and I(name).
    required: true
    type: path

fstab:
    description:
    - File to use instead of C(/etc/fstab).
    - You should not 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.
    - This parameter defaults to /etc/fstab or /etc/vfstab on Solaris.
    type: str

state:
    choices:
    - absent
    - mounted
    - present
    - unmounted
    - remounted
    description:
    - If C(mounted), the device will be actively mounted and appropriately configured
      in I(fstab). If the mount point is not present, the mount point will be created.
    - If C(unmounted), the device will be unmounted without changing I(fstab).
    - C(present) only specifies that the device is to be configured in I(fstab) and does
      not trigger or require a mount.
    - C(absent) specifies that the device mount's entry will be removed from I(fstab)
      and will also unmount the device and remove the mount point.
    - C(remounted) specifies that the device will be remounted for when you want to force
      a refresh on the mount itself (added in 2.9). This will always return changed=true.
    required: true
    type: str

backup:
    default: false
    description:
    - Create a backup file including the timestamp information so you can get the original
      file back if you somehow clobbered it incorrectly.
    type: bool
    version_added: '2.5'
    version_added_collection: ansible.builtin

fstype:
    description:
    - Filesystem type.
    - Required when I(state) is C(present) or C(mounted).
    type: str

passno:
    default: 0
    description:
    - Passno (see fstab(5)).
    - Note that if set to C(null) and I(state) set to C(present), it will cease to work
      and duplicate entries will be made with subsequent runs.
    - Deprecated on Solaris systems.
    type: str