New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
depth |
no | None | Specifiies recurion depth. | |
name |
yes | ZFS dataset name.
aliases: ds, dataset | ||
parsable |
no |
|
Specifies if property values should be displayed in machine friendly format. | |
properties |
no | all | Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zfs(1M) man page.
aliases: props | |
recurse |
no |
|
Specifies if properties for any children should be recursively displayed. | |
type |
no | all |
|
Specifies which datasets types to display. Multiple values have to be provided in comma-separated form.
aliases: props |
- name: Gather facts about ZFS dataset rpool/export/home zfs_facts: dataset: rpool/export/home - name: Report space usage on ZFS filesystems under data/home zfs_facts: name: data/home recurse: yes type: filesystem - debug: msg: 'ZFS dataset {{ item.name }} consumes {{ item.used }} of disk space.' with_items: '{{ ansible_zfs_datasets }}'
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
parsable | if parsable output should be provided in machine friendly format. | if 'parsable' is set to True | boolean | True |
recurse | if we should recurse over ZFS dataset | if 'recurse' is set to True | boolean | True |
name | ZFS dataset name | always | string | rpool/var/spool |
zfs_datasets | ZFS dataset facts | always | string | {'setuid': 'on', 'referenced': '29.5K', 'logicalused': '3.45G', 'zoned': 'off', 'primarycache': 'all', 'logbias': 'latency', 'creation': 'Thu Jun 16 11:37 2016', 'sync': 'standard', 'copies': '1', 'sharenfs': 'off', 'usedbyrefreservation': '0', 'sharesmb': 'off', 'canmount': 'on', 'mountpoint': '/rpool', 'casesensitivity': 'sensitive', 'utf8only': 'off', 'usedbysnapshots': '0', 'mounted': 'yes', 'compression': 'off', 'xattr': 'on', 'aclmode': 'discard', 'dedup': 'off', 'snapshot_limit': 'none', 'aclinherit': 'restricted', 'compressratio': '1.00x', 'readonly': 'off', 'version': '5', 'normalization': 'none', 'filesystem_limit': 'none', 'type': 'filesystem', 'secondarycache': 'all', 'logicalreferenced': '18.5K', 'available': '43.8G', 'used': '4.41G', 'exec': 'on', 'refquota': 'none', 'refcompressratio': '1.00x', 'quota': 'none', 'snapshot_count': 'none', 'written': '29.5K', 'vscan': 'off', 'reservation': 'none', 'atime': 'on', 'recordsize': '128K', 'usedbychildren': '4.41G', 'usedbydataset': '29.5K', 'org.openindiana.caiman:install': 'ready', 'name': 'rpool', 'mlslabel': 'none', 'redundant_metadata': 'all', 'filesystem_count': 'none', 'devices': 'on', 'nbmand': 'off', 'refreservation': 'none', 'checksum': 'on', 'snapdir': 'hidden'} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
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, Helping Testing PRs and Developing Modules.