Puppet Function: mysql_password

Defined in:
lib/puppet/functions/mysql_password.rb
Function type:
Ruby 4.x API

Summary

DEPRECATED. Use the namespaced function [`mysql::password`](#mysqlpassword) instead.

Overview

mysql_password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive) ⇒ Variant[String, Sensitive[String]]

Parameters:

  • password (Variant[String, Sensitive[String]]) —

    Plain text password.

  • sensitive (Optional[Boolean])

Returns:

  • (Variant[String, Sensitive[String]]) —

    The mysql password hash from the 4.x function mysql::password.



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/puppet/functions/mysql_password.rb', line 4

Puppet::Functions.create_function(:mysql_password) do
  # @param password
  #   Plain text password.
  #
  # @return
  #   The mysql password hash from the 4.x function mysql::password.
  dispatch :mysql_password do
    required_param 'Variant[String, Sensitive[String]]', :password
    optional_param 'Boolean', :sensitive
    return_type 'Variant[String, Sensitive[String]]'
  end

  def mysql_password(password, sensitive = false)
    call_function('deprecation', 'mysql_password', "This method has been deprecated, please use the namespaced version 'mysql::password' instead.")
    call_function('mysql::password', password, sensitive)
  end
end