mysql_user

Manage MySQL and MariaDB user accounts and privileges

Collection: ansible.mysql

Full Name: parallax.community.general.mysql_user

Aliases: community.general.mysql_user, mysql_user, ansible.mysql.mysql_user

Synopsis

Manage MySQL and MariaDB user accounts and privileges

Parameters

Name	Type	Required	Default	Description
name	string	yes		Name of the MySQL user
password	string			Password for the user
host	string		`localhost`	The host part of the MySQL username
state	string		`present`	State of the user Choices: `present`, `absent`
priv	raw			MySQL privileges string (e.g. db.*:ALL)
login_host	string		`localhost`	Host running MySQL
login_port	int		`3306`	Port of the MySQL server
login_user	string		`root`	User to authenticate with
login_password	string			Password for authentication
login_unix_socket	string			Path to a Unix socket for local connections
encrypted	bool		`false`	Whether the password is already encrypted
append_privs	bool		`false`	Append privileges instead of overwriting
check_implicit_admin	bool		`false`	Check if mysql allows login as root without password
update_password	string		`always`	When to update the password Choices: `always`, `on_create`
plugin	string			Authentication plugin for the user
plugin_auth_string	string			Authentication string for the plugin
plugin_hash_string	string			Authentication hash for the plugin
resource_limits	raw			Resource limits for the user (JSON format)
tls_requires	raw			TLS requirements for the user
subtract_privs	bool		`false`	Remove only the specified privileges
host_all	bool		`false`	Apply to all existing hosts for this user
locked	bool			Lock or unlock the account
salt	string			20-byte salt for caching_sha2_password plugin authentication
client_cert	string			Client TLS certificate
client_key	string			Client TLS private key
ca_cert	string			TLS certificate authority
check_hostname	bool			Verify the server hostname
connect_timeout	int		`30`	Connection timeout in seconds
config_file	string			Additional MySQL client option file

Example

yaml

- name: Grant the application user access to its database
  mysql_user:
    name: app
    password: "{{ mysql_app_password }}"
    host: "10.0.%"
    priv: "appdb.*:ALL"
    state: present