subscription_settings: Hosting Subscription Settings

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

Usage
subscription_settings <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 1GB, the traffic limit to 500 megabytes.

plesk bin subscription_settings --update example.com -disk_space 1G -max_traffic 500M

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:

plesk bin subscription_settings --update example.com -disk_space 1G

or

plesk bin subscription_settings -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:

plesk bin subscription_settings --info example.com

or

plesk bin subscription_settings -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:

plesk bin subscription_settings --set-default example.com

or

plesk bin subscription_settings -d example.com

--update-php-settings

<domain_name>

Updates custom PHP configuration for a subscription. This configuration will override the one from the service plan and will act as a preset for all websites in the subscription. Use the utility to set values for 16 most often used PHP settings (exposed to Plesk GUI) or to add any additional PHP directive.

To set one of 16 general PHP settings, prepare the file with the settings you want to change.

Note: File syntax should be the same with php.ini (<parameter>=<value>). To set the default value to the parameter, do not use any value: <parameter>=

Then apply the settings to the subscription example.com:

plesk bin subscription_settings --update-php-settings example.com -settings my_file

 

If you cannot find a certain PHP parameter among 16 general settings, add it as an additional directive to a file and apply the changes to the subscription:

plesk bin subscription_settings --update-php-settings example.com -additional-settings my_file_add

--show-php-settings

<domain_name>

Displays information about current PHP configuration of a subscription.

To view the PHP configuration information for the subscription example.com:

plesk bin subscription_settings --show-php-settings example.com

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the domain utility:

plesk bin subscription_settings --help

or

plesk bin subscription_settings -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:

plesk bin subscription_settings -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.

 

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

plesk bin subscription_settings -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:

plesk bin subscription_settings -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.

 

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

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -max_wu 50

-max_db

<number>

Limits the number of available databases.

Unlimited if set to -1.

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

plesk bin subscription_settings -u example.com -max_db -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 for the subscription example.com to 3:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -max_subdom 15

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

plesk bin subscription_settings -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 domain names hosted under the subscription example.com:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -wuscripts true

-webmail

horde|roundcube|none

Switches webmail on or off for a subscription.

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

plesk bin subscription_settings -u example.com -webmail none

-default_server_mysql

<host:port>|none

Sets the default MySQL server.

To set the local MySQL server as the default for subscription example.com:

plesk bin subscription_settings -u example.com -default_server_mysql localhost:3306

-default_server_postgresql

<host:port>|none

Sets the default PostgreSQL server.

To set the local PostgreSQL server as the default for subscription example.com:

plesk bin subscription_settings -u example.com -default_server_postgresql localhost:5432

-no_usr

bounce:<txt>|<email>|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 for the subscription example.com:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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.
  • 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 resource overuse policy to notify:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -max_site 10

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

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -create_domains true

-outgoing_messages_mbox_limit

<number>|default

Sets the maximum number of outgoing messages from a mailbox (per hour).

To set the Unlimited value, specify "-1". Specify "default" to set the value specified in server-wide settings.

To set the limit on outgoing email messages from an email address:

plesk bin subscription_settings -u example.com -outgoing_messages_mbox_limit 8

-outgoing_messages_domain_limit

<number>|default

Sets the maximum number of outgoing messages from a domain (per hour).

To set the Unlimited value, specify "-1". Specify "default" to set the value specified in server-wide settings.

To set the limit on outgoing email messages from a domain:

plesk bin subscription_settings -u example.com -outgoing_messages_domain_limit 12

-outgoing_messages_subscription_limit

<number>|default

Sets the maximum number of outgoing messages from a subscription (per hour).

To set the Unlimited value, specify "-1". Specify "default" to set the value specified in server-wide settings.

To set the limit on outgoing email messages from a subscription:

plesk bin subscription_settings -u example.com -outgoing_messages_subscription-limit 110

-outgoing_messages_enable_sendmail

true | false | default

Sets the default value (on or off) for Linux sendmail for PHP scripts. Scripts will be able to send mail even when the limits on outgoing messages are reached for the corresponding mailbox and domain.

To prohibit PHP scripts send outgoing mail from the Plesk server using sendmail:

plesk bin subscription_settings -u example.com -outgoing_messages_enable_sendmail false

-manage_phosting_ssi

true|false

Allows/Prohibits managing subscription SSI settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_ssi true

-manage_phosting_php

true|false

Allows/Prohibits managing subscription PHP settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_php true

-manage_phosting_cgi

true|false

Allows/Prohibits managing subscription CGI settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_cgi true

-manage_phosting_perl

true|false

Allows/Prohibits managing subscription Perl settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_perl true

-manage_phosting_python

true|false

Allows/Prohibits managing subscription Python settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_python true

-manage_phosting_asp

true|false

Allows/Prohibits managing subscription ASP settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_asp true

-manage_phosting_fastcgi

true|false

Allows/Prohibits managing subscription FastCGI settings.

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

plesk bin subscription_settings -u example.com -manage_phosting_fastcgi 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:

plesk bin subscription_settings -u example.com -manage_phosting true

-manage_php_settings

true|false

Allows/Prohibits managing common PHP settings.

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

plesk bin subscription_settings -u example.com -manage_php_settings true

-manage_php_version

true|false

Allows/Prohibits choosing the PHP version.

To allow the owner of the subscription example.com to choose the PHP version:

plesk bin subscription_settings -u example.com -manage_php_version true

-manage_php_safe_mode

true|false

