reseller_pref.exe: Reseller Limits, Permissions, and Interface Settings

The reseller_pref.exe CL utility enables the administrator to set and update reseller's limits and permissions, and to define Plesk interface preferences (e.g. the default language and skin).

Location

%plesk_cli%

 

Usage
reseller_pref.exe <command> [<login_name>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]

Example

The following command updates the reseller account with the login name JDoe as follows: the reseller is allowed to manage log rotation and mailing lists, and to create customer accounts. The maximum number of available customer accounts for the reseller is restricted to 20.

reseller_pref.exe --update JDoe -manage_log true -manage_maillists true -create_clients true -max_cl 20

 

Commands
Command Parameter Description Example

--update or -u

<login_name>

Sets various properties of a reseller account.

To prohibit changing domain limits to the JDoe reseller account:

reseller.exe --update JDoe -change_limits false

or

reseller.exe -u JDoe -change_limits false

--skin-list or -sl

 

Displays a list of available skins.

To view the list of available skins:

reseller.exe --skin-list

or

reseller.exe -sl

--set-iis-app-pool-settings

<login_name>

Set up the CPU usage settings of a reseller's IIS application pool.

Used with the options: -iis-app-pool-turned-on, -cpu-usage-state, -cpu-usage-value, -cpu-usage-action, -cpu-usage-interval.

To set up the following CPU usage settings for the IIS application pool of the reseller account JDoe:

  • limit CPU usage by worker processes to 10%,
  • reduce CPU time for processes if they have exceeded the limit:

 

reseller.exe --set-iis-app-pool-settings Jdoe -iis-app-pool-turned-on true -cpu-usage-state true -cpu-usage-value 10 -cpu-usage-action Throttle

--info or -i

<login_name>

Displays information on reseller's limits, permissions, IP pool settings and preferences.

To retrieve the information about the JDoe reseller account:

reseller.exe --info JDoe

or

reseller.exe -i JDoe

--help or -h

 

Displays help on the utility use.

To view help on the utility:

reseller.exe --help

or

reseller.exe -h

 

Options
Option Parameter Description Example

-power-user

true|false

Switches the reseller to Power User mode.

To switch the reseller with the login name JDoe to the Power User mode:

# ./reseller_pref -u JDoe -power-user true

-create_domains

true|false

Allows/Prohibits creating domains.

Is false by default.

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

reseller.exe --update JDoe -create_domains true

-manage_phosting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

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

reseller.exe --update JDoe -manage_phosting true

-manage_php_settings

true|false

Allows or prohibits managing common PHP settings.

To allow the reseller with the login name JDoe to manage common PHP settings:

reseller.exe --update JDoe -manage_php_settings true

-manage_php_version

true|false

Allows or prohibits choosing PHP version and handler.

To allow the reseller with the login name JDoe to choose the PHP version and handler:

reseller.exe --update JDoe -manage_php_version true

-manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

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

reseller.exe --update JDoe -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 reseller with the login name JDoe to manage log rotation:

reseller.exe --update JDoe -manage_log true

-manage_crontab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

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

reseller.exe --update JDoe -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 reseller with the login name JDoe to manage Anonymous FTP:

reseller.exe --update JDoe -manage_anonftp true

-manage_webapps

true|false

Allows/Prohibits managing Tomcat web applications.

Is false by default.

To allow the reseller with the login name JDoe to manage Tomcat web applications:

reseller.exe --update JDoe -manage_webapps true

-manage_mail_settings

true|false

Allows or prohibits managing the mail settings.

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

reseller.exe --update JDoe -manage_mail_settings true

-manage_maillists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

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

reseller.exe --update JDoe -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 reseller with the login name JDoe to manage system access:

reseller.exe --update JDoe -manage_sh_access true

-manage_subdomains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

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

reseller.exe --update JDoe -manage_subdomains true

-manage_quota

true|false

Allows/Prohibits changing limit on using disk space.

Is false by default.

To allow the reseller with the login name JDoe to change the hard disk quota:

reseller.exe --update JohnDoe -manage_quota true

-manage_virusfilter

true|false

Allows/Prohibits managing server-side antivirus protection.

Is false by default.

To allow the reseller with the login name JDoe to manage antivirus:

reseller.exe --update JDoe -manage_virusfilter true

-allow_local_backups

true|false

Allows or prohibits backing up and restoring websites, and keeping backup files on the hosting server.

