mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-24 04:54:00 -07:00
8f8a0e1d7c
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* Adjust all __future__ imports: for i in $(grep -REl "__future__.*absolute_import" plugins/ tests/); do sed -e 's/from __future__ import .*/from __future__ import annotations/g' -i $i; done * Remove all UTF-8 encoding specifications for Python source files: for i in $(grep -REl '[-][*]- coding: utf-8 -[*]-' plugins/ tests/); do sed -e '/^# -\*- coding: utf-8 -\*-/d' -i $i; done * Remove __metaclass__ = type: for i in $(grep -REl '__metaclass__ = type' plugins/ tests/); do sed -e '/^__metaclass__ = type/d' -i $i; done
80 lines
2.2 KiB
Python
80 lines
2.2 KiB
Python
|
|
# Copyright (c) 2017, Ansible Project
|
|
# Copyright (c) 2017, Abhijeet Kasurde (akasurde@redhat.com)
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
# Parameters for influxdb modules
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
hostname:
|
|
description:
|
|
- The hostname or IP address on which InfluxDB server is listening.
|
|
type: str
|
|
default: localhost
|
|
username:
|
|
description:
|
|
- Username that is used to authenticate against InfluxDB server.
|
|
type: str
|
|
default: root
|
|
aliases: [login_username]
|
|
password:
|
|
description:
|
|
- Password that is used to authenticate against InfluxDB server.
|
|
type: str
|
|
default: root
|
|
aliases: [login_password]
|
|
port:
|
|
description:
|
|
- 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.
|
|
type: str
|
|
default: ''
|
|
version_added: '0.2.0'
|
|
validate_certs:
|
|
description:
|
|
- If set to V(false), the SSL certificates are not 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.
|
|
type: bool
|
|
default: false
|
|
timeout:
|
|
description:
|
|
- Number of seconds Requests waits for client to establish a connection.
|
|
type: int
|
|
retries:
|
|
description:
|
|
- Number of retries client performs 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.
|
|
type: bool
|
|
default: false
|
|
udp_port:
|
|
description:
|
|
- 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.
|
|
type: dict
|
|
default: {}
|
|
"""
|