mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 10:51:24 -07:00
[PR #9351/4b23e5ec backport][stable-9] s[o-y]*: normalize docs (#9368)
s[o-y]*: normalize docs (#9351)
* s[o-y]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/spectrum_model_attrs.py
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 4b23e5ecff
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
e120c64a21
commit
595c105a29
20 changed files with 994 additions and 1174 deletions
|
@ -8,37 +8,35 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: syspatch
|
||||
|
||||
short_description: Manage OpenBSD system patches
|
||||
|
||||
|
||||
description:
|
||||
- "Manage OpenBSD system patches using syspatch."
|
||||
|
||||
- Manage OpenBSD system patches using syspatch.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
|
||||
options:
|
||||
revert:
|
||||
description:
|
||||
- Revert system patches.
|
||||
type: str
|
||||
choices: [ all, one ]
|
||||
revert:
|
||||
description:
|
||||
- Revert system patches.
|
||||
type: str
|
||||
choices: [all, one]
|
||||
|
||||
author:
|
||||
- Andrew Klaus (@precurse)
|
||||
'''
|
||||
- Andrew Klaus (@precurse)
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Apply all available system patches
|
||||
community.general.syspatch:
|
||||
|
||||
|
@ -58,20 +56,20 @@ EXAMPLES = '''
|
|||
- name: Reboot if patch requires it
|
||||
ansible.builtin.reboot:
|
||||
when: syspatch.reboot_needed
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
rc:
|
||||
description: The command return code (0 means success)
|
||||
description: The command return code (0 means success).
|
||||
returned: always
|
||||
type: int
|
||||
stdout:
|
||||
description: syspatch standard output.
|
||||
description: C(syspatch) standard output.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "001_rip6cksum"
|
||||
stderr:
|
||||
description: syspatch standard error.
|
||||
description: C(syspatch) standard error.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "syspatch: need root privileges"
|
||||
|
@ -80,7 +78,7 @@ reboot_needed:
|
|||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue