Domain Limits and Preferences: domain

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:

setting up limits on domain resources usage, like the maximum number of mailboxes, databases, autoresponders, etc.
managing domain-level preferences, like web users scripting support, webmail use, etc.

Syntax

domain_pref.exe <command> [<domain_name>] [

<option1><param> [<option2><param>]…[<option N><param>]

]

Example

The following command modifies preferences of domain1.com as follows: the maximum allowed disk space for this domain is restricted to 1 Gbyte, 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 domain1.com -disk_space 1024 -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 sampledomain.com: >domain_pref.exe --update domain1.com -disk_space 1024 -max_traffic 500 or >domain_pref.exe -u domain1.com -disk_space 1024 -max_traffic 500
`--info or -i`	`<domain_name>`	Retrieves information about domain preferences.	To retrieve information about somedomain.com preferences: >domain_pref.exe --info somedomain.com or >domain_pref.exe –i somedomain.com
`--help or -h`		Displays help on the utility use.	>domain_pref.exe --help or >domain_pref.exe -h

Command

Parameter

Description

Example

--update or -u

<domain_name>

Sets the domain preferences.

To change preferences of sampledomain.com:

>domain_pref.exe --update domain1.com -disk_space 1024 -max_traffic 500

>domain_pref.exe -u domain1.com -disk_space 1024 -max_traffic 500

--info or -i

<domain_name>

Retrieves information about domain preferences.

To retrieve information about somedomain.com preferences:

>domain_pref.exe --info somedomain.com

>domain_pref.exe –i somedomain.com

--help or -h

Displays help on the utility use.

>domain_pref.exe --help

>domain_pref.exe -h

Options

