ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-26 12:21:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

zfs modules: adjust docs (#9281)

Browse source 
* zfs modules: adjust docs

* Apply suggestions from code review

* fix examples indentation

* Update plugins/modules/zfs.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-22 11:42:54 +13:00 • committed by GitHub
parent afa5716e0b
commit 1b6c05176b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 140 additions and 149 deletions
Download patch file Download diff file Expand all files Collapse all files

30
plugins/modules/zfs.py
View file

@ -9,23 +9,20 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: zfs
short_description: Manage zfs
short_description: Manage ZFS
description:
- Manages ZFS file systems, volumes, clones and snapshots
- Manages ZFS file systems, volumes, clones and snapshots.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: partial
details:
- In certain situations it may report a task as changed that will not be reported
as changed when C(check_mode) is disabled.
- For example, this might occur when the zpool C(altroot) option is set or when
a size is written using human-readable notation, such as V(1M) or V(1024K),
instead of as an unqualified byte count, such as V(1048576).
- In certain situations it may report a task as changed that will not be reported as changed when C(check_mode) is disabled.
- For example, this might occur when the zpool C(altroot) option is set or when a size is written using human-readable notation, such as
V(1M) or V(1024K), instead of as an unqualified byte count, such as V(1048576).
diff_mode:
support: full
options:
@ -36,10 +33,9 @@ options:
type: str
state:
description:
- Whether to create (V(present)), or remove (V(absent)) a
file system, snapshot or volume. All parents/children
will be created/destroyed as needed to reach the desired state.
choices: [ absent, present ]
- Whether to create (V(present)), or remove (V(absent)) a file system, snapshot or volume. All parents/children will be created/destroyed
as needed to reach the desired state.
choices: [absent, present]
required: true
type: str
origin:
@ -53,10 +49,10 @@ options:
type: dict
default: {}
author:
- Johan Wiren (@johanwiren)
'''
- Johan Wiren (@johanwiren)
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a new file system called myfs in pool rpool with the setuid property turned off
community.general.zfs:
name: rpool/myfs
@ -93,7 +89,7 @@ EXAMPLES = '''
community.general.zfs:
name: rpool/myfs
state: absent
'''
"""
import os