reseller_plan: Reseller Plans

The reseller_plan utility is used for creating and managing reseller plans.

Usage
reseller_plan <command> [<plan_name>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]

Example

The following command sets the allowed number of websites for the plan Reseller Plan to 10.

plesk bin reseller_plan --update "Reseller Plan" -max-dom 10

Commands
Command Parameter Description Example

--create or -c

<plan_name>

Creates a reseller plan.

To create a plan named Reseller Plan:

plesk bin reseller_plan --create "Reseller Plan"

or

plesk bin reseller_plan -c "Reseller Plan"

--update or -u

<plan_name>

Updates reseller plan settings.

To allow resellers created by the plan Reseller Plan to create domains:

plesk bin reseller_plan --update "Reseller Plan" -create_domains true

or

plesk bin reseller_plan -u "Reseller Plan" -create_domains true

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

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

or

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

--remove or -r

<plan_name>

Removes a reseller plan.

To remove the plan Reseller Plan:

plesk bin reseller_plan --remove "Reseller Plan"

or

plesk bin reseller_plan -r "Reseller Plan"

--xml-info or -x

<plan_name>

Displays information on a reseller plan in the XML format.

To view information on the plan Reseller Plan in the XML format:

plesk bin reseller_plan --xml-info "Reseller Plan"

or

plesk bin reseller_plan -x "Reseller Plan"

--create-default or -def

 

Creates a default reseller plan named Default Reseller.

To create a default reseller plan:

plesk bin reseller_plan --create-default

or

plesk bin reseller_plan -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 restrict 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 reseller_plan --enable-aps-filter "Plan 1"

 

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

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

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

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

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

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the utility:

plesk bin reseller_plan --help

or

plesk bin reseller_plan -h

Options
Option Parameter Description Example

-new-name

<string>

Sets a new name for an existing reseller plan.

To rename the plan from Reseller Plan 1 to Reseller Plan 2:

plesk bin reseller_plan -u "Reseller Plan 1" -new-name "Reseller 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:

plesk bin reseller_plan --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 Reseller Plan to create domains:

plesk bin reseller_plan -u "Reseller Plan" -create_domains true

-manage_mail_settings

true|false

Allows or prohibits managing the mail settings.

To allow resellers based on the "Reseller Plan" plan to manage the mail settings:

plesk bin reseller_plan -u "Reseller 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 Reseller Plan to manage physical hosting:

plesk bin reseller_plan -u "Reseller Plan" -manage_phosting true

-manage_php_settings

true|false

Allows or prohibits managing common PHP settings.

To allow resellers based on the "Reseller Plan" plan manage the common PHP settings:

plesk bin reseller_plan -u "Reseller Plan" -manage_php_settings true

-manage_php_version

true|false

Allows or prohibits choosing PHP version and handler.

To allow resellers based on the "Reseller Plan" plan choose the PHP version and handler:

plesk bin reseller_plan -u "Reseller Plan" -manage_php_version true

-manage_php_safe_mode

true|false

Allows/Prohibits managing PHP safe mode.

Is false by default.

To allow resellers created by the plan Reseller Plan to manage php safe mode:

plesk bin reseller_plan -u "Reseller Plan" -manage_php-safe-mode true

-manage_quota

true|false

Allows/Prohibits managing hard disk quota.

Is false by default.

To allow resellers created by the plan Reseller Plan to manage hard disk quota:

plesk bin reseller_plan -u "Reseller Plan" -manage_quota true

-manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_dns true

-manage_log

true|false

Allows/Prohibits managing log rotation.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_log true

-remote_access_interface

true|false

Allows/Prohibits using remote API.

To allow resellers based on the "Reseller Plan" plan to use remote API:

plesk bin reseller_plan -u "Reseller Plan" -remote_access_interface true

-manage_crontab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_crontab true

-manage_anonftp

true|false

Allows/Prohibits managing anonymous FTP.

Is false by default.

To allow resellers created by the plan Reseller Plan to manage anonymous FTP:

plesk bin reseller_plan -u "Reseller 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 Reseller Plan to manage additional FTP accounts:

plesk bin reseller_plan -u "Reseller Plan" -manage_subftp true

-manage_webapps

true|false

Allows/Prohibits managing Java applications.

Is false by default.

To allow resellers created by the plan Reseller Plan to manage Java applications:

plesk bin reseller_plan -u "Reseller Plan" -manage_webapps true

-manage_maillists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_maillists true

-manage_sh_access

true|false

Allows/Prohibits managing system access.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_sh_access true

-manage_not-chroot-shell

true|false

