Child pages
  • UAPI Functions - Mysql::set_password

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function sets a MySQL® database user's password.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Mysql/set_password?user=dbuser&password=12345luggage

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Update dbuser's password.
$update_dbuser_password = $cpanel->uapi(
    'Mysql', 'set_password',
    array(
        'user'           => 'dbuser',
        'password'       => '12345luggage',
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Update dbuser's password.
my $update_dbuser_password = $cpliveapi->uapi(
    'Mysql', 'set_password',
    {
        'user'           => 'dbuser',
        'password'       => '12345luggage',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Update the password. -->
[% execute('Mysql', 'set_password', { user => 'dbuser', password => '12345luggage' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Mysql set_password user=dbuser password=12345luggage

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": {
    "failures": [
      {
        "host": "hostname.example.com",
        "error": "These are not the droids that you are looking for."
      }
    ]
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The MySQL database user.

A MySQL database user on the cPanel account.

dbuser
passwordstring

Required

The user's new password.

A secure password that meets the server's minimum MySQL password strength requirements.

12345luggage

Returns

ReturnTypeDescriptionPossible values
failuresarray of hashes

An array of the function's error messages.

Note
titleNote:

cPanel & WHM introduced this array in version 11.48.


This array includes the host and error value.

host

string

The hostname that reported the error.

The function returns this value in the failures array.

A valid hostname.

error

string

The error message.

The function returns this value in the failures array.

A valid string.