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

For the client account with the client login name clientlogin, the following command line sets the disk space limit for the account to 20 GB, sets the account's validity period up until December 31, 2007, sets the Maximum number of subdomains limit to 20 subdomains, and enables the client to manage log rotation and mailing lists.

# ./client_pref --update clientlogin -disk_space 20GB -max_subdom 20 -expiration 2007-12-31-manage_log true -manage_maillists true

Commands

Command

Parameter

Description

Example

--update or -u

<login name>

Updates preferences and limits for an existing client account.

To disabling the option of changing domain limits:

# ./client_pref --update clientlogin -change_limits false

or

# ./client_pref -u clientlogin -change_limits false

--skin-list or -sl

 

Displays the list of available control panel interface skins.

To display 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 display information about preferences and limits set on client account with login name clientlogin:

# ./client_pref --info clientlogin

or

# ./client_pref -i clientlogin

--help or -h

 

Displays help on the use of the utility.

To display 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

Enables or disables creation of domains by a client (the Domain creation parameter).

To enable the client with login name clientlogin to create domains:

# ./client_pref -u clientlogin -create_domains true

-manage_phosting

true|false

Enables or disables physical hosting management by a client (the Physical hosting management parameter).

To enable the client with login name clientlogin to manage physical hosting:

# ./client_pref -u clientlogin -manage_phosting true

-manage_php_safe_mode

true|false

Allows/Prohibits a client to turn PHP safe mode off and on. (The PHP safe mode management parameter.)

Default value is false.

Available since Plesk 8.1.1.

To allow he client with login name clientlogin to manage PHP safe mode:

# ./client_pref -u clientlogin -manage_php_safe_mode_true

-change_limits

true|false

Enables or disables changing domain limits by the client (the Domain limits adjustment parameter).

To enable changing domain limits by the client with login name clientlogin:

# ./client_pref -u clientlogin -change_limits true

-manage_dns

true|false

Enables or disables DNS zone management by a client (the DNS zone management parameter).

To enable DNS zone management by a client with login name clientlogin:

# ./client_pref -u clientlogin -manage_dns true

-manage_log

true|false

Enables or disables log rotation management by a client (the Log rotation management parameter).

To enable log rotation management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_log true

-manage_crontab

true|false

Enables or disables crontab management (task scheduler) by a client (the Crontab management parameter).

To enable crontab management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_crontab true

-manage_anonftp

true|false

Enables or disables the anonymous FTP management by a client (the Anonymous FTP management parameter).

To enable the anonymous FTP management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_anonftp true

-manage_webapps

true|false

Enables or disables Java applications management by a client (the Java applications management parameter).

To enable Java applications management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_webapps true

-manage_maillists

true|false

Enables or disables Mailing lists management by a client (the Mailing lists management parameter).

To enable mailing lists management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_maillists true

-manage_sh_access

true|false

Enables or disables management of server shell access of any type by a client (the Management of shell access to server parameter, the Client cannot allow or disallow shell access and Client can allow access to any type of shell options).

To enable server shell access management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_sh_access true

-manage_not_chroot_shell

true|false

Enables or disables management of server shell access to the chrooted environment by a client (the Management of shell access to server parameter, the Client can allow access only to a chrooted environment options).

To enable a client with login name clientlogin to manage shell access only to the chrooted environment:

# ./client_pref -u clientlogin -manage_not_chroot_shell false

 

-manage_subdomains

true|false

Enables or disables management of subdomains by a client (the Subdomains management parameter).

To enable management of subdomains by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_subdomains true

-manage_quota

true|false

Enables or disables the hard disk quota management by a client (the Hard disk quota assignment parameter).

To enable the hard disk quota management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_quota true

-allow_local_backups

true|false

