community.proxysql.proxysql_global_variables – Gets or sets the proxysql global variables.

Note

This plugin is part of the community.proxysql collection (version 1.0.0).

To install it use: ansible-galaxy collection install community.proxysql.

To use it in a playbook, specify: community.proxysql.proxysql_global_variables.

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

The community.proxysql.proxysql_global_variables module gets or sets the proxysql global variables.

Requirements

The below requirements are needed on the host that executes this module.

PyMySQL (Python 2.7 and Python 3.X), or
MySQLdb (Python 2.x)

Parameters

Parameter	Choices/Defaults	Comments
config_file path	Default: ""	Specify a config file from which login_user and login_password are to be read.
load_to_runtime boolean	no yes ←	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	no yes ←	Save config to sqlite db on disk to persist the configuration.
value string		Defines a value the variable specified using variable should be set to.
variable string / required		Defines which variable should be returned, or if value is specified which variable should be updated.

Examples

---
# This example sets the value of a variable, saves the mysql admin variables
# config to disk, and dynamically loads the mysql admin variables config to
# runtime. It uses supplied credentials to connect to the proxysql admin
# interface.

- name: Set the value of a variable
  community.proxysql.proxysql_global_variables:
    login_user: 'admin'
    login_password: 'admin'
    variable: 'mysql-max_connections'
    value: 4096

# This example gets the value of a variable.  It uses credentials in a
# supplied config file to connect to the proxysql admin interface.

- name: Get the value of a variable
  community.proxysql.proxysql_global_variables:
    config_file: '~/proxysql.cnf'
    variable: 'mysql-default_query_delay'

Return Values

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

Key	Returned	Description
stdout dictionary	Returns the current variable and value, or the newly set value for the variable supplied..	Returns the mysql variable supplied with it's associated value. Sample: {'changed': False, 'msg': 'The variable is already been set to the supplied value', 'var': {'variable_name': 'mysql-poll_timeout', 'variable_value': '3000'}}

Authors

Ben Mildren (@bmildren)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/proxysql/proxysql_global_variables_module.html