Hosting Subscription Settings: domain_pref.exe

The domain_pref.exe utility is used for managing settings related to subscriptions and hosting services.

Location

%plesk_cli%

Usage

domain_pref.exe <command> [<domain name>] [
<option 1> <param> [<option 2> <param>] … [<option N> <param>]
]

 

Example

The following command sets the following settings for the subscription example.com: the available disk space to 1 GB, and the maximum number of MySQL databases to 4.

>domain_pref.exe --update example.com -disk_space 1G -max_db 4

 

Commands

Command

Parameter

Description

Example

--update or -u

<domain_name>

Updates subscription settings.

To restrict the amount of disk space available for the subscription example.com to 1 GB:

>domain_pref.exe --update example.com -disk_space 1G

or

>domain_pref.exe -u example.com -disk_space 1G

--info or -i

<domain_name>

Displays information about subscription settings.

To view information about settings of the subscription example.com:

>domain_pref.exe --info example.com

or

>domain_pref.exe -i example.com

--set-default or -d

<domain_name>

For subscriptions that are assigned shared IP addresses, this option sets the default domain/subscription.

To set the domain example.com as the default domain for the IP address to which it is assigned:

>domain_pref.exe --set-default example.com

or

>domain_pref.exe -d example.com

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the domain utility:

>domain_pref.exe --help

or

>domain_pref.exe -h

 

Options

Option

Parameter

Description

Example

-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 amount of disk space available for subscription example.com to 10 GB:

>domain_pref.exe -u example.com -disk_space 10G

-disk_space_soft

<number>[K|M|G]

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

Available since Parallels Plesk Panel 9.0.

To set up sending of an e-mail notification upon occupying 5 gigabytes of disk space under the subscription example.com:

>domain_pref.exe -u example.com -disk_space_soft 5G

-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 for the subscription example.com to 10 GB/month:

>domain_pref.exe -u example.com -max_traffic 10G

-max-traffic-soft

<number>[K|M|G]

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

Available since Parallels Plesk Panel 9.0.

To set the amount of traffic upon reaching which notification is sent for the subscription example.com to 5 GB/month:

>domain_pref.exe -u example.com -max_traffic_soft 5G

-max_box

<number>

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available for the subscription example.com to 50:

>domain_pref.exe -u example.com -max_box 50

-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 subscription example.com to 100 MB:

>domain_pref.exe -u example.com -mbox_quota 100M

-max_wu

<number>

Limits the number of available web users.

Unlimited if set to -1.

To restrict the maximum number of web users available for the subscription example.com to 50:

>domain_pref.exe -u example.com -max_wu 50

-max_fpse_users

<number>

Limits the maximum number of additional Microsoft FrontPage accounts that can be created on a domain.

Unlimited if set to -1.

To allow unlimited number of additional Microsoft FrontPage accounts limit on example.com:

>domain_pref.exe -u example.com -max_fpse_users -1

-max_mysql_db

<number>

Limits the number of available MySQL databases.

Unlimited if set to -1.

To set the number of MySQL databases available for the subscription example.com to unlimited:

>domain_pref.exe -u example.com -max_mysql_db -1

-max_mssql_db

<number>

Limits the number of available MSSQL databases.

Unlimited if set to -1.

To set the number of MSSQL databases available for the subscription example.com to unlimited:

>domain_pref.exe -u example.com -max_mssql_db -1

-mysql_dbase_space

<number in megabytes>

Restricts the maximum amount of disk space allotted to MySQL databases.

Unlimited if set to -1.

To restrict the disk space occupied by all MySQL databases of example.com to 500 MB:

>domain_pref.exe -u example.com -mysql_dbase_space 500

-mssql_dbase_space

<number in megabytes>

Restricts the maximum amount of disk space allotted to Microsoft SQL Server databases.

Unlimited if set to -1.

To restrict the disk space occupied by Microsoft SQL Server databases of example.com to 700 MB:

>domain_pref.exe -u example.com -mssql_dbase_space 700

-max_maillists

<number>

Limits the number of available mailing lists.

Unlimited if set to -1.

To restrict the maximum number of mailing lists available for the subscription example.com to 3:

>domain_pref.exe -u example.com -max_maillists 3

-max_webapps

<number>

Limits the number of available Java applications.

Unlimited if set to -1.

To restrict the maximum number of Java applications available for the subscription example.com to 10:

>domain_pref.exe -u example.com -max_webapps 10

-max_subdom

<number>

Limits the number of available subdomains.

Unlimited if set to -1.

To restrict the maximum number of subdomains available for the subscription example.com to 15:

>domain_pref.exe -u example.com -max_subdom 15

-max_shared_ssl_links

<number>

Restricts the number of shared SSL links.

Unlimited if set to -1.

To restrict the number of shared SSL links for the subscription example.com to 3:

>domain_pref.exe -u -max_shared_ssl_links 3

-max_cf_dsn

<number>

Limits the number of available Coldfusion DSN connections.

Unlimited if set to -1.

To set the number of Coldfusion DSN connections available for the subscription example.com to unlimited:

>domain_pref.exe -u example.com -max_cf_dsn -1

-max_odbc_dsn

<number>

Limits the number of available ODBC DSN connections.

Unlimited if set to -1.

To set the number of ODBC connections available for the subscription example.com to 5:

>domain_pref.exe -u example.com -max_odbc_dsn 5

-expiration

<YYYY-MM-DD>

Limits the validity period for a subscription.

Unlimited if set to -1.

To set the validity period for the subscription example.com to 2010-11-30:

>domain_pref.exe -u example.com -expiration 2010-11-30

-www

true|false

Enables or disables the www prefix.

Is true by default.

To disable the www prefix for domains hosted under the subscription example.com:

>domain_pref.exe -u example.com -www false

-wuscripts

true|false

Enables or disables scripting support for web users.

Is false by default.

To enable scripting support for web users for the subscription example.com:

>domain_pref.exe -u example.com -wuscripts true

-webmail

atmail|horde|none

Switches webmail on or off for a subscription.

To switch off webmail support for the subscription example.com:

>domain_pref.exe -u example.com -webmail none

-no_usr

bounce:<txt>|<email>|<IP>|reject|discard

Sets the mode of automatic action toward mail messages addressed to non-existent users.

Is reject by default.

To have messages addressed to non-existent users bounced back with text No such mailbox on the server for the subscription example.com:

>domain_pref.exe -u example.com -no_usr bounce:"No such mailbox on the server"

To have messages addressed to non-existent users forwarded to mail address admin@example.com for the subscription example.com:

>domain_pref.exe -u example.com -no_usr admin@example.com

-max_dom_aliases

<number>

Limits the number of available domain aliases.

Unlimited if set to -1.

To set the maximum number of domain aliases available for the subscription example.com to 10:

>domain_pref.exe -u example.com -max_dom_aliases 10

-max_subftp_users

<number>

Limits the maximum number of additional FTP accounts.

Unlimited if set to -1.

To allow 100 additional FTP accounts for the subscription example.com:

>domain_pref.exe -u example.com -max_subftp_users 100

-overuse

block|notify|normal|not_suspend

Sets the resource 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.

To set the resource overuse policy to notify:

>domain_pref.exe -u example.com -overuse notify

-keep_traf_stat

<number>

Defines the number of months during which the system keeps traffic usage statistics.

Keeping statistics during unlimited period if set to -0.

To make the system retain traffic statistics for example.com during 5 months:

>domain_pref.exe -u example.com -keep_traf_stat 5

-max_site

<number>

Specifies the number of websites that can be hosted under a subscription.

To set the number of websites that can be hosted under subscription example.com to 10:

>domain_pref.exe -u example.com -max_site 10

-max_site_builder

<number>

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

To set the number of websites that can be created and published with SiteBuilder under subscription example.com to 10:

>domain_pref.exe -u example.com -max_site_builder 10

-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 subscription example.com to 10:

>domain_pref.exe -u example.com -max_unity_mobile_sites 10

-sign_outgoing_mail

true|false

Allows or prohibits using DomainKeys spam protection.

Is false by default.

To use DomainKeys spam protection for the subscription example.com:

>domain_pref.exe -u example.com -sign_outgoing_mail true

-create_domains

true|false

Allows or prohibits creating domains.

Is false by default.

To allow the owner of the subscription example.com to create domains:

>domain_pref.exe -u example.com -create_domains true

-manage_phosting

true|false

Allows or prohibits managing web hosting settings.

Is false by default.

To allow the owner of the subscription example.com to manage web hosting settings:

>domain_pref.exe -u example.com -manage_phosting true

-manage_performance

