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

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.

plesk bin admin_alias --create JDoe -passwd sample -contact "John Doe" -email JDoe@example.com

Commands

Command Parameter Description Example
--create or -c <login_name>

Creates an additional Administrator account.

Requires -email and -passwd options.

To create the account with the login name JDoe, password sample, and the account’s email address JDoe@example.com:

plesk bin admin_alias --create JDoe -passwd sample -email JDoe@example.com

or

plesk bin admin_alias -c JDoe -passwd sample -email JDoe@example.com

--update or -u <login_name> Updates additional Administrator account settings.

To change the login name from JDoe to John and set the password to 12345:

plesk bin admin_alias --update JDoe -login John -passwd 12345

or

plesk bin admin_alias -u JDoe -login John -passwd 12345

--remove or -r <login_name> Removes additional Administrator account.

To remove the account with the login name JDoe:

plesk bin admin_alias --remove JDoe

or

plesk bin admin_alias -r JDoe

--info or -i <login_name> Displays additional Administrator account preferences.

To retrieve preferences of the account with the login name JDoe:

plesk bin admin_alias --info JDoe

or

plesk bin admin_alias -i JDoe

--xml-info or -xi <login_name> Displays Administrator account preferences in the XML format.

To view information about JDoe in the XML format:

plesk bin admin_alias --xml-info JDoe

or

plesk bin admin_alias -xi JDoe

--list or -l   Lists login names of additional Administrator accounts.

To list accounts login names:

plesk bin admin_alias --list

or

plesk bin admin_alias -l

--help or -h   Displays help on the utility use.

To view help on the use of this utility:

plesk bin admin_alias --help

or

plesk bin admin_alias -h

Options

Option Parameter Description Example
-login <string>

Specifies new Plesk login name for an additional Administrator account.

Used with the --update command only.

To update the account name from JDoe to John:

plesk bin admin_alias --update JDoe -login John

-passwd <password>

Specifies Plesk password for an additional Administrator account.

Required with the --create command.

See additional comments in the Note below the table.

To set the JDoe account password to 54321:

plesk bin admin_alias --update JDoe -passwd 54321

-email <email>

Specifies additional Administrator account email address.

Required with the --create command.

To set email address of JDoe to jd@example.com:

plesk bin admin_alias --update JDoe -email jd@example.com

-enabled true|false

Defines if an additional Administrator account can access Plesk.

Is true by default.

To disable access to Plesk for JDoe:

plesk bin admin_alias --update JDoe -enabled false

-contact <string> Specifies an additional Administrator’s contact name.

To set the JDoe contact name to John Doe:

plesk bin admin_alias --update JDoe -contact "John Doe"

-comment <string> Specifies information about an additional Administrator account and its user.

To update comment on JDoe account:

plesk bin admin_alias --update JDoe -comment "Administrator John Doe"

Note: We recommend that you do not use the -passwd option because passing passwords via the CLI is insecure. Use the PSA_PASSWORD environment variable instead. If you transfer the password via the PSA_PASSWORD environment variable, use single quotes to specify the empty value for the -passwd option.