1
0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-30 18:43:09 +03:00

[a-n]*.py: normalize doc_fragments (#9422)

* [a-n]*.py: normalize doc_fragments

* Update plugins/doc_fragments/ldap.py

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

* Update plugins/doc_fragments/ldap.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-28 02:30:17 +13:00
committed by GitHub
parent 2a2a9661d9
commit ed092956ba
20 changed files with 346 additions and 359 deletions

View File

@ -11,72 +11,72 @@ __metaclass__ = type
class ModuleDocFragment(object):
# Parameters for influxdb modules
DOCUMENTATION = r'''
DOCUMENTATION = r"""
options:
hostname:
description:
- The hostname or IP address on which InfluxDB server is listening.
- The hostname or IP address on which InfluxDB server is listening.
type: str
default: localhost
username:
description:
- Username that will be used to authenticate against InfluxDB server.
- Username that will be used to authenticate against InfluxDB server.
type: str
default: root
aliases: [ login_username ]
aliases: [login_username]
password:
description:
- Password that will be used to authenticate against InfluxDB server.
- Password that will be used to authenticate against InfluxDB server.
type: str
default: root
aliases: [ login_password ]
aliases: [login_password]
port:
description:
- The port on which InfluxDB server is listening.
- The port on which InfluxDB server is listening.
type: int
default: 8086
path:
description:
- The path on which InfluxDB server is accessible.
- Only available when using python-influxdb >= 5.1.0.
- The path on which InfluxDB server is accessible.
- Only available when using python-influxdb >= 5.1.0.
type: str
default: ''
version_added: '0.2.0'
validate_certs:
description:
- If set to V(false), the SSL certificates will not be validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
- If set to V(false), the SSL certificates will not be validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
type: bool
default: true
ssl:
description:
- Use https instead of http to connect to InfluxDB server.
- Use https instead of http to connect to InfluxDB server.
type: bool
default: false
timeout:
description:
- Number of seconds Requests will wait for client to establish a connection.
- Number of seconds Requests will wait for client to establish a connection.
type: int
retries:
description:
- Number of retries client will try before aborting.
- V(0) indicates try until success.
- Only available when using python-influxdb >= 4.1.0.
- Number of retries client will try before aborting.
- V(0) indicates try until success.
- Only available when using C(python-influxdb) >= 4.1.0.
type: int
default: 3
use_udp:
description:
- Use UDP to connect to InfluxDB server.
- Use UDP to connect to InfluxDB server.
type: bool
default: false
udp_port:
description:
- UDP port to connect to InfluxDB server.
- UDP port to connect to InfluxDB server.
type: int
default: 4444
proxies:
description:
- HTTP(S) proxy to use for Requests to connect to InfluxDB server.
- HTTP(S) proxy to use for Requests to connect to InfluxDB server.
type: dict
default: {}
'''
"""