The admin_alias.exe CL utility is used to manage additional Administrator-level accounts.
By using this utility, you can perform the following tasks:
Location
%plesk_cli%
Usage
admin_alias.exe <command> [<login_name>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
Example
The following command creates the additional Administrator account with the contact name John Doe, Parallels Plesk Panel login name JDoe, password sample, and account email address JDoe@example.com.
>admin_alias.exe --create JDoe -passwd sample -contact "John Doe" -email JDoe@example.com
Commands
Command |
Parameter |
Description |
Example |
||
|---|---|---|---|---|---|
|
|
Creates an additional Administrator account. Requires |
To create the account with the login name JDoe, password sample, and account e-mail address JDoe@example.com: >admin_alias.exe --create JDoe -passwd sample -email JDoe@example.com or >admin_alias.exe -c JDoe -passwd sample -email JDoe@example.com |
||
|
|
Updates additional Administrator account settings. |
To change the login name from JDoe to John and set the password to 12345: >admin_alias.exe --update JDoe -login John -passwd 12345 or >admin_alias.exe -u JDoe -login John -passwd 12345 |
||
|
|
Removes additional Administrator account. |
To remove the account with the login name JDoe: >admin_alias.exe --remove JDoe or >admin_alias.exe -r JDoe |
||
|
|
Displays additional Administrator account preferences. |
To retrieve preferences of the account with the login name JDoe: >admin_alias.exe --info JDoe or >admin_alias.exe -i JDoe |
||
|
|
Displays Administrator account preferences in the XML format. |
To view information about JDoe in the XML format: >admin_alias.exe --xml-info JDoe or >admin_alias.exe -xi JDoe |
||
|
|
Lists login names of additional Administrator accounts. |
To list accounts login names: >admin_alias.exe --list or >admin_alias.exe -l |
||
|
|
Displays help on the utility use. |
To view help on the use of this utility: >admin_alias.exe --help or >admin_alias.exe -h |
||
Options
Option |
Parameter |
Description |
Example |
|---|---|---|---|
|
|
Specifies new Parallels Plesk Panel login name for an additional Administrator account. Used with the |
To update the account name from JDoe to John: >admin_alias.exe --update JDoe -login John |
|
|
Specifies Parallels Plesk Panel password for an additional Administrator account. Required with the See additional comments in the Note below the table. |
To set the JDoe account password to 54321: >admin_alias.exe --update JDoe -passwd 54321 |
|
|
Specifies additional Administrator account email address. Required with the |
To set email address of JDoe to jd@example.com: >admin_alias.exe --update JDoe -email jd@example.com |
|
|
Defines if an additional Administrator account can access Parallels Plesk Panel. Is |
To disable access to Parallels Plesk Panel for JDoe: >admin_alias.exe --update JDoe -enabled false |
|
|
Specifies additional Administrator contact name.
|
To set the JDoe contact name to John Doe: >admin_alias.exe --update JDoe -contact "John Doe" |
|
|
Specifies information about additional Administrator account and its user. |
To update comment on JDoe account: >admin_alias.exe --update JDoe -comment "Administrator from New York" |
Note: Use of this option is not recommended. Passing passwords through CLI as parameters of the -passwd option may potentially compromise the system's security as command line can be observed by other users of the system. It is more secure to pass passwords through the environment variables. You can transfer non-encrypted passwords by using environment variable PSA_PASSWORD while using single quotes to specify the empty values in the command line for the argument of the -passwd option.
Similarly, you can transfer encrypted passwords through the environment variable PSA_CRYPTED_PASSWORD while using single quotes to specify the empty values in the command line for the argument of the -passwd option.