--create or -c

<plan_name>

Creates a reseller plan.

To create a reseller plan named Sample Plan:

reseller_plan.exe --create "Sample Plan"

or

reseller_plan.exe -c "Sample Plan"

--update or -u

<plan_name>

Sets various properties of a reseller plan.

To rename the reseller plan from Sample Plan 1 to Sample Plan 2:

reseller_plan.exe --update "Sample Plan 1" -new-name "Sample Plan 2"

or

reseller_plan.exe -u "Sample Plan 1" -new-name "Sample Plan 2"

--duplicate or -d

<plan_name>

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

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

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

or

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

--remove or -r

<plan_name>

Removes a reseller plan.

To remove the reseller plan Sample Plan:

reseller_plan.exe --remove "Sample Plan"

or

reseller_plan.exe -r "Sample Plan"

--info or -i

<plan_name>

Displays reseller template limits, permissions, preferences and IP addresses.

To view information on the reseller plan Sample Plan:

reseller_plan.exe --info "Sample Plan"

or

reseller_plan.exe -i "Sample Plan"

--xml-info or -x

<plan_name>

Displays information on a reseller template in the XML format.

To view information on the reseller plan Sample Plan in the XML format:

reseller_plan.exe --xml-info "Sample Plan"

or

reseller_plan.exe -x "Sample Plan"

--create-default or -def

Creates a reseller plan named Default Reseller.

To create a default reseller plan:

reseller_plan.exe --create-default

or

reseller_plan.exe -def

--enable-aps-filter

<plan_name>

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

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

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:

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

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

--add-aps-filter-item

<plan_name>

Adds an application to the list of applications allowed for installation.

This command can be used with the following options:

-aps-filter-item-name

-aps-filter-item-value

To add the application AdvancedPoll identified by the system by the name "advancedpoll" to the list of applications allowed for installation by subscribers to Plan 1:

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

--remove-aps-filter-item

<plan_name>

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

To remove the application named "advancedpoll" from the list of applications available for installation by subscribers to the plan Plan 1:

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

--disable-aps-filter

<plan_name>

Disables the APS applications filter and removes all its items.

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

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

--show-aps-filter-info

<plan_name>

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

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

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

--help or -h

Displays help on the utility use

To view help on the use of the utility:

reseller_plan.exe --help

or

reseller_plan.exe -h

-new-name

<string>

Sets a new name for an existing reseller plan.

To rename the reseller plan from Sample Plan 1 to Sample Plan 2:

reseller_plan.exe --update "Sample Plan 1" -new-name "Sample Plan 2"

-duplicate-name

<string>

Sets the name of a copy of the specified reseller plan.

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

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

-create_domains

true|false

Allows/Prohibits creating domains.

Is false by default.

To allow resellers created by the plan Sample Plan to set up hosting accounts for new sites:

reseller_plan.exe -u "Sample Plan" -create_domains true

-manage_mail_settings

true|false

Allows or prohibits managing the mail settings.

To allow resellers created by the plan Sample Plan to manage mail settings:

reseller_plan.exe -u "Sample Plan" -manage_mail_settings true

-manage_phosting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

To allow resellers created by the plan Sample Plan to manage physical hosting:

reseller_plan.exe -u "Sample Plan" -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:

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

-manage_php_version

true|false

Allows or prohibits choosing PHP version and handler.

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

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

-manage_sh_access

true|false

Allows/Prohibits managing access to the system through Remote Desktop.

Is false by default.

To allow resellers created by the plan Sample Plan to manage system access:

reseller_plan.exe -u "Sample Plan" -manage_sh_access true

-manage_quota

true|false

Allows/Prohibits changing limit on using disk space.

Is false by default.

To allow resellers created by the plan Sample Plan to change hard disk quota:

reseller_plan.exe -u "Sample Plan" -manage_quota true

-manage_subdomains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

To allow resellers created by the plan Sample Plan to manage subdomains:

reseller_plan.exe -u "Sample Plan" -manage_subdomains true

-manage_domain_aliases

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

To allow resellers created by the plan Sample Plan to manage domain aliases:

