Previous page

Next page

Locate page

--create or -c

<plan_name>

Creates a new hosting plan add-on.

To create a hosting plan add-on named Plan 1:

>service_plan_addon.exe --create "Plan 1"

or

>service_plan_addon.exe -c "Plan 1"

--update or -u

<plan_name>

Updates an existing hosting plan add-on.

To rename a plan add-on from Plan 1 to Plan 2:

>service_plan_addon.exe --update "Plan 1" -new-name "Plan 2"

or

>service_plan_addon.exe -u "Plan 1" -new-name "Plan 2"

--remove or -r

<plan_name>

Removes a hosting plan add-on.

To remove the plan add-on Plan 1:

>service_plan_addon.exe --remove "Plan 1"

or

>service_plan_addon.exe -r "Plan 1"

--info or -i

<plan_name>

Displays information about a plan add-on.

To view information about the plan add-on Plan 1:

>service_plan_addon.exe --info "Plan 1"

or

>service_plan_addon.exe -i "Plan 1"

--xml-info or -x

<plan_name>

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:

>service_plan_addon.exe --xml-info "Plan 1"

or

>service_plan_addon.exe -x "Plan 1"

--update-php-settings

<plan_name>

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 Panel 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 add-on Plan 1:

>service_plan_addon.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 add-on:

>service_plan_addon.exe --update-php-settings Plan1 -additional-settings my_file_add

--show-php-settings

<plan_name>

Displays information about current PHP configuration of a plan add-on.

To view the PHP configuration information for the plan add-on Plan1:

>service_plan_addon.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_addon.exe --help

or

>service_plan_addon.exe -h

-new-name

<string>

Renames a hosting plan add-on.

To rename a plan add-on from Plan 1 to Plan 2:

>service_plan_addon.exe -u "Plan 1" -new-name "Plan 2"

-owner

<login_name>

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:

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

-max_dom_aliases

<number>

Specifies the number of available domain aliases.

Unlimited if set to -1.

To set the number of domain aliases for Plan 1 to 10:

>service_plan_addon.exe -u "Plan 1" -max_dom_aliases 10

-disk_space

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

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 set the amount of disk space for Plan 1 to 100 megabytes:

>service_plan_addon.exe -u "Plan 1" -disk_space 100M

-max_traffic

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

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 that are assigned the add-on Plan 1 to use 1 additional gigabyte of data transfers per month:

>service_plan_addon.exe -u "Plan 1" -max_traffic 1G

-max_box

<number>

Specifies the number of available mailboxes.

Unlimited if set to -1.

To set the number of mailboxes for Plan 1 to 50:

>service_plan_addon.exe -u "Plan 1" -max_box 50

-mbox_quota

<number>[K|M|G]

Limits the amount of disk space that a single mailbox can occupy.

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

Unlimited if set to -1.

To set the mailbox quota for Plan 1 to 50 megabytes:

>service_plan_addon.exe -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 for Plan 1 to 100:

>service_plan_addon.exe -u "Plan 1" -max_wu 100

-max_fpse_users

<number>

Specifies the number of available additional Microsoft FrontPage accounts.

Unlimited if set to -1.

To set the number of Microsoft FrontPage accounts for Plan 1 to 5:

>service_plan_addon.exe -u "Plan 1" -max_fpse_users 5

-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 for Plan 1 to 10:

>service_plan_addon.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 for Plan 1 to 20:

>service_plan_addon.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 for Plan 1 to 5:

>service_plan_addon.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 on Plan 1 to unlimited:

>service_plan_addon.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 on Plan 1 to 10:

>service_plan_addon.exe -u "Plan 1" -mysql_dbase_space 10

-max_maillists

<number>

Specifies the number of available mailing lists.

Unlimited if set to -1.

To set the number of mailing lists on Plan 1 to 50:

>service_plan_addon.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 on Plan 1 to 100:

>service_plan_addon.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 on Plan 1 to 20:

>service_plan_addon.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 add-on Plan 1 to 10:

>service_plan_addon.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 on Plan 1 to unlimited:

>service_plan_addon.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 for sites on Plan 1 to unlimited:

>service_plan_addon.exe -u "Plan 1" -max_odbc -1

-max_site_builder

<number>

Specifies the number of websites that can be created and published with Web Presence Builder.

To set the number of websites that can be created and published with Web Presence Builder on Plan 1 to 10:

