Adding a Service Plan

Parallels Pro Control Panel is shipped with a single default Service Plan that contains all the services and options you need to create and make Parallels Pro Control Panel domains usable by your customers. However, you can add any number of additional Service Plans to suit the needs of your customers and their businesses.

Many Internet service providers find it most efficient to use a template-type Service Plan that provides the basic services and options that all their customers will use; then create additional Service Plans that add other optional services to meet specific customer needs. This way, they do not have to specify all services and options whenever they create a new Service Plan. By using a template Service Plan, they can automatically assign most services and options; then add specific additional services and options for new Service Plans.

To add a new Service Plan, use the AddPlan script.

Syntax

/usr/local/bin/AddPlan

    [-p <source plan> | -s <source site> | -d <source domain> | 
	-i <source IP> | -t <source path>]
	[-c <service>,<option>=<value>,[on|off],... ...] 
	[-f | --force] <target plan>

where:

<source plan> is the name of the Service Plan you want to use as the foundation or template for the new Service Plan. This option can be omitted, in which case the default Service Plan is used.
<source site>, <source domain>, and <source IP> are three ways to specify a site whose configuration you want to use as the foundation or template for the new Service Plan.

Note: If the -t option is used, the path will be /home/virtual/<sourcepath>/info/current.

<service> is the name of the service for which you want to specify options in this Service Plan.
<option> is optional features, if any, that you want to specify for the service.
<value> is what the option specifies, such as a name, password, or measurement. <value> may be a single string (for example, 1 or My User) or a list (for example, \[1, 2, 3\])
Each service has an enabled option, which may be used to enable or disable the service by setting this option to 1 or 0, respectively. Alternatively, the strings on and off may be used as abbreviations for the strings: enabled=1 and disabled=0.
<target plan> is the name of the new Service Plan.

The following table lists the services you can specify when you create a new Service Plan, as well as the services' options and their values.

Service	Option	Value	Description

siteinfo	enabled	1 (enabled) or 0 (disabled)	Whether site information is enabled or disabled for the site.
spam_filter	None	on (enabled) or off (disabled)	Whether spam filter is enabled or disabled for the site.
mailscanner		on (enabled) or off (disabled)	Whether virus scanning is enabled or disabled for the site.
	scan_incoming	1 (enabled) or 0(disabled)	Whether virus scanning is enabled or disabled for incoming email messages.
	scan_outgoing	1 (enabled) or 0(disabled)	Whether virus scanning is enabled or disabled for outgoing email messages.
	domain	plain text (for example: myco.com)	The default domain name for a site created with this Service Plan.
	admin_user	plain text	The user name for the Site Administrator.
	password	plain text	The Site Administrator's password. The administrator will be prompted for the plain text password.
	tpasswd	plain text	The Site Administrator's password. Specify the password by typing `tpasswd=`<plain text password> at the command line.
	cpasswd	encrypted text	The Site Administrator's password. Specify the password by typing `cpasswd=`<password in encrypted text> at the command line.
	email	plain text (for example: admin@myco.com)	The Site Administrator's email address.
aliases	enabled	1 (enabled) or 0 (disabled)	Whether the aliases option is enabled or disabled for the site.
	aliases	list of text items	The domain's aliases. Each alias can be used as the domain portion of an email address, a URL, or the target host of an FTP, Telnet, SSH, IMAP, or POP connection. This must be specified as a list, as described for ipaddrs.
analog	enabled	1 (enabled) or 0 (disabled)	Whether Analog log analyzer is enabled or disabled for the site.
logrotate	enabled	1 (enabled) or 0 (disabled)	Whether logrorate is enabled or disabled for the site.
ipinfo	namebased	1 (name-based). or 0 (IP-based)	Whether the site is name-based or IP-based.
	ipaddrs	One or more IP addresses, separated by commas.	The list of IP addresses that will be configured if this site is IP-based. The format requires brackets: `[`<address1>`,`<address2>`]` Note: Some shells treat brackets as special characters. You may need to include escape characters for the brackets: `\[`<address1>`,`<address2>`\]`
