Note
This plugin is part of the community.proxysql collection.
To install it use: ansible-galaxy collection install community.proxysql.
To use it in a playbook, specify: community.proxysql.proxysql_scheduler.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| active boolean |
| A schedule with active set to False will be tracked in the database, but will be never loaded in the in-memory data structures. |
| arg1 string | Argument that can be passed to the job. | |
| arg2 string | Argument that can be passed to the job. | |
| arg3 string | Argument that can be passed to the job. | |
| arg4 string | Argument that can be passed to the job. | |
| arg5 string | Argument that can be passed to the job. | |
| comment string | Text field that can be used for any purposed defined by the user. | |
| config_file path | Default: "" | Specify a config file from which login_user and login_password are to be read. |
| filename string / required | Full path of the executable to be executed. | |
| force_delete boolean |
| By default we avoid deleting more than one schedule in a single batch, however if you need this behaviour and you're not concerned about the schedules deleted, you can set force_delete to True. |
| interval_ms integer | Default: 10000 | How often (in millisecond) the job will be started. The minimum value for interval_ms is 100 milliseconds. |
| load_to_runtime boolean |
| Dynamically load config to runtime memory. |
| login_host string | Default: "127.0.0.1" | The host used to connect to ProxySQL admin interface. |
| login_password string | The password used to authenticate to ProxySQL admin interface. | |
| login_port integer | Default: 6032 | The port used to connect to ProxySQL admin interface. |
| login_unix_socket string | The socket used to connect to ProxySQL admin interface. | |
| login_user string | The username used to authenticate to ProxySQL admin interface. | |
| save_to_disk boolean |
| Save config to sqlite db on disk to persist the configuration. |
| state string |
| When present - adds the schedule, when absent - removes the schedule. |
---
# 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| stdout dictionary | On create/update will return the newly modified schedule, on delete it will return the deleted record. | The schedule modified or removed from proxysql Sample: {'changed': True, 'filename': '/opt/test.py', 'msg': 'Added schedule to scheduler', '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'} |
© 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