Administrator's Server Preferences: admin Utility

The admin utility is used to manage Plesk administrator control panel interface preferences and view the administrator's personal information and interface preferences through CLI.

Syntax

admin <command> [
<option_1> [<param>]
[<option_2> [<param>]]
… [<option_N> [<param>]]

Example

The following command sets the default interface skin to WinXP Olivegreen, the default interface language to Russian, and applies interface customization template CustomTemplate to the administrator's control panel interface.

# ./admin --update -skin "WinXP Olivegreen" -locale -ru-RU -template CustomTemplate

Commands

Command

Parameter

Description

Example

-update or -u

 

Updates Plesk administrator's server preferences.

To set the WinXP Olivegreen skin as the default interface skin:

# ./admin --update -skin "WinXP Olivegreen"

or

# ./admin -u -skin "WinXP Olivegreen"

--info or -i

 

Displays Plesk administrator's personal information and preferences.

To view Plesk administrator's personal information and preferences:

# ./admin --info

or

# ./admin -i

--xml-info or -xi

 

Displays Plesk administrator's personal information and preferences in the XML format.

To view Plesk administrator's personal information and preferences in the XML format:

# ./admin --xml-info

or

# ./admin -xi

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the admin utility:

# ./admin --help

or

# ./admin -h

Options

Option

Parameter

Description

Example

-locale

<language_code>

Sets the default interface language for Plesk administrator's control panel interface.

The argument of the command must be a valid four-letter language code derived from the language code described in ISO-639-2 and the corresponding country code described in ISO-3166.

For example, the Plesk code for the Italian language code is it-IT; the Plesk code for the American variant of English is en-US; the Plesk code for the British variant of English is en-GB.

To set the default interface language to Russian:

# ./admin -u -locale ru-RU

-skin

<skin_name>

Sets the default interface skin for Plesk administrator's control panel interface.

To set the default interface skin to WinXP Olivegreen:

# ./admin -u -skin "WinXP Olivegreen"

-template

<template_name>

Applies an interface customization template to Plesk administrator's control panel interface.

To apply the customization template CustomTemplate to administrator's control panel interface:

# ./admin -u -template CustomTemplate

-multiple-sessions

true|false

Allows/Prohibits having several simultaneous sessions under administrator's login.

To allow multiple sessions to run simultaneously under administrator's login:

# ./admin -u -multiple-sessions true

-max-button-length

<number>

Limits button label length for the Plesk administrator's control panel interface.

To restrict the maximum button label length for the Plesk administrator's control panel interface to 10:

# ./admin -u -max-button-length 10

-lock-screen

true|false

Prevents/Allows working with Plesk until page is completely loaded.

To allow Plesk administrator to work with the control panel even if control panel screens are not completely loaded:

# ./admin -u -lock-screen false