Plesk Utility
The plesk
command line utility is used to wrap other Plesk command
line utilities. Additionally, it provides administrators and developers
convenient way to access Plesk database, configuration files, and log
files and allows performing other important tasks such as running daily
maintenance script and the Plesk installer.
Usage
plesk [command]
Example
The following command creates the additional Administrator account with the contact name John Doe, Plesk login name JDoe, password sample, and account’s email address JDoe@example.com.
plesk bin admin_alias --create JDoe -passwd sample -contact "John Doe" -email JDoe@example.com
Commands
Command | Parameter | Description | Example |
---|---|---|---|
bin |
UTILITY |
Runs the specified Plesk command line utility (e.g.,
This is applicable to public CLI utilities located at the
|
To create the account with the login name JDoe, password sample, and the account’s email address JDoe@example.com: plesk bin admin_alias --create JDoe -passwd sample -email JDoe@example.com or plesk bin admin_alias -c JDoe -passwd sample -email JDoe@example.com |
conf |
CONFNAME |
Open the specified Plesk configuration file in the editor. The
available configuration files are: panel.ini (Plesk
internal settings), php.ini (PHP interpreter settings, for
Plesk with web interface only). |
To open plesk conf panel.ini |
daily |
[TASK_NAME] |
Run daily maintenance script. The following scripts are available:
|
To run daily check for updates: plesk daily CheckForUpdates |
db |
[COMMAND | SQL] |
Execute database specific command. Open MySQL console if no particular command was specified. Run an SQL query if it is provided instead of a command Additional commands:
Additional options:
To execute a one-time
|
To display the list of existing database tables: plesk db tables To create the plesk db dump psa --skip-extended-insert > /tmp/psa.sql To produce an XML output of the plesk db -Xe "SELECT pname FROM clients" or plesk db --xml -e "SELECT pname FROM clients"
|
listupgrade |
--source | <options>
|
Lists all Plesk versions to which you can update with the currently installed Plesk and OS. Can be used with the |
To list the Plesk versions you can update to: plesk listupgrade |
checkupgrade |
<Plesk version> | --source | <options>
|
Downloads and runs Plesk pre-upgrade checker that checks the environment before an update or migration. Helps identify potential issues with update or migration beforehand. The command downloads and runs pre-upgrade checker for the specified Plesk version. If you do not specify it, the command chooses the latest available Plesk version. Can be used with the |
To run Plesk pre-upgrade checker for version 18.0.32: plesk checkupgrade 18.0.32 |
--source |
<link> |
Used with the If you omit |
To download and run pre-upgrade checker using the repository at plesk checkupgrade --source https://autoinstall.plesk.com |
installer |
[SHORTCUT | OPTIONS] |
Run Plesk installer with given options or a predefined set of options via a shortcut. Available shortcuts:
|
To install all available updates within current Plesk version: plesk installer install-all-updates |
log |
LOGNAME |
Display the specified Plesk log file using the “ Available log files:
|
To display Plesk error log: plesk log error_log |
login |
[USERNAME][-relative-url] |
Generate a one-time login link for the specified user. If no user is specified, the link for Plesk administrator is generated. If the To use this link for logging in to Plesk, add it to the Plesk server URL based on the host name or the IP address. Otherwise, a pair of absolute links based on the the Plesk server host name and the IP address are generated. For example:
The generated links can be used only once and become invalid after 24 hours since the generation time. |
To generate a one-time login: plesk login To generate a one-time login for the user user_demo: plesk login user_demo To generate a one-time relative link for the user user_demo: plesk login user_demo -relative-url |
php |
FILENAME.php |
Run a PHP script using the Plesk PHP interpreter. |
To run the plesk php /tmp/script.php |
repair |
ASPECT [OPTION] |
Run Plesk check and repair tool. Provide aspect ‘ Available aspects:
Available options:
For details, refer to Plesk Repair Tool. |
To reconfigure the mail settings for all mailboxes belonging to the example.com domain, as well as domain-wide mail settings: plesk repair mail example.com To display help for the mail aspect of the utility: plesk repair mail -h |
sbin |
UTILITY |
Run the specified Plesk internal utility. This is applicable to the utilities located at
|
To enable nginx proxy server: plesk sbin nginxmng -e |
version |
Show product version information. Version, build date, revision and architecture will be shown. |
To view Plesk version information: plesk version |
|
ext |
<name><command>[<options>] |
Calls a command-line interface of the specified extension. |
To run the plesk ext git --list |
help |
[COMMAND] |
Show help and exit. If a command name is specified, the help
for a particular command is displayed. If no parameters are
used, the plesk utility help is displayed. |
To view the help for the plesk help repair |
Options
Option | Parameter | Description | Example |
---|---|---|---|
-verbose |
Enables verbose mode. |
To list the Plesk versions you can update to in verbose mode: plesk listupgrade -verbose |
|
-debug |
Enables debug mode. |
To download and run Plesk pre-upgrade checker in debug mode: plesk checkupgrade -debug |