Enables or disables backing up data and restoring data from backups using the the control panel repository by a client (the Allow backing up and restoring data and use / control panel's repository parameter).

To enable the client with login name clientlogin to backup and restore data using the control panel's repository:

# ./client_pref -u clientlogin -allow_local_backups true

-allow_ftp_backups

true|false

Enables or disables backing up data and restoring data from backups using the the FTP repository by a client (the Allow backing up and restoring data and use / FTP repository repository parameter).

To enable the client with login name clientlogin to backup and restore data using the FTP repository:

# ./client_pref -u clientlogin -allow_ftp_backups true

-manage_drweb

true|false

Enables or disables Dr.Web antivirus application management by a client (the Dr.Web antivirus management parameter).

Deprecated since Plesk 8.1.1. Use the manage_virusfilter option instead.

To enable management of the Dr.Web antivirus application by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_drweb true

-manage_virusfilter

true|false

Allows/Prohibits a client changing settings of the antivirus tool used on his/her domains.

To enable management of the antivirus tool by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_virusfilter true

-remote_access_interface

true|false

Enables or disables the use of the remote XML interface by a client (the Ability to use remote XML interface parameter).

To allow client with login name clientlogin to use Plesk API RPC protocol:

# ./client_pref -u clientlogin -remote_access_interface true

-manage_domain_aliases

true|false

Enables or disables management of domain aliases by a client (the Domain aliases management parameter).

To enable management of domain aliases by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_domain_aliases true

-cp_access

true|false

Enables or disables client's access to control panel (the Access to control panel parameter).

To disable control panel access for the client with login name clientlogin:

# ./client_pref -u clientlogin -cp_access false

-manage_dashboard

true|false

Enables or disables desktop (dashboard) management by a client (the Desktop management parameter).

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

To enable desktop (dashboard) management for the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_dashboard true

-dashboard

true|false

Enables or disables the use of the Desktop interface by a client. Sets the User interface parameter (the Desktop and standard interface are allowed and Only Desktop interface is allowed options only).

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

  • To allow the use of Desktop interface by the client with login name clientlogin:

    # ./client_pref -u clientlogin -dashboard true

  • To allow the use of standard interface by the client with login name clientlogin:

    # ./client_pref -u clientlogin -stdgui true

  • To set the Desktop and standard interface are allowed option for the User interface parameter:

    # ./client_pref -u clientlogin -dashboard true -stdgui true

  • To set the Only standard interface is allowed option for the User interface parameter:

    # ./client_pref -u clientlogin -dashboard false -stdgui true

  • To set the Only Desktop interface is allowed option for the User interface parameter:

    # ./client_pref -u clientlogin -dashboard true -stdgui false

-stdgui

true|false

Enables or disables the use of the standard interface by a client. Sets the User interface parameter (the Desktop and standard interface are allowed and Only standard interface is allowed options only).

The -stdgui option can set to false only if the -dashboard option is set to true.

-manage_spamfilter

true|false

Enables or disables spam filter management by a client (the Spam filter management parameter).

To enable spam filter management by the client with login name clientlogin:

# ./client_pref -u clientlogin -manage_spamfilter true

-max_dom

<number>

Sets the Maximum number of domains limit for a client.

Type "-1" to set the parameter to the Unlimited value.

To set the Maximum number of domains limit for the client with login name clientlogin to 10:

# ./client_pref -u clientlogin -max_dom 10

-max_dom_aliases

<number>

Sets the Maximum number of domain aliases limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of domain aliases limit for the client with login name clientlogin to 10:

# ./client_pref -u -max_dom_aliases 10

-disk_space

<number>[K|M|G]

Sets the Disk space limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Disk space limit for the client with login name clientlogin to 100 MB:

# ./client_pref -u clientlogin -disk_space 100M

-max_traffic

<number>[K|M|G]

Sets the Maximum amount of traffic limit (per month) for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum amount of traffic limit for the client with login name clientlogin to 10 GB/month:

# ./client_pref -u clientlogin -max_traffic 10G

-max_box

<number>

Sets the Maximum number of mailboxes limit (per month) for a client.

Type "-1" to set the parameter to Unlimited.

To set he Maximum number of mailboxes limit for the client with login name clientlogin to 10:

# ./client_pref -u clientlogin -max_box 10

-mbox_quota

<number>[K|M|G]

Sets the Set the mailbox quota limit for a client.

Type "-1" to set the parameter to Unlimited.

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

# ./client_pref -u clientlogin -mbox_quota 10M

-max_redir

<number>

Sets the Maximum number of mail redirects limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of mail redirects limit for the client with login name clientlogin to 10:

# ./client_pref -u clientlogin -max_redir 10

-max_mg

<number>

Sets the Maximum number of mail groups limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of mail groups limit for the client with login name clientlogin to 5:

# ./client_pref -u clientlogin -max_mg 5

-max_resp

<number>

Sets the Maximum number of mail autoresponders limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of mail autoresponders limit for the client with login name clientlogin to 5:

# ./client_pref -u clientlogin -max_resp 5

-max_wu

<number>

Sets the Maximum number of web users limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of web users limit for the client with login name clientlogin to 50:

# ./client_pref -u clientlogin -max_wu 50

-max_maillists

<number>

Sets the Maximum number of mailing lists limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of mailing lists limit for the client with login name clientlogin to 30:

# ./client_pref -u clientlogin -max_maillists 30

-max_db

<number>

Sets the Maximum number of databases limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the Maximum number of databases limit for the client with login name clientlogin to 20:

# ./client_pref -u clientlogin -max_db 2

-max_webapps

<number>

Sets the Maximum number of Java applications limit for a client.

Type "-1" to set the parameter to Unlimited.

 

To set the Maximum number of Java applications limit for the client with login name clientlogin to 50:

# ./client_pref -u clientlogin -max_webapps 50

-max_subdom

 

<number>

Sets the Maximum number of subdomains limit for a client.

Type "-1" to set the parameter to Unlimited.

To set the maximum number of subdomains for client with login name clientlogin to 40:

# ./client_pref -u clientlogin -max_subdom 40

-expiration

<YYYY-MM-DD>

Sets Validity period for for a client account.

Type "-1" to set the parameter to Unlimited.

To set the validity period for the client account with login name clientlogin to February 28, 2007:

# ./client_pref -u clientlogin -expiration 2007-2-28

-ip_pool

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

Adds IP addresses to or deletes IP addresses from from a client's IP address pool.

To add IP addresses 192.168.67.78 and 192.168.78.89 to the IP address pool of the client account with login name clientlogin:

# ./client_pref -u clientlogin -ip_pool add:192.168.67.78,192.168.78.89

-locale

<language code>

Sets the default interface language for client's control panel (the Interface language parameter). 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 login name clientlogin to Russian:

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

-skin

<skin name>

Sets the default interface skin for client's control panel (the Interface skin parameter).

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

# ./client_pref -u admin@example.com -skin "WinXP Olivegreen"

-multiple-sessions

true|false

Allows multiple simultaneous sessions under client's login (the Allow multiple sessions under administrator's login parameter).

To allow multiple sessions to run simultaneously under the client login name clientlogin:

# ./client_pref -u clientlogin -multiple-sessions true

-max-button-length

<number>

Sets the maximum allowed button length (in symbols) for client's control panel (the Button label length parameter).

To change the button label length to 20 for the control panel for the client with login name clientlogin:

# ./client_pref -u clientlogin -max-button-length 20

-lock-screen

true|false

Sets the Prevent users from working with the control panel until interface screens are completely loaded parameter.

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

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

-desktop-preset

<preset name>

Sets the default desktop preset for client's control panel (the Desktop preset parameter).

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

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