parameter | required | default | choices | comments |
---|---|---|---|---|
key_value |
no | The zfs module takes key=value pairs for zfs properties to be set. See the zfs(8) man page for more information. | ||
name |
yes | File system, snapshot or volume name e.g. rpool/myfs | ||
origin |
no | Snapshot from which to create a clone | ||
state |
yes |
|
Whether to create ( present ), or remove (absent ) a file system, snapshot or volume. All parents/children will be created/destroyed as needed to reach the desired state. |
# Create a new file system called myfs in pool rpool with the setuid property turned off - zfs: name: rpool/myfs state: present setuid: off # Create a new volume called myvol in pool rpool. - zfs: name: rpool/myvol state: present volsize: 10M # Create a snapshot of rpool/myfs file system. - zfs: name: rpool/myfs@mysnapshot state: present # Create a new file system called myfs2 with snapdir enabled - zfs: name: rpool/myfs2 state: present snapdir: enabled # Create a new file system by cloning a snapshot - zfs: name: rpool/cloned_fs state: present origin: rpool/myfs@mysnapshot # Destroy a filesystem - zfs: name: rpool/myfs state: absent
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.