1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/doc_fragments/influxdb.py

83 lines
2.3 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
# -*- coding: utf-8 -*-
# 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
2020-03-09 10:11:07 +01:00
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
2020-03-09 10:11:07 +01:00
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 will be used to authenticate against InfluxDB server.
type: str
default: root
aliases: [ login_username ]
password:
description:
- Password that will be used to authenticate against InfluxDB server.
type: str
default: root
aliases: [ login_password ]
port:
description:
- The port on which InfluxDB server is listening.
2020-03-09 10:11:07 +01:00
type: int
default: 8086
path:
description:
- The path on which InfluxDB server is accessible.
- Only available when using python-influxdb >= 5.1.0.
2020-03-09 10:11:07 +01:00
type: str
2022-11-01 19:25:51 +01:00
default: ''
version_added: '0.2.0'
2020-03-09 10:11:07 +01:00
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.
2020-03-09 10:11:07 +01:00
type: bool
default: true
2020-03-09 10:11:07 +01:00
ssl:
description:
- Use https instead of http to connect to InfluxDB server.
type: bool
2020-11-23 12:14:43 +01:00
default: false
2020-03-09 10:11:07 +01:00
timeout:
description:
- 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.
2020-03-09 10:11:07 +01:00
type: int
default: 3
use_udp:
description:
- Use UDP to connect to InfluxDB server.
type: bool
2020-11-23 12:14:43 +01:00
default: false
2020-03-09 10:11:07 +01:00
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
2022-11-01 19:25:51 +01:00
default: {}
2020-03-09 10:11:07 +01:00
'''