/ home / ansible / ansible.builtin / v2.9.27 / module / zfs

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

Manage zfs

| "added in version" 1.1 of ansible.builtin"

Authors: Johan Wiren (@johanwiren)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.9.27

Description

Manages ZFS file systems, volumes, clones and snapshots

Usage examples

Scanned by Steampunk Spotter

- name: Create a new file system called myfs in pool rpool with the setuid property turned off
  zfs:
    name: rpool/myfs
    state: present
    extra_zfs_properties:
      setuid: off

Scanned by Steampunk Spotter

- name: Create a new volume called myvol in pool rpool.
  zfs:
    name: rpool/myvol
    state: present
    extra_zfs_properties:
      volsize: 10M

Scanned by Steampunk Spotter

- name: Create a snapshot of rpool/myfs file system.
  zfs:
    name: rpool/myfs@mysnapshot
    state: present

Scanned by Steampunk Spotter

- name: Create a new file system called myfs2 with snapdir enabled
  zfs:
    name: rpool/myfs2
    state: present
    extra_zfs_properties:
      snapdir: enabled

Scanned by Steampunk Spotter

- name: Create a new file system by cloning a snapshot
  zfs:
    name: rpool/cloned_fs
    state: present
    origin: rpool/myfs@mysnapshot

Scanned by Steampunk Spotter

- name: Destroy a filesystem
  zfs:
    name: rpool/myfs
    state: absent

Inputs

    
name:
    description:
    - File system, snapshot or volume name e.g. C(rpool/myfs).
    required: true

state:
    choices:
    - absent
    - present
    description:
    - Whether to create (C(present)), or remove (C(absent)) a file system, snapshot or
      volume. All parents/children will be created/destroyed as needed to reach the desired
      state.
    required: true

origin:
    description:
    - Snapshot from which to create a clone.

extra_zfs_properties:
    description:
    - A dictionary of zfs properties to be set.
    - See the zfs(8) man page for more information.
    version_added: '2.5'
    version_added_collection: ansible.builtin

Install Ansible via pip

Description

Usage examples

Inputs

Install Ansible via `pip`