reseller_plan.exe -u "Sample Plan" -manage_domain_aliases true

-manage_log

true|false

Allows/Prohibits managing log rotation, namely, to adjust the cleanup and recycling of processed log files.

Is false by default.

To allow resellers created by the plan Sample Plan to manage log rotation:

reseller_plan.exe -u "Sample Plan" -manage_log true

-manage_anonftp

true|false

Allows/Prohibits managing Anonymous FTP.

Is false by default.

To allow resellers created by the plan Sample Plan to manage Anonymous FTP:

reseller_plan.exe -u "Sample Plan" -manage_anonftp true

-manage_subftp

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

To allow resellers created by the plan Sample Plan to manage additional FTP accounts:

reseller_plan.exe -u "Sample Plan" -manage_subftp true

-manage_crontab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

To allow resellers created by the plan Sample Plan to manage task scheduler:

reseller_plan.exe -u "Sample Plan" -manage_crontab 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 resellers created by the plan Sample Plan to configure spam filter:

reseller_plan.exe -u "Sample Plan" -manage_spamfilter true

-manage_virusfilter

true|false

Allows or prohibits managing antivirus protection settings.

To allow resellers created by the plan Sample Plan to manage antivirus settings:

reseller_plan.exe -u "Sample Plan" -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 resellers created by the plan Plan 1 to back up and restore websites, and keep the data on the server:

reseller_plan.exe -u "Plan 1" -allow_local_backups true

-allow_ftp_backups

true|false

Allows or prohibits backing up and restoring websites, and saving them to custom FTP servers.

To allow resellers created by the plan Plan 1 to back up and restore websites, and keep the data on custom FTP servers:

reseller_plan.exe -u "Plan 1" -allow_ftp_backups true

-allow_account_local_backups

true|false

Allows or prohibits backing up and restoring accounts and keeping backup files on the hosting server.

To allow resellers created by the plan Plan 1 to back up and restore accounts, and keep the data on the server:

reseller_plan.exe -u "Plan 1" -allow_account_local_backups true

-allow_account_ftp_backups

true|false

Allows or prohibits backing up and restoring accounts and saving them to custom FTP servers.

To allow resellers created by the plan Plan 1 to back up and restore accounts, and keep the data on custom FTP servers:

reseller_plan.exe -u "Plan 1" -allow_account_ftp_backups true

-manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

To allow resellers created by the plan Sample Plan to manage DNS:

reseller_plan.exe -u "Sample Plan" -manage_dns true

-manage_webapps

true|false

Allows/Prohibits managing Tomcat web applications.

Is false by default.

To allow resellers created by the plan Sample Plan to manage Tomcat web applications:

reseller_plan.exe -u "Sample Plan" -manage_webapps true

-manage_maillists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

To allow resellers created by the plan Sample Plan to manage mailing lists:

reseller_plan.exe -u "Sample Plan" -manage_maillists true

-manage_virusfilter

true|false

Allows/Prohibits managing server-side antivirus protection.

Is false by default.

To allow resellers created by the plan Sample Plan to manage antivirus:

reseller_plan.exe -u "Sample Plan" -manage_virusfilter true

-remote_access_interface

true|false

Allows/Prohibits using Plesk API.

Is false by default.

To allow resellers created by the plan Sample Plan to use Plesk API:

reseller_plan.exe -u "Sample Plan" -remote_access_interface true

-site_builder

true|false

Allows/Prohibits using Presence Builder.

Is false by default.

To allow resellers created by the plan Sample Plan to use Presence Builder

reseller_plan.exe -u "Sample Plan" -site_builder true

-manage_performance

true|false

Allows/Prohibits managing hosting performance.

Is false by default.

To allow resellers created by the plan Sample Plan to manage hosting performance:

reseller_plan.exe -u "Sample Plan" -manage_performance true

-manage_iis_app_pool

true|false

Allows/Prohibits managing IIS application pool.

Is false by default.

To allow resellers created by the plan Sample Plan to manage IIS application pool:

reseller_plan.exe -u "Sample Plan" -manage_iis_app_pool true

-manage_webstat

true|false

