mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 06:30:19 -07:00
[PR #8983/5b4f4174 backport][stable-9] Update docs with references to man pages (#8994)
Update docs with references to man pages (#8983)
* update docs with references to man pages
* reformat module docs
* gconftool2/_info: docs adjustments
(cherry picked from commit 5b4f41748d
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
2766898ea8
commit
bc4fda8b14
10 changed files with 461 additions and 434 deletions
|
@ -10,15 +10,20 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
author: Kairo Araujo (@kairoaraujo)
|
||||
module: mksysb
|
||||
short_description: Generates AIX mksysb rootvg backups
|
||||
description:
|
||||
- This module manages a basic AIX mksysb (image) of rootvg.
|
||||
- This module manages a basic AIX mksysb (image) of rootvg.
|
||||
seealso:
|
||||
- name: C(mksysb) command manual page
|
||||
description: Manual page for the command.
|
||||
link: https://www.ibm.com/docs/en/aix/7.3?topic=m-mksysb-command
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
|
@ -27,72 +32,73 @@ attributes:
|
|||
options:
|
||||
backup_crypt_files:
|
||||
description:
|
||||
- Backup encrypted files.
|
||||
- Backup encrypted files.
|
||||
type: bool
|
||||
default: true
|
||||
backup_dmapi_fs:
|
||||
description:
|
||||
- Back up DMAPI filesystem files.
|
||||
- Back up DMAPI filesystem files.
|
||||
type: bool
|
||||
default: true
|
||||
create_map_files:
|
||||
description:
|
||||
- Creates a new MAP files.
|
||||
- Creates a new MAP files.
|
||||
type: bool
|
||||
default: false
|
||||
exclude_files:
|
||||
description:
|
||||
- Excludes files using C(/etc/rootvg.exclude).
|
||||
- Excludes files using C(/etc/rootvg.exclude).
|
||||
type: bool
|
||||
default: false
|
||||
exclude_wpar_files:
|
||||
description:
|
||||
- Excludes WPAR files.
|
||||
- Excludes WPAR files.
|
||||
type: bool
|
||||
default: false
|
||||
extended_attrs:
|
||||
description:
|
||||
- Backup extended attributes.
|
||||
- Backup extended attributes.
|
||||
type: bool
|
||||
default: true
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- Backup name
|
||||
- Backup name
|
||||
required: true
|
||||
new_image_data:
|
||||
description:
|
||||
- Creates a new file data.
|
||||
- Creates a new file data.
|
||||
type: bool
|
||||
default: true
|
||||
software_packing:
|
||||
description:
|
||||
- Exclude files from packing option listed in
|
||||
C(/etc/exclude_packing.rootvg).
|
||||
- Exclude files from packing option listed in C(/etc/exclude_packing.rootvg).
|
||||
type: bool
|
||||
default: false
|
||||
storage_path:
|
||||
type: str
|
||||
description:
|
||||
- Storage path where the mksysb will stored.
|
||||
- Storage path where the mksysb will stored.
|
||||
required: true
|
||||
use_snapshot:
|
||||
description:
|
||||
- Creates backup using snapshots.
|
||||
- Creates backup using snapshots.
|
||||
type: bool
|
||||
default: false
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = """
|
||||
---
|
||||
- name: Running a backup image mksysb
|
||||
community.general.mksysb:
|
||||
name: myserver
|
||||
storage_path: /repository/images
|
||||
exclude_files: true
|
||||
exclude_wpar_files: true
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = """
|
||||
---
|
||||
changed:
|
||||
description: Return changed for mksysb actions as true or false.
|
||||
returned: always
|
||||
|
@ -101,7 +107,7 @@ msg:
|
|||
description: Return message regarding the action.
|
||||
returned: always
|
||||
type: str
|
||||
'''
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue