Class: Ansible::Ruby::Modules::Mysql_user

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb

Overview

Adds or removes a user from a MySQL database.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#append_privs ⇒ :yes, ...

Returns Append the privileges defined by priv to the existing ones for this user instead of overwriting existing ones.

Returns:

  • (:yes, :no, nil) —

    Append the privileges defined by priv to the existing ones for this user instead of overwriting existing ones.



36
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 36

attribute :append_privs

#check_implicit_admin ⇒ :yes, ...

Returns Check if mysql allows login as root/nopassword before trying supplied credentials.

Returns:

  • (:yes, :no, nil) —

    Check if mysql allows login as root/nopassword before trying supplied credentials.



48
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 48

attribute :check_implicit_admin

#encrypted ⇒ :yes, ...

Returns Indicate that the ‘password’ field is a ‘mysql_native_password` hash.

Returns:

  • (:yes, :no, nil) —

    Indicate that the ‘password’ field is a ‘mysql_native_password` hash



20
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 20

attribute :encrypted

#host ⇒ String?

Returns the ‘host’ part of the MySQL username.

Returns:

  • (String, nil) —

    the ‘host’ part of the MySQL username



24
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 24

attribute :host

#host_all ⇒ :yes, ...

Returns override the host option, making ansible apply changes to all hostnames for a given user. This option cannot be used when creating users.

Returns:

  • (:yes, :no, nil) —

    override the host option, making ansible apply changes to all hostnames for a given user. This option cannot be used when creating users



28
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 28

attribute :host_all

#name ⇒ String

Returns name of the user (role) to add or remove.

Returns:

  • (String) —

    name of the user (role) to add or remove



12
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 12

attribute :name

#password ⇒ Integer, ...

Returns set the user’s password.

Returns:

  • (Integer, String, nil) —

    set the user’s password.



16
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 16

attribute :password

#priv ⇒ Array<String>, ...

Returns MySQL privileges string in the format: C(db.table:priv1,priv2).,Multiple privileges can be specified by separating each one using a forward slash: C(db.table:priv/db.table:priv).,The format is based on MySQL C(GRANT) statement.,Database and table names can be quoted, MySQL-style.,If column privileges are used, the C(priv1,priv2) part must be exactly as returned by a C(SHOW GRANT) statement. If not followed, the module will always report changes. It includes grouping columns by permission (C(SELECT(col1,col2)) instead of C(SELECT(col1),SELECT(col2))).

Returns:

  • (Array<String>, String, nil) —

    MySQL privileges string in the format: C(db.table:priv1,priv2).,Multiple privileges can be specified by separating each one using a forward slash: C(db.table:priv/db.table:priv).,The format is based on MySQL C(GRANT) statement.,Database and table names can be quoted, MySQL-style.,If column privileges are used, the C(priv1,priv2) part must be exactly as returned by a C(SHOW GRANT) statement. If not followed, the module will always report changes. It includes grouping columns by permission (C(SELECT(col1,col2)) instead of C(SELECT(col1),SELECT(col2))).



32
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 32

attribute :priv

#sql_log_bin ⇒ :yes, ...

Returns Whether binary logging should be enabled or disabled for the connection.

Returns:

  • (:yes, :no, nil) —

    Whether binary logging should be enabled or disabled for the connection.



40
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 40

attribute :sql_log_bin

#state ⇒ :present, ...

Returns Whether the user should exist. When C(absent), removes the user.

Returns:

  • (:present, :absent, nil) —

    Whether the user should exist. When C(absent), removes the user.



44
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 44

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

Returns:

  • (:always, :on_create, nil) —

    C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.



52
 
# File 'lib/ansible/ruby/modules/generated/database/mysql/mysql_user.rb', line 52

attribute :update_password