Client Limits, Permissions, and Interface Settings: client_pref.exe

The client_pref.exe utility serves to set and update client limits and permissions, to manage client IP address pool settings, and to define client-specific Parallels Plesk Panel interface preferences (i.e., the default language and skin).

Location

%plesk_cli%

Usage

client_pref.exe <command> [<login_name>] [
<option 1> <param 1>[,<param 2>,…,<param n>] 
[<option 2> <param 1>[,<param 2>,…,<param n>]] 
… [<option N> <param 1>[,<param 2>,…,<param n>]]
]

Example

The following command updates the client account with the login name JohnDoe as follows: the client is allowed managing log rotation and mailing lists, backing up and restoring domains. Also, the client is allowed using Sitebuilder, the use of disk space allotted for the client is restricted to 150 MB, the client is allowed creating up to 2 subdomains, and the expiration date of the client account is set to 2008-12-31.

>client_pref.exe --update JohnDoe -manage_log true -manage_maillists true -make_dumps true -site_builder true -disk_space 150M -max_subdom 2 -expiration 2008-12-31

 

Commands

Command

Parameter

Description

Example

--update or -u

<login_name>

Sets various properties of a client account.

To prohibit changing domain limits to the JohnDoe client account:

>client_pref.exe --update JohnDoe -change_limits false

--skin-list or -sl

 

Outputs a list of available skins.

>client_pref.exe --skin-list

--info or -i

<login_name>

Outputs client account information.

To retrieve the information about the JohnDoe client account:

>client_pref.exe --info JohnDoe

--help or -h

 

Outputs help on the utility use.

>client_pref.exe –-help

 

Options

Option

Parameter

Description

Example

-create_domains

true|false

Allows/Prohibits creating domains.

Is false by default.

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

>client_pref.exe --update JohnDoe -create_domains true

-manage_phosting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_phosting true

-change_limits

true|false

Allows/Prohibits changing domain limits.

Is false by default.

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

>client_pref.exe --update JohnDoe -change_limits true

-manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_dns true

-manage_log

true|false

Allows/Prohibits managing log rotation, namely, to adjust the cleanup and recycling of processed log files.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_log true

-manage_crontab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_crontab true

-manage_anonftp

true|false

Allows/Prohibits managing Anonymous FTP.

A web site should reside on a dedicated IP address in order to use anonymous FTP service.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_anonftp true

-manage_webapps

true|false

Allows/Prohibits managing Tomcat web applications.

Is false by default.

To allow the client with the login name JohnDoe to manage Tomcat web applications:

>client_pref.exe --update JohnDoe -manage_webapps true

-manage_maillists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_maillists true

-manage_sh_access

true|false

Allows/Prohibits managing access to the system through Remote Desktop.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_sh_access true

-manage_subdomains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

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

>client_pref.exe --update JohnDoe -manage_subdomains true

-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.exe -u JDoe -manage_dashboard true

-manage_quota

true|false

Allows/Prohibits changing limit on using disk space.

Is false by default.

To allow the client with the login name JohnDoe to change the hard disk quota:

>client_pref.exe --update JohnDoe -manage_quota true

-make_dumps

true|false

Allows/Prohibits backing up and restoring domains.

Is false by default.

To allow the client with the login name JohnDoe to back up and restore domains:

>client_pref.exe --update JohnDoe -make_dumps true

-manage_virusfilter

true|false

Allows/Prohibits managing server-side antivirus protection.

Is false by default.

To allow the client with the login name JohnDoe to manage antivirus:

>client_pref.exe --update JohnDoe -manage_virusfilter true

-remote_access_interface

true|false

Allows/Prohibits using Parallels Plesk Panel API.

Is false by default.

Available since Parallels Plesk Panel 7.6.

To allow the client with the login name JohnDoe to use Parallels Plesk Panel API:

>client_pref.exe --update JohnDoe -remote_access_interface true

-site_builder

true|false

Allows/Prohibits using Sitebuilder.

Is false by default.

To allow the client with the login name JohnDoe to use Sitebuilder:

>client_pref.exe --update JohnDoe -site_builder true

-max_dom

<number>

Limits the number of available domains.

Includes domains hosted on this server, and domain forwarders that point to domains hosted on other servers.

Unlimited if set to -1.

To restrict the maximum number of domains available to the client with the login name JohnDoe to 3:

>client_pref.exe --update JohnDoe -max_dom 3

-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 JohnDoe to 2:

>client_pref.exe --update JohnDoe -max_dom_aliases 2

-disk_space

<number>[K|M|G]

Limits the amount of available disk space.

Unlimited if set to -1.

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

