mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-21 09:51:27 -07:00
[ab]*.py: normalize docs (#9421)
* [ab]*.py: normalize docs * Update plugins/modules/atomic_image.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
43599c6850
commit
2a2a9661d9
36 changed files with 1931 additions and 2013 deletions
|
@ -9,15 +9,13 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
author:
|
||||
- Kairo Araujo (@kairoaraujo)
|
||||
module: aix_filesystem
|
||||
short_description: Configure LVM and NFS file systems for AIX
|
||||
description:
|
||||
- This module creates, removes, mount and unmount LVM and NFS file system for
|
||||
AIX using C(/etc/filesystems).
|
||||
- This module creates, removes, mount and unmount LVM and NFS file system for AIX using C(/etc/filesystems).
|
||||
- For LVM file systems is possible to resize a file system.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
|
@ -60,7 +58,7 @@ options:
|
|||
description:
|
||||
- Set file system permissions. V(rw) (read-write) or V(ro) (read-only).
|
||||
type: str
|
||||
choices: [ ro, rw ]
|
||||
choices: [ro, rw]
|
||||
default: rw
|
||||
mount_group:
|
||||
description:
|
||||
|
@ -84,9 +82,8 @@ options:
|
|||
description:
|
||||
- Specifies the file system size.
|
||||
- For already V(present) it will be resized.
|
||||
- 512-byte blocks, Megabytes or Gigabytes. If the value has M specified
|
||||
it will be in Megabytes. If the value has G specified it will be in
|
||||
Gigabytes.
|
||||
- 512-byte blocks, Megabytes or Gigabytes. If the value has M specified it will be in Megabytes. If the value has G
|
||||
specified it will be in Gigabytes.
|
||||
- If no M or G the value will be 512-byte blocks.
|
||||
- If "+" is specified in begin of value, the value will be added.
|
||||
- If "-" is specified in begin of value, the value will be removed.
|
||||
|
@ -101,7 +98,7 @@ options:
|
|||
- V(mounted) checks if the file system is mounted or mount the file system.
|
||||
- V(unmounted) check if the file system is unmounted or unmount the file system.
|
||||
type: str
|
||||
choices: [ absent, mounted, present, unmounted ]
|
||||
choices: [absent, mounted, present, unmounted]
|
||||
default: present
|
||||
vg:
|
||||
description:
|
||||
|
@ -109,9 +106,9 @@ options:
|
|||
type: str
|
||||
notes:
|
||||
- For more O(attributes), please check "crfs" AIX manual.
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Create filesystem in a previously defined logical volume.
|
||||
community.general.aix_filesystem:
|
||||
device: testlv
|
||||
|
@ -166,9 +163,9 @@ EXAMPLES = r'''
|
|||
filesystem: /newfs
|
||||
rm_mount_point: true
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
changed:
|
||||
description: Return changed for aix_filesystems actions as true or false.
|
||||
returned: always
|
||||
|
@ -177,7 +174,7 @@ msg:
|
|||
description: Return message regarding the action.
|
||||
returned: always
|
||||
type: str
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible_collections.community.general.plugins.module_utils._mount import ismount
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue