Domain Limits and Preferences: domain_pref.exe

The domain_pref.exe utility serves to set up domain limits and preferences. The utility allows the following:

Location

%plesk_cli%

Usage

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

 

Example

The following command modifies preferences of example.com domain as follows: the maximum allowed disk space for this domain is restricted to 1 GB, the domain is accessible at the domain's URL with "www" prefix, the maximum number of MySQL databases used on this domain is set to 4, the maximum number of mail groups used on this domain is set to 15, and the maximum number of mail boxes allowed for this domain is set to 50.

>domain_pref.exe --update example.com -disk_space 1G -www true -max_db 4 -max_mg 15 -max_box 50

 

Commands

Command

Parameter

Description

Example

--update or -u

<domain name>

Sets the domain preferences.

To change preferences of example.com:

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

or

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

--info or -i

<domain name>

Retrieves information about domain preferences.

To retrieve information about example.com preferences:

>domain_pref.exe --info example.com

or

>domain_pref.exe –i example.com

--set-default or -d

<domain_name>

Sets a domain as the default domain for the IP address that is assigned to the domain.

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 -d example.com

--help or -h

 

Displays help on the utility use.

>domain_pref.exe --help

or

>domain_pref.exe -h

 

Options

Option

Parameter

Description

Example

-max_dom_aliases

<number>

Restricts the maximum number of available domain aliases.

Unlimited if set to -1.

To allow example.com to have maximum 2 aliases:

>domain_pref.exe --update example.com -max_dom_aliases 2

-disk_space

<number>[K|M|G]

Restricts the maximum amount of available disk space.

Unlimited if set to -1.

To allow example.com to occupy maximum 1 GB:

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

-max_traffic

<number>[K|M|G]

Restricts the maximum monthly traffic usage.

Unlimited if set to -1.

To allow example.com to use up to 10 GB per month:

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

-max_box

<number>

Restricts the maximum number of mail boxes.

Unlimited if set to -1.

To restrict the number of mailboxes for example.com to 5:

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

-mbox_quota

<number>[K|M|G]

Restricts the maximum amount of disk space allotted to a single mailbox on a domain.

Unlimited if set to -1.

To restrict the use of disk space for a single mailbox on example.com to 20 MB:

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

-total_mboxes_quota

<MB>

Limits the amount of disk space that all mailboxes on the domain can occupy.

Unlimited if set to -1.

Not available if the mail server software used with Plesk does not support handling cumulative mailbox quota.

To restrict the use of disk space for all mailboxes on example.com to 20 GB:

>domain_pref.exe -u example.com -total_mboxes_quota 20480

-max_redir

<number>

Restricts the maximum number of available mail redirects.

Unlimited if set to -1.

To restrict the number of mail redirects on example.com to 5:

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

-max_mg

<number>

Restricts the maximum number of available mail groups.

Unlimited if set to -1.

To restrict the number of mail groups on example.com to 7:

>domain_pref.exe -u example.com -max_mg 7

-max_resp

<number>

Restricts the maximum number of mail autoresponders (mail replies being sent automatically).

Unlimited if set to -1.

To restrict the number of mail autoresponders on example.com to 10:

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

-max_wu

<number>

Restricts the maximum number of web users.

Unlimited if set to -1.

To restrict the number of web users on example.com to 50:

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

-max_mysql_db

<number>

Restricts the maximum number of MySQL databases that can be used by a domain.

Unlimited if set to -1.

To restrict the number of MySQL databases on example.com to 5:

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

-max_mssql_db

<number>

Restricts the maximum number of Microsoft SQL databases that can be used by a domain.

Unlimited if set to -1.

To restrict the number of Microsoft SQL databases on example.com to 7:

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

-mysql_dbase_space

<MB>

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

<MB>

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>

Restricts the maximum number of mailing lists.

Unlimited if set to -1.

To restrict the number of mailing lists on example.com to 3:

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

-max_webapps

<number>

Restricts the maximum number of web applications.

Unlimited if set to -1.

To restrict the number of web applications on example.com to 10:

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

-max_subdom

<number>

Restricts the maximum number of subdomains.

Unlimited if set to -1.

To restrict the number of subdomains on example.com to 2:

>domain_pref.exe --update example.com -max_subdom 2

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

>domain_pref.exe -u -max_shared_ssl_links 3

-expiration

<YYYY-MM-DD>

Defines the date when a domain account expires.

Unlimited if set to -1.

To set April 1, 2009 as the expiration date for example.com:

>domain_pref.exe --update example.com -expiration 2009-04-01

-max_cf_dsn

<number>

Limits the number of available Coldfusion DSN connections.

Unlimited if set to -1.

Available since Plesk 8.2.

To set the number of Coldfusion DSN connections available for the domain 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.

Available since Plesk 8.4.1.

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

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

-www

true|false

Allows accessing a domain using URL with the www prefix.

Is true by default.

To make example.com accessible with the "www" prefix:

>domain_pref.exe --update example.com -www true

-wuscripts

true|false

Enables/Disables using scripts for web users.

To enable scripting support for web users of example.com:

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

-webmail

<horde|mewebmail|merakwebmail|smwebmail|cgpwebmail|none>

Specifies an available Webmail.

Several of the following Webmails or none are available:

Horde IMP H3 (4.1.4) (horde), CommuniGate Pro Web Client (cgpwebmail), IceWarp Web Mail 5.6.7 (merakwebmail), MailEnable Web Client (mewebmail), SmarterMail Web Client (smwebmail).

Is none by default.

To set the Webmail Horde IMP H3 on the domain example.com:

>domain_pref.exe --update example.com -webmail horde

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

Available since Plesk 7.6.

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

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

-max_subftp_users

<number>

Limits the maximum number of additional FTP accounts.

Unlimited if set to -1.

Available since Plesk 7.6.

To allow maximum 100 additional FTP accounts on example.com:

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

-no_usr

bounce:<txt>|email|ip||reject

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 on the domain 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 on the domain example.com:

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

To have messages addressed to non-existent users redirected to external mail server with IP address 192.0.2.43 on the domain example.com:

>domain_pref.exe -u example.com -no_usr 192.0.2.43

To have messages addressed to non-existent users silently rejected on the domain example.com:

>domain_pref.exe -u example.com -no_usr reject

-sign_outgoing_mail

true|false

Allows/Prohibits using DomainKeys spam protection to sign outgoing email messages.

Is false by default.

Available since Plesk 8.4.

To use DomainKeys spam protection to sign outgoing mail on the domain example.com:

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

-keep_traf_stat

<number_of_months>

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 example.com traffic statistics during 5 months:

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

-overuse

block|notify|normal

Sets the limits overusage policy.

Available since Plesk 9.0.

To set the limits overusage policy to notify:

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