community.general.influxdb_database 模块 – 管理 InfluxDB 数据库

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要更多要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.general.influxdb_database。

概要

  • 管理 InfluxDB 数据库。

要求

执行此模块的主机需要满足以下要求。

  • influxdb >= 0.9

  • requests

参数

参数

注释

database_name

字符串 / 必需

数据库的名称。

hostname

字符串

InfluxDB 服务器正在侦听的主机名或 IP 地址。

默认值： "localhost"

password

别名：login_password

字符串

将用于对 InfluxDB 服务器进行身份验证的密码。

默认值： "root"

path

字符串

在 community.general 0.2.0 中添加

InfluxDB 服务器可访问的路径。

仅在使用 python-influxdb >= 5.1.0 时可用。

默认值： ""

port

整数

InfluxDB 服务器正在侦听的端口。

默认值： 8086

proxies

字典

用于 Requests 连接到 InfluxDB 服务器的 HTTP(S) 代理。

默认值： {}

retries

整数

客户端在中止之前将尝试的重试次数。

0 表示尝试直到成功。

仅在使用 python-influxdb >= 4.1.0 时可用。

默认值： 3

ssl

布尔值

使用 https 而不是 http 连接到 InfluxDB 服务器。

选项

  • false ← (默认)

  • true

state

字符串

确定是否应创建或销毁数据库。

选项

  • "absent"

  • "present" ← (默认)

timeout

整数

Requests 将等待客户端建立连接的秒数。

udp_port

整数

用于连接到 InfluxDB 服务器的 UDP 端口。

默认值： 4444

use_udp

布尔值

使用 UDP 连接到 InfluxDB 服务器。

选项

  • false ← (默认)

  • true

username

别名：login_username

字符串

将用于对 InfluxDB 服务器进行身份验证的用户名。

默认值： "root"

validate_certs

布尔值

如果设置为 false，则不会验证 SSL 证书。

此项应仅在个人控制的使用自签名证书的站点上设置为 false。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持： 完整

可以在 check_mode 模式下运行，并返回更改状态预测，而不会修改目标。

diff_mode

支持: 无

当处于 diff 模式时，将返回已更改（或在 check_mode 模式下可能需要更改）的详细信息。

示例

# Example influxdb_database command from Ansible Playbooks
- name: Create database
  community.general.influxdb_database:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"

- name: Destroy database
  community.general.influxdb_database:
      hostname: "{{influxdb_ip_address}}"
      database_name: "{{influxdb_database_name}}"
      state: absent

- name: Create database using custom credentials
  community.general.influxdb_database:
      hostname: "{{influxdb_ip_address}}"
      username: "{{influxdb_username}}"
      password: "{{influxdb_password}}"
      database_name: "{{influxdb_database_name}}"
      ssl: true
      validate_certs: true

作者

  • Kamil Szczygiel (@kamsz)