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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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` ← (default) `true`
grants list / elements=dictionary	Права, которые необходимо предоставить этому пользователю. Принимает список словарей, содержащих ключи «database» и «privilege». Если этот аргумент не указан, текущие права останутся без изменений. Если предоставлен пустой список, все права пользователя будут удалены.
hostname string	Имя хоста или IP-адрес, на котором прослушивает сервер InfluxDB. По умолчанию: `"localhost"`
password aliases: 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) прокси-сервер для использования запросами для подключения к серверу InfluxDB. По умолчанию: `{}`
retries integer	Количество попыток, которые клиент предпримет перед прерыванием. `0` указывает на попытку до успешного завершения. Доступно только при использовании python-influxdb >= 4.1.0. По умолчанию: `3`
ssl boolean	Использовать https вместо http для подключения к серверу InfluxDB. Варианты: `false` ← (default) `true`
state string	Состояние пользователя. Варианты: `"absent"` `"present"` ← (default)
timeout integer	Количество секунд, которые Requests будут ждать установления соединения клиентом.
udp_port integer	UDP-порт для подключения к серверу InfluxDB. По умолчанию: `4444`
use_udp boolean	Использовать UDP для подключения к серверу InfluxDB. Варианты: `false` ← (default) `true`
user_name string / required	Имя пользователя.
user_password string	Пароль, который будет установлен для пользователя.
username aliases: login_username string	Имя пользователя, которое будет использоваться для аутентификации на сервере InfluxDB. По умолчанию: `"root"`
validate_certs boolean	Если установлено в `false`, SSL-сертификаты проверяться не будут. Это следует устанавливать в `false` только на лично контролируемых сайтах, использующих самозаверенные сертификаты. Варианты: `false` `true` ← (default)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз о статусе изменения без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	При работе в режиме diff вернет информацию о том, что изменилось (или, возможно, нуждается в изменении в `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

Авторы

Виталий Жута (@zhhuta)

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

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