Allows/Prohibits managing Web Statistics on the reseller's domains, namely, to choose which of the web statistics tools (or none) to use.

Is false by default.

To allow resellers created by the plan Sample Plan to manage web statistics:

reseller_plan.exe -u "Sample Plan" -manage_webstat true

-manage_additional_permissions

true|false

Allows/Prohibits managing additional write and modify permissions.

If it is true, the full access permission for the domain httpdocs/ and httpsdocs/ files and subfolders are granted to the Plesk IIS User.

May be required for web applications correct functioning, but is insecure.

Is false by default.

To allow resellers created by the plan Sample Plan to manage additional write/modify permissions:

reseller_plan.exe -u "Sample Plan" -manage_additional_permissions true

-manage_shared_ssl

true|false

Allows/Prohibits managing the Shared SSL feature: making one of the reseller's domains a Master SSL Domain which shares its SSL certificates with other domains, and creating shared SSL links to Master for his other domains.

Is false by default.

To allow resellers created by the plan Sample Plan to manage shared SSL:

reseller_plan.exe -u "Sample Plan" -manage_shared_ssl true

-create_clients

true|false

Allows/Prohibits creating customer accounts.

Is false by default.

To allow resellers created by the plan Sample Plan to create customer accounts:

reseller_plan.exe -u "Sample Plan" -create_clients true

-allow_oversell

true|false

Allows/Prohibits managing overselling policy.

Is false by default.

To allow resellers created by the plan Sample Plan to manage overselling policy:

reseller_plan.exe -u "Sample Plan" -allow_oversell true

-oversell

true|false

Specifies overselling policy as follows:

true - overselling policy

false - strict policy

Is true by default.

To set overselling policy for resellers created by the plan Sample Plan to strict:

reseller_plan.exe -u "Sample Plan" -oversell false

-overuse

block|not_suspend|notify|normal|not_suspend_notify

Sets the resource overuse policy:

• normal - overuse is allowed.
• notify - overuse is allowed; when the resource usage limit is reached, an e-mail notice is sent according to the event notification settings.
• not_suspend - overuse is allowed only for disk space and traffic resources.
• block - overuse is not allowed, and the user account is suspended when the resource usage limit is reached.
• not_suspend_notify - overuse is allowed only for disk space and traffic resources; an e-mail notice is sent according to the event notification settings.

To set resource overuse policy for resellers created by the plan Sample Plan to notify:

reseller_plan.exe -u "Sample Plan" -overuse notify

-max-dom

<number>

Limits the number of available domains.

Includes domains hosted on this server, and domain forwarders that point to web sites hosted on other servers.

Unlimited if set to -1.

To restrict the maximum number of domains available to resellers created by the plan Sample Plan to 50:

reseller_plan.exe -u "Sample Plan" -max-dom 50

-max-dom-aliases

<number>

Limits the number of available domain aliases.

Unlimited if set to -1.

To restrict the maximum number of domain aliases available to resellers created by the plan Sample Plan to 3

reseller_plan.exe -u "Sample Plan" -max-dom-aliases 3

-disk-space

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

Limits the amount of available disk space.

Unlimited if set to -1.

To restrict the maximum amount of disk space available to resellers created by the plan Sample Plan to 100 MB:

reseller_plan.exe -u "Sample Plan" -disk-space 100

-disk-space-soft

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

Sets the amount of disk space upon reaching which notification is sent.

To set up sending of an e-mail notification upon occupying 5 gigabytes of disk space under the subscriptions created by the plan Plan 1:

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

-max-traffic

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

Limits the monthly traffic usage.

Unlimited if set to -1.

To restrict the maximum amount of traffic available to clients created by the plan Sample Plan to 10 GB/month:

reseller_plan.exe -u "Sample Plan" -max-traffic 10240

-max-traffic-soft

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

Sets the monthly amount of traffic upon reaching which notification is sent.

To set the amount of traffic upon reaching which notification is sent for users on the plan Plan 1 to 500 megabytes per month:

>service_plan.exe -u "Plan 1" -max-traffic-soft 500M

-max-box

