service_plan: Hosting Plans

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

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

plesk bin service_plan -c "Personal Sites" -hosting true -disk_space 500M -max_traffic 1G

Commands
Command Parameter Description Example

--create or -c

<service-plan-name>

Creates a new hosting plan.

To create a hosting plan named Plan 1:

plesk bin service_plan --create "Plan 1"

or

plesk bin service_plan -c "Plan 1"

--update or -u

<service-plan-name>

Updates an existing hosting plan.

To rename a plan from Plan 1 to Plan 2:

plesk bin service_plan --update "Plan 1" -new-name "Plan 2"

or

plesk bin service_plan -u "Plan 1" -new-name "Plan 2"

--duplicate or -d

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

plesk bin service_plan --duplicate "Plan 1" -duplicate-name "Plan 1 Copy"

or

plesk bin service_plan -d "Plan 1" -duplicate-name "Plan 1 Copy"

--remove or -r

<service-plan-name>

Removes a hosting plan.

To remove the plan Plan 1:

plesk bin service_plan --remove "Plan 1"

or

plesk bin service_plan -r "Plan 1"

--create-default or -def

 

Creates a default hosting plan named Default Domain.

To create a hosting plan:

plesk bin service_plan --create-default

or

plesk bin service_plan -def

--info or -i

<service-plan-name>

Displays information about a plan.

To view information about the plan Plan 1:

plesk bin service_plan --info "Plan 1"

or

plesk bin service_plan -i "Plan 1"

--xml-info or -x

<service-plan-name>

Displays information about a plan in the XML format.

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

plesk bin service_plan --xml-info "Plan 1"

or

plesk bin service_plan -x "Plan 1"

--enable-aps-filter

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

plesk bin service_plan --enable-aps-filter "Plan 1"

 

plesk bin service_plan --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "wordpress"

--add-aps-filter-item

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

plesk bin service_plan --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--remove-aps-filter-item

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

plesk bin service_plan --remove-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--disable-aps-filter

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

plesk bin service_plan --disable-aps-filter "Plan 1"

--show-aps-filter-info

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

plesk bin service_plan --show-aps-filter-info "Plan 1"

--add-custom-plan-item

<service-plan-name>

Adds a record about an additional service included into 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":

plesk bin service_plan --add-custom-plan-item "Plan 1" -custom-plan-item-name "appname"

--remove-custom-plan-item

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

plesk bin service_plan --remove-custom-plan-item "Plan 1" -custom-plan-item-name "appname"

--remove-all-custom-plan-items

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

plesk bin service_plan --remove-all-custom-plan-items "Plan 1"

--show-custom-plan-items

<service-plan-name>

Shows a list of custom service plan items.

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

plesk bin service_plan --show-custom-plan-items "Plan 1"

--update-php-settings

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

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

plesk bin service_plan --update-php-settings Plan1 -additional-settings my_file_add

--show-php-settings

<service-plan-name>

Displays information about current PHP configuration of a service plan.

To view the PHP configuration information for the plan Plan1:

plesk bin service_plan --show-php-settings Plan1

--help or -h

 

Displays a help reference for the utility.

To view a help reference for the utility:

plesk bin service_plan --help

or

plesk bin service_plan -h

Options
Option Parameter Description Example

-new-name

<string>

Renames a hosting plan.

To rename a plan from Plan 1 to Plan 2:

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

plesk bin service_plan -d "Plan 1" -duplicate-name "Plan 1 Copy"

-owner

<login>

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:

plesk bin service_plan -u "Plan 1" -owner JDoe -new-name "Plan 2"

-no_usr

bounce:<txt>|<email>|reject

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:

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

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

plesk bin service_plan -u "Plan 1" -max_dom_aliases 10

-overuse

block|not_suspend| notify|normal|

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:

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

plesk bin service_plan -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 email notification upon occupying 5 gigabytes of disk space under the subscriptions created by the plan Plan 1:

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

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

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

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

plesk bin service_plan -u "Plan 1" -mbox_quota 50M

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

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

plesk bin service_plan -u "Plan 1" -max_subftp_users 10

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

plesk bin service_plan -u "Plan 1" -max_db 20

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

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

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

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

plesk bin service_plan -u "Plan 1" -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 subscriptions created by the plan Plan 1 to 10:

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

plesk bin service_plan -u "Plan 1" -expiration 1Y

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

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

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

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

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

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

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

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

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

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

plesk bin service_plan -u "Plan 1" -wuscripts true

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

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

plesk bin service_plan -u "Plan 1" -quota 100M

-ssl

true|false

Enables or disables SSL/TLS support.

Is false by default.

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

plesk bin service_plan -u "Plan 1" -ssl true

