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

Примечание

Этот модуль является частью коллекции community.proxysql (версия 1.6.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 boolean	Расписание с active, установленным в `False`, будет отслеживаться в базе данных, но никогда не загружаться во внутренние структуры данных. Варианты: `false` `true` ← (по умолчанию)
arg1 string	Аргумент, который может быть передан задаче.
arg2 string	Аргумент, который может быть передан задаче.
arg3 string	Аргумент, который может быть передан задаче.
arg4 string	Аргумент, который может быть передан задаче.
arg5 string	Аргумент, который может быть передан задаче.
comment string	Поле текста, которое может использоваться для любых целей, определенных пользователем.
config_file path	Укажите конфигурационный файл, из которого будут считываться login_user и login_password. По умолчанию: `""`
filename string / обязательно	Полный путь к исполняемому файлу, который будет запущен.
force_delete boolean	По умолчанию, мы избегаем удаления более одного расписания в одной группе. Однако, если вам нужна эта функциональность, и вас не волнуют удаленные расписания, вы можете установить force_delete в `True`. Варианты: `false` ← (по умолчанию) `true`
interval_ms integer	Как часто (в миллисекундах) задача будет запускаться. Минимальное значение для interval_ms составляет 100 миллисекунд. По умолчанию: `10000`
load_to_runtime boolean	Динамически загружать конфигурацию в оперативную память. Варианты: `false` `true` ← (по умолчанию)
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.
save_to_disk boolean	Сохранить конфигурацию в базу данных sqlite на диске для сохранения настроек. Варианты: `false` `true` ← (по умолчанию)
state string	При `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/proxysql/proxysql_scheduler_module.html