Documentation

mysql_variables - Manage MySQL global variables

New in version 1.3.

Synopsis

Query / Set MySQL variables

Requirements (on host that executes module)

  • MySQLdb

Options

parameter required default choices comments
config_file
(added in 2.0)
 no ~/.my.cnf
    Specify a config file from which user and password are to be read
    connect_timeout
    (added in 2.1)
    		 no 30
      The connection timeout when connecting to the MySQL server.
      login_host
      		 no localhost
        Host running the database
        login_password
        		 no
          The password used to authenticate with
          login_port
          		 no 3306
            Port of the MySQL server. Requires login_host be defined as other then localhost if login_port is used
            login_unix_socket
            		 no
              The path to a Unix domain socket for local connections
              login_user
              		 no
                The username used to authenticate with
                ssl_ca
                (added in 2.0)
                		 no
                  The path to a Certificate Authority (CA) certificate. This option, if used, must specify the same certificate as used by the server.
                  ssl_cert
                  (added in 2.0)
                  		 no
                    The path to a client public key certificate.
                    ssl_key
                    (added in 2.0)
                    		 no
                      The path to the client private key.
                      value
                      		 no
                        If set, then sets variable value to this
                        variable
                        		 yes
                          Variable name to operate

                          Examples

                          # Check for sync_binlog setting
- mysql_variables: variable=sync_binlog

# Set read_only variable to 1
- mysql_variables: variable=read_only value=1

                          Notes

                          Note

                          Requires the MySQLdb Python package on the remote host. For Ubuntu, this is as easy as apt-get install python-mysqldb. (See apt.) For CentOS/Fedora, this is as easy as yum install MySQL-python. (See yum.)

                          Note

                          Both login_password and login_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.

                          This is a Core Module

                          For more information on what this means please read Core Modules

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