Getting Started With Command-Line Utilities

Standard command-line utilities are located in a folder defined by the Windows environment variable %plesk_cli%. By default, it is C:\Program Files (x86)\Parallels\Plesk\bin.

Extended command-line utilities are located in a folder defined by the Windows environment variable %plesk_bin%. By default, it is C:\Program Files (x86)\Parallels\Plesk\admin\bin.

To run command line utilities:

  1. Log in to the Plesk server as Administrator or another user with administrator's privileges.
  2. Use one of the following options to run a utility:
    • To run an utility from any directory, use the following command line format:

      %plesk_cli%\<utility name> [commands] [options]

      or

      %plesk_bin%\<utility name> [commands] [options]

    • To make %plesk_bin% or %plesk_cli% your current directory and run a utility from its home directory, run the following commands:
    • cd %plesk_cli%

      <utility name> [commands] [options]

      or

      cd %plesk_bin%

      <utility name> [commands] [options]

    • To run an utility using a special plesk utility, run the following command:

      plesk bin <utility name> [commands] [options]

For exact command syntax of each utility, consult the corresponding sections in the Chapter "Using Command Line Utilities".

Note: All input parameters for the utilities must be passed in the UTF-8 encoding. It is the required condition for Plesk stable work.

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.