Parameter |
Choices/Defaults |
Comments |
append_privs
bool
(added in 1.4) |
|
Append the privileges defined by priv to the existing ones for this user instead of overwriting existing ones.
|
check_implicit_admin
bool
(added in 1.3) |
|
Check if mysql allows login as root/nopassword before trying supplied credentials.
|
config_file
(added in 2.0) |
Default:
~/.my.cnf
|
Specify a config file from which user and password are to be read.
|
connect_timeout
(added in 2.1) |
Default:
30
|
The connection timeout when connecting to the MySQL server.
|
encrypted
bool
(added in 2.0) |
|
Indicate that the 'password' field is a `mysql_native_password` hash
|
host
|
Default:
localhost
|
the 'host' part of the MySQL username
|
host_all
bool
(added in 2.1) |
|
override the host option, making ansible apply changes to all hostnames for a given user. This option cannot be used when creating users
|
login_host
|
Default:
localhost
|
Host running the database.
|
login_password
|
|
The password used to authenticate with.
|
login_port
|
Default:
3306
|
Port of the MySQL server. Requires login_host be defined as other then localhost if login_port is used.
|
login_unix_socket
|
|
The path to a Unix domain socket for local connections.
|
login_user
|
|
The username used to authenticate with.
|
name
required |
|
name of the user (role) to add or remove
|
password
|
|
set the user's password.
|
priv
|
|
MySQL privileges string in the format: db.table:priv1,priv2 .
Multiple privileges can be specified by separating each one using a forward slash: db.table:priv/db.table:priv .
The format is based on MySQL GRANT statement.
Database and table names can be quoted, MySQL-style.
If column privileges are used, the priv1,priv2 part must be exactly as returned by a SHOW GRANT statement. If not followed, the module will always report changes. It includes grouping columns by permission (SELECT(col1,col2 ) instead of SELECT(col1 ,SELECT(col2))).
|
sql_log_bin
bool
(added in 2.1) |
|
Whether binary logging should be enabled or disabled for the connection.
|
ssl_ca
(added in 2.0) |
|
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) |
|
The path to a client public key certificate.
|
ssl_key
(added in 2.0) |
|
The path to the client private key.
|
state
|
Choices:
present ←
- absent
|
Whether the user should exist. When absent , removes the user.
|
update_password
(added in 2.0) |
Choices:
always ←
- on_create
|
always will update passwords if they differ. on_create will only set the password for newly created users.
|