Client Limits, Permissions, and Interface Settings: client_pref Utility

The client_pref utility enables the administrator to set and edit the client's limits and permissions, to manage the client's IP pool, and to define Plesk interface preferences (e.g. the default language and skin) for the client through CLI.

Syntax

client_pref <command> <client_login_name> [
<option_1> [<param>]
[<option_2> [<param>]]
… [<option_N> [<param>]]

Example

The following command updates the client account with the login name JDoe as follows: the client is allowed to manage log rotation and mailing lists and to create up to 20 subdomains. The use of disk space allotted for the client is restricted to 20 GB, and the expiration date of the client account is set to 2008-12-31.

# ./client_pref --update JDoe -manage_log true -manage_maillists true -max_subdom 20 -disk_space 20G -expiration 2008-12-31

Commands

Command

Parameter

Description

Example

--update or -u

<login_name>

Updates preferences and limits for an existing client account.

To disable changing domain limits for the client account with the login name JDoe:

# ./client_pref --update JDoe -change_limits false

or

# ./client_pref -u JDoe -change_limits false

--skin-list or -sl

 

Displays the list of available control panel interface skins.

To view the list of available interface skins:

# ./client_pref --skin-list

or

# ./client_pref -sl

--info or -i

<login_name>

Displays information about client account preferences and limits.

To view information about preferences and limits set on the client account with login name JDoe:

# ./client_pref --info JDoe

or

# ./client_pref -i JDoe

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the client_pref utility:

# ./client_pref --help

or

# ./client_pref -h

Options

Option

Parameter

Description

Example

-create_domains

true|false

Allows/Prohibits creation domains.

Is false by default.

To allow the client with the login name JDoe to create domains:

# ./client_pref -u JDoe -create_domains true

-manage_phosting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

To allow the client with the login name JDoe to manage physical hosting:

# ./client_pref -u JDoe -manage_phosting true

-manage_php_safe_mode

true|false

Allows/Prohibits managing PHP safe mode.

Is false by default.

Available since Plesk 8.1.1.

To allow the client with login name JDoe to manage PHP safe mode:

# ./client_pref -u JDoe -manage_php_safe_mode true

-change_limits

true|false

Allows/Prohibits changing domain limits.

Is false by default.

To allow the client with the login name JDoe to change domain limits:

# ./client_pref -u JDoe -change_limits true

-manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

To allow the client with the login name JDoe to manage DNS:

# ./client_pref -u JDoe -manage_dns true

-manage_log

true|false

Allows/Prohibits managing log rotation.

Is false by default.

To allow the client with the login name JDoe to manage log rotation:

# ./client_pref -u JDoe -manage_log true

-manage_crontab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

To allow the client with the login name JDoe to manage task scheduler:

# ./client_pref -u JDoe -manage_crontab true

-manage_anonftp

true|false

Allows/Prohibits managing anonymous FTP.

Is false by default.

To allow the client with the login name JDoe to manage anonymous FTP:

# ./client_pref -u JDoe -manage_anonftp true

-manage_webapps

true|false

Allows/Prohibits managing Java applications.

Is false by default.

To allow the client with the login name JDoe to manage Java applications:

# ./client_pref -u JDoe -manage_webapps true

-manage_maillists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

To allow the client with the login name JDoe to manage mailing lists:

# ./client_pref -u JDoe -manage_maillists true

-manage_sh_access

true|false

Allows/Prohibits managing system access.

Is false by default.

To allow the client with the login name JDoe to manage system access:

# ./client_pref -u JDoe -manage_sh_access true

-manage_not_chroot_shell

true|false

Allows/Prohibits managing non-chrooted environment.

Is false by default.

To allow the client with the login name JDoe to manage non-chrooted environment:

# ./client_pref -u JDoe -manage_not_chroot_shell true

-manage_subdomains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

To allow the client with the login name JDoe to manage subdomains:

# ./client_pref -u JDoe -manage_subdomains true

-manage_quota

true|false

Allows/Prohibits managing hard disk quota.

Is false by default.

To allow the client with login name JDoe to manage hard disk quota:

# ./client_pref -u JDoe -manage_quota true

-make_dumps

true|false

Allows/Prohibits backing up and restoring data.

Deprecated.

Is false by default.

To allow the client with the login name JDoe to backup and restore data:

# ./client_pref -u JDoe -make_dumps true

-allow_local_backups

true|false

Allows/Prohibits backing up and restoring data using the Plesk repository.

Is false by default.

To allow the client with the login name JDoe to backup and restore data using the Plesk repository:

# ./client_pref -u JDoe -allow_local_backups true

-allow_ftp_backups

true|false

Allows/Prohibits backing up and restoring data using the FTP repository.

Is false by default.

To allow the client with the login name JDoe to backup and restore data using the FTP repository:

# ./client_pref -u JDoe -allow_ftp_backups true

-manage_drweb

true|false

Allows/Prohibits managing Dr.Web antivirus application used on client's domains.

Deprecated since Plesk 8.1.1. Use the -manage_virusfilter option instead.

To allow the client with the login name JDoe to manage the Dr.Web antivirus application:

# ./client_pref -u JDoe -manage_drweb true

-manage_virusfilter

true|false

Allows/Prohibits managing antivirus tool used on client's domains.

Is false by default.

To allow the client with the login name JDoe to manage antivirus tool:

# ./client_pref -u JDoe -manage_virusfilter true

-remote_access_interface

true|false

Allows/Prohibits using Plesk API.

Is false by default.

To allow the client with the login name JDoe to use Plesk API:

# ./client_pref -u JDoe -remote_access_interface true

-manage_domain_aliases

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

To allow the client with the login name JDoe to manage domain aliases:

# ./client_pref -u JDoe -manage_domain_aliases true

-cp_access

true|false

Allows/Prohibits accessing Plesk GUI (as opposite to using Plesk API).

Is true by default.

To prohibit the client with login name JDoe from accessing Plesk GUI:

# ./client_pref -u JDoe -cp_access false

-manage_dashboard

true|false

Allows/Prohibits managing desktop view.

Can be set to true only if the -dashboard option is set to true.

Is true by default.

To prohibit the client with login name JDoe from managing desktop view:

# ./client_pref -u JDoe -manage_dashboard true

-stdgui

true|false

Allows/Prohibits using standard view.

Can be set to false only if the -dashboard option is set to true.

Is true by default.

To prohibit the client with the login name JDoe from using standard view:

# ./client_pref -u JDoe -stdgui false

-manage_spamfilter

true|false

Allows/Prohibits managing spam filter.

Is false by default.

To allow the client with the login name JDoe to manage spam filter:

# ./client_pref -u JDoe -manage_spamfilter true

-manage_webstat

true|false

Allows/Prohibits managing web statistics.

Is false by default.

Available since Plesk 8.2.

To allow the client with the login name JDoe to manage web statistics:

# ./client_pref -u JDoe -manage_webstat true

-max_dom

<number>

Limits the number of available domains.

Unlimited if set to-1.

To restrict maximum number of domains available to the client with the login name JDoe to 10:

# ./client_pref -u JDoe -max_dom 10

-max_dom_aliases

<number>

Limits the number of available domain aliases.

Unlimited if set to -1.

To restrict the maximum number of domain aliases available to the client with the login name JDoe to 5:

# ./client_pref -u JDoe -max_dom_aliases 5

-disk_space

<number>[K|M|G]

Limits the amount of available disk space.

A number without a letter is interpreted as the number of bytes.

Unlimited if set to -1.

To restrict the maximum amount of disk space available to the client with the login name JDoe to 100 MB:

# ./client_pref -u JDoe -disk_space 100M

-max_traffic

<number>[K|M|G]

Limits the monthly traffic usage.

A number without a letter is interpreted as the number of bytes.

Unlimited if set to -1.

To restrict the maximum amount of traffic available to the client with the login name JDoe to 10 GB/month:

# ./client_pref -u JDoe -max_traffic 10G

-max_box

<number>

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available to the client with the login name JDoe to 100:

# ./client_pref -u JDoe -max_box 100

-mbox_quota

<number>[K|M|G]

Limits the amount of disk space that a single mailbox can occupy.

A number without a letter is interpreted as the number of bytes.

Unlimited if set to -1.

To set the mailbox quota for the client with login name JDoe to 10 MB:

# ./client_pref -u JDoe -mbox_quota 10M

-max_redir

<number>

Limits the number of available mail redirects.

Unlimited if set to -1.

To restrict the maximum number of mail redirects available to the client with the login name JDoe to 10:

# ./client_pref -u JDoe -max_redir 10

-max_mg

<number>

Limits the number of available mail groups.

Unlimited if set to -1.

To set the number of mail groups available to the client with the login name JDoe to unlimited:

# ./client_pref -u JDoe -max_mg -1

-max_resp

<number>

Limits the number of available mail autoresponders.

Unlimited if set to -1.

To restrict the maximum number of mail autoresponders available to the client with the login name JDoe to 5:

# ./client_pref -u JDoe -max_resp 5

-max_wu

<number>

Limits the number of available web users.

Unlimited if set to -1.

To restrict the maximum number of web users available to the client with the login name JDoe to 50:

# ./client_pref -u JDoe -max_wu 50

-max_maillists

<number>

Limits the number of available mailing lists.

Unlimited if set to -1.

To restrict the maximum number of mailing lists available to the client with the login name JDoe to 30:

# ./client_pref -u JDoe -max_maillists 30

-max_db

<number>

Limits the number of available databases.

Unlimited if set to -1.

To restrict the maximum number of databases available to the client with the login name JDoe to 20:

# ./client_pref -u JDoe -max_db 2

-max_webapps

<number>

Limits the number of available Java applications.

Unlimited if set to -1.

To restrict the maximum number of Java applications available to the client with the login name JDoe to 50:

# ./client_pref -u JDoe -max_webapps 50

-max_subdom

<number>

Limits the number of available subdomains.

Unlimited if set to -1.

To restrict the maximum number of subdomains available to the client with the login name JDoe to 40:

# ./client_pref -u JDoe -max_subdom 40

-expiration

<YYYY-MM-DD>

Limits the validity period of a client account.

Unlimited if set to -1.

To set the validity period of the client account with the login name JDoe to February 29, 2008:

# ./client_pref -u JDoe -expiration 2008-2-29

-ip_pool

add|del:<ip1>,<ip2>,..,<ipN>

Adds/Deletes IP addresses to/from a client's IP address pool.

To add IP addresses 192.0.2.78 and 192.0.2.89 to the IP address pool of the client account with login name JDoe:

# ./client_pref -u JDoe -ip_pool add:192.0.2.78,192.0.2.89

-locale

<language_code>

Sets the default interface language for client'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 for the client with the login name JDoe to Russian:

# ./client_pref -u JDoe -locale ru-RU

-language

<language_code>

Sets the default interface language for client's control panel interface.

Deprecated since Plesk 8.0. Use the -locale option instead.

To set the default interface language for the client with the login name JDoe to Russian:

# ./client_pref -u JDoe -language ru-RU

-skin

<skin_name>

Sets the default interface skin for a client's control panel interface.

To set the skin WinXP Olivegreen as the default interface skin for the client with the login name JDoe:

# ./client_pref -u JDoe -skin "WinXP Olivegreen"

-multiple-sessions

true|false

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

Is true by default.

To prohibit multiple sessions to run simultaneously under login of the client with the login name JDoe:

# ./client_pref -u JDoe -multiple-sessions false

-max-button-length

<number>

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

To restrict the maximum button label length for the control panel interface of the client with the login name JDoe to 10:

# ./client_pref -u JDoe -max-button-length 10

-lock-screen

true|false

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

Is true by default.

To prevent client with login name JDoe from working with the control panel until control panel screens are completely loaded:

# ./client_pref -u JDoe -lock-screen true

-desktop-preset

<preset_name>

Sets the default desktop preset for client's control panel interface.

To set the preset Custom Desktop as the default interface skin for the client with the login name JDoe:

# ./client_pref -u JDoe -skin "Custom Desktop"