Allows/Prohibits managing non-chrooted environment.

Is false by default.

To allow resellers created by the plan Reseller Plan to manage non-chrooted environment:

plesk bin reseller_plan -u "Reseller Plan" -manage_not-chroot-shell true

-manage_subdomains

true|false

Allow/Prohibits managing subdomains.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_subdomains true

-manage_domain_aliases

true|false

Allows or prohibits managing domain aliases.

To allow resellers based on the "Reseller Plan" plan to manage domain aliases:

plesk bin reseller_plan -u "Reseller Plan" -manage_domain_aliases true

-allow_local_backups

true|false

Allows/Prohibits backing up and restoring data using the Plesk's storage.

Is false by default.

To allow resellers created by the plan Reseller Plan to back up and restore data using the Plesk's storage:

plesk bin reseller_plan -u "Reseller Plan" -allow_local-backups true

-allow_ftp_backups

true|false

Allows/Prohibits backing up and restoring data using the FTP storage.

Is false by default.

To allow resellers created by the plan Reseller Plan to back up and restore data using the FTP storage:

plesk bin reseller_plan -u "Reseller Plan" -allow_ftp-backups true

-allow_account_local_backups

true|false

Allows/Prohibits backing up and restoring account data using the Plesk's storage.

Is false by default.

To allow resellers based on the "Reseller Plan" plan to to back up and restore account data using the Plesk's storage:

plesk bin reseller_plan -u "Reseller Plan" -allow_account_local_backups true

-allow_account_ftp_backups

true|false

Allows/Prohibits backing up and restoring account data using the FTP storage.

Is false by default.

To allow resellers based on the "Reseller Plan" plan to to back up and restore account data using the FTP storage:

plesk bin reseller_plan -u "Reseller Plan" -allow_account_ftp_backups true

-manage_virusfilter

true|false

Allows/Prohibits managing antivirus settings.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_virusfilter true

-remote-access-interface

true|false

Allows/Prohibits using Plesk Panel API.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -remote-access-interface true

-manage_domain-aliases

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_domain-aliases true

-manage_webstat

true|false

Allows/Prohibits managing web statistics.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_webstat true

-manage_performance

true|false

Allows/Prohibits managing performance.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -manage_performance true

-create_clients

true|false

Allows/Prohibits creating customer accounts.

Is false by default.

To allow resellers created by the plan Reseller Plan to create client accounts:

plesk bin reseller_plan -u "Reseller Plan" -create_clients true

-allow_oversell

true|false

Allows/Prohibits managing resource overselling policy.

Is false by default.

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

plesk bin reseller_plan -u "Reseller Plan" -allow_oversell true

-oversell

true|false

Specifies the resource overselling policy as follows:

true - overselling policy

false - strict policy

Is true by default.

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

plesk bin reseller_plan -u "Reseller Plan" -oversell false

-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 resellers created by the plan Reseller Plan to notify:

plesk bin reseller_plan -u "Reseller Plan" -overuse notify

-manage_spamfilter

true|false

Allows/Prohibits managing spam filter.

Is false by default.

To allow resellers created by the plan Reseller Plan to manage spam filter:

plesk bin reseller_plan -u "Reseller Plan" -manage_spamfilter true

-max-dom

<number>

Limits the number of available domains.

Unlimited if set to -1.

To restrict the maximum number of domains available to resellers created by the plan Reseller Plan to 10:

plesk bin reseller_plan -u "Reseller Plan" -max-dom 10

-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 Reseller Plan to 5:

plesk bin reseller_plan -u "Reseller Plan" -max-dom-aliases 5

-disk-space

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

Limits the amount of available disk space.

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

Unlimited if set to -1.

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

plesk bin reseller_plan -u "Reseller Plan" -disk-space 100G

-disk-space-soft

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

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

To set the amount of disk space upon reaching which notification is sent for resellers created by the plan Reseller Plan to 70 GB:

plesk bin reseller_plan -u "Reseller Plan" -disk-space-soft 70G

-max-traffic

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

Limits the monthly traffic usage.

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

Unlimited if set to -1.

To restrict the maximum amount of traffic available to resellers created by the plan Reseller Plan to 100 GB/month:

plesk bin reseller_plan -u "Reseller Plan" -max-traffic 100G

-max-traffic-soft

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

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

To set the amount of traffic upon reaching which notification is sent for resellers created by the plan Reseller Plan to 70 GB/month:

plesk bin reseller_plan -u "Reseller Plan" -max-traffic-soft 70G

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

plesk bin reseller_plan -u "Reseller Plan" -max-box 100

