admin_alias.exe: Additional Administrator Accounts
The admin_alias CL utility is used to manage additional Administrator-level accounts.
By using this utility, you can perform the following tasks:
- creating additional Administrator accounts
- enabling and disabling access to Plesk for additional Administrator accounts
- updating additional Administrator account preferences
- removing additional Administrator accounts
Location
%plesk_cli%
Usage
admin_alias <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, Plesk login name JDoe, password sample, and account's 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 the account's 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 usage. |
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 Plesk 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 Plesk password for an additional Administrator account. Required with the |
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 Plesk. Is |
To disable access to Plesk for JDoe: admin_alias.exe --update JDoe -enabled false |
|
|
|
Specifies an additional Administrator's contact name.
|
To set the JDoe contact name to John Doe: admin_alias.exe --update JDoe -contact "John Doe" |
|
|
|
Specifies information about an additional Administrator account and its user. |
To update comment on JDoe account: admin_alias.exe --update JDoe -comment 'Administrator John Doe' |