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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.proxysql. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.proxysql.proxysql_scheduler.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

PyMySQL
mysqlclient

Параметры

Параметр	Комментарии
active логическое значение	Расписание с параметром active, установленным в `False`, будет храниться в базе данных, но не будет загружаться в структуры данных в памяти. Допустимые значения: `false` `true` ← (по умолчанию)
arg1 строка	Аргумент, передаваемый заданию.
arg2 строка	Аргумент, передаваемый заданию.
arg3 строка	Аргумент, передаваемый заданию.
arg4 строка	Аргумент, передаваемый заданию.
arg5 строка	Аргумент, передаваемый заданию.
comment строка	Текстовое поле, которое пользователь может использовать для любых целей.
config_file путь	Укажите файл конфигурации, из которого будут прочитаны значения login_user и login_password. По умолчанию: `""`
filename строка / обязательный	Полный путь к исполняемому файлу, который необходимо запустить.
force_delete логическое значение	По умолчанию мы не удаляем несколько расписаний за один пакетный запрос. Если вам требуется такое поведение и вас не беспокоит, какие именно расписания будут удалены, установите для force_delete значение `True`. Допустимые значения: `false` ← (по умолчанию) `true`
interval_ms целое число	Периодичность запуска задания (в миллисекундах). Минимальное значение interval_ms — 100 миллисекунд. По умолчанию: `10000`
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.
save_to_disk логическое значение	Сохранять конфигурацию в базе данных SQLite на диске, чтобы обеспечить ее сохранность. Допустимые значения: `false` `true` ← (по умолчанию)
state строка	Если задано `present` — расписание добавляется, если задано `absent` — расписание удаляется. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

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

Примеры

---
# 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 словарь	Расписание, измененное или удаленное из proxysql. Возвращается: При создании или обновлении возвращается измененное расписание, при удалении — удаленная запись. Пример: `{"changed": true, "filename": "/opt/test.py", "msg": "Added schedule to scheduler", "schedules": [{"active": "1", "arg1": null, "arg2": null, "arg3": null, "arg4": null, "arg5": null, "comment": "", "filename": "/opt/test.py", "id": "1", "interval_ms": "10000"}], "state": "present"}`

Ключ

Описание

stdout

словарь

Расписание, измененное или удаленное из proxysql.

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

Пример: {"changed": true, "filename": "/opt/test.py", "msg": "Added schedule to scheduler", "schedules": [{"active": "1", "arg1": null, "arg2": null, "arg3": null, "arg4": null, "arg5": null, "comment": "", "filename": "/opt/test.py", "id": "1", "interval_ms": "10000"}], "state": "present"}

Авторы

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_scheduler_module.html