PLESK COMMAND LINE INTERFACE

Chapter 2. How It Works

Plesk CLI is a set of utilities which use Plesk core functionality to provide alternative control over the Plesk business objects. It is possible to create, update and remove clients, domains, mail addresses and other objects, controllable from Plesk Control Panel web interface.

Plesk CLI utilities may be used by the root user from the console or script. Utilities require "root" or "psaadm" privileges to operate.

Plesk CLI supports localized names of business objects in the same fashion as Plesk itself. It means, you can create clients with contact name using your native locale. To force some particular locale, you should set LANG environment variable appropriately.

Plesk CLI does not require the web interface of Plesk Server Administrator to be run.

Security note: Passing passwords throught the command line as parameters of utilities is not good for the system's security as command line may be observed by users of the system. It's more secure to pass passwords throught the environment variables. For this purposes PSA_PASSWORD and PSA_CRYPTED_PASSWORD environment variables should be used.

You can transfer not encrypted passwords via environment variable PSA_PASSWORD, by specifying the empty value in the command line for the passwd arguments (like " -passwd ''") and setting the password value in the PSA_PASSWORD variable.

Similarly, you can transfer the crypted password via the environment variable PSA_CRYPTED_PASSWORD, by specifying the empty value in the command line for the passwd arguments (like " -passwd ''") and by setting the password value in the PSA_CRYPTED_PASSWORD variable.

to top