System and Interface Preferences: server_pref.exe

The server_pref.exe utility is used to manage server-wide settings. Using this utility, one can perform the following operations:

Location

%plesk_cli%

Usage

server_pref.exe <command> [
<option_1> [<param>]
[<option_2> [<param>]]
… [<option_N> [<param>]]

Example

The following command sets the Plesk server host name to host.example.com, enables including mailboxes in the disk space usage calculation, and enables including only outbound traffic in the traffic calculation.

>server_pref.exe --update -hostname host.example.com -include-mailboxes true -traffic-direction out

Commands

Command

Parameter

Description

Example

--set-default-locale

 

Deprecated. Use --set-default command with -locale option.

 

--set-default-skin

 

Deprecated. Use --set-default command with -skin option.

 

--set-default or -sd

 

Sets default server-wide parameters.

Requires -locale, -skin, -template options in any combinations.

To set Plesk default locale to English (United States) and default skin to Aqua Compact:

>server_pref.exe --set-default -locale en-US -skin "Aqua Compact"

or

>server_pref.exe -sd -locale en-US -skin "Aqua Compact"

--locales-list or -ll

 

Displays the list of available supported interface languages (locales).

To view the list of available interface languages (locales):

>server_pref.exe --locales-list

--skins-list or -sl

 

Displays the list of available Plesk control panel skins.

To view the list of available skins:

>server_pref.exe --skins-list

--templates-list or -tl

 

Displays the list of available interface customization templates.

To view the list of available interface customization templates:

>server_pref.exe --templates-list

-update or -u

 

Updates Plesk server preferences.

 

--help or -h

 

Displays help on the use of the utility.

>server_pref.exe --help

or

>server_pref.exe -h

Options

Option

Parameter

Description

Example

-locale

<language code>

Sets the default interface language for Plesk control panel interface.

The argument of the option 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.

Used with the --set-default only.

To set the default interface language for Plesk administrator's interface to Italian:

>server_pref.exe -sd -locale it-IT

-skin

<skin name>

Sets the default interface skin for Plesk control panel interface.

Used with the --set-default only.

To set the skin WinXP Olivegreen as the default skin:

>server_pref.exe -sd -skin "WinXP Olivegreen"

-template

<template name>

Sets the default interface customization template to Plesk control panel interface.

Used with the --set-default only.

To apply customization template Interface Customization Template to administrator's control panel interface:

>server_pref.exe -sd -template "Interface customization template"

-hostname

<string>

Sets the full host name of the server.

To set the host name to host.example.com:

>server_pref.exe -u -hostname host.example.com

-include-logs

true|false

Enables/Disables including log files in the disk space usage calculation.

To enable including log files in the disk space usage calculation:

>server_pref.exe -u -include-logs true

-include-mysql-databases

true|false

Enables/Disables including disk space allocated to MySQL databases in the disk space usage calculation.

To count MySQL databases disk space in the overall statistics:

>server_pref.exe -u -include-mysql-databases true

-include-mssql-databases

true|false

Enables/Disables including disk space allocated to Microsoft SQL databases in the disk space usage calculation.

To count Microsoft SQL databases disk space in the overall statistics:

>server_pref.exe -u -include-mssql-databases true

-include-mailboxes

true|false

Enables/Disables including mailboxes in the disk space usage calculation.

To enable including mailboxes in the disk space usage calculation:

>server_pref.exe -u -include-mailboxes true

-include-webapps

true|false

Enables/Disables including Tomcat Java web applications in the disk space usage calculation.

To enable including web applications in the disk space usage calculation:

>server_pref.exe -u -include-webapps true

-include-maillists

true|false

Enables/Disables including mailing lists in the disk space usage calculation.

To enable including mailing lists in the disk space usage calculation:

>server_pref.exe -u -include-maillists true

-include-domaindumps

true|false

Enables/Disables including domain backup files in the disk space usage calculation.

To enable including domain backup files in the disk space usage calculation:

>server_pref.exe -u -include-domaindumps true

-stat-keep

<months>

Limits the number of months to retain traffic statistics.

Is 3 by default.

To retain traffic statistics for 6 months:

>server_pref.exe -u -stat-keep 6

-traffic-direction

both|in|out

Specifies a type of calculating traffic. The following types are available:

  • inbound and outbound (both)
  • inbound (in)
  • outbound (out)

To include only outbound traffic in the traffic calculation:

>server_pref.exe -u -traffic-direction out

-force-db-prefix

true|false

Enables/Disables adding database owner login name (client or reseller) to database names as prefix <<client|reseller>_login>_.

Is false by default.

To enable creating databases with names <client|reseller login>_<database name>:

>server_pref.exe -u -force-db-prefix true

-force-db-user-prefix

<true|false>

Enables/Disables adding database owner login name (client or reseller) to database user names as prefix <<client|reseller>_login>_.

Is false by default.

To enable creating database users with names <client|reseller login>_<database user name>:

>server_pref.exe -u -force-db-user-prefix true

-db-user-length

<integer>

Limits the number of characters in database user name.

To limit database user name to 25 characters:

>server_pref.exe -u -db-user-length 25

-forbid-create-dns-subzone

true|false

Disables/Enables users to create DNS subzones in other users' DNS superzones.

Is false by default.

Available since Plesk 8.4.

To prohibit users from creating DNS subzones in other user's DNS superzones:

>server_pref.exe -u -forbid-create-dns-subzone true