service_plan.exe: Hosting Plans

The service_plan utility is used for managing hosting plans through the command line.

Location

%plesk_cli%

 

Usage
service_plan.exe <command> [<plan_name>] [
<option 1> <param> [<option 2> <param>] ... [<option N> <param>]
]

 

Example

The following command creates a hosting plan named Personal Sites, which allocates 500 megabytes of disk space and 1 gigabyte of traffic per month.

service_plan.exe -c "Personal Sites" -hosting true -disk_space 500M -max_traffic 1G

 

Commands
Command Parameter Description Example

--create or -c

<plan_name>

Creates a new hosting plan.

To create a hosting plan named Plan 1:

service_plan.exe --create "Plan 1"

or

service_plan.exe -c "Plan 1"

--update or -u

<plan_name>

Updates an existing hosting plan.

To rename a plan from Plan 1 to Plan 2:

service_plan.exe --update "Plan 1" -new-name "Plan 2"

or

service_plan.exe -u "Plan 1" -new-name "Plan 2"

--duplicate or -d

<plan_name>

Duplicates a hosting plan by making its copy with the name specified in the '-duplicate-name' option.

To make a copy of the hosting plan named Plan 1:

service_plan.exe --duplicate "Plan 1" -duplicate-name "Plan 1 Copy"

or

service_plan.exe -d "Plan 1" -duplicate-name "Plan 1 Copy"

--remove or -r

<plan_name>

Removes a hosting plan.

To remove the plan Plan 1:

service_plan.exe --remove "Plan 1"

or

service_plan.exe -r "Plan 1"

--create-default or -def

 

Creates a default hosting plan named Default Domain.

To create a hosting plan:

service_plan.exe --create-default

or

service_plan.exe -def

--info or -i

<plan_name>

Displays information about a plan.

To view information about the plan Plan 1:

service_plan.exe --info "Plan 1"

or

service_plan.exe -i "Plan 1"

--xml-info or -x

<plan_name>

Displays information about a plan in the XML format.

To view information about the plan Plan 1 in the XML format:

service_plan.exe --xml-info "Plan 1"

or

service_plan.exe -x "Plan 1"

--enable-aps-filter

<plan_name>

Enables the APS applications filter for the specified plan. A filter restricts the number of applications available for installation on websites.

If an applications filter is not enabled (configured), then the subscriber can install all applications available from the Application Catalog + those that were uploaded to the server by the administrator and marked as available for installation.

You can learn more about restricting access to applications in Administrator's Guide > Web Applications.

To switch on the application filter and restricts the number of applications available for installation under subscriptions created by plan Plan 1 to a single application named WordPress, use the following two commands:

service_plan.exe --enable-aps-filter "Plan 1"

 

service_plan.exe --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "wordpress"

--add-aps-filter-item

<plan_name>

Adds an application to the list of applications allowed for installation on websites on the specified plan.

This command can be used with the following options:

-aps-filter-item-name

-aps-filter-item-value

To add an application AdvancedPoll identified by the system by a name "advancedpoll" to the list of applications allowed for installation on sites hosted on the plan Plan 1:

service_plan.exe --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--remove-aps-filter-item

<plan_name>

Removes an APS application from the list of applications available for installation.

To remove the application named "advancedpoll" from the list of applications available for installation on sites on the plan Plan 1:

service_plan.exe --remove-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--disable-aps-filter

<plan_name>

Disables the APS applications filter and removes all its items.

To let the subscriber to the plan Plan 1 to install all available applications without restrictions:

service_plan.exe --disable-aps-filter "Plan 1"

--show-aps-filter-info

<plan_name>

Shows information on the active APS applications filter. If an applications filter is disabled, then the subscriber can install all applications available from the Application Catalog + those that were uploaded to the server by the administrator and marked as available for installation.

To check if application filtering is enabled for the plan Plan 1:

service_plan.exe --show-aps-filter-info "Plan 1"

--add-custom-plan-item

<plan_name>

