proxysql_scheduler - Adds or removes schedules from proxysql admin interface.

New in version 2.3.

Synopsis

  • The proxysql_scheduler module adds or removes schedules using the proxysql admin interface.

Options

parameter required default choices comments
active
 no True
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
 no
Argument that can be passed to the job.
arg2
 no
Argument that can be passed to the job.
arg3
 no
Argument that can be passed to the job.
arg4
 no
Argument that can be passed to the job.
arg5
 no
Argument that can be passed to the job.
comment
 no
Text field that can be used for any purposed defined by the user.
config_file
 no
Specify a config file from which login_user and login_password are to be read.
filename
 yes
Full path of the executable to be executed.
force_delete
 no
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
 no 10000
How often (in millisecond) the job will be started. The minimum value for interval_ms is 100 milliseconds.
load_to_runtime
 no True
Dynamically load mysql host config to runtime memory.
login_host
 no 127.0.0.1
The host used to connect to ProxySQL admin interface.
login_password
 no None
The password used to authenticate to ProxySQL admin interface.
login_port
 no 6032
The port used to connect to ProxySQL admin interface.
login_user
 no None
The username used to authenticate to ProxySQL admin interface.
save_to_disk
 no True
Save mysql host config to sqlite db on disk to persist the configuration.
state
 no present
  • present
  • absent
When present - adds the schedule, when absent - removes the schedule.

Examples

---
# 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 M(proxysql_manage_config) module).  It
# uses supplied credentials to connect to the proxysql admin interface.

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

- proxysql_scheduler:
    config_file: '~/proxysql.cnf'
    filename: "/opt/old_script.py"
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
stdout
The schedule modified or removed from proxysql
 On create/update will return the newly modified schedule, on delete it will return the deleted record. dict {'msg': 'Added schedule to scheduler', 'state': 'present', 'changed': True, 'filename': '/opt/test.py', 'schedules': [{'comment': '', 'arg1': None, 'arg2': None, 'arg3': None, 'arg4': None, 'arg5': None, 'filename': '/opt/test.py', 'interval_ms': '10000', 'active': '1', 'id': '1'}]}

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/proxysql_scheduler_module.html