Previous page

Next page

Locate page

--create or -c

<plan_name>

Creates a reseller plan.

To create a plan named Reseller Plan:

# ./reseller_plan --create "Reseller Plan"

or

# ./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:

# ./reseller_plan --update "Reseller Plan" -create-domains true

or

# ./reseller_plan -u "Reseller Plan" -create-domains true

--remove or -r

<plan_name>

Removes a reseller plan.

To remove the plan Reseller Plan:

# ./reseller_plan --remove "Reseller Plan"

or

# ./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:

# ./reseller_plan --xml-info "Reseller Plan"

or

# ./reseller_plan -x "Reseller Plan"

--create-default or -def

Creates a default reseller plan named Default Reseller.

To create a default reseller plan:

# ./reseller_plan --create-default

or

# ./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.

You can learn more about restricting access to applications in Administrator's Guide at http://download1.parallels.com/Plesk/PP10/10.1.0/Doc/en-US/online/plesk-administrator-guide/66341.htm.

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:

# ./reseller_plan --enable-aps-filter "Plan 1"

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./reseller_plan --help

or

# ./reseller_plan -h

-new-name

<string>

Sets a new name for an existing reseller plan.

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

# ./reseller_plan -u "Reseller Plan 1" -new-name "Reseller Plan 2"

-cp-access

true|false

Allows/Prohibits accessing Parallels Plesk Panel GUI (as opposite to using Parallels Plesk Panel API).

Is true by default.

To prohibit the resellers created by the plan Reseller Plan from accessing Parallels Plesk Panel GUI:

# ./reseller_plan -u "Reseller Plan" -cp-access false

-create-domains

true|false

Allows/Prohibits creating domains.

Is false by default.

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

# ./reseller_plan -u "Reseller Plan" -create-domains 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:

# ./reseller_plan -u "Reseller Plan" -manage-phosting 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:

# ./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:

# ./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:

# ./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:

# ./reseller_plan -u "Reseller Plan" -manage-log 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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./reseller_plan -u "Reseller Plan" -manage-subdomains true

-allow-local-backups

true|false

Allows/Prohibits backing up and restoring data using the Parallels Plesk Panel repository.

Is false by default.

To allow resellers created by the plan Reseller Plan to back up and restore data using the Parallels Plesk Panel repository:

# ./reseller_plan -u "Reseller Plan" -allow-local-backups true

-allow-ftp-backups

true|false

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

Is false by default.

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

# ./reseller_plan -u "Reseller Plan" -allow-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:

# ./reseller_plan -u "Reseller Plan" -manage-virusfilter true

-remote-access-interface

true|false

Allows/Prohibits using Parallels Plesk Panel API.

Is false by default.

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

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./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:

# ./reseller_plan -u "Reseller Plan" -max-dom-aliases 5

-disk-space

<number>[K|M|G]

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:

# ./reseller_plan -u "Reseller Plan" -disk-space 100G

-disk-space-soft

<number>[K|M|G]

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

Available since Parallels Plesk Panel 9.0.

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

# ./reseller_plan -u "Reseller Plan" -disk-space-soft 70G

-max-traffic

<number>[K|M|G]

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:

# ./reseller_plan -u "Reseller Plan" -max-traffic 100G

-max-traffic-soft

<number>[K|M|G]

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

Available since Parallels Plesk Panel 9.0.

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

# ./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:

# ./reseller_plan -u "Reseller Plan" -max-box 100

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

# ./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:

# ./reseller_plan -u "Reseller Plan" -max-wu 50

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

# ./reseller_plan -u "Reseller Plan" -max-maillists 30

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

# ./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:

# ./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:

# ./reseller_plan -u "Reseller Plan" -max-cl 5

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

# ./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:

# ./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:

# ./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:

# ./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:

# ./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 the Panel, 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:

# ./reseller_plan -u "Reseller Plan" -select-db-server 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:

# ./reseller_plan -u "Reseller Plan" -access_appcatalog true

-allow_insecure_sites

true|false

Allows or prohibits overriding server-wide security policy on web hosting scripting options, if the policy is set up.

To allow the resellers subscribed to the plan Reseller Plan to override security policy:

# ./reseller_plan -u "Reseller Plan" -allow_insecure_sites true

-aps-filter-item-name

<name|URL>

Specifies identifier of APS applications filter item: whether the filtered app is identified in the Panel 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 --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.