-ssl-redirect

true|false

Enables or disables SEO-safe 301 redirection from HTTP to HTTPS.

Is false by default.

To enable redirection from HTTP to HTTPS on the subscriptions created by the service plan Plan 1:

plesk bin service_plan -u "Plan 1" -ssl-redirect 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:

plesk bin service_plan -u "Plan 1" -asp 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:

plesk bin service_plan -u "Plan 1" -ssi 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:

plesk bin service_plan -u "Plan 1" -php true

-php_handler_id

cgi|fastcgi|fpm|module|plesk-php52-cgi|plesk-php52-fastcgi|plesk-php53-cgi|plesk-php53-fastcgi|plesk-php54-cgi|plesk-php54-fastcgi|plesk-php54-fpm|plesk-php55-cgi|plesk-php55-fastcgi|plesk-php55-fpm|plesk-php56-cgi|plesk-php56-fastcgi|plesk-php56-fpm

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

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

plesk bin service_plan -u "Plan 1" -php_handler_id fastcgi

-php_served_by_nginx

true|false

Determines whether PHP scripts are served by Apache or nginx.

To make nginx serve PHP for subscriptions based on the "Plan 1" plan:

plesk bin service_plan -u "Plan 1" -php_served_by_nginx true

-cgi

true|false

Enables or disables CGI support.

Is false by default.

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

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

plesk bin service_plan -u "Plan 1" -perl true

-python

true|false

Enables or disables Python support.

Is false by default.

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

plesk bin service_plan -u "Plan 1" -python true

-fastcgi

true|false

Enables or disables FastCGI support.

Is false by default.

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

plesk bin service_plan -u "Plan 1" -fastcgi true

-webstat

none|webalizer|awstats

Enables or disables Web statistic support; selects Web statistics application (Awstats or Webalizer).

Is none by default.

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

plesk bin service_plan -u "Plan 1" -webstat webalizer

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

plesk bin service_plan -u "Plan 1" -err_docs true

-shell

<shell_name>|false

Allows or prohibits access to server shell with FTP user account credentials.

(Use the --shells command of the domain utility to view the list of available shells).

Is false by default.

To enable shell access and set the shell to /bin/sh for FTP users on subscriptions created by the plan Plan 1:

plesk bin service_plan -u "Plan 1" -shell /bin/sh

To view the list of available shells:

plesk bin domain --shells

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

plesk bin service_plan -u "Plan 1" -webstat_protdir true

-dns_zone_type

master|slave

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

Is master by default.

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

plesk bin service_plan -u "Plan 1" -dns_zone_type slave

-publish-sb-site

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:

plesk bin service_plan -u "Plan 1" -publish-sb-site true

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

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

plesk bin service_plan -u "Plan 1" -max_connections 100

-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 and Buy) Mode for Presence Builder.

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

plesk bin service_plan -u "Plan 1" -upsell_site_builder true

-webmail

horde|atmail|roundcube|none

Allows using webmail and selects the webmail type (horde,atmail,roundcube), or prohibits webmail (none) .

 

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

plesk bin service_plan -u "Plan 1" -webmail horde

-apache-restrict-follow-sym-links

true|false

Allows or prohibits the ability of Apache to follow symbolic links.

To enable Apache following symbolic links for the domains belonging to users who subscribe to the plan Plan 1:

plesk bin service_plan -u "Plan 1" -apache-restrict-follow-sym-links true

-apache-additional-settings

<filename>

Specifies the full path to the file with Apache settings for HTTP.

To specify the path to the file containing the Apache settings to be used for serving sites that belong to subscriptions based on the "Plan 1" plan via HTTP:

plesk bin service_plan -u "Plan 1" -apache-additional-settings /etc/httpd/conf/custom_http.conf

-apache-additional-ssl-settings

<filename>

Specifies the full path to the file with Apache settings for HTTPS.

To specify the path to the file containing the Apache settings to be used for serving sites that belong to subscriptions based on the "Plan 1" plan via HTTPS:

plesk bin service_plan -u "Plan 1" -apache-additional-ssl-settings /etc/httpd/conf/custom_https.conf

-nginx-additional-settings

<filename>

Specifies the full path to the file with nginx settings.

To specify the path to the file containing the nginx settings to be used for serving sites that belong to subscriptions based on the "Plan 1" plan via HTTPS:

plesk bin service_plan -u "Plan 1" -nginx-additional-settings /etc/nginx/custom.conf

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

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

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

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

plesk bin service_plan -u "Plan 1" -manage_php_version true

-manage_php_safe_mode

true | false

Allows or prohibits switching PHP safe mode on and off.

To allow the users who subscribe to the plan Plan 1 to switch PHP safe mode on or off:

