Reseller Templates: reseller

Reseller Templates: reseller_template.exe

The reseller_template.exe utility serves to set and update reseller template limits, permissions, and preferences.

The utility allows the following operations:

creating, renaming, and removing reseller templates
setting up reseller template limits and preferences

Location

%plesk_cli%

Usage

reseller_template.exe <command> [<template_name>] [

<option 1> <param 1>[<param 2>…<param n>]

[<option 2> <param 1>[<param 2>…<param n>]]

… [<option N> <param 1>[<param 2>…<param n>]]

Example

The following command changes name of the existing reseller template SampleTemplate 1 to SampleTemplate 2, allows hard disk quota management, and domain creation to resellers created with this template, sets the disk space limit to unlimited, enables allocation of up to 12 exclusive IP addresses to the reseller accounts, and sets the validity period for the reseller accounts to 1 year from the creation date.

>reseller_template.exe --update "Sample Template 1" -new-name "Sample Template 2" -manage_quota true -create_domains true -disk_space -1 -excl_ip_num 12 -expiration 1Y

Commands

Command	Parameter	Description	Example
`--create` or `-c`	`<template_name>`	Creates a reseller template.	To create the reseller template named Sample Template: >reseller_template.exe --create "Sample Template" or >reseller_template.exe -c "Sample Template"
`--update` or `-u`	`<template_name>`	Sets various properties of a reseller template.	To rename the reseller template from Sample Template 1 to Sample Template 2: >reseller_template.exe --update "Sample Template 1" -new-name "Sample Template 2" or >reseller_template.exe -u "Sample Template 1" -new-name "Sample Template 2"
`--remove` or `-r`	`<template_name>`	Removes a reseller template.	To remove the reseller template Sample Template: >reseller_template.exe --remove "Sample Template" or >reseller_template.exe -r "Sample Template"
`--info` or `-i`	`<template_name>`	Displays reseller template limits, permissions, preferences and IP addresses.	To view information on the reseller template Sample Template: >reseller_template.exe --info "Sample Template" or >reseller_template.exe -i "Sample Template"
`--xml-info` or `-x`	`<template_name>`	Displays information on a reseller template in the xml format.	To view information on the reseller template Sample Template in the xml format: >reseller_template.exe --xml-info "Sample Template" or >reseller_template.exe -x "Sample Template"
`--help` or `-h`		Displays help on the utility use	To view help on the use of the utility: >reseller_template.exe --help or >reseller_template.exe -h

Options

Option	Parameter	Description	Example
`-new-name`	`<string>`	Sets a new name for an existing reseller template.	To rename the reseller template from Sample Template 1 to Sample Template 2: >reseller_template.exe --update "Sample Template 1" -new-name "Sample Template 2"
`-cp_access`	`true\|false`	Allows/Prohibits accessing Parallels Plesk Panel GUI (as opposite to using Plesk API). Is `true` by default.	To prohibit resellers created with the template Sample Template from accessing to Plesk CP: >reseller_template.exe -u "Sample Template" -cp_access false
`-create_domains`	`true\|false`	Allows/Prohibits creating domains. Is `false` by default.	To allow resellers created with the template Sample Template to set up hosting accounts for new sites: >reseller_template.exe -u "Sample Template" -create_domains true
`-manage_phosting`	`true\|false`	Allows/Prohibits managing physical hosting. Is `false` by default.	To allow resellers created with the template Sample Template to manage physical hosting: >reseller_template.exe -u "Sample Template" -manage_phosting true
`-manage_sh_access`	`true\|false`	Allows/Prohibits managing access to the system through Remote Desktop. Is `false` by default.	To allow resellers created with the template Sample Template to manage system access: >reseller_template.exe -u "Sample Template" -manage_sh_access true
`-manage_quota`	`true\|false`	Allows/Prohibits changing limit on using disk space. Is `false` by default.	To allow resellers created with the template Sample Template to change hard disk quota: >reseller_template.exe -u "Sample Template" -manage_quota true
`-manage_subdomains`	`true\|false`	Allows/Prohibits managing subdomains. Is `false` by default.	To allow resellers created with the template Sample Template to manage subdomains: >reseller_template.exe -u "Sample Template" -manage_subdomains true
`-manage_domain_aliases`	`true\|false`	Allows/Prohibits managing domain aliases. Is `false` by default.	To allow resellers created with the template Sample Template to manage domain aliases: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to manage log rotation: >reseller_template.exe -u "Sample Template" -manage_log true
`-manage_anonftp`	`true\|false`	Allows/Prohibits managing Anonymous FTP. Is `false` by default.	To allow resellers created with the template Sample Template to manage Anonymous FTP: >reseller_template.exe -u "Sample Template" -manage_anonftp true
`-manage_subftp`	`true\|false`	Allows/Prohibits managing additional FTP accounts. Is `false` by default.	To allow resellers created with the template Sample Template to manage additional FTP accounts: >reseller_template.exe -u "Sample Template" -manage_subftp true
`-manage_crontab`	`true\|false`	Allows/Prohibits managing task scheduler. Is `false` by default.	To allow resellers created with the template Sample Template to manage task scheduler: >reseller_template.exe -u "Sample Template" -manage_crontab true
`-change_limits`	`true\|false`	Allows/Prohibits changing domain limits. Is `false` by default.	To allow resellers created with the template Sample Template to change domain limits: >reseller_template.exe -u "Sample Template" -change_limits true
`-manage_dns`	`true\|false`	Allows/Prohibits managing DNS. Is `false` by default.	To allow resellers created with the template Sample Template to manage DNS: >reseller_template.exe -u "Sample Template" -manage_dns true
`-manage_webapps`	`true\|false`	Allows/Prohibits managing Tomcat web applications. Is `false` by default.	To allow resellers created with the template Sample Template to manage Tomcat web applications: >reseller_template.exe -u "Sample Template" -manage_webapps true
`-manage_maillists`	`true\|false`	Allows/Prohibits managing mailing lists. Is `false` by default.	To allow resellers created with the template Sample Template to manage mailing lists: >reseller_template.exe -u "Sample Template" -manage_maillists true
`-manage_virusfilter`	`true\|false`	Allows/Prohibits managing server-side antivirus protection. Is `false` by default.	To allow resellers created with the template Sample Template to manage antivirus: >reseller_template.exe -u "Sample Template" -manage_virusfilter true
`-make_dumps`	`true\|false`	Allows/Prohibits backing up and restoring domains. Is `false` by default.	To allow resellers created with the template Sample Template to back up and restore domains: >reseller_template.exe -u "Sample Template" -make_dumps true
`-remote_access_interface`	`true\|false`	Allows/Prohibits using Parallels Plesk Panel API. Is `false` by default.	To allow resellers created with the template Sample Template to use Parallels Plesk Panel API: >reseller_template.exe -u "Sample Template" -remote_access_interface true
`-site_builder`	`true\|false`	Allows/Prohibits using Sitebuilder. Is `false` by default.	To allow resellers created with the template Sample Template to use Sitebuilder >reseller_template.exe -u "Sample Template" -site_builder true
`-manage_performance`	`true\|false`	Allows/Prohibits managing hosting performance. Is `false` by default.	To allow resellers created with the template Sample Template to manage hosting performance: >reseller_template.exe -u "Sample Template" -manage_performance true
`-manage_iis_app_pool`	`true\|false`	Allows/Prohibits managing IIS application pool. Is `false` by default.	To allow resellers created with the template Sample Template to manage IIS application pool: >reseller_template.exe -u "Sample Template" -manage_iis_app_pool true
`-manage_dashboard`	`true\|false`	Allows/Prohibits managing desktop view. Can be set to `true` only if the `-dashboard` option is set to `true`. Is `true` by default.	To prohibit clients created with the template Sample Template from managing desktop view: >reseller_template.exe -u "Sample Template" -manage_dashboard false
`-dashboard`	`true\|false`	Allows/Prohibits using desktop view. Can be set to `false` only if the `-stdgui` option is set to `true`. Is `true` by default.	To prohibit resellers created with the template Sample Template from using desktop view: >reseller_template.exe -u "Sample Template" -dashboard false
`-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 with the template Sample Template to manage web statistics: >reseller_template.exe -u "Sample Template" -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 Parallels Plesk Panel IIS User. May be required for web applications correct functioning, but is insecure. Is `false` by default.	To allow resellers created with the template Sample Template to manage additional write/modify permissions: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to manage shared SSL: >reseller_template.exe -u "Sample Template" -manage_shared_ssl true
`-stdgui`	`true\|false`	Allows/Prohibits using Parallels Plesk Panel standard view. Can be set to `false` only if the `-dashboard` option is set to `true`. Is `true` by default.	To prohibit resellers created with the template Sample Template from using Parallels Plesk Panel standard view: >reseller_template.exe -u "Sample Template" -stdgui false
`-create_clients`	`true\|false`	Allows/Prohibits creating client accounts. Is `false` by default.	To allow resellers created with the template Sample Template to create client accounts: >reseller_template.exe -u "Sample Template" -create_clients true
`-allow-oversell`	`true\|false`	Allows/Prohibits managing limits policy. Is `false` by default.	To allow resellers created with the template Sample Template to manage limits policy: >reseller_template.exe -u "Sample Template" -allow-oversell true
`-oversell`	`true\|false`	Specifies limits policy as follows: `true` - oversell policy `false` - strict policy Is `true` by default.	To set limits policy for resellers created with the template Sample Template to strict: >reseller_template.exe -u "Sample Template" -oversell false
`-overuse`	`block\|notify\|normal`	Sets the limits overusage policy. Is `normal` by default.	To set limits overusage policy for resellers created with the template Sample Template to notify: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 50: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 3 >reseller_template.exe -u "Sample Template" -max_dom_aliases 3
`-disk_space`	`<MB>`	Limits the amount of available disk space. Unlimited if set to `-1`.	To restrict the maximum amount of disk space available to resellers created with the template Sample Template to 100 MB: >reseller_template.exe -u "Sample Template" -disk_space 100
`-max_traffic`	`<MB/month>`	Limits the monthly traffic usage. Unlimited if set to `-1`.	To restrict the maximum amount of traffic available to clients created with the template Sample Template to 10 GB/month: >reseller_template.exe -u "Sample Template" -max_traffic 10240
`-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 with the template Sample Template to 50: >reseller_template.exe -u "Sample Template" -max_box 50
`-mbox_quota`	`<KB>`	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 with the template Sample Template to 10 MB: >reseller_template.exe -u "Sample Template" -mbox_quota 10240
`-total_mboxes_quota`	`<MB>`	Limits the amount of disk space that all mailboxes can occupy. Unlimited if set to `-1`.	To set the total mailboxes quota to resellers created with the template Sample Template to 500 MB: >reseller_template.exe -u "Sample Template" -total_mboxes_quota 500
`-max_redir`	`<number>`	Limits the number of available mail redirects. Unlimited if set to `-1`.	To restrict the number of mail redirects available to resellers created with the template Sample Template to 3: >reseller_template.exe -u "Sample Template" -max_redir 3
`-max_mg`	`<number>`	Limits the number of available mail groups. Unlimited if set to `-1`.	To restrict the number of mail groups available to resellers created with the template Sample Template to 10: >reseller_template.exe -u "Sample Template" -max_mg 10
`-max_resp`	`<number>`	Limits the number of available mail autoresponders. Unlimited if set to `-1`.	To restrict the number of mail autoresponders available to resellers created with the template Sample Template to 5: >reseller_template.exe -u "Sample Template" -max_resp 5
`-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 with the template Sample Template to unlimited: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 50: >reseller_template.exe -u "Sample Template" -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 clients created with the template Sample Template to 100: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 15: >reseller_template.exe -u "Sample Template" -max_db 15
`-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 with the template Sample Template to 10: >reseller_template.exe -u "Sample Template" -max_mssql_db 10
`-mysql_dbase_space`	`<MB>`	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 with the template Sample Template to unlimited: >reseller_template.exe -u "Sample Template" -mysql_dbase_space -1
`-mssql_dbase_space`	`<MB>`	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 with the template Sample Template to 100 MB: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 100: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 100: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 20: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to 50: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to unlimited: >reseller_template.exe -u "Sample Template" -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 with the template Sample Template to unlimited: >reseller_template.exe -u "Sample Template" -max_odbc -1
`-expiration`	`<number><Y\|M\|D>`	Limits the validity period of reseller accounts created with the template. Unlimited if set to `-1`.	To restrict the validity period to reseller accounts created with the template Sample Template to 20 days: >reseller_template.exe -u "Sample Template" -expiration 20D To restrict the validity period to resellers created with the template Sample Template to 1 year: >reseller_template.exe -u "Sample Template" -expiration 1Y
`-max_cl`	`<number>`	Limits the number of available client accounts.	To restrict the number of client accounts available to resellers created with the template Sample Template to 5: >reseller_template.exe -u "Sample Template" -max_cl 5
`-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 with the template Sample Template: >reseller_template.exe -u "Sample Template" -ip_pool add:192.0.2.12,192.0.2.32
`-excl_ip_num`	`<number>`	Limits the number of available exclusive IP addresses.	To restrict the number of exclusive IP addresses available to resellers created with the template Sample Template: >reseller_template.exe -u "Sample Template" -excl_ip_num 12
`-max_cf_dsn`	`<number>`	Limits the number of available Coldfusion DSN connections. Unlimited if set to `-1`.	To set the number of Coldfusion DSN connections available to resellers created with the template Sample Template to unlimited: >reseller_template.exe -u "Sample Template" -max_cf_dsn -1
`-select_db_server`	`true\|false`	Allows/Prohibits choosing DB server from the servers registered in Parallels Plesk Panel, when creating a database. Is `false` by default.	To allow the resellers created with the template Sample Template to choose a DB server when creating a database: >reseller_template.exe --update "Sample Template" -select_db_server true

Note: If the -dashboard and -stdgui options are not specified when a client template is created, the corresponding parameters will be set to true, that is, both the Parallels Plesk Panel standard view and Desktop view options will be enabled by default.