diskquota	enabled	1 (enabled) or 0 (disabled)	Whether disk quota is enabled or disabled for the site.
	units	B or b for bytes KB or kb for kilobytes MB or mb for megabytes GB or gb for gigabytes	The unit of measurement for disk quota.
	quota	<quota> <unit> (for example: 500 MB)	The number specifying the size of the quota, in the units specified.
telnet	enabled	1 (enabled) or 0 (disabled)	Whether Telnet is enabled or disabled for the site.
	jail	1 or 0	If set to 1, the Site Administrator's shell access to the site through Telnet will be jailed within the site's file system. If set to 0, the Site Administrator may browse the entire server's file system, except where restricted by directory ownership or permissions.
bandwidth	enabled	1 (enabled) or 0 (disabled)	Whether bandwidth montoring is enabled or disabled for the site. Important: Disabling bandwidth while adding a domain using the `AddVirtDomain` script produces erratic mail behavior. Do not disable bandwidth when you add a domain using the `AddVirtDomain` script.
	threshold	number	The number of bytes, after which the Site Administrator should be notified that the site has exceeded its bandwidth allocation.
	rollover	number (any number between 1 and 31)	The date that will be used to calculate monthly totals. Note: If set to 0, the last date of each month is used.
	units	B or b (Bytes) KB or kb (Kilobytes) MB or mb (Megabytes) GB or gb (Gigabytes)	The unit of measurement used to indicate bandwidth threshold.
ssh	enabled	1 (enabled) or 0 (disabled)	Whether SSH access is enabled or disabled for the site.
	jail	1 or 0	If set to 1, the Site Administrator's shell access to the site through SSH will be jailed within the site's file system. If set to 0, the Site Administrator can browse the entire server's file system, except where restricted by directory ownership or permissions.
imap	enabled	1 (enabled) or 0 (disabled)	Whether the IMAP mail protocol is enabled or disabled for the site.
bind	enabled	1 (enabled) or 0 (disabled)	Whether the BIND name server protocol is enabled or disabled for the site.
users	maxusers	number	The maximum number of users allowed on this site.
proftpd	ftpserver	plain text	The FTP server's domain name. Note: If you are using domain aliasing, and the name of this server contains a prefix (such as FTP), followed by the domain name as specified in siteinfo, the aliasing function will attach this prefix to all other aliases to generate FTP server names.
apache	enabled	1 (enabled) or 0 (disabled)	Whether the Apache Web server protocol is enabled or disabled for the site.
	jail	1 (enabled) or 0 (disabled)	If set to 1, a high security site is created. If set to 0, a 3.1 compatible site or low security site is created.
	webserver	plain text	The Apache Web server's domain name. Note: If you are using domain aliasing, and the name of this server contains a prefix (such as apache), followed by the domain name as specified in siteinfo, the aliasing function will attach this prefix to all other aliases to generate Web server names.
	jail	1 or 0	If set to 1, certain Apache features and Apache-related services will be restricted access to other sites' data. In particular, mod_perl and mod_php will be disabled for the domain (interpretation and execution of PHP and Perl scripts will be re-routed through jailed CGI versions of PHP and Perl), and the use of "Options FollowSymlinks" will be denied. If set to 0, these restrictions will be removed.
	mailserver	plain text	The mail server's domain name. Note: If you are using domain aliasing, and the name of this server contains a prefix (such as mail), followed by the domain name as specified in siteinfo, the aliasing function will attach this prefix to all other aliases to generate mail server names.
	preference	number	The preference to give to MX records for the mail server names.
anonftp	enabled	1 (enabled) or 0 (disabled)	Whether Anonymous FTP access is enabled or disabled for the site.
openssl	enabled	1 (enabled) or 0 (disabled)	Whether OpenSSL access is enabled or disabled for the site.
cgi	enabled	1 (enabled) or 0 (disabled)	Whether CGI scripting is enabled or disabled for the site.
	scriptalias	plain text	The leading component (after the host name) of URLs referencing CGI scripts for this site.