plesk bin service_plan -u "Plan 1" -manage_php_safe_mode true

-manage_sh_access

true|false

Allows or prohibits managing access over SSH to the chrooted environment on the server.

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

plesk bin service_plan -u "Plan 1" -manage_sh_access true

-manage_not_chroot_shell

true|false

Allows or prohibits managing access over SSH to any shell available on the server.

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

plesk bin service_plan -u "Plan 1" -manage_not_chroot_shell 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:

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

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

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

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

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

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

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

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

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

plesk bin service_plan -u "Plan 1" -manage_mail_settings 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:

plesk bin service_plan -u "Plan 1" -manage_webstat 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:

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

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

plesk bin service_plan -u "Plan 1" -manage_virusfilter 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:

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

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

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

plesk bin service_plan -u "Plan 1" -allow_account_ftp_backups 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:

plesk bin service_plan -u "Plan 1" -manage_performance 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:

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

plesk bin service_plan -u "Plan 1" -remote_db_connection 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:

plesk bin service_plan -u "Plan 1" -manage_protected_dirs true

-access_service_users

true|false

Allows or prohibits managing additional user accounts.

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

plesk bin service_plan -u "Plan 1" -access_service_users 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:

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

plesk bin service_plan -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 an unlimited number of times.

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

plesk bin service_plan -u "Plan 1" -allow_license_stubs

-nginx-proxy-mode

true | false

Turns on/off the proxy mode for the nginx reverse proxy server. Turn off to use nginx for processing all HTTP requests for websites' content (without Apache participating in this processing). Is true by default.

To allow subscriptions to use nginx for processing requests for websites' content, turn off nginx proxy mode by running the command:

plesk bin service_plan -u "Plan 1" -nginx-proxy-mode false

-aps-filter-item-name

<name|URI>

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

 

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:

plesk bin service_plan --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 URI 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":

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

plesk bin service_plan --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):

plesk bin service_plan --update-php-settings Plan1 -additional-settings my_file_add

-outgoing-messages-mbox-limit

<number>|default

