community.general.influxdb_user – Управление пользователями InfluxDB
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.influxdb_user.
Обзор
- Управление пользователями InfluxDB.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- influxdb >= 0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin boolean |
| Указывает, должен ли пользователь быть включен в роль администратора. Начиная с версии 2.8, роль также будет обновлена. |
| grants список / элементы=словарь | Права, которые необходимо предоставить этому пользователю. Принимает список словарей, содержащих ключи "база данных" и "право". Если этот аргумент не указан, текущие права останутся неизменными. Если указан пустой список, все права пользователя будут удалены. | |
| hostname строка | Значение по умолчанию: "localhost" | Имя хоста или IP-адрес, на котором слушает сервер InfluxDB. Начиная с Ansible 2.5, по умолчанию установлено значение localhost. |
| password строка | Значение по умолчанию: "root" | Пароль, который будет использоваться для аутентификации на сервере InfluxDB. Псевдоним login_password добавлен в Ansible 2.5.Псевдонимы: login_password |
| path строка добавлен в 0.2.0 community.general | Путь, по которому доступен сервер InfluxDB. Доступен только при использовании python-influxdb >= 5.1.0 | |
| port целое число | Значение по умолчанию: 8086 | Порт, на котором слушает сервер InfluxDB. |
| proxies словарь | HTTP(S) прокси, который необходимо использовать для запросов к серверу InfluxDB. | |
| retries целое число | Значение по умолчанию: 3 | Количество попыток, которые клиент сделает перед прерыванием. 0 означает попытки до успеха.Доступно только при использовании python-influxdb >= 4.1.0 |
| ssl boolean |
| Использовать https вместо http для подключения к серверу InfluxDB. |
| state строка |
| Состояние пользователя. |
| timeout целое число | Количество секунд, которое Requests будут ждать, пока клиент установит подключение. | |
| udp_port целое число | Значение по умолчанию: 4444 | UDP порт для подключения к серверу InfluxDB. |
| use_udp boolean |
| Использовать UDP для подключения к серверу InfluxDB. |
| user_name строка / обязательно | Имя пользователя. | |
| user_password строка | Пароль, который необходимо установить для пользователя. | |
| username строка | Значение по умолчанию: "root" | Имя пользователя, которое будет использоваться для аутентификации на сервере InfluxDB. Псевдоним login_username добавлен в Ansible 2.5.Псевдонимы: login_username |
| validate_certs boolean |
| Если установлено значение no, сертификаты SSL не будут проверены.Это необходимо только для использования на сайтах, управляемых лично, с самозаверенными сертификатами. |
Примеры
- 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: yes
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/influxdb_user_module.html