Adds a record about an additional service included into a hosting plan. Before you assign a custom plan item to a plan, you need to configure the plan item in Plesk. This can be done by means of the user interface, API or the custom_plan_items command-line utility.

You can read about custom plan items in Administrator's Guide > Offer Additional Services.

To grant the subscribers to Plan 1 with access to a custom application named "appname":

service_plan.exe --add-custom-plan-item "Plan 1" -custom-plan-item-name "appname"

--remove-custom-plan-item

<plan_name>

Removes a record about provided additional service from the plan.

To revoke access to the application "appname" from the subscribers to the plan Plan 1:

service_plan.exe --remove-custom-plan-item "Plan 1" -custom-plan-item-name "appname"

--remove-all-custom-plan-items

<plan_name>

Removes all custom service plan items provided as additional services.

To prohibit users subscribed to the plan Plan 1 to access all applications that were added as custom items:

service_plan.exe --remove-all-custom-plan-items "Plan 1"

--show-custom-plan-items

<plan_name>

Shows a list of custom service plan items.

To view all custom plan items included in the plan Plan 1:

service_plan.exe --show-custom-plan-items "Plan 1"

--update-php-settings

<plan_name>

Updates custom PHP configuration for a service plan. This configuration will act as a preset for all subscriptions. 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 plan Plan 1:

service_plan.exe --update-php-settings Plan1 -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 plan:

service_plan.exe --update-php-settings Plan1 -additional-settings my_file_add

--show-php-settings

<plan_name>

Displays information about current PHP configuration of a service plan.

To view the PHP configuration information for the plan Plan1:

service_plan.exe --show-php-settings Plan1

--help or -h

 

Displays a help reference for the utility.

To view a help reference for the utility:

service_plan.exe --help

or

service_plan.exe -h

 

Options
Option Parameter Description Example

-new-name

<string>

Renames a hosting plan.

To rename a plan from Plan 1 to Plan 2:

service_plan.exe -u "Plan 1" -new-name "Plan 2"

-duplicate-name

<string>

Sets the name of the copy of the specified hosting plan.

To make a copy with the name Plan 1 Copy of the hosting plan named Plan 1:

service_plan.exe -d "Plan 1" -duplicate-name "Plan 1 Copy"

-owner

<login_name>

Specifies the owner of a hosting plan. If the hosting plan is created for the server administrator, then this option must be omitted.

To rename the plan Plan 1 owned by a reseller with the username JDoe:

service_plan.exe -u "Plan 1" -owner JDoe -new-name "Plan 2"

-no_usr

bounce:<txt>|

<email>|<ip>|

reject|discard

Specifies what to do with incoming mail messages addressed to non-existent users.

 

To have messages addressed to non-existent users forwarded to mail address admin@example.com for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -no_usr admin@example.com

To have messages addressed to non-existent users rejected without accepting for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -no_usr reject

-max_dom_aliases

<number>

Specifies the number of available domain aliases.

Unlimited if set to -1.

To set the number of domain aliases available for subscriptions created by the plan Plan 1 to 10:

service_plan.exe -u "Plan 1" -max_dom_aliases 10

-overuse

block|not_suspend| notify|normal|not_suspend_notify

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 for the subscriptions created by the plan Plan 1 to notify:

service_plan.exe -u "Plan 1" -overuse notify

-disk_space

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

Specifies the amount of available disk space.

Unlimited if set to -1.

A number without a letter is interpreted as the number of bytes.

To restrict the amount of disk space available for subscriptions created by the plan Plan 1 to 100 megabytes:

service_plan.exe -u "Plan 1" -disk_space 100M

-disk_space_soft

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

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 subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -disk_space_soft 5G

-max_traffic

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

Sets the monthly traffic usage.

Unlimited if set to -1.

A number without a letter is interpreted as the number of bytes.

To allow subscriptions created by the plan Plan 1 to use up to 1 gigabyte per month:

service_plan.exe -u "Plan 1" -max_traffic 1G