<number>

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available to resellers created by the plan Sample Plan to 50:

reseller_plan.exe -u "Sample Plan" -max-box 50

-mbox-quota

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

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

Unlimited if set to -1.

To set the quota of a single mailbox to resellers created by the plan Sample Plan to 10 MB:

reseller_plan.exe -u "Sample Plan" -mbox-quota 10240

-total-mboxes-quota

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

Limits the amount of disk space that all mailboxes can occupy.

Unlimited if set to -1.

To set the total mailboxes quota for resellers created by the plan Sample Plan to 500 MB:

reseller_plan.exe -u "Sample Plan" -total-mboxes-quota 500

-max-wu

<number>

Limits the number of available web users.

Unlimited if set to -1.

To set the number of web users available to resellers created by the plan Sample Plan to unlimited:

reseller_plan.exe -u "Sample Plan" -max-wu -1

-max-fpse_users

<number>

Limits the number of available additional Microsoft FrontPage accounts.

Unlimited if set to -1.

To restrict the number of additional Microsoft FrontPage accounts available to resellers created by the plan Sample Plan to 50:

reseller_plan.exe -u "Sample Plan" -max-fpse_users 50

-max-subftp-users

<number>

Limits the number of available additional FTP accounts.

Unlimited if set to -1.

To restrict the number of additional FTP accounts available to resellers created by the plan Sample Plan to 100:

reseller_plan.exe -u "Sample Plan" -max-subftp-users 100

-max-db

<number>

Limits the number of available MySQL databases.

Unlimited if set to -1.

To restrict the number of MySQL databases available to resellers created by the plan Sample Plan to 15:

reseller_plan.exe -u "Sample Plan" -max-db 15

-max-mysql-db

<number>

Specifies the number of available MySQL databases.

Unlimited if set to -1.

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

reseller_plan.exe -u "Plan 1" -max-mysql-db 20

-max-mssql-db

<number>

Limits the number of available Microsoft SQL databases.

Unlimited if set to -1.

To restrict the number of Microsoft SQL databases available to resellers created by the plan Sample Plan to 10:

reseller_plan.exe -u "Sample Plan" -max-mssql-db 10

-mysql-dbase-space

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

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

Unlimited if set to -1.

To set the MySQL databases quota to resellers created by the plan Sample Plan to unlimited:

reseller_plan.exe -u "Sample Plan" -mysql-dbase-space -1

-mssql-dbase-space

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

Limits the amount of disk space that all Microsoft SQL databases can occupy.

Unlimited if set to -1.

To restrict the Microsoft SQL databases quota to resellers created by the plan Sample Plan to 100 MB:

reseller_plan.exe -u "Sample Plan" -mssql-dbase-space 100

-max-maillists

<number>

Limits the number of available mailing lists.

Unlimited if set to -1.

To restrict the maximum number of mailing lists available to resellers created by the plan Sample Plan to 100:

reseller_plan.exe -u "Sample Plan" -max-maillists 100

-max-webapps

<number>

Limits the number of available Tomcat applications.

Unlimited if set to -1.

To restrict the maximum number of Tomcat applications available to resellers created by the plan Sample Plan to 100:

reseller_plan.exe -u "Sample Plan" -max-webapps 100

-max-subdom

<number>

Limits the number of available subdomains.

Unlimited if set to -1.

To restrict the maximum number of subdomains available to resellers created by the plan Sample Plan to 20:

reseller_plan.exe -u "Sample Plan" -max-subdom 20

-max-iis-app-pools

<number>

Limits the number of available IIS application pools.

Unlimited if set to -1.

To restrict the maximum number of IIS application pools available to resellers created by the plan Sample Plan to 50:

reseller_plan.exe -u "Sample Plan" -max-iis-app-pools 50

-max-shared-ssl-links

<number>

Limits the number of available shared SSL links.

Unlimited if set to -1.

To set the number of shared SSL links available to resellers created by the plan Sample Plan to unlimited:

reseller_plan.exe -u "Sample Plan" -max-shared-ssl-links -1

-max-odbc

<number>

Limits the number of available ODBC connections.

Unlimited if set to -1.

