mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 19:01:26 -07:00
[PR #9352/9fc3092b backport][stable-9] s[e-n]*: normalize docs (#9398)
s[e-n]*: normalize docs (#9352)
* s[e-n]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* quote line with : and remove extraneous notes
* Update plugins/modules/slack.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/seport.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 9fc3092bb3
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
c64705474d
commit
7506742c38
20 changed files with 627 additions and 689 deletions
|
@ -8,8 +8,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: sensu_client
|
||||
author: "David Moreau Simard (@dmsimard)"
|
||||
short_description: Manages Sensu client configuration
|
||||
|
@ -27,8 +26,8 @@ options:
|
|||
state:
|
||||
type: str
|
||||
description:
|
||||
- Whether the client should be present or not
|
||||
choices: [ 'present', 'absent' ]
|
||||
- Whether the client should be present or not.
|
||||
choices: ['present', 'absent']
|
||||
default: present
|
||||
name:
|
||||
type: str
|
||||
|
@ -49,7 +48,8 @@ options:
|
|||
- The subscriptions array items must be strings.
|
||||
safe_mode:
|
||||
description:
|
||||
- If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the check.
|
||||
- If safe mode is enabled for the client. Safe mode requires local check definitions in order to accept a check request and execute the
|
||||
check.
|
||||
type: bool
|
||||
default: false
|
||||
redact:
|
||||
|
@ -99,11 +99,9 @@ options:
|
|||
type: dict
|
||||
description:
|
||||
- The servicenow definition scope, used to configure the Sensu Enterprise ServiceNow integration (Sensu Enterprise users only).
|
||||
notes:
|
||||
- Check mode is supported
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
# Minimum possible configuration
|
||||
- name: Configure Sensu client
|
||||
community.general.sensu_client:
|
||||
|
@ -146,20 +144,20 @@ EXAMPLES = '''
|
|||
- name: Delete the Sensu client configuration
|
||||
community.general.sensu_client:
|
||||
state: "absent"
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
config:
|
||||
description: Effective client configuration, when state is present
|
||||
description: Effective client configuration, when state is present.
|
||||
returned: success
|
||||
type: dict
|
||||
sample: {'name': 'client', 'subscriptions': ['default']}
|
||||
file:
|
||||
description: Path to the client configuration file
|
||||
description: Path to the client configuration file.
|
||||
returned: success
|
||||
type: str
|
||||
sample: "/etc/sensu/conf.d/client.json"
|
||||
'''
|
||||
"""
|
||||
|
||||
import json
|
||||
import os
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue