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

Примечание

Этот модуль входит в коллекцию community.proxysql (версия 1.8.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 логический	Пользователь, для которого параметр active имеет значение `False`, будет храниться в базе данных, но никогда не будет загружаться в структуры данных в памяти. Если параметр не указан, по умолчанию в базе данных ProxySQL для active используется значение `True`. Варианты: `false` `true`
backend логический	Если для backend задано значение `True`, эта пара (имя пользователя, пароль) используется для аутентификации в экземпляре ProxySQL. Варианты: `false` `true` ← (по умолчанию)
config_file путь	Укажите файл конфигурации, из которого следует считывать значения login_user и login_password. По умолчанию: `""`
default_hostgroup целое число	Если для запросов, отправленных этим пользователем, нет подходящего правила, генерируемый им трафик направляется в указанную группу хостов. Если параметр не указан, значение по умолчанию в базе данных ProxySQL для use_ssl равно 0.
default_schema строка	Схема, на которую по умолчанию должно переключаться соединение.
encrypt_password логический	Зашифровать пароль в открытом виде, переданный в параметре password, используя метод, указанный в encryption_method. Варианты: `false` ← (по умолчанию) `true`
encryption_method строка	Метод шифрования, используемый, если для encrypt_password задано значение `True`. Варианты: `"mysql_native_password"` ← (по умолчанию) `"caching_sha2_password"`
fast_forward логический	Если для fast_forward задано значение `True`, запрос будет обходить слой обработки запросов (перезапись, кэширование) и передаваться непосредственно на сервер backend без изменений. Если параметр не указан, по умолчанию в базе данных ProxySQL для fast_forward используется значение `False`. Варианты: `false` `true`
frontend логический	Если для frontend задано значение `True`, эта пара (имя пользователя, пароль) используется для аутентификации на серверах mysqld в любой группе хостов. Варианты: `false` `true` ← (по умолчанию)
load_to_runtime логический	Динамически загрузить конфигурацию в память среды выполнения. Варианты: `false` `true` ← (по умолчанию)
login_host строка	Хост для подключения к интерфейсу администрирования ProxySQL. По умолчанию: `"127.0.0.1"`
login_password строка	Пароль для аутентификации в интерфейсе администрирования ProxySQL.
login_port целое число	Порт для подключения к интерфейсу администрирования ProxySQL. По умолчанию: `6032`
login_unix_socket строка	Сокет для подключения к интерфейсу администрирования ProxySQL.
login_user строка	Имя пользователя для аутентификации в интерфейсе администрирования ProxySQL.
max_connections целое число	Максимальное количество соединений, которые ProxySQL откроет с backend для этого пользователя. Если параметр не указан, по умолчанию в базе данных ProxySQL для max_connections используется значение 10000.
password строка	Пароль пользователя, подключающегося к экземпляру mysqld или ProxySQL.
salt строка добавлено в community.proxysql 1.7.0	Соль, используемая, если для encryption_method задано значение `caching_sha2_password`. Если параметр не указан, salt представляет собой случайно сгенерированную строку, значение которой будет изменяться в базе данных ProxySQL при каждом выполнении.
save_to_disk логический	Сохранить конфигурацию в базе данных sqlite на диске, чтобы обеспечить ее постоянное хранение. Варианты: `false` `true` ← (по умолчанию)
state строка	Если задано значение `present` — добавить пользователя, если `absent` — удалить пользователя. Варианты: `"present"` ← (по умолчанию) `"absent"`
transaction_persistent логический	Если этот параметр задан для пользователя, с которым клиент MySQL подключается к ProxySQL (то есть для пользователя «frontend»), транзакции, начатые в группе хостов, останутся в этой группе независимо от любых других правил. Если параметр не указан, по умолчанию в базе данных ProxySQL для transaction_persistent используется значение `False`. Варианты: `false` `true`
use_ssl логический	Если для use_ssl задано значение `True`, соединения этого пользователя будут устанавливаться с использованием SSL. Если параметр не указан, по умолчанию в базе данных ProxySQL для use_ssl используется значение `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'
    salt: 'secrets_of_20_chars_'
    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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/proxysql/proxysql_mysql_users_module.html