client_pref: Client Limits, Permissions, and Interface Settings

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

Usage
client_pref <command> [<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.

plesk bin 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:

plesk bin client_pref --update JDoe -change_limits false

or

plesk bin 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:

plesk bin client_pref --skin-list

or

plesk bin 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:

plesk bin client_pref --info JDoe

or

plesk bin 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:

plesk bin client_pref --help

or

plesk bin client_pref -h

Options
Option Parameter Description Example

-overuse

block|notify|normal

Sets the overuse policy for the customer account.

To set the overuse policy to "block" for the customer account JDoe:

 

plesk bin client_pref -u JDoe -overuse block

-create_domains

true|false

Allows/Prohibits creation domains.

Is false by default.

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

plesk bin 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:

plesk bin client_pref -u JDoe -manage_phosting true

-manage_php_safe_mode

true|false

Allows/Prohibits managing PHP safe mode.

Is false by default.

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

plesk bin 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:

plesk bin 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:

plesk bin 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:

plesk bin client_pref -u JDoe -manage_log true

-manage_mail_settings

true|false

Allows/Prohibits managing the mail settings.

To allow the client with the login name JDoe to manage the mail settings:

plesk bin client_pref -u JDoe -manage_mail_settings 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:

plesk bin 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:

plesk bin 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:

plesk bin 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:

plesk bin 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:

plesk bin client_pref -u JDoe -manage_sh_access true

-manage_performance_bandwidth

true|false

Allows/Prohibits managing the bandwidth limit.

To allow the client with the login name JDoe to manage the bandwidth limit:

plesk bin client_pref -u JDoe -manage_performance_bandwidth true

-manage_performance_connections

true|false

Allows/Prohibits managing the number of connections limit.

To allow the client with the login name JDoe to manage the number of connections limit:

plesk bin client_pref -u JDoe -manage_performance_connections true

-manage_phosting_errdocs

true|false

Allows/Prohibits managing the custom error documents.

To allow the client with the login name JDoe to manage the custom error documents:

plesk bin client_pref -u JDoe -manage_phosting_errdocs true

-manage_phosting_ssl

true|false

Allows/Prohibits managing the SSL certificates.

To allow the client with the login name JDoe to manage the SSL certificates:

plesk bin client_pref -u JDoe -manage_phosting_ssl true

-access_appcatalog

true|false

Allows/Prohibits access to the Application Catalog.

To allow the client with the login name JDoe to access the Application Catalog:

plesk bin client_pref -u JDoe -access_appcatalog true

-access_service_users

true|false

Allows/Prohibits managing the auxiliary user accounts.

To allow the client with the login name JDoe to manage the auxiliary user accounts:

plesk bin client_pref -u JDoe -access_service_users true

-allow_oversell

true|false

Allows/Prohibits overselling.

To allow the client with the login name JDoe to oversell:

plesk bin client_pref -u JDoe -allow_oversell 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:

plesk bin 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:

plesk bin 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:

plesk bin client_pref -u JDoe -manage_quota true

-allow_local_backups

true|false

Allows/Prohibits backing up and restoring data using the Plesk's storage.

Is false by default.

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

plesk bin client_pref -u JDoe -allow_local_backups true

-allow_ftp_backups

true|false

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

Is false by default.

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

plesk bin client_pref -u JDoe -allow_ftp_backups true

-allow_account_local_backups

true|false

Allows/Prohibits backing up and restoring the account data using the Plesk's storage.

To allow the client with the login name JDoe to backup and restore the account data using the Plesk's storage:

plesk bin client_pref -u JDoe -allow_account_local_backups true

-allow_account_ftp_backups

true|false

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

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

plesk bin client_pref -u JDoe -allow_account_ftp_backups true

-allow_insecure_sites

true|false

Allows/Prohibits configuring potentially insecure web scripting options that override the provider's policy.

To allow the client with the login name JDoe to configure potentially insecure web scripting options:

plesk bin client_pref -u JDoe -allow_insecure_sites true

-allow_license_stubs

true|false

Allows/Prohibits activating APS apps using license keys from the Plesk license pool.

To allow the client with the login name JDoe to activate APS apps using license keys from the Plesk license pool:

plesk bin client_pref -u JDoe -allow_license_stubs 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:

plesk bin 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:

plesk bin client_pref -u JDoe -remote_access_interface true

-manage_security_wordpress_toolkit

true|false

Allows/Prohibits access to the WordPress Toolkit Security Management feature.

To allow the client with the login name JDoe to access the WordPress Toolkit Security Management feature:

plesk bin client_pref -u JDoe -manage_security_wordpress_toolkit 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:

plesk bin client_pref -u JDoe -manage_domain_aliases true

-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:

plesk bin client_pref -u JDoe -manage_spamfilter true

-manage_subftp

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

To allow the client with the login name JohnDoe to manage additional FTP accounts:

plesk bin client_pref --update JohnDoe -manage_subftp true

-manage_webstat

true|false

Allows/Prohibits managing web statistics.

Is false by default.

 

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

plesk bin client_pref -u JDoe -manage_webstat true

-manage_website_maintenance

true|false

Allows/Prohibits access to the Website Copying feature.

To allow the client with the login name JDoe to access the Website Copying feature:

plesk bin client_pref -u JDoe -manage_website_maintenance true

-manage_wordpress_toolkit

true|false

Allows/Prohibits access to the Wordpress Toolkit.

To allow the client with the login name JDoe to access the WordPress Toolkit:

plesk bin client_pref -u JDoe -manage_wordpress_toolkit 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:

plesk bin 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:

plesk bin 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 GB:

plesk bin client_pref -u JDoe -disk_space 100G

-disk_space_soft

<number>[K|M|G]

Sets the amount of disk space upon reaching which notification is sent.

To set the amount of disk space upon reaching which notification is sent for the client with the login name JDoe to 70 GB:

plesk bin client_pref -u JDoe -disk_space_soft 70G

-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:

plesk bin client_pref -u JDoe -max_traffic 10G

-max_traffic_soft

<number>[K|M|G]

Sets the monthly amount of traffic upon reaching which notification is sent.

To set the amount of traffic upon reaching which notification is sent to 70 GB/month:

plesk bin client_pref -u JDoe -max_traffic_soft 70G

-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:

plesk bin 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:

plesk bin client_pref -u JDoe -mbox_quota 10M

-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:

plesk bin 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:

plesk bin 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:

plesk bin client_pref -u JDoe -max_db 2

-max_subftp_users

<number>

Limits the number of available additional FTP accounts.

Unlimited if set to -1.

To restrict the maximum number of additional FTP accounts available to the client with the login name JohnDoe to 100:

plesk bin client_pref -u JohnDoe -max_subftp_users 100

-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:

plesk bin 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:

plesk bin client_pref -u JDoe -max_subdom 40

-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:

plesk bin client_pref -u JDoe -locale 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:

plesk bin 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:

plesk bin client_pref -u JDoe -multiple-sessions false

-manage_phosting_ssi

true|false

Allows/Prohibits managing the SSI settings.

To allow the customer named JDoe to manage the SSI settings:

 

plesk bin client_pref -u JDoe -manage_phosting_ssi

-manage_phosting_php

true|false

Allows/Prohibits managing the PHP settings.

To allow the customer named JDoe to manage the PHP settings:

 

plesk bin client_pref -u JDoe -manage_phosting_php

-manage_phosting_cgi

true|false

Allows/Prohibits managing the CGI settings.

To allow the customer named JDoe to manage the CGI settings:

 

plesk bin client_pref -u JDoe -manage_phosting_cgi

-manage_phosting_perl

true|false

Allows/Prohibits managing the Perl settings.

To allow the customer named JDoe to manage the Perl settings:

 

plesk bin client_pref -u JDoe -manage_phosting_perl

-manage_phosting_python

true|false

Allows/Prohibits managing the Python settings.

To allow the customer named JDoe to manage the Python settings:

 

plesk bin client_pref -u JDoe -manage_phosting_python

-manage_phosting_asp

true|false

Allows/Prohibits managing the ASP settings.

To allow the customer named JDoe to manage the ASP settings:

 

plesk bin client_pref -u JDoe -manage_phosting_asp

-manage_phosting_fastcgi

true|false

Allows/Prohibits managing the FastCGI settings.

To allow the customer named JDoe to manage the FastCGI settings:

 

plesk bin client_pref -u JDoe -manage_phosting_fastcgi

-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:

plesk bin client_pref -u JDoe -max-button-length 10

-select_db_server

true|false

Allows/Prohibits choosing a DB server from the servers registered in Plesk, when creating a database.

Is false by default.

To allow the client with the login name JDoe to choose DB server on which a database is to be created:

plesk bin client_pref -u JDoe -select_db_server true

-remote_db_connection

true|false

Allows/Prohibits managing remote access for database users.

To allow the client with the login name JDoe to manage remote access for database users:

plesk bin client_pref -u JDoe -remote_db_connection true

-manage_performance

true|false

Allows/Prohibits to manage hosting performance.

Is false by default.

To prevent client with login name JDoe from managing hosting performance:

plesk bin client_pref -u JDoe -manage_performance false

-manage_php_settings

true|false

Allows/Prohibits to manage PHP settings.

Is false by default.

To allow the client with the login name JDoe to customize PHP settings for his websites:

plesk bin client_pref -u JDoe -manage_php_settings true

-manage_php_version

true|false

Allows/Prohibits to choose the PHP version.

To allow the client with the login name JDoe to choose the PHP version:

plesk bin client_pref -u JDoe -manage_php_version true

-manage_protected_dirs

true|false

Allows/Prohibits to manage the password-protected directories.

To allow the client with the login name JDoe to manage the password-protected directories:

plesk bin client_pref -u JDoe -manage_protected_dirs true

-site_builder

true|false

Allows/Prohibits to manage Presence Builder.

To allow the client with the login name JDoe to use Presence Builder:

plesk bin client_pref -u JDoe -site_builder true

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.