-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 for users on the plan Plan 1 to 500 megabytes per month:

service_plan.exe -u "Plan 1" -max_traffic_soft 500M

-max_box

<number>

Specifies the number of available mailboxes.

Unlimited if set to -1.

To set the number of mailboxes available for subscriptions created by the plan Plan 1 to 50:

service_plan.exe -u "Plan 1" -max_box 50

-mbox_quota

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

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 subscriptions created by the plan Plan 1 to 50 megabytes:

service_plan.exe -u "Plan 1" -mbox_quota 50M

-total_mboxes_quota

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

Limits the total domain mail quota to the specified size.

Unlimited if set to -1.

To set the total mailbox quota for subscriptions created by the plan Plan 1 to 100 megabytes:

service_plan.exe -u "Plan 1" -total_mboxes_quota 100M

-max_wu

<number>

Specifies the allowed number of web user accounts.

Unlimited if set to -1.

To set the number of web users available for subscriptions created by the plan Plan 1 to 100:

service_plan.exe -u "Plan 1" -max_wu 100

-max_subftp_users

<number>

Specifies the number of available additional FTP accounts.

Unlimited if set to -1.

To set the number of additional FTP accounts available for subscriptions created by the plan Plan 1 to 10:

service_plan.exe -u "Plan 1" -max_subftp_users 10

-max_db

or

-max_mysql_db

<number>

Specifies the number of available MySQL databases.

Unlimited if set to -1.

To set the number of databases available for subscriptions created by the plan Plan 1 to 20:

service_plan.exe -u "Plan 1" -max_db 20

-max_mssql_db

<number>

Specifies the number of available Microsoft SQL Server databases.

Unlimited if set to -1.

To set the number of Microsoft SQL Server databases available for subscriptions created by the plan Plan 1 to 5:

service_plan.exe -u "Plan 1" -max_mssql_db 5

-mysql_dbase_space

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

Specifies the amount of disk space that all MySQL databases can occupy.

Unlimited if set to -1.

To set the disk quota for MySQL databases under subscriptions created by the plan Plan 1 to unlimited:

service_plan.exe -u "Plan 1" -mysql_dbase_space -1

-mssql_dbase_space

<number>

[B|K|M|G|T]

Specifies the amount of disk space that all MS SQL databases can occupy.

Unlimited if set to -1.

To set the disk quota for MS SQL databases under subscriptions created by the plan Plan 1 to 10:

service_plan.exe -u "Plan 1" -mysql_dbase_space 10

-mssql_dbase_filesize

<number>

[B|K|M|G|T]

Limits the file size of a Microsoft SQL Server database to the specified value.

Unlimited if set to -1.

To restrict the file size of Microsoft SQL Server databases under subscriptions created by the plan Plan 1 to 1000 MB:

service_plan.exe -u "Plan 1" -mssql_dbase_filesize 1000M

-mssql_dbase_log_filesize

<number>

[B|K|M|G|T]

Limits the log file size of a Microsoft SQL Server database to the specified value.

Unlimited if set to -1.

To restrict the log file size of Microsoft SQL Server databases under subscriptions created by the plan Plan 1 to 5000 MB:

service_plan.exe -u "Plan 1" -mssql_dbase_filesize 5000M

-max_maillists

<number>

Specifies the number of available mailing lists.

Unlimited if set to -1.

To set the number of mailing lists available for subscriptions created by the plan Plan 1 to 50:

service_plan.exe -u "Plan 1" -max_maillists 50

-max_webapps

<number>

Specifies the number of Java applications allowed for installation on sites.

Unlimited if set to -1.

To set the allowed number of Java applications for subscriptions created by the plan Plan 1 to 100:

service_plan.exe -u "Plan 1" -max_webapps 100

-max_subdom

<number>

Specifies the number of available subdomains.

Unlimited if set to -1.

To set the number of subdomains allowed for subscriptions created by the plan Plan 1 to 20:

service_plan.exe -u "Plan 1" -max_subdom 20

-max_site

<number>

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

