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 john_doe, password sample, and account’s email address john_doe@example.com.

plesk bin admin_alias --create john_doe -passwd 'sample' -contact 'John Doe' -email john_doe@example.com

Commands

Command

Parameter

Description

Example

--create or -c

<login_name>

Creates an additional Administrator account.

Requires the -email, -passwd, and -contact options.

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

plesk bin admin_alias --create john_doe -passwd 'sample' -contact 'John Doe' -email john_doe@example.com

or

plesk bin admin_alias -c john_doe -passwd 'sample' -contact 'John Doe' -email john_doe@example.com

--update or -u

<login_name>

Updates additional Administrator account settings.

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

plesk bin admin_alias --update john_doe -login John -passwd '12345'

or

plesk bin admin_alias -u john_doe -login John -passwd '12345'

--remove or -r

<login_name>

Removes additional Administrator account.

To remove the account with the login name john_doe:

plesk bin admin_alias --remove john_doe

or

plesk bin admin_alias -r john_doe

--info or -i

<login_name>

Displays additional Administrator account preferences.

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

plesk bin admin_alias --info john_doe

or

plesk bin admin_alias -i john_doe

--xml-info or -xi

<login_name>

Displays Administrator account preferences in the XML format.

To view information about john_doe in the XML format:

plesk bin admin_alias --xml-info john_doe

or

plesk bin admin_alias -xi john_doe

--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 john_doe to John:

plesk bin admin_alias --update john_doe -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 john_doe account password to 54321:

plesk bin admin_alias --update john_doe -passwd '54321'

-email

<email>

Specifies additional Administrator account email address.

Required with the --create command.

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

plesk bin admin_alias --update john_doe -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 john_doe:

plesk bin admin_alias --update john_doe -enabled false

-contact

<string>

Specifies an additional Administrator’s contact name.

To set the john_doe contact name to John Doe:

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

-comment

<string>

Specifies information about an additional Administrator account and its user.

To update comment on john_doe account:

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

-locale

<language code>

Sets the interface language for an additional administrator account (for example, “it-IT” for Italian)

To set the interface language for the additional administrator account john_doe to Italian:

plesk bin admin_alias --update john_doe -locale 'it-IT'

-multiple_sessions

<true|false>

Allows multiple sessions for an additional administrator account.

To allow multiple sessions for the additional administrator account john_doe:

plesk bin admin_alias --update john_doe -multiple_sessions true

-enable_admin_restrictions

<true|false>

Enables the Restricted Mode for an additional administrator account.

To enable the Restricted Mode for the additional administrator account john_doe:

plesk bin admin_alias --update john_doe -enable_admin_restrictions true

-force_admin_restrictions

<true|false>

Forces the Restricted Mode for an additional administrator account.

To force the Restricted Mode for the additional administrator account john_doe:

plesk bin admin_alias --update john_doe -force_admin_restrictions true

-enable_power_user

<true|false>

Enables the Power User view for an additional administrator account.

To enable the Power User view for the additional administrator account john_doe:

plesk bin admin_alias --update john_doe -enable_power_user true

-force_power_user

<true|false>

Forces the Power User view for an additional administrator account.

To force the Power User view for the additional administrator account john_doe:

plesk bin admin_alias --update john_doe -force_power_user true

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.