community.proxysql.proxysql_scheduler – Добавляет или удаляет расписания из интерфейса администрирования proxysql.
Примечание
Этот плагин является частью коллекции community.proxysql (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.proxysql.
Для использования в книге задач укажите: community.proxysql.proxysql_scheduler.
Краткое описание
- Модуль community.proxysql.proxysql_scheduler добавляет или удаляет расписания с использованием интерфейса администрирования proxysql.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- PyMySQL (Python 2.7 и Python 3.X), или
- MySQLdb (Python 2.x)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| active boolean |
| Расписание с active, установленным в значение False, будет отслеживаться в базе данных, но никогда не будет загружаться в структуры данных в оперативной памяти. |
| arg1 string | Аргумент, который может быть передан задаче. | |
| arg2 string | Аргумент, который может быть передан задаче. | |
| arg3 string | Аргумент, который может быть передан задаче. | |
| arg4 string | Аргумент, который может быть передан задаче. | |
| arg5 string | Аргумент, который может быть передан задаче. | |
| comment string | Поле для текста, которое может использоваться для любых целей, определенных пользователем. | |
| config_file path | Значение по умолчанию: "" | Укажите файл конфигурации, из которого следует считывать login_user и login_password. |
| filename string / required | Полный путь к исполняемому файлу, который будет выполнен. | |
| force_delete boolean |
| По умолчанию мы избегаем удаления более одного расписания в одной группе, однако, если вам нужна эта функция и вы не беспокоитесь о удаленных расписаниях, вы можете установить force_delete в значение True. |
| interval_ms integer | Значение по умолчанию: 10000 | Как часто (в миллисекундах) задача будет запускаться. Минимальное значение для interval_ms составляет 100 миллисекунд. |
| load_to_runtime boolean |
| Динамическая загрузка конфигурации в оперативную память. |
| login_host string | Значение по умолчанию: "127.0.0.1" | Хост, используемый для подключения к интерфейсу администрирования ProxySQL. |
| login_password string | Пароль, используемый для аутентификации в интерфейсе администрирования ProxySQL. | |
| login_port integer | Значение по умолчанию: 6032 | Порт, используемый для подключения к интерфейсу администрирования ProxySQL. |
| login_unix_socket string | Сокет, используемый для подключения к интерфейсу администрирования ProxySQL. | |
| login_user string | Имя пользователя, используемое для аутентификации в интерфейсе администрирования ProxySQL. | |
| save_to_disk boolean |
| Сохранение конфигурации в базу данных sqlite на диске для сохранения конфигурации. |
| state string |
| При значении present, добавляет расписание, при значении absent, удаляет расписание. |
Примеры
---
# This example adds a schedule, it saves the scheduler config to disk, but
# avoids loading the scheduler config to runtime (this might be because
# several servers 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 schedule
community.proxysql.proxysql_scheduler:
login_user: 'admin'
login_password: 'admin'
interval_ms: 1000
filename: "/opt/maintenance.py"
state: present
load_to_runtime: False
# This example removes a schedule, saves the scheduler config to disk, and
# dynamically loads the scheduler config to runtime. It uses credentials
# in a supplied config file to connect to the proxysql admin interface.
- name: Remove a schedule
community.proxysql.proxysql_scheduler:
config_file: '~/proxysql.cnf'
filename: "/opt/old_script.py"
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| stdout dictionary | При создании/обновлении вернёт недавно изменённое расписание, при удалении вернёт удалённую запись. | Расписание, изменённое или удалённое из proxysql Пример: {'changed': True, 'filename': '/opt/test.py', 'msg': 'Добавленo расписание в планировщик', 'schedules': [{'active': '1', 'arg1': None, 'arg2': None, 'arg3': None, 'arg4': None, 'arg5': None, 'comment': '', 'filename': '/opt/test.py', 'id': '1', 'interval_ms': '10000'}], 'state': 'present'} |
Авторы
- Ben Mildren (@bmildren)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/proxysql/proxysql_scheduler_module.html