To allow the reseller with the login name JDoe to back up and restore websites, and keep the data on the server:

reseller.exe --update JDoe -allow_local_backups true

-allow_ftp_backups

true|false

Allows or prohibits backing up and restoring websites, and saving them to custom FTP servers.

To allow the reseller with the login name JDoe to back up and restore websites, and keep the data on custom FTP servers:

reseller.exe --update JDoe -allow_ftp_backups true

-allow_account_local_backups

true|false

Allows or prohibits backing up and restoring accounts and keeping backup files on the hosting server.

To allow the reseller with the login name JDoe to back up and restore accounts, and keep the data on the server:

reseller.exe --update JDoe -allow_account_local_backups true

-allow_account_ftp_backups

true|false

Allows or prohibits backing up and restoring accounts and saving them to custom FTP servers.

To allow the reseller with the login name JDoe to back up and restore accounts, and keep the data on custom FTP servers:

reseller.exe --update JDoe -allow_account_ftp_backups true

-remote_access_interface

true|false

Allows/Prohibits using Plesk API.

Is false by default.

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

reseller.exe --update JDoe -remote_access_interface true

-site_builder

true|false

Allows/Prohibits using Presence Builder.

Is false by default.

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

reseller.exe --update JDoe -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 reseller with the login name JDoe to 3:

reseller.exe --update JDoe -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 reseller with the login name JDoe to 2:

reseller.exe --update JDoe -max_dom_aliases 2

-disk_space

<number>[B|K|M|G|T]

Limits the amount of available disk space.

Unlimited if set to -1.

To restrict the maximum amount of disk space available to the reseller with the login name JDoe to 1 GB:

reseller.exe --update JDoe -disk_space 1024M

-disk_space_soft

<number>[B|K|M|G|T]

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 reseller with the login name JDoe to 700 MB:

>reseller_pref -u JDoe -disk_space_soft 700M

-max_traffic

<number>[B|K|M|G|T]

Limits monthly traffic usage.

Unlimited if set to -1.

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

reseller.exe --update JDoe -max_traffic 10240M

-max_traffic_soft

<number>[B|K|M|G|T]

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 5 GB/month:

>reseller_pref -u JDoe -max_traffic_soft 5120M

-max_box

<number>

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available to the reseller with the login name JDoe to 10:

reseller.exe --update JDoe -max_box 10

-mbox_quota

<KB>

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 reseller with the login name JDoe to 100 MB:

reseller.exe --update JDoe -mbox_quota 102400

-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 reseller with the login name JDoe to unlimited:

reseller.exe --update JDoe -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 reseller with the login name JDoe to 30:

reseller.exe --update JDoe -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 reseller with the login name JDoe to unlimited:

reseller.exe -u JDoe -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 reseller with the login name JDoe to 100:

reseller.exe -u JDoe -max_subftp_users 100

-max_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 reseller with the login name JDoe to 5:

reseller.exe -u JDoe -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 reseller with the login name JDoe to 15:

reseller.exe --update JDoe -max_mssql_db 15

-mysql_dbase_space

<number>[B|K|M|G|T]

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 reseller with the login name JDoe to 200 MB:

reseller.exe --update JDoe -mysql_dbase_space 200M

-mssql_dbase_space

<number>[B|K|M|G|T]

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 reseller with the login name JDoe to 300 MB:

reseller.exe --update JDoe -mssql_dbase_space 300M

-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 reseller with the login name JDoe to 50:

reseller.exe --update JohnDoe -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 reseller with the login name JDoe to 4:

reseller.exe -u JDoe -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 reseller with the login name JDoe to 6:

reseller.exe -u JDoe -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 reseller with the login name JDoe to 3:

reseller.exe -u JDoe -max_shared_ssl_links 3

-max_odbc_dsn

<number>

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

Unlimited if set to -1.

To restrict the maximum number of ODBC connections available to the reseller with the login name JDoe to 5:

reseller.exe -u JDoe -max_odbc_dsn 5

-language

<string>

Specifies which language is used in a reseller'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 JDoe reseller account:

reseller.exe -u JDoe -language it-IT

-skin

<string>

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

To set the WinXP Reloaded skin for the JDoe reseller account:

reseller.exe --update JDoe -desktop-preset "WinXP Reloaded"

-multiple-sessions

true|false

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

Is true by default.

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

reseller.exe -u JDoe -multiple-sessions false

-iis-app-pool-turned-on

true|false

Turns on or off an IIS application pool for a reseller.