true|false

Allows or prohibits managing hosting performance settings.

 

To allow the owner of the subscription example.com to manage hosting performance settings:

>domain_pref.exe -u example.com -manage_performance true

-manage_sh_access

true|false

Allows or prohibits managing access to the system through Remote Desktop.

To allow the owner of the subscription example.com to manage access and to connect to the server:

>domain_pref.exe -u example.com -manage_sh_access true

-manage_quota

true|false

Allows or prohibits changing the amount of allocated disk space.

To allow the owner of the subscription example.com to manage the hard quota on allocated disk space:

>domain_pref.exe -u example.com -manage_quota true

-manage_subdomains

true|false

Allows or prohibits managing subdomains.

 

To allow the owner of the subscription example.com to manage subdomains:

>domain_pref.exe -u example.com -manage_subdomains true

-manage_domain_aliases

true|false

Allows or prohibits managing domain aliases.

To allow the owner of the subscription example.com to manage domain aliases:

>domain_pref.exe -u example.com -manage_domain_aliases true

-manage_log

true|false

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

To allow the owner of the subscription example.com to adjust log recycling settings:

>domain_pref.exe -u example.com -manage_log true

-manage_anonftp

true|false

Allows or prohibits managing Anonymous FTP.

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

Is false by default.

To allow the owner of the subscription example.com to set up anonymous FTP share:

>domain_pref.exe -u example.com -manage_anonftp true

-manage_subftp

true|false

Allows or prohibits managing additional FTP accounts.

To allow the owner of the subscription example.com to set up additional FTP accounts:

>domain_pref.exe -u example.com -manage_subftp true

-manage_crontab

true|false

Allows or prohibits scheduling tasks on the server.

To allow the owner of the subscription example.com to schedule tasks on the server:

>domain_pref.exe -u example.com -manage_crontab true

-manage_dns

true|false

Allows or prohibits managing DNS settings for websites.

Is false by default.

To allow the owner of the subscription example.com to manage DNS zones:

>domain_pref.exe -u example.com -manage_dns true

-manage_webapps

true|false

Allows or prohibits installing and managing Java web applications.

To allow the owner of the subscription example.com to install and manage Java applications:

>domain_pref.exe -u example.com -manage_webapps true

-manage_maillists

true|false

Allows or prohibits managing mailing lists.

To allow the owner of the subscription example.com to set up mailing lists:

>domain_pref.exe -u example.com -manage_maillists true

-manage_spamfilter

true|false

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

To allow the owner of the subscription example.com to configure spam filter:

>domain_pref.exe -u example.com -manage_spamfilter true

-manage_virusfilter

true|false

Allows or prohibits managing antivirus protection settings.

To allow the owner of the subscription example.com to manage antivirus settings:

>domain_pref.exe -u example.com -manage_virusfilter true

-manage_iis_app_pool

true|false

Allows or prohibits managing IIS application pool.

 

To allow the owner of the subscription example.com to manage IIS application pool:

>domain_pref.exe -u example.com -manage_iis_app_pool true

-manage_webstat

true|false

Allows or prohibits selecting the web statistics program to use for websites.

To allow the owner of the subscription example.com to select web statistics program:

>domain_pref.exe -u example.com -manage_webstat true

-manage_additional_permissions

true|false

Allows or 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.

To allow the owner of the subscription example.com to manage additional write/modify permissions:

>domain_pref.exe -u example.com -manage_additional_permissions true

-manage_shared_ssl

true|false

Allows or prohibits using SSL certificates shared by the provider.

To allow the owner of the subscription example.com to use shared SSL certificates for securing websites:

>domain_pref.exe -u example.com -manage_shared_ssl true

-select_db_server

true|false

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

To allow the owner of the subscription example.com to select a database server during creation of a new database:

>domain_pref.exe -u example.com -select_db_server 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 owner of the subscription example.com to back up and restore websites, and keep the data on the server:

>domain_pref.exe -u example.com -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 owner of the subscription example.com to back up and restore websites, and keep the data on custom FTP servers:

>domain_pref.exe -u example.com -allow_ftp_backups true

-access_appcatalog

true|false

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

To allow the owner of the subscription example.com to access applications catalog and install applications on websites:

>domain_pref.exe -u example.com -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 owner of the subscription example.com to override security policy:

>domain_pref.exe -u example.com -allow_insecure_sites true