>service_plan_addon.exe -u "Plan 1" -max_site_builder 10

-max_unity_mobile_sites

<number>

Specifies the number of mobile site versions that can be created with the external UNITY Mobile service.

To set the number of mobile websites that can be created on Plan 1 to 10:

>service_plan_addon.exe -u "Plan 1" -max_unity_mobile_sites 10

-maillist

true|false

Enables or disables support for mailing lists.

Is false by default.

To enable support for mailing lists on Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.exe -u "Plan 1" -wuscripts true

-hosting

true|false

Allow or prohibits hosting of websites.

Is false by default.

To allow website hosting on Plan 1:

>service_plan_addon.exe -u "Plan 1" -hosting true

-quota

<number>[K|M|G]

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 Plan 1 to 100 megabytes:

>service_plan_addon.exe -u "Plan 1" -quota 100M

-publish-sb-site

true|false

Allows or prohibits publishing sites with Web Presence Builder.

Is false by default.

To allow publishing sites with Web Presence Builder on Plan 1:

>service_plan_addon.exe -u "Plan 1" -sb_publish true

-ssl

true|false

Enables or disables SSL support.

Is false by default.

To enable SSL support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -ssl true

-fp

true|false

Enables or disables Microsoft FrontPage support.

Is false by default.

To enable FrontPage support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -fp true

-fp_ssl

true|false

Enables or disables Microsoft FrontPage over SSL support.

Can be set to true only if the -ssl option is set to true.

Is false by default.

To enable FrontPage over SSL support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -fp_ssl true

-fp_auth

true|false

Allows or prohibits remote Microsoft FrontPage authoring.

Is false by default.

To allow remote FrontPage authoring on Plan 1:

>service_plan_addon.exe -u "Plan 1" -fpauth true

-ssi

true|false

Enables or disables SSI support.

Is false by default.

To enable SSI support on Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.exe -u "Plan 1" -ssi_html true

-php

true|false

Enables or disables PHP support.

Is false by default.

To enable PHP support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -php true

-php_handler_type

<cgi|fastcgi|isapi>

Specifies PHP support mode.

To enable running PHP as FastCGI on Plan 1:

>service_plan_addon.exe -u "Plan 1" -php_handler_type fastcgi

-php_version

4|5

Specifies PHP version that should be supported.

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

Is set to 4 by default.

To select PHP5 support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -php_version 5

-cgi

true|false

Enables or disables CGI support.

Is false by default.

To enable CGI support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -cgi true

-perl

true|false

Enables or disables Perl support.

Is false by default.

To enable Perl support on Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.exe -u "Plan 1" -python true

-coldfusion

true|false

Enables or disables ColdFusion support.

Is false by default.

To enable ColdFusion support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -coldfusion true

-miva

true|false

Enables or disables Miva support.

To enable Miva support on Plan 1:

>service_plan_addon.exe -u "Plan 1" -miva true

-webstat

none|webalizer|awstats|smarterstats|urchin

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

Is none by default.

To enable Webalizer support on Plan 1:

>service_plan_addon.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 Plan 1:

>service_plan_addon.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 plan Plan 1:

>service_plan_addon.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 on Plan 1:

>service_plan_addon.exe -u "Plan 1" -iis_app_pool true

-write_modify

true|false

Allows or prohibits granting to the Panel IIS User the Full access permission for the site's httpdocs/ files and subdirectories (may be required for web applications correct functioning, but is insecure).

Is false by default.

To allow the users subscribed to Plan 1 to write and modify files and subdirectories in httpdocs directory:

>service_plan_addon.exe -u "Plan 1" -write_modify true

-cpu_usage

<number in percent>

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

To limit the maximum CPU usage by IIS application pools on subscriptions assigned the plan add-on Plan 1 to 3% of the total CPU capacity:

>service_plan_addon.exe -u "Plan 1" -cpu_usage 3

-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 assigned the plan add-on Plan 1 to 500 kilobytes per second:

>service_plan_addon.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 Plan 1 to 100:

>service_plan_addon.exe -u "Plan 1" -max_connections 100

-max_cf_dsn

<number>

Limits the number of available ColdFusion data source name connections.

To set the number of Coldfusion DSN connections on Plan 1 to unlimited:

>service_plan_addon.exe -u "Plan 1" -max_cf_dsn -1

