community.proxysql.proxysql_mysql_users модуль — Добавляет или удаляет пользователей mysql из интерфейса администрирования proxysql

Примечание

Этот модуль является частью коллекции community.proxysql (версия 1.6.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.proxysql. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: community.proxysql.proxysql_mysql_users.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Модуль community.proxysql.proxysql_mysql_users добавляет или удаляет пользователей mysql с помощью интерфейса администрирования proxysql.

Требования

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

PyMySQL
mysqlclient

Параметры

Параметр	Комментарии
active boolean	Пользователь с параметром active, установленным в `False`, будет отслеживаться в базе данных, но никогда не будет загружаться во внутрисистемные структуры данных. Если параметр опущен, используется значение по умолчанию из базы данных ProxySQL для active — `True`. Варианты: `false` `true`
backend boolean	Если backend установлен в `True`, эта пара (имя пользователя, пароль) используется для аутентификации в экземпляре ProxySQL. Варианты: `false` `true` ← (default)
config_file path	Укажите файл конфигурации, из которого будут считываться login_user и login_password. Значение по умолчанию: `""`
default_hostgroup integer	Если нет совпадающего правила для запросов, отправленных этим пользователем, генерируемый им трафик отправляется в указанную группу хостов. Если параметр опущен, используется значение по умолчанию из базы данных ProxySQL для use_ssl — 0.
default_schema string	Схема, на которую должно быть по умолчанию переключено соединение.
encrypt_password boolean	Шифрует незашифрованный пароль, переданный в параметре password, используя метод, определённый в encryption_method. Варианты: `false` ← (default) `true`
encryption_method string	Метод шифрования, используемый, когда encrypt_password установлен в `True`. Варианты: `"mysql_native_password"` ← (default)
fast_forward boolean	Если fast_forward установлен в `True`, fast_forward обойдёт слой обработки запросов (переписывание, кэширование) и передаст запрос напрямую на сервер back-end. Если параметр опущен, используется значение по умолчанию из базы данных ProxySQL для fast_forward — `False`. Варианты: `false` `true`
frontend boolean	Если frontend установлен в `True`, эта пара (имя пользователя, пароль) используется для аутентификации на серверах mysqld для любой группы хостов. Варианты: `false` `true` ← (default)
load_to_runtime boolean	Динамически загрузить конфигурацию в оперативную память. Варианты: `false` `true` ← (default)
login_host string	Хост, используемый для подключения к интерфейсу администратора ProxySQL. Значение по умолчанию: `"127.0.0.1"`
login_password string	Пароль, используемый для аутентификации в интерфейсе администратора ProxySQL.
login_port integer	Порт, используемый для подключения к интерфейсу администратора ProxySQL. Значение по умолчанию: `6032`
login_unix_socket string	Сокет, используемый для подключения к интерфейсу администратора ProxySQL.
login_user string	Имя пользователя, используемое для аутентификации в интерфейсе администратора ProxySQL.
max_connections integer	Максимальное количество соединений, которые ProxySQL откроет для back-end для этого пользователя. Если параметр опущен, используется значение по умолчанию из базы данных ProxySQL для max_connections — 10000.
password string	Пароль пользователя, подключающегося к экземпляру mysqld или ProxySQL.
save_to_disk boolean	Сохранить конфигурацию в базу данных sqlite на диске для сохранения конфигурации. Варианты: `false` `true` ← (default)

state строка	При значении `present` - добавляет пользователя, при значении `absent` - удаляет пользователя. Выбооры: `"present"` ← (по умолчанию) `"absent"`
transaction_persistent логический	Если для пользователя, с которым подключается MySQL-клиент к ProxySQL (таким образом, «фронтенд» пользователь), установлено это значение, транзакции, начатые в группе хостов, останутся в этой группе хостов независимо от других правил. Если опущено, значение по умолчанию для transaction_persistent в базе данных proxysql - `False`. Выбооры: `false` `true`
use_ssl логический	Если use_ssl установлено в `True`, подключения от этого пользователя будут выполняться с использованием SSL-подключений. Если опущено, значение по умолчанию для use_ssl в базе данных proxysql - `False`. Выбооры: `false` `true`
username строка / обязательно	Имя пользователя, подключающегося к экземпляру mysqld или ProxySQL.

Примечания

Примечание

Поддерживает check_mode.

Примеры

---
# This example adds a user, it saves the mysql user config to disk, but
# avoids loading the mysql user config to runtime (this might be because
# several users are being added and the user wants to push the config to
# runtime in a single batch using the community.general.proxysql_manage_config
# module).  It uses supplied credentials to connect to the proxysql admin
# interface.

- name: Add a user
  community.proxysql.proxysql_mysql_users:
    login_user: 'admin'
    login_password: 'admin'
    username: 'productiondba'
    state: present
    load_to_runtime: false

# This example removes a user, saves the mysql user config to disk, and
# dynamically loads the mysql user config to runtime.  It uses credentials
# in a supplied config file to connect to the proxysql admin interface.

- name: Remove a user
  community.proxysql.proxysql_mysql_users:
    config_file: '~/proxysql.cnf'
    username: 'mysqlboy'
    state: absent

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
stdout словарь	Пользователь MySQL, измененный или удаленный из proxysql. Возвращается: При создании/обновлении возвращается измененный пользователь, при удалении - удаленный запись. Пример: `{"changed": true, "msg": "Added user to mysql_users", "state": "present", "user": {"active": 1, "backend": 1, "default_hostgroup": 1, "default_schema": null, "fast_forward": 0, "frontend": 1, "max_connections": 10000, "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "schema_locked": 0, "transaction_persistent": 0, "use_ssl": 0, "username": "guest_ro"}, "username": "guest_ro"}`

Ключ

Описание

stdout

словарь

Пользователь MySQL, измененный или удаленный из proxysql.

Возвращается: При создании/обновлении возвращается измененный пользователь, при удалении - удаленный запись.

Пример: {"changed": true, "msg": "Added user to mysql_users", "state": "present", "user": {"active": 1, "backend": 1, "default_hostgroup": 1, "default_schema": null, "fast_forward": 0, "frontend": 1, "max_connections": 10000, "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "schema_locked": 0, "transaction_persistent": 0, "use_ssl": 0, "username": "guest_ro"}, "username": "guest_ro"}

Авторы

Ben Mildren (@bmildren)

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

© 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/proxysql/proxysql_mysql_users_module.html