>client_pref.exe --update JohnDoe -disk_space 1000M

-disk_space_soft

<MB>

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

Available since Parallels Plesk Panel 9.0.

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

>client_pref.exe -u JDoe -disk_space_soft 700

-max_traffic

<number>[K|M|G]

Limits monthly traffic usage.

Unlimited if set to -1.

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

>client_pref.exe --update JohnDoe -max_traffic 10G

-max_traffic_soft

<MB/month>

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

Available since Plesk 9.0.

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

>client_pref.exe -u JDoe -max_traffic_soft 5120

-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 JohnDoe to 10:

>client_pref.exe --update JohnDoe -max_box 10

-mbox_quota

<number>[K|M|G]

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

Unlimited if set to -1.

To set the quota of a single mailbox to the client with the login name JohnDoe to 10 MB:

>client_pref.exe --update JohnDoe -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 JohnDoe to 3:

>client_pref.exe --update JohnDoe -max_redir 3

-max_mg

<number>

Limits the number of available mail groups.

Unlimited if set to -1.

To restrict the maximum number of mail groups available to the client with the login name JohnDoe to 5:

>client_pref.exe --update JohnDoe -max_mg 5

-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 JohnDoe to 5:

>client_pref.exe --update JohnDoe -max_resp 5

-max_wu

<number>

Limits the number of available web users.

Unlimited if set to -1.

To set the number of web users available to the client with the login name JohnDoe to unlimited:

>client_pref.exe --update JohnDoe -max_wu -1

-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 JohnDoe to 30:

>client_pref.exe --update JohnDoe -max_maillists 30

-max_fpse_users

<number>

Limits the number of available additional Microsoft FrontPage accounts.

Unlimited if set to -1.

To set the number of additional Microsoft FrontPage accounts available to the client with the login name JohnDoe to unlimited:

>client_pref.exe -u JohnDoe -max_fpse_users -1

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

>client_pref.exe -u JohnDoe -max_subftp_users 100

-max_mysql_db

<number>

Limits the number of available MySQL databases.

Unlimited if set to -1.

To restrict the maximum number of MySQL databases available to the client with the login name JohnDoe to 5:

>client_pref.exe -u JohnDoe -max_db 5

-max_mssql_db

<number>

Limits the number of available Microsoft SQL databases.

Unlimited if set to -1.

To restrict the number of Microsoft SQL databases available to the client with the login name JohnDoe to 15:

>client_pref.exe --update JohnDoe -max_mssql_db 15

-mysql_dbase_space

<MB>

Limits the amount of disk space that all MySQL databases can occupy.

Unlimited if set to -1.

To set the MySQL databases quota to the client with the login name JohnDoe to 200 MB:

>client_pref.exe --update JaneDoe -mysql_dbase_space 200

-mssql_dbase_space

<MB>

Limits the amount of disk space that all Microsoft SQL databases can occupy.

Unlimited if set to -1.

To set the Microsoft SQL databases quota to the client with the login name JohnDoe to 300 MB:

>client_pref.exe --update JohnDoe -mssql_dbase_space 300

-max_webapps

<number>

Limits the number of available Tomcat web applications.

Unlimited if set to -1.

To restrict the maximum number of Tomcat web applications available to the client with the login name JohnDoe to 5:

>client_pref.exe --update JohnDoe -max_webapps 5

-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 JohnDoe to 4:

>client_pref.exe -u JohnDoe -max_subdom 4

-max_iis_app_pools

<number>

Limits the number of available IIS application pools.

Unlimited if set to -1.

To restrict the maximum number of IIS application pools available to the client with the login name JohnDoe to 6:

>client_pref.exe -u JohnDoe -max_iis_app_pools 6

-max_shared_ssl_links

<number>

Limits the number of available shared SSL links.

Unlimited if set to -1.

To restrict the maximum number of shared SSL links available to the client with the login name JohnDoe to 3:

>client_pref.exe -u JohnDoe -max_shared_ssl_links 3

-max_cf_dsn

<number>

Limits the number of available Coldfusion DSN connections.

Unlimited if set to -1.

Available since Parallels Plesk Panel 8.2.

To set the number of Coldfusion DSN connections available to the client with the login name JohnDoe to unlimited:

>client_pref.exe -u JohnDoe -max_cf_dsn -1

-max_odbc_dsn

<number>

Limits the number of ODBC DSN connections available to the client.

Unlimited if set to -1.

Available since Parallels Plesk Panel 8.4.1.

To restrict the maximum number of ODBC connections available to the client with the login name JohnDoe to 5:

