community.proxysql.proxysql_scheduler 模块 – 从 proxysql 管理界面添加或删除计划任务

注意

此模块是 community.proxysql 集合（版本 1.6.0）的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.proxysql。您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：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"}

作者

• Ben Mildren (@bmildren)

集合链接

• 问题跟踪器
• 存储库（源代码）