To set the number of websites included in the plan Plan1 to 10:

service_plan.exe -u "Plan 1" -max_site 10

-max_shared_ssl_links

<number>

Specifies the number of websites that can be configured to use SSL certificates shared by a Master SSL domain.

Unlimited if set to -1.

To set the number of websites that can use shared SSL under subscriptions created by the plan Plan 1 to unlimited:

service_plan.exe -u "Plan 1" -max_shared_ssl_links -1

-max_odbc

<number>

Specifies the number of ODBC connections available for websites under a subscription.

To set the number of ODBC connections available under subscriptions created by the plan Plan 1 to unlimited:

service_plan.exe -u "Plan 1" -max_odbc -1

-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 subscriptions created by the plan Plan 1 to 10:

service_plan.exe -u "Plan 1" -max_site_builder 10

-expiration

<number>[Y|M|D]

Sets validity period for subscriptions created by a plan.

Unlimited if set to -1.

To set the validity period for subscription created by the plan Plan 1 to one year:

service_plan.exe -u "Plan 1" -expiration 1Y

-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 created by the plan Plan 1 to 10:

service_plan.exe -u "Plan 1" -max_unity_mobile_sites 10

-log-rotate

true|false

Enables or disables recycling of log files.

To enable recycling of web server log files for websites created by users of the plan Plan 1:

service_plan.exe -u "Plan 1" -log_rotate true

-log-bysize

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

Enables or disables log rotation based on the current log file size.

A number without a letter is interpreted as the number of bytes.

To enable log rotation once the current log file reaches the 20 KB size on websites created by users of the plan Plan 1:

service_plan.exe -u "Plan 1" -log_bysize 20K

-log-bytime

daily|weekly|

monthly

Enables or disables log rotation based on the current log file size.

To set weekly log rotation for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -log-bytime weekly

-log-max-num-files

<number>

Limits the maximum number of stored log file instances.

To set the maximum number of stored log file instances for subscriptions created by the plan Plan 1 to 5:

service_plan.exe -u "Plan 1" -log_max_num 5

-log-compress

true|false

Enables or disables compression of log files.

To enable log file compression for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -log_compress true

-log-email

<email>

Enables or disables automatic sending of rotated log files to the specified e-mail address.

To enable automatic sending of rotated log files to admin@example.com on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -log-email admin@example.com

-keep_traf_stat

<number>

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

The data are kept during an unlimited period if this option is set to 0.

To make the system retain traffic statistics for subscriptions created by the plan Plan 1 during 5 months:

service_plan.exe -u "Plan 1" -keep_traf_stat 5

-mail

true|false

Enables or disables the mail service.

To enable the mail service for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -mail true

-maillist

true|false

Enables or disables support for mailing lists.

Is false by default.

To enable support for mailing lists on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -maillist true

-wuscripts

true|false

Allows or prohibits execution of scripts by web users.

Is false by default.

To allow web users to use scripts on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -wuscripts true

-dns_zone_type

master|slave

Specifies whether the Plesk's DNS server should act as master or slave for domain's DNS zone.

To set the Plesk's DNS server to act as slave DNS server for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -dns_zone_type slave

-hosting

true|false

Allow or prohibits hosting of websites.

Is false by default.

To allow website hosting on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -hosting true

-quota

<number>

[B|K|M|G|T]

Limits the amount of available disk space.

Unlimited if set to -1.

Is unlimited by default.

A number without a letter is interpreted as the number of bytes.

This is a hard limit that cannot be exceeded.

To set the hard disk quota for subscriptions created by the plan Plan 1 to 100 megabytes:

service_plan.exe -u "Plan 1" -quota 100M

-sb_publish

true|false

Allows or prohibits publishing sites with Presence Builder.

Is false by default.

To allow publishing sites with Presence Builder on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -sb_publish true

-ssl

true|false

Enables or disables SSL support.

Is false by default.

To enable SSL support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -ssl true

-ssi

true|false

Enables or disables SSI support.