mod_perl	enabled	1 (enabled) or 0 (disabled)	Whether mod_perl for Apache is enabled or disabled for the site.
	alias	plain text	The leading component (after the host name) of URLs referencing Perl scripts for this site.
reseller	enabled	1 (enabled) or 0 (disabled)	Whether reseller access is enabled or disabled for the site.
	reseller_id	plain text	The name of the reseller.
tomcat4	enabled	1 (enabled) or 0 (disabled)	Whether Tomcat is enabled or disabled for the site.
develenv	enabled	1 (enabled) or 0 (disabled)	Whether GNU development tools is enabled or disabled for the site.
ssi	enabled	1 (enabled) or 0 (disabled)	Whether Server Side Includes (SSI) is enabled or disabled for the site.
sendmail	enabled	1 (enabled) or 0 (disabled)	Whether the Sendmail mail server protocol is enabled or disabled for the site.
subdomain	enabled	1 (enabled) or 0 (disabled)	Whether subdomains are enabled or disabled for the site.
	max	number	The maximum number of subdomains that can be created for a site. Note: -1 indicates unlimited subdomains for a site.
	wildcards	1 (enabled) or 0 (disabled)	Whether subdomain wildcards are enabled or disabled for the site. Note: Enabling subdomain wildcards for a site (for example, example1.com), will cause the range of (sub)domain names, "*.example1.com" to be reserved for the site. No other site on the Parallels Pro server will be allowed to have the same site name.
	base	plain text	This indicates the base directory, relative to the site's file system, under which all subdomains for the site will be located. Note: This restriction only applies to regular subdomains. User subdomains will have their directory in `/home/`<owner>`/public_html/`
weblogs	enabled	1 (enabled) or 0 (disabled)	Whether Web logs is enabled or disabled for the site.
vacation	enabled	1 (enabled) or 0 (disabled)	Whether vacation message is enabled or disabled for the site.
majordomo	enabled	1 (enabled) or 0 (disabled)	Whether Majordomo mailing list is enabled or disabled for the site.
sqmail	enabled	1 (enabled) or 0 (disabled)	Whether SquirrelMail Web-based email is enabled or disabled for the site.
frontpage	enabled	1 (enabled) or 0 (disabled)	Whether Microsoft FrontPage is enabled or disabled for the site.
mivamerchant	enabled	1 (enabled) or 0 (disabled)	Whether Miva Merchant is enabled or disabled for the site.
webalizer	enabled	1 (enabled) or 0 (disabled)	Whether Webalizer log analyzer is enabled or disabled for the site.
mysql	enabled	1 (enabled) or 0 (disabled)	Whether the MySQL database server protocol is enabled or disabled for the site.
	dbaseadmin	plain text	The user name of the site's database administrator.
	dbaseprefix	plain text	The specified string that is prefixed to the name of any database that the Site Administrator creates. Note: Since this prefix defaults to the first 30 characters of the domain name, we recommend that you not change this unless it conflicts with an already existing prefix.
	dbasenum	number	The number of databases that can be created by the Site Administrator.
vhbackup	enabled	1 (enabled) or 0 (disabled)	Whether site and user level backup is available for a site.
files	enabled	1 (enabled) or 0 (disabled)	Whether File Manager access is enabled or disabled for the site.
Power Tools
scriptsmgr	enabled	on (enabled) or off (disabled)	Whether Power Tools is enabled or disabled for the site.
<tool_name> such as formmail-4.2b	enabled	1 (enabled) or 0 (disabled)	Whether the tools are enabled or disabled for the site. You must specify the appropriate value for each tool.

The following section lists some examples of the service plan syntax.

Example 1

This example adds a new Service Plan called Gold. Gold uses the default Service Plan as its template, but excludes the CGI service.

AddPlan -p default -c cgi,off Gold

Example 2

This example adds a new Service Plan called Gold. Gold uses the default Service Plan as its template, but includes the aliases service.

AddPlan -p default -c aliases,on,aliases=\[.org,.net\] Gold