Option	Parameter	Description	Example
`-max_dom_aliases`	`<number>`	Restricts the maximum number of available domain aliases. `-1` means unlimited.	To allow sampledomain.com to have maximum 2 aliases: >domain_pref.exe --update sampledomain.com -max_dom_aliases 2
`-disk_space`	`<Mbytes>`	Restricts the maximum amount of available disk space. `-1` means unlimited.	To allow sampledomain.com to occupy maximum 1 Gbyte: >domain_pref.exe --update sampledomain.com -disk_space 1024
`-max_traffic`	`<Mbytes>`	Restricts the maximum monthly traffic usage. `-1` means unlimited.	To allow sampledomain.com to use up to 10 Gbytes per month: >domain_pref.exe --update sampledomain.com -disk_space 10240
`-max_box`	`<number>`	Restricts the maximum number of mail boxes. `-1` means unlimited.	To restrict the number of mailboxes for sampledomain.com to 5: >domain_pref.exe -u sampledomain.com -max_box 5
`-mbox_quota`	`<number>`	Restricts the maximum amount of disk space allotted to a single mail box on a domain (in KB). `-1` means unlimited.	To restrict the use of disk space for a single mailbox on sampledomain.com to 20 Mbytes: >domain_pref.exe -u sampledomain.com -mbox_quota 20480
`-total_mboxes_quota`	`<number>`	Limits the amount of disk space that all mailboxes on the domain can occupy (in Mbytes). If set to `-1`, means unlimited. 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 sampledomain.com to 20 Gbytes: >domain_pref.exe -u sampledomain.com -total_mboxes_quota 20480
`-max_redir`	`<number>`	Restricts the maximum number of available mail redirects. `-1` means unlimited.	To restrict the number of mail redirects on sampledomain.com to 5: >domain_pref.exe -u sampledomain.com -max_redir 5
`-max_mg`	`<number>`	Restricts the maximum number of available mail groups. `-1` means unlimited.	To restrict the number of mail groups on sampledomain.com to 7: >domain_pref.exe -u sampledomain.com -max_mg 7
`-max_resp`	`<number>`	Restricts the maximum number of mail autoresponders (mail replies being sent automatically). `-1` means unlimited.	To restrict the number of mail autoresponders on sampledomain.com to 10: >domain_pref.exe -u sampledomain.com -max_resp 10
`-max_wu`	`<number>`	Restricts the maximum number of web users. `-1` means unlimited.	To restrict the number of web users on sampledomain.com to 50: >domain_pref.exe -u sampledomain.com -max_wu 50
`-max_db`	`<number>`	Restricts the maximum number of MySQL databases that can be used by a domain. `-1` means unlimited.	To restrict the number of MySQL databases on sampledomain.com to 5: >domain_pref.exe -u sampledomain.com -max_db 5
`-max_mssql_db`	`<number>`	Restricts the maximum number of Microsoft SQL databases that can be used by a domain. `-1` means unlimited.	To restrict the number of Microsoft SQL databases on sampledomain.com to 7: >domain_pref.exe -u sampledomain.com -max_mssql_db 7
`-mysql_dbase_space`	`<Mbytes>`	Restricts the maximum amount of disk space allotted to MySQL databases (in MB). `-1` means unlimited.	To restrict the disk space occupied by all MySQL databases of sampledomain.com to 500 Mbytes: >domain_pref.exe -u sampledomain.com -mysql_dbase_space 500
`-mssql_dbase_space`	`<Mbytes>`	Restricts the maximum amount of disk space allotted to Microsoft SQL Server databases (in MB). `-1` means unlimited.	To restrict the disk space occupied by Microsoft SQL Server databases of sampledomain.com to 700 Mbytes: >domain_pref.exe -u sampledomain.com -mssql_dbase_space 700
`-max_maillists`	`<number>`	Restricts the maximum number of mailing lists. `-1` means unlimited.	To restrict the number of mailing lists on sampledomain.com to 3: >domain_pref.exe -u sampledomain.com -max_maillists 3
`-max_webapps`	`<number>`	Restricts the maximum number of web applications. `-1` means unlimited.	To restrict the number of web applications on sampledomain.com to 10: >domain_pref.exe --update sampledomain.com -max_webapps 10
`-max_subdom`	`<number>`	Restricts the maximum number of subdomains. `-1` means unlimited.	To restrict the number of subdomains on sampledomain.com to 2: >domain_pref.exe --update sampledomain.com -max_subdom 2
`-max_shared_ssl_links`	`<number>`	Restricts the number of shared SSL links. `-1` means unlimited.	To restrict the number of shared SSL links for sampledomain.com to 3: >domain_pref.exe -u -max_shared_ssl_links 3
`-expiration`	`<YYYY-MM-DD>`	Defines the date when a domain account expires. `-1` means unlimited.	To set April 1, 2009 as the expiration date for sampledomain.com: >domain_pref.exe --update sampledomain.com -expiration 2009-04-01
`-www`	`true\|false`	Allows accessing a domain using URL with the www prefix. Default value is `true`.	To make sampledomain.com accessible with the "www" prefix: >domain_pref.exe --update sampledomain.com -www true
`-wuscripts`	`true\|false`	Enables/Disables using scripts for web users.	To enable scripting support for web users of sampledomain.com: >domain_pref.exe -u sampledomain.com -wuscripts true
`-webmail`	`true\|false`	Enables/Disables using Web mail.	To enable Web mail on sampledomain.com: >domain_pref.exe --update sampledomain.com -webmail true
`-max_fpse_users`	`<number>`	Limits the maximum number of additional Microsoft FrontPage accounts that can be created on a domain. `-1` means unlimited. Available since Plesk 7.6.	To allow unlimited number of additional Microsoft FrontPage accounts limit on sampledomain.com: >domain_pref.exe -u sampledomain.com -max_fpse_users -1
`-max_subftp_users`	`<number>`	Limits the maximum number of additional FTP accounts. `-1` means unlimited. Available since Plesk 7.6.	To allow maximum 100 additional FTP accounts on sampledomain.com: >domain_pref.exe -u sampledomain.com -max_subftp_users 100
`-no_usr`	`[bounce: <txt>] \| [<email>]`	Sets the 'bounce' or 'catch-all' processing mode for the incoming email addressed to a mail user that does not exist on a domain. The option is obsolete.	To set the 'bounce' mode for the mail received for a non-existing user on sampledomain.com: >domain_pref.exe --update sampledomain.com -no_usr bounce:spam To redirect all mail received for a non-existing users on sampledomain.com to spam@sampledomain.com: >domain_pref.exe -u sampledomain.com -no_usr spam@sampledomain.com
`-keep_traf_stat`	`<number>`	Defines the number of months during which the system keeps traffic usage statistics. `0` means keeping the statistics during unlimited period.	To make the system retain sampledomain.com traffic statistics during 5 months: >domain_pref.exe --update sampledomain.com -keep_traf_stat 5