Is false by default.

To enable SSI support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -ssi true

-ssi_html

true|false

Enables or disables SSI support for *.htm, *.html files.

Is false by default.

To enable SSI support for HTML files on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -ssi_html true

-php

true|false

Enables or disables PHP support.

Is false by default.

To enable PHP support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -php true

-php_handler_id

cgi-5|cgi-5.3|cgi-5.4|cgi-5.5|cgi-5.6|fastcgi-5|fastcgi-5.3|fastcgi-5.4|fastcgi

-5.5|fastcgi-5.6|isapi-5

Associates the specified PHP handler with the service plan. Specify the handler's identifier (default: fastcgi-5).

To enable running PHP of version 5.4 as FastCGI on subscriptions created under the plan Plan 1:

service_plan.exe -u "Plan 1" -php_handler_id fastcgi-5.4

-cgi

true|false

Enables or disables CGI support.

Is false by default.

To enable CGI support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -cgi true

-perl

true|false

Enables or disables Perl support.

Is false by default.

To enable Perl support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -perl true

-asp

true|false

Enables or disables Apache ASP support.

Is false by default.

To enable Apache ASP support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -asp true

-asp.net

true|false

Enables or disables ASP.NET support.

Is false by default.

To enable ASP.NET support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -asp.net true

-asp.net_version

1.1|2.0|4.0

Specifies ASP.NET version.

Can be specified only if the -asp.net option is set to true.

Is 1.1 by default.

To enable ASP.NET v. 2.0 support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -asp.net_version 2.0

-python

true|false

Enables or disables Python support.

Is false by default.

To enable Python support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -python true

-miva

true|false

Enables or disables Miva support.

To enable Miva support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -miva true

-upsell_site_builder

true|false

Allows or prohibits creating trial websites in Presence Builder.

You can read about trial websites in Administrator's Guide > Trial (Try nd Buy) Mode for Presence Builder.

To allow creating trial sites with Presence Builder on the plan Plan 1:

service_plan.exe -u "Plan 1" -upsell_site_builder true

-webstat

none|webalizer|

awstats|smarterstats

Enables or disables Web statistic support; selects Web statistics application.

Is none by default.

To enable Webalizer support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -webstat webalizer

-webstat_protdir

true|false

Enables or disables access to web statistics data through the protected directory /plesk-stat/.

Is false by default.

To enable password-protected access to the web statistics data on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -webstat_protdir true

-err_docs

true|false

Enables or disables custom server error messages.

Is false by default.

To enable custom error messages support on subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -err_docs true

-iis_app_pool

true|false

Enables or disables a dedicated IIS application pool.

Is false by default.

To enable a dedicated IIS application pool for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -iis_app_pool true

-iis_app_pool_addons

true|false

Allows or prohibits using a dedicated IIS application pool for each website.

Is true by default.

To enable a dedicated IIS application pool for every website belonging to subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -iis_app_pool_addons true

-write_modify

true|false

Allows or prohibits granting the Plesk IIS user and IIS application pool user the full access permission for the httpdocs/ and httpsdocs/ files and subdirectories of websites.

This permission might be required for correct functioning of web applications. Note that this permission, when granted, might seriously compromise website security.

Is false by default.

To allow the subscribers to Plan 1 to write and modify files and subdirectories in httpdocs/ and httpsdocs/ directories:

service_plan.exe -u "Plan 1" -write_modify true

-webdeploy

true|false

Allows or prohibits Web Deploy publishing.

Is false by default.

To allow the subscribers to Plan 1 to use web deploy publishing:

service_plan.exe -u "Plan 1" -webdeploy true

-max_worker_processes

<number>

The maximum number of worker processes permitted to service requests for IIS.

To limit the number of worker processes servicing websites of subscribers to Plan 1 to 5:

service_plan.exe -u "Plan 1" -max_worker_processes 5

-idle_timeout

<minutes>

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

To make the worker processes servicing websites of subscribers to Plan 1 to shut down after 5 minutes of inactivity:

service_plan.exe -u "Plan 1" -idle_tmeout 5

-cpu_usage

<number in percent>

Limits CPU use by the dedicated IIS application pool, if it is provided to the plan subscribers.

Unlimited if set to -1.

To edit settings of IIS application pools on subscriptions created under the plan Plan 1:

  • limit the maximum CPU usage to 3% of the total CPU capacity,
  • 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:

 

service_plan.exe -u "Plan 1" -iis-app-pool true -cpu-usage-action KillW3wp -cpu-usage-interval 5 -cpu_usage 3

 

-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 on subscriptions created under the plan Plan 1 recycles to 1 hour:

service_plan.exe -u "Plan 1" -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 on subscriptions created under the plan Plan 1 can process before it recycles to 1000:

service_plan.exe -u "Plan 1" -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 on subscriptions created under the plan Plan 1 to recycle to 5 MB:

service_plan.exe -u "Plan 1" -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 on subscriptions created under the plan Plan 1 to recycle to 10 MB:

service_plan.exe -u "Plan 1" -iis_app_pool true -recycling_by_private_memory 10240

-bandwidth

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

Limits the network use by sites (in units per second).

Unlimited is set to -1.

To limit the maximum network use by sites under subscriptions created by the plan Plan 1 to 500 kilobytes per second:

service_plan.exe -u "Plan 1" -bandwidth 500K

-max_connections

<number>

Limits the number of available simultaneous network connections to sites.

Unlimited is set to -1.

To limit the number of simultaneous network connections to websites on subscriptions created by the plan Plan 1 to 100:

service_plan.exe -u "Plan 1" -max_connections 100

-webmail

atmail|merakwebmail|smwebmail|horde|mewebmail|none

Allows using webmail and selects the webmail type:

Atmail (atmail); commercial Atmail version (atmailcom); CommuniGate Pro Web Client (cgpwebmail); Horde IMP H3 (4.1.4) (horde); Merak Webmail (merakwebmail); MailEnable Web Client (mewebmail); SmarterMail Web Client (smewebmail).

To enable Horde Webmail support for subscriptions created by the plan Plan 1:

service_plan.exe -u "Plan 1" -webmail horde

-create_domains

true|false

Allows or prohibits creating domains.

Is false by default.

To allow the users who subscribe to the plan Plan 1 to create domains:

service_plan.exe -u "Plan 1" -create_domains true

-manage_phosting

true|false

Allows or prohibits managing web hosting settings.

Is false by default.

To allow the users who subscribe to the plan Plan 1 to change web hosting settings:

service_plan.exe -u "Plan 1" -manage_phosting true

-manage_php_settings

true|false

Allows or prohibits managing common PHP settings.

To allow managing common PHP settings on subscriptions based on the "Plan 1" plan:

service_plan.exe -u "Plan 1" -manage_php_settings true

-manage_php_version

true|false

Allows or prohibits choosing PHP version and handler.

To allow choosing PHP version and handler on subscriptions based on the "Plan 1" plan:

service_plan.exe -u "Plan 1" -manage_php_version true

-manage_performance

true|false

Allows or prohibits managing hosting performance settings.

To allow the users who subscribe to the plan Plan 1 to manage hosting performance settings:

service_plan.exe -u "Plan 1" -manage_performance true

-manage_sh_access

true|false

Allows or prohibits managing access to the server over Remote Desktop.

To allow the users who subscribe to the plan Plan 1 to manage access and to connect to the server:

service_plan.exe -u "Plan 1" -manage_sh_access true

-manage_quota

true|false

Allows or prohibits changing the amount of allocated disk space.

To allow the users who subscribe to the plan Plan 1 to manage the hard quota on allocated disk space:

service_plan.exe -u "Plan 1" -u -manage_quota true

-manage_subdomains

true|false

Allows or prohibits managing subdomains.

To allow the users who subscribe to the plan Plan 1 to manage subdomains:

service_plan.exe -u "Plan 1" -manage_subdomains true

