community.general.zfs_facts module – Gather facts about ZFS datasets.

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.zfs_facts.

Synopsis

  • Gather facts from ZFS dataset properties.

Parameters

Parameter

Comments

depth

integer

Specifies recursion depth.

name

aliases: ds, dataset

string / required

ZFS dataset name.

parsable

boolean

Specifies if property values should be displayed in machine friendly format.

Choices:

  • no ← (default)

  • yes

properties

string

Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zfs(1M) man page.

Default: “all”

recurse

boolean

Specifies if properties for any children should be recursively displayed.

Choices:

  • no ← (default)

  • yes

type

string

Specifies which datasets types to display. Multiple values have to be provided in comma-separated form.

Choices:

  • all ← (default)

  • filesystem

  • volume

  • snapshot

  • bookmark

Examples

- name: Gather facts about ZFS dataset rpool/export/home
  community.general.zfs_facts:
    dataset: rpool/export/home

- name: Report space usage on ZFS filesystems under data/home
  community.general.zfs_facts:
    name: data/home
    recurse: yes
    type: filesystem

- ansible.builtin.debug:
    msg: 'ZFS dataset {{ item.name }} consumes {{ item.used }} of disk space.'
  with_items: '{{ ansible_zfs_datasets }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

name

string

ZFS dataset name

Returned: always

Sample: “rpool/var/spool”

parsable

boolean

if parsable output should be provided in machine friendly format.

Returned: if ‘parsable’ is set to True

Sample: true

recurse

boolean

if we should recurse over ZFS dataset

Returned: if ‘recurse’ is set to True

Sample: true

zfs_datasets

string

ZFS dataset facts

Returned: always

Sample: {“aclinherit”: “restricted”, “aclmode”: “discard”, “atime”: “on”, “available”: “43.8G”, “canmount”: “on”, “casesensitivity”: “sensitive”, “checksum”: “on”, “compression”: “off”, “compressratio”: “1.00x”, “copies”: “1”, “creation”: “Thu Jun 16 11:37 2016”, “dedup”: “off”, “devices”: “on”, “exec”: “on”, “filesystem_count”: “none”, “filesystem_limit”: “none”, “logbias”: “latency”, “logicalreferenced”: “18.5K”, “logicalused”: “3.45G”, “mlslabel”: “none”, “mounted”: “yes”, “mountpoint”: “/rpool”, “name”: “rpool”, “nbmand”: “off”, “normalization”: “none”, “org.openindiana.caiman:install”: “ready”, “primarycache”: “all”, “quota”: “none”, “readonly”: “off”, “recordsize”: “128K”, “redundant_metadata”: “all”, “refcompressratio”: “1.00x”, “referenced”: “29.5K”, “refquota”: “none”, “refreservation”: “none”, “reservation”: “none”, “secondarycache”: “all”, “setuid”: “on”, “sharenfs”: “off”, “sharesmb”: “off”, “snapdir”: “hidden”, “snapshot_count”: “none”, “snapshot_limit”: “none”, “sync”: “standard”, “type”: “filesystem”, “used”: “4.41G”, “usedbychildren”: “4.41G”, “usedbydataset”: “29.5K”, “usedbyrefreservation”: “0”, “usedbysnapshots”: “0”, “utf8only”: “off”, “version”: “5”, “vscan”: “off”, “written”: “29.5K”, “xattr”: “on”, “zoned”: “off”}

Authors

  • Adam Števko (@xen0l)