>client_pref.exe -u JohnDoe -max_odbc_dsn 5

-expiration

<YYYY-MM-DD>

Limits the validity period of a client account.

To make the JohnDoe client account valid till 31 December 2008:

>client_pref.exe -u JohnDoe -expiration 2008-12-31

-ip_pool

add|del:<ip 1>,<ip 2>,..,<ip N>

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

Deprecated since Parallels Plesk Panel 9.0. Use ip_pool.exe utility instead.

To add IP address 192.0.2.127 to IP address pool of JohnDoe client account:

>client_pref.exe -u JohnDoe -ip_pool add:192.0.2.127

-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 Parallels Plesk Panel code for the Italian language code is it-IT; the Plesk code for the American variant of English is en-US; the Parallels Plesk Panel 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.exe -u JDoe -locale ru-RU

-language

<string>

Specifies which language is used in a client's control panel interface.

String should contain the first two letters of the language name and first two letters of the country name.

To set Italian language as default for the JohnDoe client account:

>client_pref.exe -u JohnDoe -language it-IT

-skin

<string>

Specifies which skin is used in a client's control panel interface.

To set the WinXP Reloaded skin for the JohnDoe client account:

>client_pref.exe --update JohnDoe -skin "WinXP Reloaded"

-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.exe -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.exe -u JDoe -max-button-length 10

-lock-screen

true|false

Prevents/Allows working with Parallels Plesk Panel 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.exe -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.exe -u JDoe -desktop-preset "Custom Desktop"

-cp_access

true|false

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

Is true by default.

Available since Parallels Plesk Panel 7.6.

To prohibit client with the login name JohnDoe from accessing to Parallels Plesk Panel CP:

>client_pref.exe --update JohnDoe -cp_access false

-manage_subftp

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

Available since Parallels Plesk Panel 7.6.

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

>client_pref.exe --update JohnDoe -manage_subftp true

-manage_domain_aliases

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

Available since Parallels Plesk Panel 7.6.

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

>client_pref.exe --update JohnDoe -manage_domain_aliases true

-manage_performance

true|false

Allows/Prohibits managing hosting performance.

Is false by default.

Available since Parallels Plesk Panel 7.6.

To allow the client with the login name JohnDoe to manage hosting performance settings:

>client_pref.exe --update JohnDoe -manage_performance true

-manage_iis_app_pool

true|false

Allows/Prohibits managing IIS application pool.

Is false by default.

Available since Parallels Plesk Panel 7.6.

To allow the client with the login name JohnDoe to manage IIS application pool:

>client_pref.exe --update JohnDoe -manage_iis_app_pool true

-manage_webstat

true|false

Allows/Prohibits managing Web Statistics on the client's domains, namely, to choose which of the web statistics tools (or none) to use.

Is false by default.

Available since Parallels Plesk Panel 8.1.1.

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

>client_pref.exe --update JohnDoe -manage_webstat true

-manage_additional_permissions

true|false

Allows/Prohibits managing additional write and modify permissions.

If it is true, the full access permission for the domain httpdocs/ and httpsdocs/ files and subfolders are granted to the Parallels Plesk Panel IIS User.

May be required for web applications correct functioning, but is insecure.

Is false by default.

Available since Parallels Plesk Panel 8.1.1.

To allow the client with the login name JohnDoe to manage additional write/modify permissions:

>client_pref.exe --update JohnDoe -manage_additional_permissions true

-manage_spamfilter

true|false

Allows/Prohibits configuring spam filter on the mail account level (if the correspondent option is enabled in the server-wide configuration).

Is false by default.

Available since Parallels Plesk Panel 8.1.1.

To allow the client with the login name JohnDoe to configure spam filter:

>client_pref.exe --update JohnDoe -manage_spamfilter true

-manage_shared_ssl

true|false

Allows/prohibits managing the Shared SSL feature: making one of the client's domains a Master SSL Domain which shares its SSL certificates with other domains, and creating shared SSL links to Master for his other domains.

Is false by default.

Available since Parallels Plesk Panel 8.2.

To allow the client with the login name JohnDoe to manage shared SSL:

>client_pref.exe --update JohnDoe -manage_shared_ssl true

-select_db_server

true|false

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

Is false by default.

Available since Parallels Plesk Panel 8.6.

To allow the client with the login name JohnDoe to choose a DB server when creating a database:

>client_pref.exe --update JohnDoe -select_db_server true

-overuse

block|notify|normal

Sets the limits overusage policy.

Available since Parallels Plesk Panel 9.0.

To set the limits overusage policy for the client with the login name JDoe to notify:

>client_pref -u JDoe -overuse notify