-create_domains

true|false

Allows or prohibits creating domains.

Is false by default.

To allow the users subscribed to the plan add-on Plan 1 to create domains:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to change web hosting settings:

>service_plan_addon.exe -u "Plan 1" -manage_phosting true

-manage_performance

true|false

Allows or prohibits managing hosting performance settings.

To allow the users subscribed to the plan add-on Plan 1 to manage hosting performance settings:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to manage access and to connect to the server:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to manage the hard quota on allocated disk space:

>service_plan_addon.exe -u "Plan 1" -u -manage_quota true

-manage_subdomains

true|false

Allows or prohibits managing subdomains.

To allow the users subscribed to the plan add-on Plan 1 to manage subdomains:

>service_plan_addon.exe -u "Plan 1" -manage_subdomains true

-manage_domain_aliases

true|false

Allows or prohibits managing domain aliases.

To allow the users subscribed to the plan add-on Plan 1 to manage domain aliases:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to adjust log recycling settings:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to set up anonymous FTP share:

>service_plan_addon.exe -u "Plan 1" -manage_anonftp true

-manage_subftp

true|false

Allows or prohibits managing additional FTP accounts.

To allow the users subscribed to the plan add-on Plan 1 to set up additional FTP accounts:

>service_plan_addon.exe -u "Plan 1" -manage_subftp true

-manage_crontab

true|false

Allows or prohibits scheduling tasks on the server.

To allow the users subscribed to the plan add-on Plan 1 to schedule tasks on the server:

>service_plan_addon.exe -u "Plan 1" -manage_crontab true

-manage_dns

true|false

Allows or prohibits managing DNS settings for websites.

To allow the users subscribed to the plan add-on Plan 1 to manage DNS zones:

>service_plan_addon.exe -u "Plan 1" -manage_dns true

-manage_webapps

true|false

Allows or prohibits installing and managing Java web applications.

To allow the users subscribed to the plan add-on Plan 1 to install and manage Java applications:

>service_plan_addon.exe -u "Plan 1" -manage_webapps true

-manage_maillists

true|false

Allows or prohibits managing mailing lists.

To allow the users subscribed to the plan add-on Plan 1 to set up mailing lists:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to configure spam filter:

>service_plan_addon.exe -u "Plan 1" -manage_spamfilter true

-manage_virusfilter

true|false

Allows or prohibits managing antivirus protection settings.

To allow the users subscribed to the plan add-on Plan 1 to manage antivirus settings:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to manage IIS application pool settings:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to select web statistics program:

>service_plan_addon.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 add-on Plan 1 to allow or prohibit the Panel IIS User to write and modify files and subdirectories in httpdocs/:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to use shared SSL certificates:

>service_plan_addon.exe -u "Plan 1" -manage_shared_ssl rue

-select_db_server

true|false

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

To allow the users subscribed to the plan add-on Plan 1 to select a database server during creation of a new database:

>service_plan_addon.exe -u "Plan 1" -select_db_server 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 subscribed to the plan add-on Plan 1 to back up and restore websites, and keep the data on the server:

>service_plan_addon.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 subscribed to the plan add-on Plan 1 to back up and restore websites, and keep the data on custom FTP servers:

>service_plan_addon.exe -u "Plan 1" -allow_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 add-on Plan 1 to access applications catalog and install applications on websites:

>service_plan_addon.exe -u "Plan 1" -access_appcatalog true

-allow_license_stubs

true|false

If your Panel 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 add-on Plan 1 to install APS apps using licenses from the license bundle:

>service_plan_addon.exe -u "Plan 1" -allow_license_stubs

-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 subscribed to the plan add-on Plan 1 to override security policy:

>service_plan_addon.exe -u "Plan 1" -allow_insecure_sites true

-settings

<filename>

Sets the file containing custom PHP settings for a plan add-on. The file can include only 16 general PHP settings exposed to the Panel GUI.

Used with --update-php-settings only.

To set custom PHP configuration from the file my_file to the plan add-on Plan1:

>service_plan_addon.exe --update-php-settings Plan1 -settings my_file

-additional-settings

<filename>

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 Panel GUI.

Used with --update-php-settings only.

To add directives to custom PHP configuration from the file my_file_add (Plan1):

>service_plan_addon.exe --update-php-settings Plan1 -additional-settings my_file_add