-manage_domain_aliases

true|false

Allows or prohibits managing domain aliases.

To allow the users who subscribe to the plan Plan 1 to manage domain aliases:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to adjust log recycling settings:

service_plan.exe -u "Plan 1" -manage_log true

-manage_anonftp

true|false

Allows or prohibits managing Anonymous FTP.

A subscription should be assigned a dedicated IP address in order to use anonymous FTP service.

Is false by default.

To allow the users who subscribe to the plan Plan 1 to set up anonymous FTP share:

service_plan.exe -u "Plan 1" -manage_anonftp true

-manage_subftp

true|false

Allows or prohibits managing additional FTP accounts.

To allow the users who subscribe to the plan Plan 1 to set up additional FTP accounts:

service_plan.exe -u "Plan 1" -manage_subftp true

-manage_crontab

true|false

Allows or prohibits scheduling tasks on the server.

To allow the users who subscribe to the plan Plan 1 to schedule tasks on the server:

service_plan.exe -u "Plan 1" -manage_crontab true

-manage_dns

true|false

Allows or prohibits managing DNS settings for websites.

To allow the users who subscribe to the plan Plan 1 to manage DNS zones:

service_plan.exe -u "Plan 1" -manage_dns true

-manage_webapps

true|false

Allows or prohibits installing and managing Java web applications.

To allow the users who subscribe to the plan Plan 1 to install and manage Java applications:

service_plan.exe -u "Plan 1" -manage_webapps true

-manage_mail_settings

true|false

Allows or prohibits managing the mail settings.

To allow the users who subscribe to the plan Plan 1 to manage mail settings:

service_plan.exe -u "Plan 1" -manage_mail_settings true

-manage_maillists

true|false

Allows or prohibits managing mailing lists.

To allow the users who subscribe to the plan Plan 1 to set up mailing lists:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to configure spam filter:

service_plan.exe -u "Plan 1" -manage_spamfilter true

-manage_virusfilter

true|false

Allows or prohibits managing antivirus protection settings.

To allow the users who subscribe to the plan Plan 1 to manage antivirus settings:

service_plan.exe -u "Plan 1" -manage_virusfilter true

-manage_iis_app_pool

true|false

Allows or prohibits managing IIS application pool settings.

To allow the users who subscribe to the plan Plan 1 to manage IIS application pool settings:

service_plan.exe -u "Plan 1" -manage_iis_app_pool true

-manage_webstat

true|false

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

To allow the users who subscribe to the plan Plan 1 to select web statistics program:

service_plan.exe -u "Plan 1" -manage_webstat true

-manage_additional_permissions

true|false

Allows or prohibits the subscriber to set the Full access permission for files and directories in their sites' httpdocs/ directories.

To let the subscribers to plan Plan 1 to allow or prohibit the Plesk IIS User to write and modify files and subdirectories in httpdocs/:

service_plan.exe -u "Plan 1" -manage_additional_permissions true

-manage_shared_ssl

true|false

Allows or prohibits using SSL certificates shared by the hosting service provider.

To allow the users who subscribe to the plan Plan 1 to use shared SSL certificates:

service_plan.exe -u "Plan 1" -manage_shared_ssl rue

-manage_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit.

To allow the users who subscribe to the plan Plan 1 access to the WordPress toolkit:

service_plan.exe -u "Plan 1" -manage_wordpress_toolkit true

-manage_security_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit security feature.

To allow the users who subscribe to the plan Plan 1 access to the WordPress toolkit security feature:

service_plan.exe -u "Plan 1" -manage_security_wordpress_toolkit 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 users who subscribe to the plan Plan 1 to select a database server during creation of a new database:

service_plan.exe -u "Plan 1" -select_db_server true

-remote_db_connection

true|false

Allows or prohibits managing remote database access settings.

To allow the users who subscribe to the plan Plan 1 to manage remote database access settings.

service_plan.exe -u "Plan 1" -remote_db_connection true

-manage_website_maintenance

