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.
Example
The following command creates a subscription for the administrator’s customer with the username JDoe based on the hosting plan Default Domain, sets up a site for the domain example.com, assigns IP address 192.168.1.100 to the subscription, and sets the username JDoe and password userpass_123 for access to the subscription:
plesk bin subscription --create example.com -owner admin -service-plan "Default Domain" -ip 192.168.1.100 -login JDoe -passwd "userpass_123"
Commands
Command | Parameter | Description | Example |
---|---|---|---|
bin |
UTILITY |
Runs the specified Plesk command line utility. This is applicable to public CLI utilities located in the
|
To create a subscription for the administrator’s customer with the username JDoe based on the hosting plan Default Domain, set up a site for the domain example.com, assign IP address 192.168.1.100 to the subscription, and set the username JDoe and password userpass_123 for access to the subscription: plesk bin subscription --create example.com -owner admin -service-plan "Default Domain" -ip 192.168.1.100 -login JDoe -passwd "userpass_123" |
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:
|
To display the list of existing database tables: plesk db tables |
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 |
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. Available log files:
|
Display Plesk error log: plesk log php_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 -relative-url option is used, a relative link will be
generated. For example:
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 relative link for the user user_demo: plesk login user_demo -relative-url |
php |
FILENAME.php |
Run specified PHP script using the Plesk PHP interpreter
(%plesk_dir%admin\bin\php.exe ). |
To run the plesk php "C:\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 applies to utilities located in the
|
To change type of the 10.58.70.125 IP address which belongs to the JDoe’s IP pool to shared: plesk sbin ip_pool --update 10.58.70.125 -type shared -owner JDoe |
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 |