-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 available to resellers created by the plan Reseller Plan to 10 GB:

plesk bin reseller_plan -u "Reseller Plan" -mbox-quota 10G

-max-wu

<number>

Limits the number of available mail users.

Unlimited if set to -1.

To restrict the maximum number of mail users available to resellers created by the plan Reseller Plan to 50:

plesk bin reseller_plan -u "Reseller Plan" -max-wu 50

-max-subftp-users

<number>

Limits the number of FTP accounts.

Unlimited if set to -1.

To limit the number of FTP accounts for reseller accounts based on the "Reseller Plan" plan to 10:

plesk bin reseller_plan -u "Reseller Plan" -max-subftp-users 10

-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 Reseller Plan to 30:

plesk bin reseller_plan -u "Reseller Plan" -max-maillists 30

-max-db

<number>

Limits the number of available databases.

Unlimited if set to -1.

To restrict the maximum number of databases available to resellers created by the plan Reseller Plan to 2:

plesk bin reseller_plan -u "Reseller Plan" -max-db 2

-max-webapps

<number>

Limits the number of available Java applications.

Unlimited if set to -1.

To restrict the maximum number of Java applications available to resellers created by the plan Reseller Plan to 50:

plesk bin reseller_plan -u "Reseller Plan" -max-webapps 50

-max-subdom

<number>

Limits the number of available subdomains.

Unlimited if set to -1.

To set the number of subdomains available to resellers created by the plan Reseller Plan to unlimited:

plesk bin reseller_plan -u "Reseller Plan" -max-subdom -1

-max-cl

<number>

Limits the number of available customer accounts.

To set the number of customer accounts available to resellers created by the plan Reseller Plan to 5:

plesk bin reseller_plan -u "Reseller 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:

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

plesk bin reseller_plan -u "Reseller Plan" -max-unity-mobile-sites 10

-ip_pool

add|del:<ip1>,<ip2>,..,<ipN>

Adds/Deletes shared IP addresses to/from reseller's IP pool.

To add shared IP addresses 192.0.2.78 and 192.0.2.89 to the IP pools of resellers created by the plan Reseller Plan:

plesk bin reseller_plan -u "Reseller Plan" -ip_pool add:192.0.2.78,192.0.2.89

-excl_ip_num

<number>

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

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

plesk bin reseller_plan -u "Reseller Plan" -excl_ip_num 4

-excl_ipv6_num

<number>

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

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

plesk bin reseller_plan -u "Reseller Plan" -excl_ipv6_num 4

-select_db_server

true|false

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

To allow resellers created by the plan Reseller Plan to choose a DB server on which a database is to be created:

plesk bin reseller_plan -u "Reseller Plan" -select_db_server true

-remote_db_connection

true|false

Allows or prohibits managing remote database access settings.

To allow resellers based on the "Reseller Plan" plan to manage the remote database access settings:

plesk bin reseller_plan -u "Reseller Plan" -remote_db_connection true

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

plesk bin reseller_plan -u "Reseller Plan" -access_appcatalog true

-manage_website_maintenance

true|false

Allows or prohibits access to website copying.

To allow resellers based on the "Reseller Plan" plan access to website copying:

plesk bin reseller_plan -u "Reseller Plan" --manage_website_maintenance true

-manage_wordpress_toolkit

true|false

Allows or prohibits access to the WordPress toolkit.

To allow resellers based on the "Reseller Plan" plan access the WordPress Toolkit:

plesk bin reseller_plan -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 resellers based on the "Reseller Plan" plan access the WordPress Toolkit security feature:

plesk bin reseller_plan -u "Reseller Plan" -manage_security_wordpress_toolkit true

-manage_protected_dirs

true|false

Allows or prohibits managing password-protected directories.

To allow resellers based on the "Reseller Plan" plan to manage password-protected directories:

plesk bin reseller_plan -u "Reseller Plan" -manage_protected_dirs true

-access_service_users

true|false

Allows or prohibits managing auxiliary user accounts.

To allow resellers based on the "Reseller Plan" plan manage the auxiliary user accounts:

plesk bin reseller_plan -u "Reseller Plan" -access_service_users 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 resellers subscribed to the plan Reseller Plan to override security policy:

plesk bin reseller_plan -u "Reseller Plan" -allow_insecure_sites true

-manage_not_chroot_shell

true|false

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

To allow resellers based on the "Reseller Plan" plan manage access to any shell:

plesk bin reseller_plan -u "Reseller Plan" -manage_not_chroot_shell 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:

plesk bin reseller_plan -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 the 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:

plesk bin reseller_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 URL of the filtered APS app.

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.