zpool_facts – Gather facts about ZFS pools¶
Parameters¶
Examples¶
# Gather facts about ZFS pool rpool
- zpool_facts: pool=rpool
# Gather space usage about all imported ZFS pools
- zpool_facts: properties='free,size'
- debug: msg='ZFS pool {{ item.name }} has {{ item.free }} free space out of {{ item.size }}.'
with_items: '{{ ansible_zfs_pools }}'
Returned Facts¶
Facts returned by this module are added/updated in the hostvars
host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
name
string
|
always |
ZFS pool name
Sample:
rpool
|
parsable
boolean
|
if 'parsable' is set to True |
if parsable output should be provided in machine friendly format.
Sample:
True
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Adam Števko (@xen0l)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.