Sets the maximum number of outgoing messages from a mailbox (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 limit on outgoing email messages from an email address:

plesk bin service_plan -u "Default Domain" -outgoing-messages-mbox-limit 5

-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 limit on outgoing email messages from a domain:

plesk bin service_plan -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 limit on outgoing email messages from a subscription:

plesk bin service_plan -u "Default Domain" -outgoing-messages-subscription-limit 50

-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 service_plan -u "Default Domain" -outgoing-messages-enable-sendmail false

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

plesk bin service_plan -u "Plan 1" -unpaid-website-status disabled

-cgroups_cpu_usage

<number>[%]

Limits the CPU usage of a subscription, in percent (-1 for Unlimited).

To set limits on CPU usage for subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_cpu_usage 50

-cgroups_cpu_usage_soft

<number>[%]

Sends a notification when the specified soft limit on CPU usage is reached.

To set a soft limit on CPU usage for subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_cpu_usage_soft 40

-cgroups_cpu_period

<number>

Sets the period of time (in seconds) to gather statistics for calculating CPU usage over that period (5 minutes, an hour, a day). Allowed values are 300, 3600, 86400.

To set a period of time to calculate CPU usage for subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_cpu_period 3600

-cgroups_ram_usage

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

Limits the RAM usage of a subscription, in Bytes (-1 for Unlimited). Must not be less than 1MB.

To set limits on RAM usage for subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_ram_usage 1400

-cgroups_ram_usage_soft

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

Sends a notification when the specified soft limit on RAM usage is reached. Must not be less than 1MB.

To set a soft limit on RAM usage for subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_ram_usage_soft 1024

-cgroups_ram_period

<number>

Sets the period of time (in seconds) to gather statistics for calculating RAM usage over that period (5 minutes, an hour, a day). Allowed values are 300, 3600, 86400.

To set a period of time to calculate RAM usage for subscriptions created for service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_ram_period 3600

-cgroups_disk_read_usage

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

Limits the disk read bandwidth usage of a subscription, in Bytes/s (-1 for Unlimited).

To set limits on disk read usage for subscriptions created for service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_disk_read_usage 10240000

-cgroups_disk_read_usage_soft

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

Sends a notification when the specified limit on disk read bandwidth usage is reached (Bytes/s).

To set a soft limit on disk read usage by subscriptions created for service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_disk_read_usage_soft 10000000

-cgroups_disk_read_period

<number>

Sets the period of time (in seconds) to gather statistics for calculating disk read speed usage over that period (5 minutes, an hour, a day). Allowed values are 300, 3600, 86400.

To set a period of time to calculate disk read speed usage by subscriptions created for service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_disk_read_period 3600

-cgroups_disk_write_usage

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

Limits the disk write bandwidth usage of a subscription, in Bytes/s (-1 for Unlimited).

To set limits on disk write usage by subscriptions created for service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_disk_write_usage 10240000

-cgroups_disk_write_usage_soft

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

Sends a notification when the specified limit on disk write bandwidth usage is reached (Bytes/s).

To set a soft limit on disk write usage by subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_disk_write_usage_soft 10000000

-cgroups_disk_write_period

<number>

Sets the period of time (in seconds) to gather statistics for calculating disk write speed usage over that period (5 minutes, an hour, a day). Allowed values are 300, 3600, 86400.

To set a period of time to calculate disk write speed usage for subscriptions of service plan Plan 1:

 

plesk bin service_plan -u "Plan 1" -cgroups_disk_write_period 3600

-outgoing_messages_mbox_limit

<number>|default

Sets the limit on 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 messages for all mailboxes that belong to subscriptions based on the "Plan 1" plan to 10:

plesk bin service_plan -u "Plan 1" -outgoing_messages_mbox_limit 10

-outgoing_messages_domain_limit

<number>|default

Sets the limit on 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 messages for all domains that belong to subscriptions based on the "Plan 1" plan to 10:

plesk bin service_plan -u "Plan 1" -outgoing_messages_domain_limit 10

-outgoing_messages_subscription_limit

<number>|default

Sets the limit on 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 messages for all subscriptions based on the "Plan 1" plan to 10:

plesk bin service_plan -u "Plan 1" -outgoing_messages_subscription_limit 10

-outgoing_messages_enable_sendmail

true|false|default

Turns Linux Sendmail for PHP scripts on or off. Scripts will be able to send mail even when the limits on outgoing messages are reached for the corresponding mailbox and domain.

To enable sendmail for all subscriptions based on the "Plan 1" plan:

plesk bin service_plan -u "Plan 1" -outgoing_messages_enable_sendmail true

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

plesk bin service_plan -u "Plan 1" -default_server_mysql 123.123.123.123:3306

-default_server_postgresql

<host:port>|none

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

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

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

plesk bin service_plan -u "Plan 1" -default_server_postgresql 123.123.123.123:5432

-ext_permission_git_manage_git

true|false

Allows Git management. Requires the Git Manager extension installed.

To allow Git management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_git_manage_git true

-ext_permission_ruby_support_management

true|false

Allows Ruby management. Requires the Ruby Manager extension installed.

To allow Ruby management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_ruby_support_management true

-ext_permission_ruby_state_management

true|false

Allows Ruby state management. Requires the Ruby Manager extension installed.

To allow Ruby state management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_ruby_state_management true

-ext_permission_ruby_version_management

true|false

Allows Ruby version management. Requires the Ruby Manager extension installed.

To allow Ruby version management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_ruby_version_management true

-ext_permission_nodejs_support_management

true|false

Allows Node.js management. Requires the Node.js Manager extension installed.

To allow Node.js management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_nodejs_support_management true

-ext_permission_nodejs_state_management

true|false

Allows Node.js state management. Requires the Node.js Manager extension installed.

To allow Node.js state management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_nodejs_state_management true

-ext_permission_nodejs_version_management

true|false

Allows Node.js version management. Requires the Node.js Manager extension installed.

To allow Node.js version management to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1: -ext_permission_nodejs_version_management true

-ext_permission_wp_toolkit_manage_wordpress_toolkit

true|false

Gives access to the WordPress Toolkit extension.

To give access to WordPress Toolkit to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan 1" -ext_permission_wp_toolkit_manage_wordpress_toolkit true

-ext_permission_wp_toolkit_manage_security_wordpress_toolkit

true|false

Gives access to security management in the WordPress Toolkit extension.

To give access to security management in WordPress Toolkit to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_wp_toolkit_manage_security_wordpress_toolkit true

-ext_permission_wp_toolkit_manage_cloning

true|false

Allows cloning of WordPress installations in the WordPress Toolkit extension.

To allow cloning of WordPress installations to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_wp_toolkit_manage_cloning true

-ext_permission_wp_toolkit_manage_syncing

true|false

Allows synchronization of WordPress installations in the WordPress Toolkit extension.

To allow synchronization of WordPress installations to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_wp_toolkit_manage_syncing true

-ext_permission_wp_toolkit_manage_autoupdates

true|false

Allows management of auto-updates in the WordPress Toolkit extension.

To allow auto-updates management in WordPress Toolkit to the owners of subscriptions based on the service plan Plan1:

plesk bin service_plan -u "Plan1" -ext_permission_wp_toolkit_manage_autoupdates true

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.