Модуль community.general.influxdb_user — управление пользователями InfluxDB

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.influxdb_user.

Краткое описание
Требования
Параметры
Атрибуты
Примеры

Краткое описание

Управление пользователями InfluxDB.

Требования

Перечисленные ниже требования необходимы на хосте, на котором выполняется этот модуль.

influxdb >= 0.9

Параметры

Параметр	Комментарии
admin boolean	Должен ли пользователь иметь роль администратора. Начиная с версии 2.8, роль также обновляется. Варианты: `false` ← (по умолчанию) `true`
grants list / elements=dictionary	Права, предоставляемые этому пользователю. Принимает список словарей с ключами «database» и «privilege». Если этот аргумент не указан, текущие права остаются без изменений. Если указан пустой список, у пользователя отзываются все права.
hostname string	Имя хоста или IP-адрес, на котором прослушивает подключения сервер InfluxDB. По умолчанию: `"localhost"`
password псевдонимы: login_password string	Пароль для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
path string добавлено в community.general 0.2.0	Путь, по которому доступен сервер InfluxDB. Доступно только при использовании python-influxdb >= 5.1.0. По умолчанию: `""`
port integer	Порт, на котором прослушивает подключения сервер InfluxDB. По умолчанию: `8086`
proxies dictionary	Прокси HTTP(S), используемый Requests для подключения к серверу InfluxDB. По умолчанию: `{}`
retries integer	Количество повторных попыток клиента перед завершением работы. `0` означает повторять попытки до успеха. Доступно только при использовании `python-influxdb` >= 4.1.0. По умолчанию: `3`
ssl boolean	Использовать https вместо http для подключения к серверу InfluxDB. Варианты: `false` ← (по умолчанию) `true`
state string	Состояние пользователя. Варианты: `"absent"` `"present"` ← (по умолчанию)
timeout integer	Количество секунд, в течение которых Requests ожидает установления соединения с клиентом.
udp_port integer	UDP-порт для подключения к серверу InfluxDB. По умолчанию: `4444`
use_udp boolean	Использовать UDP для подключения к серверу InfluxDB. Варианты: `false` ← (по умолчанию) `true`
user_name string / обязательный	Имя пользователя.
user_password string	Пароль, который будет задан пользователю.
username псевдонимы: login_username string	Имя пользователя для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
validate_certs boolean	Если задано значение `false`, SSL-сертификаты не проверяются. Задавайте это значение только для сайтов под личным контролем, использующих самоподписанные сертификаты; в остальных случаях следует использовать `false`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Create a user on localhost using default login credentials
  community.general.influxdb_user:
    user_name: john
    user_password: s3cr3t

- name: Create a user on localhost using custom login credentials
  community.general.influxdb_user:
    user_name: john
    user_password: s3cr3t
    login_username: "{{ influxdb_username }}"
    login_password: "{{ influxdb_password }}"

- name: Create an admin user on a remote host using custom login credentials
  community.general.influxdb_user:
    user_name: john
    user_password: s3cr3t
    admin: true
    hostname: "{{ influxdb_hostname }}"
    login_username: "{{ influxdb_username }}"
    login_password: "{{ influxdb_password }}"

- name: Create a user on localhost with privileges
  community.general.influxdb_user:
    user_name: john
    user_password: s3cr3t
    login_username: "{{ influxdb_username }}"
    login_password: "{{ influxdb_password }}"
    grants:
      - database: 'collectd'
        privilege: 'WRITE'
      - database: 'graphite'
        privilege: 'READ'

- name: Destroy a user using custom login credentials
  community.general.influxdb_user:
    user_name: john
    login_username: "{{ influxdb_username }}"
    login_password: "{{ influxdb_password }}"
    state: absent

Авторы

Vitaliy Zhhuta (@zhhuta)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/influxdb_user_module.html