Allows or prohibits switching PHP safe mode on or off.

To allow the owner of the subscription example.com to manage PHP safe mode:

plesk bin subscription_settings -u example.com -manage_php_safe_mode 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:

plesk bin subscription_settings -u example.com -manage_performance true

-manage_sh_access

true|false

Allows or prohibits managing access to the system through SSH.

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

plesk bin subscription_settings -u example.com -manage_sh_access true

-manage_performance_bandwidth

true|false

Allows/Prohibits managing the maximum bandwidth usage.

To allow the owner of the subscription example.com to manage maximum bandwidth usage:

plesk bin subscription_settings -u example.com -manage_performance_bandwidth true

-manage_performance_connections

true|false

Allows/Prohibits managing the maximum number of connections.

To allow the owner of the subscription example.com to manage maximum number of connections:

plesk bin subscription_settings -u example.com -manage_performance_connections true

-manage_phosting_errdocs

true|false

Allows/Prohibits enabling and disabling custom error documents.

To allow the owner of the subscription example.com to manage custom error documents:

plesk bin subscription_settings -u example.com -manage_phosting_errdocs true

-manage_phosting_ssl

true|false

Allows/Prohibits enabling and disabling SSL support.

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

plesk bin subscription_settings -u example.com -manage_phosting_ssl 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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -manage_webapps true

-manage_mail_settings

true|false

Allows/Prohibits adjusting mail settings.

To allow the administrator adjusting mail settings:

plesk bin subscription_settings -u example.com -manage_mail_settings 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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -manage_virusfilter 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:

plesk bin subscription_settings -u example.com -manage_webstat true

-select_db_server

true|false

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

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

plesk bin subscription_settings -u example.com -select_db_server true

-remote_db_connection

true|false

Allows or prohibits setting up custom access settings for database users under a subscription.

To allow the owner of the subscription example.com to set up remote or local access to their databases:

plesk bin subscription_settings -u example.com -remote_db_connection true

-manage_website_maintenance

true|false

Allows/Prohibits performing website maintenance.

To allow the owner of the subscription example.com to perform website maintenance:

plesk bin subscription_settings -u example.com -manage_website_maintenance true

-manage_wordpress_toolkit

true|false

Allows/Prohibits access to the WordPress Toolkit.

To allow the owner of the subscription example.com to access the WordPress Toolkit:

plesk bin subscription_settings -u example.com -manage_wordpress_toolkit true

-manage_security_wordpress_toolkit

true|false

Allows/Prohibits access to the WordPress Toolkit Security Management feature.

To allow the owner of the subscription example.com to access the WordPress Toolkit Security Management feature:

plesk bin subscription_settings -u example.com -manage_security_wordpress_toolkit true

-manage_protected_dirs

true|false

Allows/Prohibits managing password-protected directories.

To allow the owner of the subscription example.com to manage password-protected directories:

plesk bin subscription_settings -u example.com -manage_protected_dirs true

-access_service_users

true|false

Allows/Prohibits managing auxiliary user accounts.

To allow the owner of the subscription example.com to manage auxiliary user accounts:

plesk bin subscription_settings -u example.com -access_service_users true

-manage_hosting_type

true|false

Allows/Prohibits managing hosting type.

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

plesk bin subscription_settings -u example.com -manage_hosting_type true

-rename_domains

true|false

Allows/Prohibits renaming domains.

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

plesk bin subscription_settings -u example.com -rename_domains true

-manage_not_chroot_shell

true|false

Allows/Prohibits choosing non-chrooted shells.

To allow the owner of the subscription example.com to choose non-chrooted shells:

plesk bin subscription_settings -u example.com -manage_not_chrooted_shell 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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -allow_ftp_backups true

-allow_account_local_backups

true|false

Allows/Prohibits creating account backups in the server storage.

To allow the owner of the subscription example.com to create account backups in the server storage:

plesk bin subscription_settings -u example.com -allow_account_local_backups true

-allow_account_ftp_backups

true|false

Allows/Prohibits creating account backups in an FTP storage.

To allow the owner of the subscription example.com to create account backups in an FTP storage:

plesk bin subscription_settings -u example.com -allow_account_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:

plesk bin subscription_settings -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:

plesk bin subscription_settings -u example.com -allow_insecure_sites true

-allow_license_stubs

true|false

If your Plesk license comes in a bundle with APS app licenses, you can install such apps without the need to purchase the app licenses from vendors. By setting the -allow_license_stubs option to true, you grant your customer the same permission: They can install apps from the bundle to their websites without purchasing app licenses. Note that you cannot limit the number of app installations a customer is allowed to perform. Thus, a customer can install a commercial app an unlimited number of times.

To allow the owner of the subscritpion example.com to install APS apps using licenses from the license bundle:

plesk bin subscription_settings -u example.com -allow_license_stubs

-settings

<filename>

Sets the file containing custom PHP settings for a subscription. The file can include only 16 general PHP settings exposed to the Plesk GUI.

Used with --update-php-settings only.

To set custom PHP configuration from the file my_file to the subscritpion example.com:

plesk bin subscription_settings --update-php-settings example.com -settings my_file

-additional-settings

<filename>

Sets the file containing custom PHP settings for a subscription. The file can include any PHP directive except 16 general PHP settings exposed to the Plesk GUI.

Used with --update-php-settings only.

To add directives to custom PHP configuration from the file my_file_add (example.com):

plesk bin subscription_settings --update-php-settings example.com -additional-settings my_file_add

 

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.