To set the number of ODBC connections available to resellers created by the plan Sample Plan to unlimited:

reseller_plan.exe -u "Sample Plan" -max-odbc -1

-max-cl

<number>

Limits the number of available customer accounts.

To restrict the number of customer accounts available to resellers created by the plan Sample Plan to 5:

reseller_plan.exe -u "Sample Plan" -max-cl 5

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

reseller_plan.exe -u "Reseller Plan" -max-site-builder 10

-max-unity-mobile-sites

<number>

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

To set the number of mobile websites that can be created under reseller subscriptions created by the plan Reseller Plan to 10:

reseller_plan.exe -u "Reseller Plan" -max-unity-mobile-sites 10

-ip_pool

<add|del>:<ip 1>,<ip 2>,...,<ip N>

Adds/Deletes shared IP addresses to/from IP address pool.

To add IP addresses 192.0.2.12 and 192.0.2.32 to IP address pools of resellers created by the plan Sample Plan:

reseller_plan.exe -u "Sample Plan" -ip_pool add:192.0.2.12,192.0.2.32

-excl_ip_num

<number>

Limits the number of available exclusive IPv4 addresses that can be assigned to a reseller.

To restrict the number of exclusive IPv4 addresses available to resellers created by the plan Sample Plan:

reseller_plan.exe -u "Sample Plan" -excl_ip_num 12

-excl-ipv6-num

<number>

Limits the number of available exclusive IPv6 addresses that can be assigned to a reseller.

To restrict the number of exclusive IPv6 addresses available to resellers created by the plan Sample Plan:

reseller_plan.exe -u "Sample Plan" -excl_ipv6_num 12

-access_appcatalog

true|false

Allows or prohibits access to applications catalog for viewing and installing prepackaged applications on sites.

To allow the resellers subscribed to the plan Reseller Plan to access applications catalog and install applications on websites:

reseller_plan.exe -u "Reseller Plan" -access_appcatalog true

-manage_website_maintenance

true|false

Allows or prohibits access to website copying.

To allow the resellers subscribed to the plan Reseller Plan to access website copying.

reseller_plan.exe -u "Reseller Plan" -manage_website_maintenance true

-manage_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit.

To allow the resellers subscribed to the plan Reseller Plan access to the WordPress toolkit:

reseller_plan.exe -u "Reseller Plan" -manage_wordpress_toolkit true

-manage_security_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit security feature.

To allow the resellers subscribed to the plan Reseller Plan access to the WordPress toolkit security feature:

reseller_plan.exe -u "Reseller Plan" -manage_security_wordpress_toolkit true

-manage_protected_dirs

true|false

Allows or prohibits managing password-protected directories.

To allow the resellers subscribed to the plan Reseller Plan to manage password-protected directories:

reseller_plan.exe -u "Reseller Plan" -manage_protected_dirs true

-access_service_users

true|false

Allows or prohibits managing auxiliary user accounts.

To allow the resellers subscribed to the plan Reseller Plan to manage auxiliary user accounts:

reseller_plan.exe -u "Reseller Plan" -access_service_users 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 resellers the same permission: They can install apps from the bundle to their websites without purchasing app licenses as well as grant this permission to their customers. Note that you cannot limit the number of app installations a reseller and their customers are allowed to perform. Thus, they can install a commercial app an unlimited number of times.

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

reseller_plan.exe -u "Reseller Plan" -allow_license_stubs

-aps-filter-item-name

<name|URL>

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

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

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

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

-aps-filter-item-value

<value>

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

-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 resellers subscribed to the plan Reseller Plan to override security policy:

reseller_plan.exe -u "Reseller Plan" -allow_insecure_sites true

-select_db_server

true|false

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

Is false by default.

To allow the resellers created by the plan Sample Plan to choose a DB server when creating a database:

reseller_plan.exe --update "Sample Plan" -select_db_server true

-remote_db_connection

true|false

Allows or prohibits managing remote database access settings.

To allow the resellers created by the plan Sample Plan to manage remote database access settings.

reseller_plan.exe --update "Sample Plan" -remote_db_connection true