community.mysql.mysql_variables – Manage MySQL global variables¶
Note
This plugin is part of the community.mysql collection (version 1.4.0).
To install it use: ansible-galaxy collection install community.mysql
.
To use it in a playbook, specify: community.mysql.mysql_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 |
---|---|---|
ca_cert
path
|
The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server.
aliases: ssl_ca |
|
check_hostname
boolean
added in 1.1.0 of community.mysql
|
|
Whether to validate the server host name when an SSL connection is required. Corresponds to MySQL CLIs
--ssl switch.Setting this to
false disables hostname verification. Use with caution.Requires pymysql >= 0.7.11.
This optoin has no effect on MySQLdb.
|
client_cert
path
|
The path to a client public key certificate.
aliases: ssl_cert |
|
client_key
path
|
The path to the client private key.
aliases: ssl_key |
|
config_file
path
|
Default: "~/.my.cnf"
|
Specify a config file from which user and password are to be read.
|
connect_timeout
integer
|
Default: 30
|
The connection timeout when connecting to the MySQL server.
|
login_host
string
|
Default: "localhost"
|
Host running the database.
In some cases for local connections the login_unix_socket=/path/to/mysqld/socket, that is usually
/var/run/mysqld/mysqld.sock , needs to be used instead of login_host=localhost. |
login_password
string
|
The password used to authenticate with.
|
|
login_port
integer
|
Default: 3306
|
Port of the MySQL server. Requires login_host be defined as other than localhost if login_port is used.
|
login_unix_socket
string
|
The path to a Unix domain socket for local connections.
|
|
login_user
string
|
The username used to authenticate with.
|
|
mode
string
added in 0.1.0 of community.mysql
|
|
global assigns value to a global system variable which will be changed at runtime but won't persist across server restarts.persist assigns value to a global system variable and persists it to the mysqld-auto.cnf option file in the data directory (the variable will survive service restarts).persist_only persists value to the mysqld-auto.cnf option file in the data directory but without setting the global variable runtime value (the value will be changed after the next service restart).Supported by MySQL 8.0 or later.
For more information see https://dev.mysql.com/doc/refman/8.0/en/set-variable.html.
|
value
string
|
If set, then sets variable value to this.
|
|
variable
string
/ required
|
Variable name to operate.
|
Notes¶
Note
Does not support
check_mode
.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 PyMySQL or MySQLdb library installed on the target machine for the Python interpreter Ansible uses, for example, if it is Python 3, you must install the library for Python 3. You can also change the 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.
See Also¶
See also
- community.mysql.mysql_info
The official documentation on the community.mysql.mysql_info module.
- MySQL SET command reference
Complete reference of the MySQL SET command documentation.
Examples¶
- name: Check for sync_binlog setting
community.mysql.mysql_variables:
variable: sync_binlog
- 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 | Returned | Description |
---|---|---|
queries
list
/ elements=string
added in 0.1.0 of community.mysql |
if executed |
List of executed queries which modified DB's state.
Sample:
['SET GLOBAL `read_only` = 1']
|
Authors¶
Balazs Pocze (@banyek)