service_plan_addon: Hosting Plan Add-ons
The service_plan_addon
utility is used for managing hosting plan add-ons through the command line.
Usage
Example
The following command creates a hosting plan add-on named Ten additional websites. It enables the subscribed users to create ten websites more.
Commands
Command | Parameter | Description | Example |
---|---|---|---|
|
|
Creates a new hosting plan add-on. |
To create a hosting plan add-on named Additional 5 gigabytes of disk space: plesk bin service_plan_addon --create "Additional 5 gigabytes of disk space" or plesk bin service_plan_addon -c "Additional 5 gigabytes of disk space" |
|
|
Updates an existing hosting plan add-on. |
To rename a plan add-on from Plan 1 to Plan 2: plesk bin service_plan_addon --update "Plan 1" -new-name "Plan 2" or plesk bin service_plan_addon -u "Plan 1" -new-name "Plan 2" |
|
|
Duplicates a hosting plan add-on by making its copy with the name specified in the ' |
To make a copy of a plan add-on Plan 1 with the name Plan 1 Copy: plesk bin service_plan_addon --duplicate "Plan 1" -duplicate-name "Plan 1 Copy" or plesk bin service_plan_addon -d "Plan 1" -duplicate-name "Plan 1 Copy" |
|
|
Removes a hosting plan add-on. |
To remove the plan add-on Plan 1: plesk bin service_plan_addon --remove "Plan 1" or plesk bin service_plan_addon -r "Plan 1" |
|
|
Displays information about a plan add-on. |
To view information about the plan add-on Plan 1: plesk bin service_plan_addon --info "Plan 1" or plesk bin service_plan_addon -i "Plan 1" |
|
|
Displays information about a plan add-on in the XML format. |
To view information about the plan add-on Plan 1 in the XML format: plesk bin service_plan_addon --xml-info "Plan 1" or plesk bin service_plan_addon -x "Plan 1" |
|
|
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:
|
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 add-on Plan 1: plesk bin service_plan --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll" |
|
|
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 add-on Plan 1: plesk bin service_plan --remove-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll" |
|
|
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 add-on Plan 1: plesk bin service_plan --show-aps-filter-info "Plan 1" |
|
|
Updates custom PHP configuration for a plan add-on. This configuration will override the one from the main service plan. 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 Then apply the settings to the plan add-on Plan 1: plesk bin service_plan_addon --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 add-on: plesk bin service_plan_addon --update-php-settings Plan1 -additional-settings my_file_add |
|
|
Displays information about current PHP configuration of a plan add-on. |
To view the PHP configuration information for the plan add-on Plan1: plesk bin service_plan_addon --show-php-settings Plan1 |
|
|
Displays a help reference for the utility. |
To view a help reference for the utility: plesk bin service_plan_addon --help or plesk bin service_plan_addon -h |
Options
Option | Parameter | Description | Example |
---|---|---|---|
|
|
Renames a plan add-on. |
To rename a plan add-on from Plan 1 to Plan 2: plesk bin service_plan_addon -u "Plan 1" -new-name "Plan 2" |
|
|
Sets the name of the copy of the specified add-on plan. |
To make a copy with the name Plan 1 Copy of the plan named Plan 1: plesk bin service_plan_addon -d "Plan 1" -duplicate-name "Plan 1 Copy" |
|
|
Specifies the owner of a hosting plan add-on. If the plan add-on is created for the server administrator, then this option must be omitted. |
To rename the plan add-on Plan 1 owned by a reseller with the username JDoe: plesk bin service_plan_addon -u "Plan 1" -owner JDoe -new-name "Plan 2" |
|
|
Specifies the number of available domain aliases. Unlimited if set to |
To set the number of domain aliases for Plan 1 to 10: plesk bin service_plan_addon -u "Plan 1" -max_dom_aliases 10 |
|
|
Specifies the amount of available disk space. Unlimited if set to A number without a letter is interpreted as the number of bytes. |
To restrict the amount of disk space for Plan 1 to 100 megabytes: plesk bin service_plan_addon -u "Plan 1" -disk_space 100M |
|
|
Sets the monthly traffic usage. Unlimited if set to A number without a letter is interpreted as the number of bytes. |
To allow subscriptions that are assigned the add-on Plan 1 to use 1 additional gigabyte of data transfers per month: plesk bin service_plan_addon -u "Plan 1" -max_traffic 1G |
|
|
Specifies the number of available mailboxes. Unlimited if set to |
To set the number of mailboxes for Plan 1 to 50: plesk bin service_plan_addon -u "Plan 1" -max_box 50 |
|
|
Specifies 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 |
To set the mailbox quota for Plan 1 to 50 megabytes: plesk bin service_plan_addon -u "Plan 1" -mbox_quota 50M |
|
|
Specifies the allowed number of web user accounts. Unlimited if set to |
To set the number of web users for Plan 1 to 100: plesk bin service_plan_addon -u "Plan 1" -max_wu 100 |
|
|
Specifies the number of available additional FTP accounts. Unlimited if set to |
To set the number of additional FTP accounts for Plan 1 to 10: plesk bin service_plan_addon -u "Plan 1" -max_subftp_users 10 |
|
|
Specifies the number of available MySQL databases. Unlimited if set to |
To set the number of databases for Plan 1 to 20: plesk bin service_plan_addon -u "Plan 1" -max_db 20 |
|
|
Specifies the number of available mailing lists. Unlimited if set to |
To set the number of mailing lists for Plan 1 to 50: plesk bin service_plan_addon -u "Plan 1" -max_maillists 50 |
|
|
Specifies the number of Java applications allowed for installation on sites. Unlimited if set to |
To set the allowed number of Java applications for Plan 1 to 100: plesk bin service_plan_addon -u "Plan 1" -max_webapps 100 |
|
|
Specifies the number of available subdomains. Unlimited if set to |
To set the number of subdomains allowed for Plan 1 to 20: plesk bin service_plan_addon -u "Plan 1" -max_subdom 20 |
|
|
Specifies the number of websites that can be hosted under a subscription. |
To set the number of websites included in Plan 1 to 10: plesk bin service_plan_addon -u "Plan 1" -max_site 10 |
|
|
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 Plan 1 to 10: plesk bin service_plan_addon -u "Plan 1" -max_site_builder 10 |
|
|
Specifies the number of mobile site versions that can be created with the external UNITY Mobile service. |
To set the number of mobile websites for Plan 1 to 10: plesk bin service_plan_addon -u "Plan 1" -max_unity_mobile_sites 10 |
|
|
Enables or disables support for mailing lists. Is |
To enable support for mailing lists for Plan 1: plesk bin service_plan_addon -u "Plan 1" -maillist true |
|
|
Allows or prohibits execution of scripts by web users. Is |
To allow web users to use scripts on Plan 1: plesk bin service_plan_addon -u "Plan 1" -wuscripts true |
|
|
Allow or prohibits hosting of websites. Is |
To allow website hosting on Plan 1: plesk bin service_plan_addon -u "Plan 1" -hosting true |
|
|
Limits the amount of available disk space. Unlimited if set to 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 Plan 1 to 100 megabytes: plesk bin service_plan_addon -u "Plan 1" -quota 100M |
|
|
Enables or disables SSL support. Is |
To enable SSL support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -ssl true |
|
|
Enables or disables Apache ASP support. Is |
To enable Apache ASP support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -asp true |
|
|
Enables or disables SSI support. Is |
To enable SSI support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -ssi true |
|
|
Enables or disables PHP support. Is |
To enable PHP support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -php true |
|
|
Associates the specified PHP handler with the plan addon. Specify the handler's identifier (default: |
To enable running PHP as FastCGI on the plan Plan Addon 1: plesk bin service_plan_addon -u "Plan Addon 1" -php_handler_id fastcgi |
|
|
Allows or prohibits access to server shell with FTP user account credentials. (Use the Is |
To enable shell access and set the shell to plesk bin service_plan -u "Plan Addon 1" -shell /bin/sh To view the list of available shells: plesk bin domain --shells |
|
|
Enables or disables CGI support. Is |
To enable CGI support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -cgi true |
|
|
Enables or disables Perl support. Is |
To enable Perl support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -perl true |
|
|
Enables or disables Python support. Is |
To enable Python support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -python true |
|
|
Enables or disables FastCGI support. Is |
To enable FastCGI support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -fastcgi true |
|
|
Enables or disables Web statistic support; selects Web statistics application (Awstats or Webalizer). Is |
To enable Webalizer support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -webstat webalizer |
|
|
Enables or disables custom server error messages. Is |
To enable custom error messages support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -err_docs true |
|
|
Enables or disables access to web statistics data through the protected directory Is |
To enable password-protected access to the web statistics data on Plan 1: plesk bin service_plan_addon -u "Plan 1" -webstat_protdir true |
|
|
Allows or prohibits publishing sites with Presence Builder. Is |
To allow publishing sites with Presence Builder on Plan 1: plesk bin service_plan_addon -u "Plan 1" -publish-sb-site true |
|
<number>[B|K|M|G|T] |
Limits the network use by sites (in units per second). Unlimited is set to |
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_addon -u "Plan 1" -bandwidth 500K |
|
|
Limits the number of available simultaneous network connections to sites. Unlimited is set to |
To limit the number of simultaneous network connections to websites on Plan 1 to 100: plesk bin service_plan_addon -u "Plan 1" -max_connections 100 |
|
|
Enables or disables Miva support. |
To enable Miva support on Plan 1: plesk bin service_plan_addon -u "Plan 1" -miva true |
|
|
Allows or prohibits creating domains. Is |
To allow the users who are subscribed to the plan add-on Plan 1 to create domains: plesk bin service_plan_addon -u "Plan 1" -create_domains true |
|
|
Allows or prohibits managing web hosting settings. Is |
To allow the users who are subscribed to the plan add-on Plan 1 to change web hosting settings: plesk bin service_plan_addon -u "Plan 1" -manage_phosting true |
|
|
Allows or prohibits managing common PHP settings. |
To allow managing common PHP settings on subscriptions based on the "Plan Addon 1" plan: plesk bin service_plan -u "Plan Addon 1" -manage_php_settings true |
|
|
Allows or prohibits choosing PHP version and handler. |
To allow choosing PHP version and handler on subscriptions based on the "Plan Addon 1" plan: plesk bin service_plan -u "Plan Addon 1" -manage_php_version true |
|
|
Allows or prohibits managing password-protected directories. |
To allow the users who subscribe to the plan Plan Addon 1 to manage password-protected directories: plesk bin service_plan -u "Plan Addon 1" -manage_protected_dirs true |
|
|
Allows or prohibits switching PHP safe mode on and off. |
To allow the users who are subscribed to the plan add-on Plan 1 to switch PHP safe mode on or off: plesk bin service_plan_addon -u "Plan 1" -manage_php_safe_mode true |
|
|
Allows or prohibits managing access over SSH to the chrooted environment on the server. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage access and to connect to the server: plesk bin service_plan_addon -u "Plan 1" -manage_sh_access true |
|
|
Allows or prohibits managing auxiliary user accounts. |
To allow the users who subscribe to the plan Plan Addon 1 to manage auxiliary user accounts: plesk bin service_plan -u "Plan Addon 1" -access_service_users true |
|
|
Allows or prohibits overselling. |
To allow overselling for users who subscribe to the plan Plan Addon 1: plesk bin service_plan -u "Plan Addon 1" -allow_oversell true |
|
|
Allows or prohibits managing access over SSH to any shell available on the server. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage access and to connect to the server: plesk bin service_plan_addon -u "Plan 1" -manage_not_chroot_shell true |
|
|
Allows or prohibits changing the amount of allocated disk space. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage the hard quota on allocated disk space: plesk bin service_plan_addon -u "Plan 1" -u -manage_quota true |
|
|
Allows or prohibits managing subdomains. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage subdomains: plesk bin service_plan_addon -u "Plan 1" -manage_subdomains true |
|
|
Allows or prohibits managing domain aliases. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage domain aliases: plesk bin service_plan_addon -u "Plan 1" -manage_domain_aliases true |
|
|
Allows or prohibits managing log rotation, namely, to adjust the cleanup and recycling of processed log files. |
To allow the users who are subscribed to the plan add-on Plan 1 to adjust log recycling settings: plesk bin service_plan_addon -u "Plan 1" -manage_log true |
|
|
Allows or prohibits managing the mail settings. |
To allow the users who subscribe to the plan Plan Addon 1 to manage mail settings: plesk bin service_plan -u "Plan Addon 1" -manage_mail_settings true |
|
|
Allows or prohibits managing Anonymous FTP. A subscription should be assigned a dedicated IP address in order to use anonymous FTP service. Is |
To allow the users who are subscribed to the plan add-on Plan 1 to set up anonymous FTP share: plesk bin service_plan_addon -u "Plan 1" -manage_anonftp true |
|
|
Allows or prohibits managing additional FTP accounts. |
To allow the users who are subscribed to the plan add-on Plan 1 to set up additional FTP accounts: plesk bin service_plan_addon -u "Plan 1" -manage_subftp true |
|
|
Allows or prohibits scheduling tasks on the server. |
To allow the users who are subscribed to the plan add-on Plan 1 to schedule tasks on the server: plesk bin service_plan_addon -u "Plan 1" -manage_crontab true |
|
|
Allows or prohibits managing DNS settings for websites. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage DNS zones: plesk bin service_plan_addon -u "Plan 1" -manage_dns true |
|
|
Allows or prohibits installing and managing Java web applications. |
To allow the users who are subscribed to the plan add-on Plan 1 to install and manage Java applications: plesk bin service_plan_addon -u "Plan 1" -manage_webapps true |
|
|
Allows or prohibits selecting the web statistics program to use for websites. |
To allow the users who are subscribed to the plan add-on Plan 1 to select web statistics program: plesk bin service_plan_addon -u "Plan 1" -manage_webstat true |
|
|
Allows or prohibits access to website copying. |
To allow the users who subscribe to the plan Plan Addon 1 access to website copying. plesk bin service_plan -u "Plan Addon 1" -manage_website_maintenance true |
|
|
Allows or prohibits access to the WordPress toolkit. |
To allow the users who subscribe to the plan Plan Addon 1 access to the WordPress toolkit: plesk bin service_plan -u "Plan Addon 1" -manage_wordpress_toolkit true |
|
|
Allows or prohibits using the Plesk API. |
To allow the users who subscribe to the plan Plan Addon 1 use the Plesk API: plesk bin service_plan -u "Plan Addon 1" -remote_access_interface true |
|
|
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: plesk bin service_plan -u "Plan 1" -manage_security_wordpress_toolkit true |
|
|
Allows or prohibits managing mailing lists. |
To allow the users who are subscribed to the plan add-on Plan 1 to set up mailing lists: plesk bin service_plan_addon -u "Plan 1" -manage_maillists true |
|
|
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 are subscribed to the plan add-on Plan 1 to configure spam filter: plesk bin service_plan_addon -u "Plan 1" -manage_spamfilter true |
|
|
Allows or prohibits managing antivirus protection settings. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage antivirus settings: plesk bin service_plan_addon -u "Plan 1" -manage_virusfilter true |
|
|
Allows or prohibits backing up and restoring websites, and keeping backup files on the hosting server. |
To allow the users who are subscribed to the plan add-on Plan 1 to back up and restore websites, and keep the data on the server: plesk bin service_plan_addon -u "Plan 1" -allow_local_backups true |
|
|
Allows or prohibits backing up and restoring websites, and saving them to custom FTP servers. |
To allow the users who are subscribed to the plan add-on Plan 1 to back up and restore websites, and keep the data on custom FTP servers: plesk bin service_plan_addon -u "Plan 1" -allow_ftp_backups true |
|
|
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 Addon 1 to back up and restore accounts, and keep the data on the server: plesk bin service_plan -u "Plan Addon 1" -allow_account_local_backups true |
|
|
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 Addon 1 to back up and restore accounts, and keep the data on custom FTP servers: plesk bin service_plan -u "Plan Addon 1" -allow_account_ftp_backups true |
|
|
Allows or prohibits managing hosting performance settings. |
To allow the users who are subscribed to the plan add-on Plan 1 to manage hosting performance settings: plesk bin service_plan_addon -u "Plan 1" -manage_performance true |
|
|
Allows or prohibits choosing DB server from the servers registered in Plesk, when creating a database. |
To allow the users who are subscribed to the plan add-on Plan 1 to select a database server during creation of a new database: plesk bin service_plan_addon -u "Plan 1" -select_db_server true |
|
|
Allows or prohibits managing remote database access settings. |
To allow the users who subscribe to the plan Plan Addon 1 to manage remote database access settings. plesk bin service_plan -u "Plan Addon 1" -remote_db_connection true |
|
|
Allows or prohibits access to applications catalog for viewing and installing prepackaged applications on sites. |
To allow the users who are subscribed to the plan add-on Plan 1 to access applications catalog and install applications on websites: plesk bin service_plan_addon -u "Plan 1" -access_appcatalog true |
|
|
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 |
To allow the users who subscribe to the plan add-on Plan 1 to install APS apps using licenses from the license bundle: plesk bin service_plan_addon -u "Plan 1" -allow_license_stubs |
|
|
Allows or prohibits overriding server-wide security policy on web hosting scripting options, if the policy is set up. |
To allow the users who are subscribed to the plan add-on Plan 1 to override security policy: plesk bin service_plan_addon -u "Plan 1" -allow_insecure_sites true |
|
|
Sets the file containing custom PHP settings for a plan add-on. The file can include only 16 general PHP settings exposed to the Plesk GUI. Used with |
To set custom PHP configuration from the file my_file to the plan add-on Plan1: plesk bin service_plan_addon --update-php-settings Plan1 -settings my_file |
|
|
Sets the file containing custom PHP settings for a plan add-on. The file can include any PHP directive except 16 general PHP settings exposed to the Plesk GUI. Used with |
To add directives to custom PHP configuration from the file my_file_add (Plan1): plesk bin service_plan_addon --update-php-settings Plan1 -additional-settings my_file_add |
|
|
Specifies the identifier of APS applications filter item: whether the filtered app is identified in 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 add-on Plan 1: plesk bin service_plan_addon --add-aps-filter-item "Plan 1" -aps-filter-item-name name -aps-filter-item-value "advancedpoll" |
|
|
Specifies the actual name or URI of the filtered APS app. |