community.mysql.mysql_variables module – Manage MySQL global variables
Note
This module is part of the community.mysql collection (version 3.5.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.mysql
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.mysql.mysql_variables
.
Synopsis
Query / Set MySQL variables.
Requirements
The below requirements are needed on the host that executes this module.
mysqlclient (Python 3.5+) or
PyMySQL (Python 2.7 and Python 3.x) or
MySQLdb (Python 2.x)
Parameters
Parameter |
Comments |
---|---|
The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server. |
|
Whether to validate the server host name when an SSL connection is required. Corresponds to MySQL CLIs Setting this to Requires pymysql >= 0.7.11. This option has no effect on MySQLdb. Choices:
|
|
The path to a client public key certificate. |
|
The path to the client private key. |
|
Specify a config file from which user and password are to be read. The default config file, The default config file, To prevent the default config file from being read, set config_file to be an empty string. Default: |
|
The connection timeout when connecting to the MySQL server. Default: |
|
Host running the database. In some cases for local connections the login_unix_socket=/path/to/mysqld/socket, that is usually Default: |
|
The password used to authenticate with. |
|
Port of the MySQL server. Requires login_host be defined as other than localhost if login_port is used. Default: |
|
The path to a Unix domain socket for local connections. Use this parameter to avoid the |
|
The username used to authenticate with. |
|
Supported by MySQL 8.0 or later. For more information see https://dev.mysql.com/doc/refman/8.0/en/set-variable.html. Choices:
|
|
If set, then sets variable value to this. |
|
Variable name to operate. |
Notes
Note
Does not support
check_mode
.To avoid the
Please explicitly state intended protocol
error, use the login_unix_socket argument, for example,login_unix_socket: /run/mysqld/mysqld.sock
.Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) package installed on the remote host. The Python package may be installed with apt-get install python-pymysql (Ubuntu; see ansible.builtin.apt) or yum install python2-PyMySQL (RHEL/CentOS/Fedora; see ansible.builtin.yum). You can also use dnf install python2-PyMySQL for newer versions of Fedora; see ansible.builtin.dnf.
Be sure you have mysqlclient, PyMySQL, or MySQLdb library installed on the target machine for the Python interpreter Ansible discovers. For example if ansible discovers and uses Python 3, you need to install the Python 3 version of PyMySQL or mysqlclient. If ansible discovers and uses Python 2, you need to install the Python 2 version of either PyMySQL or MySQL-python.
If you have trouble, it may help to force Ansible to use the Python interpreter you need by specifying
ansible_python_interpreter
. For more information, see https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html.Both
login_password
andlogin_user
are required when you are passing credentials. If none are present, the module will attempt to read the credentials from~/.my.cnf
, and finally fall back to using the MySQL default login of ‘root’ with no password.If there are problems with local connections, using login_unix_socket=/path/to/mysqld/socket instead of login_host=localhost might help. As an example, the default MariaDB installation of version 10.4 and later uses the unix_socket authentication plugin by default that without using login_unix_socket=/var/run/mysqld/mysqld.sock (the default path) causes the error ``Host ‘127.0.0.1’ is not allowed to connect to this MariaDB server``.
Alternatively, you can use the mysqlclient library instead of MySQL-python (MySQLdb) which supports both Python 2.X and Python >=3.5. See https://pypi.org/project/mysqlclient/ how to install it.
If credentials from the config file (for example,
/root/.my.cnf
) are not needed to connect to a database server, but the file exists and does not contain a[client]
section, before any other valid directives, it will be read and this will cause the connection to fail, to prevent this set it to an empty string, (for exampleconfig_file: ''
).
See Also
See also
- community.mysql.mysql_info
Gather information about MySQL servers.
- MySQL SET command reference
Complete reference of the MySQL SET command documentation.
Examples
# If you encounter the "Please explicitly state intended protocol" error,
# use the login_unix_socket argument
- name: Check for sync_binlog setting
community.mysql.mysql_variables:
variable: sync_binlog
login_unix_socket: /run/mysqld/mysqld.sock
- name: Set read_only variable to 1 persistently
community.mysql.mysql_variables:
variable: read_only
value: 1
mode: persist
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of executed queries which modified DB’s state. Returned: if executed Sample: |