To turn off IIS application pool for the reseller Jdoe:

 

reseller.exe --set-iis-app-pool-settings Jdoe -iis-app-pool-turned-on false

-max-worker-processes

<number>

Sets the maximum number of worker processes permitted to service requests for IIS application pool.

To set the maximum number of worker processes for the dedicated IIS application pool of the reseller Jdoe to 3:

>customer.exe --update Jdoe -iis_app_pool true -max-worker-processes 3

-managed-pipeline-mode

Integrated|Classic

Configures ASP.NET to run in classic mode as an ISAPI extension or in integrated mode where managed code is integrated into the request-processing pipeline.

To have ASP.NET run in the integrated mode for the dedicated IIS application pool of the reseller Jdoe:

>customer.exe --update Jdoe -iis_app_pool true -managed-pipeline-mode Integrated

-idle-timeout

<minutes>

The amount of time a worker process will remain idle before it shuts down.

To set the length of time worker processes for the dedicated IIS application pool of the reseller Jdoe are allowed to remain idle to 2 minutes:

>customer.exe --update Jdoe -iis_app_pool true -idle-timeout 2

-cpu-usage-state

true|false

Switches IIS application pool CPU usage monitoring on or off.

To set up the following CPU usage settings for the IIS application pool of the reseller JDoe:

  • limit CPU usage by worker processes to 10%,
  • shut down the IIS application pool for the rest of the reset interval if the processes have exceeded the limit,
  • reset monitoring data every 5 minutes:

     

    reseller.exe --set-iis-app-pool-settings Jdoe -iis-app-pool-turned-on true -cpu-usage-state true -cpu-usage-value 10 -cpu-usage-action KillW3wp -cpu-usage-interval 5

-cpu-usage-value

<integer number>

Specifies the maximum percentage of CPU time that worker processes in an application pool are allowed to consume over a period of time specified by the -cpu-usage-interval option.

If the limit is exceeded, the event is written to the event log and an optional set of events can be triggered. These optional events are determined by the -cpu-usage-action option.

-cpu-usage-action

NoAction | KillW3wp

Specifies the action that IIS takes when worker processes exceed the limit on CPU time usage.

  • NoAction - no action is taken when the CPU limit is exceeded. A warning is written to the event log.
  • KillW3wp - processes that exceed their CPU limit will be forced to shut down.

-cpu-usage-interval

<minutes>

Specifies the reset interval for monitoring of CPU usage by worker processes.

-recycling-by-time

<minutes>

The period of time after which IIS application pool recycles.

To set the period of time after which the dedicated IIS application pool of the reseller Jdoe recycles to 1 hour:

reseller.exe --update Jdoe -iis_app_pool true -recycling-by-time 60

-recycling-by-requests

<number>

The maximum number of requests IIS application pool can process before it recycles.

To set the maximum number of requests the dedicated IIS application pool of the reseller Jdoe can process before it recycles to 1000:

reseller.exe --update Jdoe -iis_app_pool true -recycling-by-requests 1000

-recycling-by-virtual-memory

<KB>

The maximum amount of virtual memory a worker process can consume before causing IIS application pool to recycle.

To set the maximum amount of virtual memory a worker process can consume before causing the dedicated IIS application pool of the reseller Jdoe to recycle to 5 MB:

reseller.exe --update Jdoe -iis_app_pool true -recycling-by-virtual-memory 5120

-recycling-by-private-memory

<KB>

The maximum amount of private memory a worker process can consume before causing IIS application pool to recycle.

To set the maximum amount of private memory a worker process can consume before causing the dedicated IIS application pool of the reseller Jdoe to recycle to 10 MB:

reseller.exe --update Jdoe -iis_app_pool true -recycling-by-private-memory 10240

-manage_subftp

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

To allow the reseller with the login name JDoe to manage additional FTP accounts:

reseller.exe --update JDoe -manage_subftp true

-manage_domain_aliases

true|false

Allows/Prohibits managing domain aliases.

Is false by default..

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

reseller.exe --update JDoe -manage_domain_aliases true

-manage_performance

true|false

Allows/Prohibits managing hosting performance.

Is false by default..

To allow the reseller with the login name JDoe to manage hosting performance settings:

reseller.exe --update JDoe -manage_performance true

-manage_iis_app_pool

true|false

Allows/Prohibits managing IIS application pool.

Is false by default..

To allow the reseller with the login name JDoe to manage IIS application pool:

reseller.exe --update JDoe -manage_iis_app_pool true

-manage_webstat

true|false

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

Is false by default.

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

reseller.exe --update JDoe -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 Plesk IIS User.

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

Is false by default.

To allow the reseller with the login name JDoe to manage additional write/modify permissions:

reseller.exe --update JDoe -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.

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

reseller.exe --update JDoe -manage_spamfilter true

-manage_shared_ssl

true|false

Allows/prohibits managing the Shared SSL feature: making one of the reseller'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.

To allow the reseller with the login name JDoe to manage shared SSL:

reseller.exe --update JDoe -manage_shared_ssl true

-select_db_server

true|false

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

Is false by default.

To allow the reseller with the login name JDoe to choose a DB server when creating a database:

reseller.exe --update JDoe -select_db_server true

-remote_db_connection

true|false

Allows or prohibits managing remote database access settings.

To allow the reseller with the login name JDoe to manage remote database access settings.

reseller.exe --update JDoe -remote_db_connection true

 

-access_appcatalog

true|false

Allows or prohibits access to applications catalog for viewing and installing prepackaged applications on sites.

To allow the reseller with the login name JDoe to access applications catalog and install applications on websites:

reseller.exe -u JDoe -access_appcatalog true

-allow_insecure_sites

true|false

Allows or prohibits overriding server-wide security policy on web hosting scripting options, if the policy is set up.

To allow the reseller with the login name JDoe to override security policy:

reseller.exe -u JDoe -allow_insecure_sites true

-create_clients

true|false

Allows/Prohibits creating customer accounts.

Is false by default.

To allow the reseller with the login name JDoe to create customer accounts:

reseller.exe -u JDoe -create_clients true

-allow_oversell

true|false

Allows/Prohibits managing limits policy.

Is false by default.

To allow managing limits policy to the reseller with the login name JDoe:

reseller.exe -u JDoe -allow_oversell true

-manage_website_maintenance

true|false

Allows or prohibits access to website copying.

To allow the reseller with the login name JDoe access to website copying.

reseller.exe -u JDoe -manage_website_maintenance true

-manage_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit.

To allow the reseller with the login name JDoe access to the WordPress toolkit:

reseller.exe -u JDoe -manage_wordpress_toolkit true

-manage_security_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit security feature.

To allow the reseller with the login name JDoe access to the WordPress toolkit security feature:

reseller.exe -u JDoe -manage_security_wordpress_toolkit true

-manage_protected_dirs

true|false

Allows or prohibits managing password-protected directories.

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

reseller.exe -u JDoe -manage_protected_dirs true

-access_service_users

true|false

Allows or prohibits managing auxiliary user accounts.

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

reseller.exe -u JDoe -access_service_users true

 

-oversell

true|false

Specifies limits policy:

true - oversell policy

false - strict policy

Is true by default.

To set limits policy for the reseller with the login name JDoe to strict:

reseller.exe -u JDoe -oversell false

 

-max_cl

<number>

Limits the number of available customer accounts.

Unlimited if set to -1.

To set the number of available customer accounts for the reseller with the login name JDoe to 5:

reseller.exe -u JDoe -max_cl 5

-max_site_builder

<number>

Specifies the number of websites that can be created and published with Presence Builder.

To set the number of websites that can be created and published with Presence Builder for reseller with the username JDoe to 5:

reseller.exe -u JDoe -max_site_builder 5

-max_unity_mobile_sites

<number>

Specifies the number of mobile site versions that can be created with the external UNITY Mobile service.

To set the number of mobile websites that can be created under subscriptions of reseller JDoe to 5:

reseller.exe -u JDoe -max_unity_mobile_sites 5

-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 reseller with the login name JDoe to Russian:

reseller.exe -u JDoe -locale ru-RU

-overuse

block|not_suspend|

notify|normal

Sets the overuse policy:

  • normal - overuse is allowed.
  • notify - overuse is allowed; when the resource usage limit is reached, an e-mail notice is sent according to the event notification settings.
  • not_suspend - overuse is allowed only for disk space and traffic resources.
  • block - overuse is not allowed, and the user account is suspended when the resource usage limit is reached.
  • not_suspend_notify - overuse is allowed only for disk space and traffic resources; an e-mail notice is sent according to the event notification settings.

To set the overuse policy for the reseller with the login name JDoe to notify:

reseller.exe -u JDoe -overuse notify

 

 

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.