true|false

Allows or prohibits access to website copying.

To allow the users who subscribe to the plan Plan 1 access to website copying.

service_plan.exe -u "Plan 1" -manage_website_maintenance true

-manage_protected_dirs

true|false

Allows or prohibits managing password-protected directories.

To allow the users who subscribe to the plan Plan 1 to manage password-protected directories:

service_plan.exe -u "Plan 1" -manage_protected_dirs true

-access_service_users

true|false

Allows or prohibits managing auxiliary user accounts.

To allow the users who subscribe to the plan Plan 1 to manage auxiliary user accounts:

service_plan.exe -u "Plan 1" -access_service_users 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 users who subscribe to the plan Plan 1 to back up and restore websites, and keep the data on the server:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to back up and restore websites, and keep the data on custom FTP servers:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to back up and restore accounts, and keep the data on the server:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to back up and restore accounts, and keep the data on custom FTP servers:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to access applications catalog and install applications on websites:

service_plan.exe -u "Plan 1" -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 users who subscribe to the plan Plan 1 to override security policy:

service_plan.exe -u "Plan 1" -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 customers 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 a

To allow the users who subscribe to the plan Plan 1 to install APS apps using licenses from the license bundle:

service_plan.exe -u "Plan 1" -allow_license_stubs

-aps-filter-item-name

<name|URL>

Specifies identifier of APS applications filter item: whether the filtered app is identified in Plesk by name or URL.

The option to identify an application by URL is reserved for future uses and is not currently available.

To add an application AdvancedPoll identified by the system by a name "advancedpoll" to the list of applications allowed for installation by users on the plan Plan 1:

service_plan.exe --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

-aps-filter-item-value

<value>

Specifies the actual name or URL of the filtered APS app.

-custom-plan-item-name

<value>

Service plan item name.

To grant subscribers to the plan Plan 1 with access to a custom application named "appname":

service_plan.exe --add-custom-plan-item "Plan 1" -custom-plan-item-name "appname"

-settings

<filename>

Sets the file containing custom PHP settings for a service plan. 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 plan Plan1:

service_plan.exe --update-php-settings Plan1 -settings my_file

-additional-settings

<filename>

Sets the file containing custom PHP settings for a service plan. 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 (Plan1):

service_plan.exe --update-php-settings Plan1 -additional-settings my_file_add

-unpaid-website-status

disabled|suspended|

active

Sets the status for websites in suspended subscriptions (default: suspended).

To make websites receive the disabled status when their subscription (that has service plan Plan 1) becomes suspended:

service_plan.exe -u "Plan 1" -unpaid-website-status disabled

-outgoing-messages-domain-limit

<number>|default

Sets the maximum number of outgoing messages from a domain (per hour) that Plesk will use by default in subscriptions created under the specified service plan.

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

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

service_plan.exe -u "Default Domain" -outgoing-messages-domain-limit 10

-outgoing-messages-subscription-limit

<number>|default

Sets the maximum number of outgoing messages from a subscription (per hour) that Plesk will use by default in subscriptions created under the specified service plan.

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

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

service_plan.exe -u "Default Domain" -outgoing-messages-subscription-limit 50

-default_server_mssql

<host:port|none>

Sets the default Microsoft SQL Server. Websites within the plan's subscriptions will use it for storing SQL Server databases.

The none value means that SQL Server will be disabled in Plesk. However, the SQL Server databases already used by websites will still be accessible.

To set the default database server of Microsoft SQL Server type for the service plan Plan 1:

service_plan.exe -u "Plan 1" -default_server_mssql localhost:0

-default_server_mysql

<host:port|none>

Sets the default MySQL database server. Websites within the plan's subscriptions will use it for storing MySQL databases.

The none value means that MySQL will be disabled in Plesk. However, the MySQL databases already used by websites will still be accessible.

To set the default database server of MySQL type for the service plan Plan 1:

service_plan.exe -u "Plan 1" -default_server_mysql 123.123.123.123:3306

  

 

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.