Parallels Plesk Panel Reference Guide

Parallels® Plesk Control Panel

2 Preface

ISBN: N/A Parallels 660 SW 39th Street Suite 205 Renton, Washington 98057 USA Phone: +1 (425) 282 6400 Fax: +1 (425) 282 6444

Distribution of this work or derivative of this work in any form is prohibited unless prior written

permission is obtained from the copyright holder.

Patented technology protected by U.S.Patents 7,328,225; 7,325,017; 7,293,033; 7,099,948;

7,076,633.

Patents pending in the U.S. Product and service names mentioned herein are the trademarks of their respective owners.

Contents

Preface 5

About This Document .................................................................................................................... 5

Who Should Read This Document ................................................................................................ 5

Typographical Conventions ........................................................................................................... 6

Feedback ....................................................................................................................................... 6

History of Changes in CL Utilities 7

Command Line Utilities Overview 12

Getting Started With Command Line Utilities 14

Using Command Line Utilities 15

Additional FrontPage Accounts: fpseuser.exe ............................................................................ 16

Additional FTP Accounts: ftpsubaccount.exe .............................................................................. 19

Anonymous FTP Service: anonftp.exe ........................................................................................ 22

Client Accounts: client.exe .......................................................................................................... 25

Client Limits, Permissions, and Interface Settings: client_pref.exe ............................................ 29

Client Templates: client_template.exe ........................................................................................ 38

Control Panel Appearance: server_pref.exe ............................................................................... 49

Custom Buttons: custombutton.exe ............................................................................................ 51

Database Servers: database-server.exe ..................................................................................... 57

Databases: database.exe ............................................................................................................ 60

Desktop Presets: desktop.exe ..................................................................................................... 63

Domain Accounts: domain.exe .................................................................................................... 66

Domain Administrator Accounts: domadmin.exe ........................................................................ 76

Domain Aliases: domalias.exe .................................................................................................... 83

Domain Limits and Preferences: domain_pref.exe ..................................................................... 86

Domain Templates: domain_template.exe .................................................................................. 93

Firewall: firewall.exe .................................................................................................................. 105

Hosted Objects Security: HostingSecurity.exe .......................................................................... 106

IP Addresses: ipmanage.exe .................................................................................................... 113

License Keys: keyupdate.exe .................................................................................................... 115

Mail Accounts: mail.exe ............................................................................................................. 116

Mail Server Configuration Restore: mchk.exe ........................................................................... 122

Mail Server Options: mailserver.exe ......................................................................................... 125

Mailing Lists: maillist.exe ........................................................................................................... 126

Protection on Site Directories: protdir.exe ................................................................................. 129

Server Security: ApplySecurity.exe ........................................................................................... 132

Server Initial Configuration And Administrator's Personal Info: init_conf.exe ........................... 134

Single Sign-On Configuration: sso.exe ..................................................................................... 137

Sitebuilder Integration: Sitebuilder.exe ..................................................................................... 140

Spam Filtering Configuration on the Mailbox Level: spamassassin.exe ................................... 142

Statistics Calculation: statistics.exe........................................................................................... 145

Spam Filtering Configuration on the Server Level: spamassassin_server.exe ........................ 149

Preface 4

SQL Query Execution: dbclient.exe .......................................................................................... 152

Subdomains: subdomain.exe .................................................................................................... 154

Virtual Directories: virtdir.exe .................................................................................................... 161

Web Users: webuser.exe .......................................................................................................... 168

Preface 5

In this section:

About This Document ........................................................................................ 5

Who Should Read This Document .................................................................... 5

Typographical Conventions ............................................................................... 6

Feedback .......................................................................................................... 6

Preface

About This Document

This document contains a complete description of Plesk for Windows command line utilities, which includes detailed information on the utilities, commands and options, all accompanied with real examples.

Who Should Read This Document

This document is intended for Plesk administrators who want to manage the Plesk server and its configuration locally using command line utilities. The document can also be used by third-party developers to integrate Plesk with other products installed on the same server.

6 Preface

Typographical Conventions

Formatting convention

Type of Information

Example

Special Bold

Items you must select, such as menu options, command buttons, or items in a list.

Go to the QoS tab. Titles of chapters, sections, and subsections.

Read the Basic Administration chapter.

Italics

Used to emphasize the importance of a point, to introduce a term or to designate a command line placeholder, which is to be replaced with a real name or value.

These are the so-called shared VPSs.

msiexec /i <name of the

aforementioned *.msi file or GUID>

Monospace

The names of style sheet selectors, files and directories, and CSS fragments.

Install Plesk to the ”c:\plesk bin” directory.

Preformatted

On-screen computer output in your command-line sessions; logs; source code in XML, C++, or other programming s.

05:31:49 Success. Admin John Smith was added.

Preformatted Bold

What you type, contrasted with on-screen computer output.

>cd %plesk_bin%

The following kinds of formatting in the text identify special information.

Feedback

If you have found a mistake in this guide, or if you have suggestions or ideas on how to improve this guide, please send your feedback using the online form at

http://www.parallels.com/en/support/usersdoc/. Please include in your report the guide's title,

chapter and section titles, and the fragment of text in which you have found an error.

This chapter describes the version-specific changes in the CL utilities. The changes are

C H A P T E R 1

History of Changes in CL Utilities

grouped by new features in CLI. To describe a particular change in CLI, we use the following notation:

 (+) - the defined utility or command or option is added  (-) - the defined utility or command or option is deprecated  (*) - the defined utility or command or option is modified

Plesk 8.6

 Added managing limit on maximum number of ODBC DSN connections.

 (+) client_pref.exe: -max_odbc_dsn option  (+) domain_pref.exe: -max_odbc_dsn option

 Added managing permission on selecting database server on which a database is

to be created.

 (+) client_pref.exe: -select_db_server option  (+) client_template.exe: -select_db_server option  (+) domadmin.exe: -select_db_server option

Plesk 8.4

 Dropped creating blog and photo subdomains in Sitebuilder upon domain creation

in Plesk.

 (-) domain.exe: -sb_subdomains_create option  (-) server_pref.exe:-blog-and-photo option  (-) domain_template.exe: -sb_subdomains_create option

 Added support for DomainKeys spam protection used to sign outgoing email

messages.

 (+) domain_pref.exe: -sign_outgoing_mail option  (+) mailserver.exe: --sign-outgoing-mail command  (+) mailserver.exe: --verify-incoming-mail command

8 History of Changes in CL Utilities

Plesk 8.3

 Choosing Webmail

It is possible now to choose which Webmail to use on a per-domain basis.

 Managing ASP settings

The improved utility virtdir.exe allows managing the following ASP settings: specifying the maximum size of ASP buffer and entity body of ASP requests, and enabling/disabling ASP client-side and server-side script debugging.

 Managing Firewall

The new utility firewall.exe allows managing Windows Firewall as follows: enabling/disabling Windows Firewall and enabling default Firewall rules for a network interface.

 Calculating mailbox usage statistics

The improved utility statistics.exe allows calculating the amount of disk space used by every mailbox on a specified or all domains.

 Managing SSO service

The new utility sso.exe allows managing configuration of the single sign-on authentication form as follows: enabling/disabling the SSO service on Plesk server, configuring SSO service and getting SSO service configuration. The utility also allows managing the SSO branding: set, get and remove branded URLs for domains.

Plesk 8.2  SQL queries execution

It is possible now to execute UPDATE and SELECT SQL queries against local or remote Microsoft SQL, MySQL and Jet databases via CLI.

 Restoring mail server configuration

The current reference now contains a completed description of the mchk.exe utility which allows you to restore mail server configuration basing on the data stored in Plesk database.

 Calculating resources usage statistics

Improved statistics.exe allows calculating HTTP, FTP traffic and/or disk space usage for selected domains, sending configurable email notifications on exceeding limits, and launching "reached-limit" event actions.

 Configuring Windows security settings of Plesk server, and Plesk hosted objects

Two brand new utilities ApplySecurity.exe and HostingSecurity.exe make configuring Windows security of the entire Plesk server really easy.

History of Changes in CL Utilities 9

Plesk 8.1.x

 Managing domain administrator accounts

Plesk 8.1 CLI provides a new utility domadmin.exe which serves to manage domain administrators' accounts. This includes editing domain administrator's personal information, viewing information about the domain, setting up the domain management preferences (control panel access and interface features), and domain administrator's permissions.

 Managing additional FTP accounts

Along with the "main" FTP account created during the setup of physical hosting on a domain, Plesk allows creating additional FTP accounts with adjustable access rights to specific domain folders. Plesk 8.1 introduces the new utility ftpsubaccount.exe which enables Plesk administrator to create and remove additional FTP accounts on domains, change account login credentials, hard disk quota, home directory, and user permissions.

 Managing domain aliases

The new Plesk 8.1 utility domalias.exe allows creating or deleting domain aliases, viewing information about domain aliases, enabling or disabling Web and mail services on domain aliases.

 Managing client and domain templates

Plesk client and templates are now managed via CLI, which means that you can create/remove templates, and edit all the templates parameters: limits on resource usage, permissions of a client and domain users, hosting parameters, and so on.

 Managing desktop presets

The new Plesk task-oriented Desktop design allows Plesk users to access the Plesk pages and functions they need much more quickly. Desktop preset is a specific Desktop configuration used as default for a specific type of Plesk users.

 Managing custom buttons

Custom buttons pointing to a URL, and custom buttons linked to site applications can now be created, removed, and edited (interface location, button names, context help messages, and other parameters).

 Managing Database Servers

The database-server.exe and the database.exe utilities are updated to fully support new Plesk for Windows feature Remote Database Servers, meaning that now you can manage multiple database servers (local and remote) via CLI.

 Server-wide configuration of mail server

Plesk 8.1.1 introduces new CL utility enabling Plesk administrators to set up serverwide configuration of mail service. Currently, only enabling/disabling check-up of the mailbox passwords in the dictionary is available, but the functionality is going to be extended.

10 History of Changes in CL Utilities

Plesk 7.6.x

 Subscribing for mass mailing of SWsoft

In Plesk 7.6 for Windows and later, the administrator is allowed to subscribe for mass mailing of SWsoft and to get announcements on new products, the information about discounts, and other useful information.

 ASP.NET version support on domains and subdomains

Plesk CLI now allows choosing a default version of Microsoft ASP.NET (1.1 and

2.0) for domains and subdomains with ASP.NET support.

 Creating virtual subdomains

Along with physical subdomains (having their own folder structure not related to the structure of a parent domain), Plesk now provides the opportunity to create virtual subdomains that are physically hosted within the folder structure of the parent domain. This approach allows direct access to resources (applications, etc.) of the parent domain from within a virtual subdomain.

 Creating virtual directories on the site

This is the newest feature supported in Plesk 7.6.1 for Windows. Now Plesk supports virtual directories created on a site and mapping its physical folders. Virtual directories are provided with flexible access settings, SSL support, ASP.NET support and other useful features.

 Providing support for multiple FrontPage users on a domain

For domains with FrontPage support, Plesk provides the opportunity to create multiple additional FrontPage user accounts (extra FP accounts created in addition to the one, FP WebAdmin). Once created, these accounts can be managed via the

administrator‟s FP account. Additional FrontPage accounts cannot be deleted by

FP WebAdmin.

 Providing remote access to Plesk CP for a client via XML-based interface

Plesk can provide a client with an opportunity to create/manage/delete the client‟s

domains programmatically via a special RPC-XML based interface. This feature can be useful for the clients selling domains via the Internet.

 Extended management capabilities for Clients

The new version of Plesk for Windows provides some additional capabilities of managing clients via CLI. Namely, now the administrator can use CLI to

allow/prohibit a client to access the client‟s Plesk via Control Panel, to manage the

client‟s IIS application pool, to set aliases for the client‟s domains, to manage the client‟s hosting performance, and finally, to create and manage additional FTP

accounts (a new feature that allows the use of FTP accounts with access permissions for the specified domain folders only) on the client‟s domains and subdomains.

 Managing SiteBuilder integration support on a Client and Domain

Plesk supports integration with SWsoft SiteBuilder. Thus, if any version of SiteBuilder is integrated with Plesk and configured properly, creating a new client in Plesk entails creating a SB user associated with this client, which is called synchronization with SiteBuilder. Beginning with version 7.6, Plesk can integrate SiteBuilder v.3.0 or later and the administrator can decide via CLI whether to put a client in sync with SB or to disable SB support for this client.

History of Changes in CL Utilities 11

In case a given client supports SB (any version), then creating a new domain owned by this client entails creating an empty site and publishing it on the domain. Here Plesk allows the administrator to disable publishing, including via CLI.

Also, in case a given client supports SB v.3.0 or later, creating a new domain can be accompanied with creating and publishing two related subdomains – blog and photo. The administrator is allowed to enable/disable this option via CLI.

 Managing spam filtering in SpamAssassin

Now Plesk allows the administrator to enable/disable spam filtering for the specified email box by means of SpamAssassin via CLI.

 Managing server-wide spam filtering in SpamAssassin

This is also the freshest feature supported in Plesk 7.6.1 for Windows and later. Now Plesk allows the administrator to define spam filtering settings on the serverwide level. These settings can be forcedly applied to all mailboxes of the server either instead of or along with personal spamcheck settings enabled for each mailbox individually.

Plesk command line interface (CLI) is designed for integration of Plesk Server

CL Utility

Affected Object

anonftp.exe (on page 22)

anonymous FTP service

ApplySecurity.exe (on page

132)

security settings of server files and folders

client.exe (on page 25)

client accounts, client personal info, and several account options

client_pref.exe (on page 29)

client limits, permissions, and interface settings

client_template.exe (on page

38)

client templates

custombutton.exe (on page

51)

custom buttons

database.exe (on page 60)

databases, database users

database-server.exe (on page

57)

database servers

desktop.exe (on page 63)

desktop presets

dbclient.exe (on page 152)

SQL queries

domadmin.exe (on page 76)

domain administrator accounts

domain.exe (on page 66)

domain accounts

domain_pref.exe (on page 86)

domain limits and preferences

domain_template.exe (on page

93)

domain templates

domalias.exe (on page 83)

domain aliases

C H A P T E R 2

Command Line Utilities Overview

Administrator with third-party applications. It can also be used for managing Plesk instances by administrators experienced in using Plesk and Microsoft Windows command line. This feature provides the command line interface to the majority of management tasks that can be performed by Plesk administrator. The CLI provides the alternative means of control for various business objects in Plesk. Plesk command line utilities use the Plesk core functionality to create, manage, and delete clients, domains, services and other Plesk objects.

At the moment, Plesk provides the following command line utilities (in alphabetical order):

Command Line Utilities Overview 13

CL Utility

Affected Object

firewall.exe (on page 105)

firewall

fpseuser.exe (on page 16)

additional FrontPage user accounts

ftpsubaccount.exe (on page

19)

additional FTP accounts

HostingSecurity.exe (on page

106)

security settings of Plesk hosted objects (domain, subdomain and web user folders and files)

init_conf.exe (on page 134)

initial server configuration, administrator personal info

ipmanage.exe (on page 113)

IP addresses

keyupdate.exe (on page 115)

license keys

mail.exe (on page 116)

mail accounts

mailserver.exe (on page 125)

mail server configuration

maillist.exe (on page 126)

mailing lists

mchk.exe (on page 122)

mail server configuration

protdir.exe (on page 129)

web protection of domain directories

server_pref.exe (on page 49)

Plesk Control Panel appearance

sso.exe (on page 137)

single sign-on configuration

spamassassin.exe (on page

142)

spam filter parameters on the level of mail account

spamassassin_server.exe (on page 149)

server-wide spam filter parameters

statistics.exe (on page 145)

resources usage statistics

subdomain.exe (on page 154)

subdomains

virtdir.exe (on page 161)

virtual directories

webuser.exe (on page 168)

web user accounts

For general instructions on executing command line utilities on Plesk server, consult the Getting Started with Command Line Utilities (on page 14) section.

Plesk for Windows CLU are located in the folder defined by the Windows environment

C H A P T E R 3

Getting Started With Command Line Utilities

variable %plesk_bin%. By default, it is C:\Program Files\Parallels\Plesk\admin\bin if Plesk was clean installed, and C:\Program Files\SWsoft\Plesk\admin\bin if Plesk was updated from earlier

versions. If your Plesk is installed into different folder, all utilities are located at %plesk_dir%\admin\bin.

 To run command line utilities: 1 Log in to the Plesk server as Administrator or another user with

administrator's privileges.

2 Use one of the following options to run a utility:

 To run a utility from any directory, use the following command line format:

>%plesk_bin%\<utility name> [parameters] [options]

 To make %plesk_dir%\admin\bin\ your current directory and run a utility

from its home directory, run the following commands:

>cd %plesk_bin% ><utility name> [parameters] [options]

For exact command syntax of each utility, consult the corresponding sections in the Chapter "Using Command Line Utilities (on page 15)".

This chapter describes in detail the commands and options currently available in the

In this chapter:

Additional FrontPage Accounts: fpseuser.exe ................................................... 16

Additional FTP Accounts: ftpsubaccount.exe..................................................... 19

Anonymous FTP Service: anonftp.exe .............................................................. 22

Client Accounts: client.exe ................................................................................ 25

Client Limits, Permissions, and Interface Settings: client_pref.exe .................... 29

Client Templates: client_template.exe ............................................................... 38

Control Panel Appearance: server_pref.exe ...................................................... 49

Custom Buttons: custombutton.exe ................................................................... 51

Database Servers: database-server.exe ........................................................... 57

Databases: database.exe .................................................................................. 60

Desktop Presets: desktop.exe ........................................................................... 63

Domain Accounts: domain.exe .......................................................................... 66

Domain Administrator Accounts: domadmin.exe ............................................... 76

Domain Aliases: domalias.exe .......................................................................... 83

Domain Limits and Preferences: domain_pref.exe ............................................ 86

Domain Templates: domain_template.exe ........................................................ 93

Firewall: firewall.exe .......................................................................................... 105

Hosted Objects Security: HostingSecurity.exe ................................................... 106

IP Addresses: ipmanage.exe ............................................................................. 113

License Keys: keyupdate.exe ............................................................................ 115

Mail Accounts: mail.exe ..................................................................................... 116

Mail Server Configuration Restore: mchk.exe .................................................... 122

Mail Server Options: mailserver.exe .................................................................. 125

Mailing Lists: maillist.exe ................................................................................... 126

Protection on Site Directories: protdir.exe ......................................................... 129

Server Security: ApplySecurity.exe ................................................................... 132

Server Initial Configuration And Administrator's Personal Info: init_conf.exe ..... 134

Single Sign-On Configuration: sso.exe .............................................................. 137

Sitebuilder Integration: Sitebuilder.exe .............................................................. 140

Spam Filtering Configuration on the Mailbox Level: spamassassin.exe ............. 142

Statistics Calculation: statistics.exe ................................................................ ... 145

Spam Filtering Configuration on the Server Level: spamassassin_server.exe ... 149

SQL Query Execution: dbclient.exe ................................................................... 152

Subdomains: subdomain.exe ............................................................................ 154

Virtual Directories: virtdir.exe ............................................................................. 161

Web Users: webuser.exe .................................................................................. 168

C H A P T E R 4

Using Command Line Utilities

Plesk for Windows command line interface. Each command and option is accompanied by a description and a usage example.

16 Using Command Line Utilities

Additional FrontPage Accounts:

Command

Parameter

Description

Example

--create or -c

<login_name

Creates an additional FP account with the specified login on the specified domain.

Requires -domain option.

To create the JohnDoe account on example.com:

>fpseuser.exe --create JohnDoe -domain example.com –passwd 12345

>fpseuser.exe -c JohnDoe domain example.com –passwd 12345

fpseuser.exe

On a domain with FrontPage support, Plesk allows creating multiple FrontPage users in addition to FP WebAdmin created by default. The fpseuser.exe utility serves to perform create, update and delete operations against these additional FP accounts on the domain via CLI. The utility enables doing the following:

 creating and deleting additional FP accounts  modifying access credentials for an additional FP account  setting and modifying hard disk quota for an additional FP account  displaying information about an existing additional FP account

Note: This utility and all its commands and options are available since Plesk 7.6.

Usage

fpseuser.exe <command> [<login_name>] [ <option1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command creates the JohnDoe FrontPage account with the 12345

password on example.com and restricts the use of disk space for it to 20 MB.

>fpseuser.exe --create JohnDoe -domain example.com –passwd 12345 quota 20

Commands

Using Command Line Utilities 17

Command

Parameter

Description

Example

--update or -u

<login_name

Updates the additional FP account with the specified login name.

To change the hard disk quota for JohnDoe to 20 MB:

>fpseuser.exe --update JohnDoe –quota 20

>fpseuser.exe -u JohnDoe – quota 20

--remove or -r

<login_name

Removes the specified additional FP account from the system.

To remove JohnDoe account:

>fpseuser.exe --remove JohnDoe

>fpseuser.exe –r JohnDoe

--info or - i

<login_name

Retrieves the information about the specified account.

To retrieve the info about JohnDoe account:

>fpseuser.exe --info JohnDoe

>fpseuser.exe -i JohnDoe

--help or - h

Displays help on the use of the utility.

To see the help info on the use of this utility:

>fpseuser.exe --help

>fpseuser.exe -h

Option

Parameter

Description

Example

-login

<login_name>

Sets the new login for the specified additional FP account.

To set the John login name for the JohnDoe account:

>fpseuser.exe --update JohnDoe -login John

-passwd

Sets the password for the specified additional FP account.

Required with -create.

To set the mypass password for JohnDoe account:

>fpseuser.exe --update JohnDoe -passwd mypass

Options

18 Using Command Line Utilities

Option

Parameter

Description

Example

-domain

<domain_name

Specifies the domain on which the additional FP account is to be created.

Required with -create. Is not required for other operations as the additional FP account has a unique name in the system.

To create an additional FP account on example.com:

>fpseuser.exe --create JohnDoe -domain example.com –passwd 12345

-quota

<MB>

Restricts the hard disk space allotted for the specified FP user account.

Unlimited if set to 0.

To restrict the use of disk space for JohnDoe account to 20 MB:

>fpseuser.exe --update JohnDoe -quota 20

Using Command Line Utilities 19

Additional FTP Accounts:

Command

Parameter

Description

Example

--create or

-c

<login_na me>

Creates the additional FTP account.

Requires -

domain and - passwd options.

To create an additional FTP account with login name JohnDoe and password userpass on the domain example.com:

>ftpsubaccount.exe --create JohnDoe -passwd userpass -domain example.com

--update or

-u

<login_na me>

Updates a configuration of the existing additional FTP account with data specified in the options.

To change the password of additional FTP account for user with the login name JohnDoe to newpass:

>ftpsubaccount.exe --update JohnDoe -passwd newpass

>ftpsubaccount.exe -u JohnDoe passwd newpass

ftpsubaccount.exe

The ftpsubaccount.exe utility is designed to manage additional FTP accounts. The utility allows the following operations:

 creating/deleting additional FTP account on domain  changing additional FTP account login credentials, hard disk quota, home directory,

and user permissions

Note: This utility and all its commands and options are available only for Plesk 8.1 and later.

Usage

ftpsubaccount.exe <command> [<login_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command creates an additional FTP account for the user JohnDoe on

the domain example.com, sets password userpass for the user, sets the hard disk quota for the additional FTP account to 50 MB, specifies the /httpdocs/ directory as the default home directory for the additional FTP account, and sets the Read permission for the user.

>ftpsubaccount.exe --create JohnDoe -domain example.com -passwd userpass -quota 50 -access_read true

Commands

20 Using Command Line Utilities

Command

Parameter

Description

Example

--remove or

-r

<login_na me>

Deletes an additional FTP account for a user with a specified login name.

To delete the additional FTP account for the user with the login name JohnDoe:

>ftpsubaccount.exe --remove JohnDoe

>ftpsubaccount.exe -r JohnDoe

--info or -

<login_na me>

Displays information about a specified additional FTP account.

To view information about the additional FTP account for user with the login name JohnDoe:

>ftpsubaccount.exe --info JohnDoe

>ftpsubaccount.exe -i JohnDoe

--help or –

Displays help on the use of the utility.

To view help on the use of this utility:

>ftpsubaccount.exe --help

>ftpsubaccount.exe -h

Option

Parameter

Description

Example

-login

<login_nam e>

Sets a login name for a user of an additional FTP account.

To change the login name of the additional FTP account user from JohnDoe to John:

>ftpsubaccount.exe -u JohnDoe login John

-passwd

Sets a password for an additional FTP account.

To change the password of the additional FTP account user JohnDoe to newpassword:

>ftpsubaccount.exe -u JohnDoe passwd newpassword

-domain

<domain_na me>

Specifies a domain on which an additional FTP account is to be created.

Required with -create.

To create the additional FTP account with the login name JohnDoe and password userpass on the domain example.com:

>ftpsubaccount.exe --create JohnDoe -passwd userpass domain example.com

Options

Using Command Line Utilities 21

Option

Parameter

Description

Example

-quota

<MB>

Limits the amount of available disk space for an additional FTP account.

Unlimited if set to 0 or a negative number.

To restrict the hard disk quota for the additional FTP account user JohnDoe to 50 MB:

>ftpsubaccount.exe -u JohnDoe quota 50

To set the hard disk quota for the additional FTP account user JohnDoe to unlimited:

>ftpsubaccount.exe -u JohnDoe quota 0

>ftpsubaccount.exe -u JohnDoe quota -1

-home

<home_path >

Sets a path to the home directory for an additional FTP account.

Is /httpdocs by default.

To set the home directory for the additional FTP account user JohnDoe to the existing directory /httpdocs:

>ftpsubaccount.exe -u JohnDoe home /httpdocs

The path is defined relative to the domain home directory path. The specified directory must exist.

access_ read

true|false

Allows/Prohibits viewing the content of the home directory and download files from it.

Is false by default.

To give read permission for the additional FTP account user JohnDoe:

>ftpsubaccount.exe -u JohnDoe access_read true

access_ write

true|false

Allows/Prohibits creating, viewing, renaming and deleting directories in the home directory.

Is false by default.

To give write permission for the additional FTP account user JohnDoe:

>ftpsubaccount.exe -u JohnDoe access_read true

22 Using Command Line Utilities

Anonymous FTP Service: anonftp.exe

Command

Parameter

Description

Example

--update or -u

<domain_name>

Updates the anonymous FTP settings.

To enable the anonymous FTP service on the domain example.com:

>anonftp.exe --update example.com -status true

>anonftp.exe -u example.com

-status true

--info or -i

<domain_name>

Retrieves the information about anonymous FTP settings.

To get the info about anonymous FTP settings on example.com:

>anonftp.exe --info example.com

>anonftp.exe -i example.com

The anonftp.exe utility serves to manage the anonymous FTP service. The utility allows the following operations:

 enabling/disabling anonymous FTP access  restricting the download bandwidth and the maximum number of simultaneous

connections

 managing incoming directory parameters and login message options

Usage

anonftp.exe <command> [<domain_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command enables the anonymous FTP service on the domain

example.com, restricts the number of simultaneous FTP connections to 15, allows creating subdirectories within the incoming directory, and restricts the download bandwidth to 500 KB.

>anonftp.exe --update example.com -status true -max-connects 15 incoming true -bandwidth 500

Commands

Using Command Line Utilities 23

Command

Parameter

Description

Example

--help or -h

Displays help on the use of the utility.

To see the help info on the use of this utility:

>anonftp.exe --help

>anonftp.exe –h

Option

Parameter

Description

Example

-status

true|false

Enables/Disables the anonymous FTP service on the specified domain.

To enable the anonymous FTP service on example.com:

>anonftp.exe --update example.com -status true

-message

true|false

Enables/Disables displaying a login message.

Is false by default.

To display the 'Welcome!' login message when logging to the anonymous FTP service on example.com:

>anonftp.exe --update example.com -status true

-message true -messagetext "Welcome!"

-message-text

Specifies a login message text.

-incoming

true|false

Enables/Disables upload to the incoming directory.

Is false by default.

To enable uploading files to the incoming directory:

>anonftp.exe --update example.com -status true

-incoming true

-incoming-

dirs

true|false

Allows/Prohibit creating directories in the incoming directory.

Is false by default.

To allow creating directories in the incoming directory:

>anonftp.exe --update example.com -status true

-incoming-dirs true

-incoming-

downloads

true|false

Enables/Disables downloading from the incoming directory.

Is false by default.

To allow downloading from the incoming directory:

>anonftp.exe --update example.com -status true

-incoming-downloads true

-incoming-

limit

<KB>

Restricts the disk space used by the incoming directory.

Unlimited if set to -1.

To restrict the disk space for the incoming directory to 10 MB:

>anonftp.exe --update example.com -status true

-incoming-limit 10240

-max-connects

Restricts the number of available simultaneous connections.

Unlimited if set to -1.

To restrict the number of simultaneous FTP connections to 40:

>anonftp.exe --update example.com -status true

-max-connects 40

Options

24 Using Command Line Utilities

Option

Parameter

Description

Example

-bandwidth

<KB>

Restricts the download bandwidth.

Unlimited if set to -1.

Note: use this option only if the anonymous FTP service on a domain supports download restriction.

For example, the MS FTP server doesn't support this feature.

To restrict the download bandwidth to 1 MB:

>anonftp.exe --update example.com -status true

-bandwidth 1024

Using Command Line Utilities 25

Client Accounts: client.exe

Command

Parameter

Description

Example

--create or -c

<login_name>

Creates a client account.

Requires -name and -passwd options.

To create the account for John Doe with the login name JohnDoe and password sample:

>client.exe --create JohnDoe -name "John Doe"

-passwd "sample"

--update or -u

<login_name>

Updates a client account.

To change the login name from JohnDoe to John and set the password to 12345:

>client.exe --update JohnDoe -login John passwd 12345

The client.exe utility is designed for the purpose of managing Plesk client accounts. The utility allows the following:

 creating and removing client accounts  enabling/disabling existing client accounts  editing client's personal information  enabling/disabling dedicated IIS application pools for clients  setting a limit on client's CPU usage  enabling/disabling synchronization of client account with Sitebuilder user account

Usage

client.exe <command> [<login_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command creates the client account for John Doe, sets JohnDoe as the

login name and MyPass as the password, specifies the Unites States as the client‟s country, tells Plesk not to send to Plesk administrator a notification on the account creation, enables the use of the dedicated IIS application pool for this client, and allows the use of maximum 7% of CPU for the client‟s IIS application pool.

>client.exe --create JohnDoe -name "John Doe" -passwd MyPass -notify false -iis_app_pool true -cpu_usage 7

Commands

26 Using Command Line Utilities

Command

Parameter

Description

Example

--remove or -r

<login_name>

Removes a client account.

To remove the client account with the login name JohnDoe:

>client.exe --remove JohnDoe

--info or -i

<login_name>

Outputs a client info.

To retrieve the info on the account with the login name JohnDoe:

>client.exe --info JohnDoe

--on

<login_name>

Enables a client account.

To enable the account with the login name JohnDoe:

>client.exe --on JohnDoe

--off

<login_name>

Disables a client account.

To disable the account with the login name JohnDoe:

>client.exe --off JohnDoe

--help or -h

Displays help on the utility use.

>client.exe --help

Option

Parameter

Description

Example

-status

true|false

Enables/Disables a client account.

Is true by default. Duplicates --on and --

off commands to make the utility compatible with further versions of Plesk.

To disable client account with the login name JohnDoe:

>client.exe --update JohnDoe -status false

-company

Specifies a client's company name.

To set the company name in the personal info of the

JohnDoe account to MegaCompany Inc.:

>client.exe --update JohnDoe -company "MegaCompany Inc."

-name

Specifies a client's contact name.

Required with -create.

See the Example above.

-login

<login_name

Specifies a client's login name used to entering Plesk control panel.

Used with --update only.

To change the account login name from JohnDoe to John:

>client.exe --update JohnDoe -login John

Options

Using Command Line Utilities 27

Option

Parameter

Description

Example

-passwd

Specifies a client's password used to entering Plesk control panel.

Required with -create.

To create the account for the client John Doe with the login name JohnDoe and the password sample:

>client.exe --create JohnDoe -name "John Doe" -passwd sample

-phone

Specifies a client's phone number.

To set the phone number in the personal info of the client with the login name JohnDoe to 5552345678:

>client.exe --update JohnDoe -phone 5552345678

-fax

Specifies a client's fax number.

To set the fax number in the personal info of the client with the login name JohnDoe to 5556676677:

>client.exe --update JohnDoe -fax 5556676677

-email

<email>

Specifies a client's email address.

To set the email address in the personal info of the client with the login name JohnDoe to jd@example.com:

>client.exe --update JohnDoe -email jd@example.com

-addr

Specifies a client‟s

postal address.

To set the postal address in the personal info of the client with the login name JohnDoe to Elm str. 17:

>client.exe --update JohnDoe -addr "Elm str. 17"

-city

Specifies a client's city.

To set the city in the personal info of the client with the login name JohnDoe to New York:

>client.exe --update JohnDoe -city "New York"

-state

Specifies a client's state/province.

To set the state in the personal info of the of the client with the login name JohnDoe to NY:

>client.exe --update JohnDoe -state NY

28 Using Command Line Utilities

Option

Parameter

Description

Example

-pcode

Specifies a client's zip/postal code.

To set the zip code in the personal info of the client with the login name JohnDoe to 77381:

>client.exe --update JohnDoe -pcode 77381

-country

Specifies a client's country: a two-letters upper-case code in compliance with ISO

3166.

To set the country in the personal info of the client with the login name JohnDoe to United States:

>client.exe --update JohnDoe -country US

-notify

true|false

Enables/Disables sending a notification on a client account creation.

Used with --create only.

See the Example above.

-iis_app_pool

true|false

Specifies whether the dedicated IIS application pool is provided for a client.

Is false by default.

To grant dedicated IIS application pool to the account with the login name JohnDoe:

>client.exe --update JohnDoe iis_app_pool true

-cpu_usage

Limits a percent of CPU usage for a client's IIS application pool (in %).

Used only if a client is provided with dedicated IIS application pool.

Unlimited if set to -1.

To restrict the CPU usage for the dedicated IIS application pool of the account with the login name JohnDoe to 5%:

>client.exe --update JohnDoe iis_app_pool true cpu_usage 5

-sb_sync

true|false

Enables/Disables synchronization with Sitebuilder 3.x when creating a new client account.

Is true by default. Used with --create

only.

Available since Plesk

7.6.

To create the account not synchronized with Sitebuilder 3.x:

>client.exe --create JohnDoe -name "John Doe" -passwd MyPass

-sb_sync false

Using Command Line Utilities 29

Client Limits, Permissions, and Interface

Command

Parameter

Description

Example

--update or -u

<login_name>

Sets various properties of a client account.

To prohibit changing domain limits to the JohnDoe client account:

>client_pref.exe --update JohnDoe -change_limits false

--skin-list or -sl

Outputs a list of available skins.

>client_pref.exe --skinlist

--info or -i

<login_name>

Outputs client account information.

To retrieve the information about the JohnDoe client account:

>client_pref.exe --info JohnDoe

--help or -h

Outputs help on the utility use.

>client_pref.exe –-help

Settings: client_pref.exe

The client_pref.exe utility serves to set and edit client limits and permissions, to manage client IP address pool, and to define client-specific Plesk interface preferences (i.e., the default language and skin).

Usage

client_pref.exe <command> [<login_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 updates the client account with the login name JohnDoe as

follows: the client is allowed managing log rotation and mailing lists, backing up and restoring domains. Also, the client is allowed using Sitebuilder, the use of disk space allotted for the client is restricted to 150 MB, the client is allowed creating up to 2 subdomains, and the expiration date of the client account is set to 2008-12-31.

>client_pref.exe --update JohnDoe -manage_log true -manage_maillists true -make_dumps true -site_builder true -disk_space 150 -max_subdom 2

-expiration 2008-12-31

Commands

30 Using Command Line Utilities

Option

Parameter

Description

Example

create_doma

ins

true|false

Allows/Prohibits creating domains.

Is false by default.

To allow the client with the login name JohnDoe to create domains:

>client_pref.exe --update JohnDoe -create_domains true

manage_phos

ting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

To allow the client with the login name JohnDoe to manage physical hosting:

>client_pref.exe --update JohnDoe -manage_phosting true

change_limi

true|false

Allows/Prohibits changing domain limits.

Is false by default.

To allow the client with the login name JohnDoe to change domain limits:

>client_pref.exe --update JohnDoe -change_limits true

-manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

To allow the client with the login name JohnDoe to manage DNS:

>client_pref.exe --update JohnDoe -manage_dns 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 the client with the login name JohnDoe to manage log rotation:

>client_pref.exe --update JohnDoe -manage_log true

manage_cron

tab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

To allow the client with the login name JohnDoe to manage task scheduler:

>client_pref.exe --update JohnDoe -manage_crontab true

manage_anon

ftp

true|false

Allows/Prohibits managing Anonymous FTP.

A web site should reside on a dedicated IP address in order to use anonymous FTP service.

Is false by default.

To allow the client with the login name JohnDoe to manage Anonymous FTP:

>client_pref.exe --update JohnDoe -manage_anonftp true

Options

Using Command Line Utilities 31

Option

Parameter

Description

Example

manage_weba

pps

true|false

Allows/Prohibits managing Tomcat web applications.

Is false by default.

To allow the client with the login name JohnDoe to manage Tomcat web applications:

>client_pref.exe --update JohnDoe -manage_webapps true

manage_mail

lists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

To allow the client with the login name JohnDoe to manage mailing lists:

>client_pref.exe --update JohnDoe -manage_maillists true

manage_sh_a

ccess

true|false

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

Is false by default.

To allow the client with the login name JohnDoe to manage system access:

>client_pref.exe --update JohnDoe -manage_sh_access true

manage_subd

omains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

To allow the client with the login name JohnDoe to manage subdomains:

>client_pref.exe --update JohnDoe -manage_subdomains true

manage_quot

true|false

Allows/Prohibits changing limit on using disk space.

Is false by default.

To allow the client with the login name JohnDoe to change the hard disk quota:

>client_pref.exe --update JohnDoe -manage_quota true

-make_dumps

true|false

Allows/Prohibits backing up and restoring domains.

Is false by default.

To allow the client with the login name JohnDoe to back up and restore domains:

>client_pref.exe --update JohnDoe -make_dumps true

manage_viru

sfilter

true|false

Allows/Prohibits managing server-side antivirus protection.

Is false by default.

To allow the client with the login name JohnDoe to manage antivirus:

>client_pref.exe --update JohnDoe -manage_virusfilter true

remote_acce ss_interfac

true|false

Allows/Prohibits using Plesk API.

Is false by default.

Available since Plesk

7.6.

To allow the client with the login name JohnDoe to use Plesk API:

>client_pref.exe --update JohnDoe remote_access_interface true

site_builde

true|false

Allows/Prohibits using Sitebuilder.

Is false by default.

To allow the client with the login name JohnDoe to use Sitebuilder:

>client_pref.exe --update JohnDoe -site_builder true

32 Using Command Line Utilities

Option

Parameter

Description

Example

-max_dom

Limits the number of available domains.

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

Unlimited if set to -1.

To restrict the maximum number of domains available to the client with the login name JohnDoe to 3:

>client_pref.exe --update JohnDoe -max_dom 3

max_dom_ali

ases

Limits the number of available domain aliases.

Unlimited if set to -1.

To restrict the maximum number of domain aliases available to the client with the login name JohnDoe to 2:

>client_pref.exe --update JohnDoe -max_dom_aliases 2

-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 the client with the login name JohnDoe to 100 MB:

>client_pref.exe --update JohnDoe -disk_space 100

max_traffic

Limits monthly traffic usage.

Unlimited if set to -1.

To restrict the maximum amount of traffic available to the client with the login name JohnDoe to 10 GB:

>client_pref.exe --update JohnDoe -max_traffic 10240

-max_box

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available to the client with the login name JohnDoe to 10:

>client_pref.exe --update JohnDoe -max_box 10

-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 the client with the login name JohnDoe to 10 MB:

>client_pref.exe --update JohnDoe -mbox_quota 10240

total_mboxe

s_quota

<MB>

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

Unlimited if set to -1. Not available if the mail

server software used with Plesk does not support handling cumulative mailbox quota.

To set the total mailboxes quota to the JohnDoe account to 100 MB:

>client_pref.exe --update JohnDoe -total_mboxes_quota 100

Using Command Line Utilities 33

Option

Parameter

Description

Example

-max_redir

Limits the number of available mail redirects.

Unlimited if set to -1.

To restrict the maximum number of mail redirects available to the client with the login name JohnDoe to 3:

>client_pref.exe --update JohnDoe -max_redir 3

-max_mg

Limits the number of available mail groups.

Unlimited if set to -1.

To restrict the maximum number of mail groups available to the client with the login name JohnDoe to 5:

>client_pref.exe --update JohnDoe -max_mg 5

-max_resp

Limits the number of available mail auto responders.

Unlimited if set to -1.

To restrict the maximum number of mail auto responders available to the client with the login name JohnDoe to 5:

>client_pref.exe --update JohnDoe -max_resp 5

-max_wu

Limits the number of available web users.

Unlimited if set to -1.

To set the number of web users available to the client with the login name JohnDoe to unlimited:

>client_pref.exe --update JohnDoe -max_wu -1

max_maillis

Limits the number of available mailing lists.

Unlimited if set to -1.

To restrict the maximum number of mailing lists available to the client with the login name JohnDoe to 30:

>client_pref.exe --update JohnDoe -max_maillists 30

max_fpse_us ers

Limits the number of available additional Microsoft FrontPage accounts.

Unlimited if set to -1.

To set the number of additional Microsoft FrontPage accounts available to the client with the login name JohnDoe to unlimited:

>client_pref.exe -u JohnDoe

-max_fpse_users -1

max_subftp_ users

Limits the number of available additional FTP accounts.

Unlimited if set to -1.

To restrict the maximum number of additional FTP accounts available to the client with the login name JohnDoe to 100:

>client_pref.exe -u JohnDoe

-max_subftp_users 100

-max_db

Limits the number of available MySQL databases.

Unlimited if set to -1.

To restrict the maximum number of MySQL databases available to the client with the login name JohnDoe to 5:

>client_pref.exe -u JohnDoe

-max_db 5

max_mssql_d

Limits the number of available Microsoft SQL databases.

Unlimited if set to -1.

To restrict the number of Microsoft SQL databases available to the client with the login name JohnDoe to 15:

>client_pref.exe --update JohnDoe -max_mssql_db 15

34 Using Command Line Utilities

Option

Parameter

Description

Example

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 the client with the login name JohnDoe to 200 MB:

>client_pref.exe --update JaneDoe -mysql_dbase_space 200

mssql_dbase

_space

<MB>

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

Unlimited if set to -1.

To set the Microsoft SQL databases quota to the client with the login name JohnDoe to 300 MB:

>client_pref.exe --update JohnDoe -mssql_dbase_space 300

max_webapps

Limits the number of available Tomcat web applications.

Unlimited if set to -1.

To restrict the maximum number of Tomcat web applications available to the client with the login name JohnDoe to 5:

>client_pref.exe --update JohnDoe -max_webapps 5

-max_subdom

Limits the number of available subdomains.

Unlimited if set to -1.

To restrict the maximum number of subdomains available to the client with the login name JohnDoe to 4:

>client_pref.exe -u JohnDoe

-max_subdom 4

max_iis_app

_pools

Limits the number of available IIS application pools.

Unlimited if set to -1.

To restrict the maximum number of IIS application pools available to the client with the login name JohnDoe to 6:

>client_pref.exe -u JohnDoe

-max_iis_app_pools 6

max_shared_

ssl_links

Limits the number of available shared SSL links.

Unlimited if set to -1.

To restrict the maximum number of shared SSL links available to the client with the login name JohnDoe to 3:

>client_pref.exe -u JohnDoe

-max_shared_ssl_links 3

-max_cf_dsn

Limits the number of available Coldfusion DSN connections.

Unlimited if set to -1.

Available since Plesk

8.2.

To set the number of Coldfusion DSN connections available to the client with the login name JohnDoe to unlimited:

>client_pref.exe -u JohnDoe

-max_cf_dsn -1

max_odbc_ds

Limits the number of ODBC DSN connections available to the client.

Unlimited if set to -1.

Available since Plesk

8.4.1.

To restrict the maximum number of ODBC connections available to the client with the login name JohnDoe to 5:

>client_pref.exe -u JohnDoe

-max_odbc_dsn 5

Using Command Line Utilities 35

Option

Parameter

Description

Example

-expiration

<YYYY-MM-

DD>

Limits the validity period of a client account.

To make the JohnDoe client account valid till 31 December 2008:

>client_pref.exe -u JohnDoe

-expiration 2008-12-31

-ip_pool

add|del:<i p 1>,<ip 2>,..,<ip

Adds/Deletes IP addresses to/from client‟s IP address pool.

To add IP address 192.0.2.127 to IP address pool of JohnDoe client account:

>client_pref.exe -u JohnDoe

-ip_pool add:192.0.2.127

-language

Specifies which language is used in a client's control panel interface.

String should contain the first two letters of the language name and first two letters of the country name.

To set Italian language as default for the JohnDoe client account:

>client_pref.exe -u JohnDoe

-language it-IT

-skin

Specifies which skin is used in a client's control panel interface.

To set the WinXP Reloaded skin for the JohnDoe client account:

>client_pref.exe --update JohnDoe -skin "WinXP Reloaded"

-cp_access

true|false

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

Is true by default.

Available since Plesk

7.6.

To prohibit client with the login name JohnDoe from accessing to Plesk CP:

>client_pref.exe --update JohnDoe -cp_access false

manage_subf

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

Available since Plesk

7.6.

To allow the client with the login name JohnDoe to manage additional FTP accounts:

>client_pref.exe --update JohnDoe -manage_subftp true

manage_doma

in_aliases

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

Available since Plesk

7.6.

To allow the client with the login name JohnDoe to manage domain aliases:

>client_pref.exe --update JohnDoe manage_domain_aliases true

36 Using Command Line Utilities

Option

Parameter

Description

Example

manage_perf

ormance

true|false

Allows/Prohibits managing hosting performance.

Is false by default.

Available since Plesk

7.6.

To allow the client with the login name JohnDoe to manage hosting performance settings:

>client_pref.exe --update JohnDoe -manage_performance true

manage_iis_

app_pool

true|false

Allows/Prohibits managing IIS application pool.

Is false by default.

Available since Plesk

7.6.

To allow the client with the login name JohnDoe to manage IIS application pool:

>client_pref.exe --update JohnDoe manage_iis_app_pool true

manage_webs tat

true|false

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

Is false by default.

Available since Plesk

8.1.1.

To allow the client with the login name JohnDoe to manage web statistics:

>client_pref.exe --update JohnDoe -manage_webstat true

manage_addi tional_perm issions

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.

Available since Plesk

8.1.1.

To allow the client with the login name JohnDoe to manage additional write/modify permissions:

>client_pref.exe --update JohnDoe manage_additional_permissio ns true

Using Command Line Utilities 37

Option

Parameter

Description

Example

manage_spam

filter

true|false

Allows/Prohibits configuring spam filter on the mail account level (if the correspondent option is enabled in the serverwide configuration).

Is false by default.

Available since Plesk

8.1.1.

To allow the client with the login name JohnDoe to configure spam filter:

>client_pref.exe --update JohnDoe -manage_spamfilter true

manage_shar

ed_ssl

true|false

Allows/prohibits managing the Shared SSL feature: making one of the client'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.

Available since Plesk

8.2.

To allow the client with the login name JohnDoe to manage shared SSL:

>client_pref.exe --update JohnDoe -manage_shared_ssl true

select_db_s erver

true|false

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

Is false by default.

Available since Plesk

8.6.

To allow the client with the login name JohnDoe to choose a DB server when creating a database:

>client_pref.exe --update JohnDoe -select_db_server true

38 Using Command Line Utilities

Client Templates: client_template.exe

Command

Parameter

Description

Example

--create or -c

<template_ name>

Creates a new client template.

To create the client template named Sample Template:

>client_template.exe --create "Sample Template"

>client_template.exe -c "Sample Template"

The client_template.exe utility serves to set and edit client template limits, permissions, and preferences.

The utility allows the following operations:

 creating, renaming, and deleting client templates  setting up client template limits and preferences

Note: This utility is available since Plesk 8.1.

Usage

client_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 the name of existing client template

SampleTemplate 1 to the new name SampleTemplate 2, enables hard disk quota management by client, enables domain creation by client, sets the disk space limit to unlimited, enables allocation of up to 12 exclusive IP addresses to client account, and sets the validity period for client account to 1 year from the creation date.

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

Using Command Line Utilities 39

Command

Parameter

Description

Example

--update or -u

<template_ name>

Sets various properties of a client template.

To rename the client template from Sample Template 1 to Sample Template 2:

>client_template.exe --update "Sample Template 1" -new-name "Sample Template 2"

>client_template.exe -u "Sample Template 1" -new-name "Sample Template 2"

--remove or -r

<template_ name>

Removes a client template.

To remove the client template Sample Template:

>client_template.exe --remove "Sample Template"

>client_template.exe -r "Sample Template"

--info or -

<template_ name>

Displays information about a client template

To view information about the client template Sample Template:

>client_template.exe --info "Sample Template"

>client_template.exe -i "Sample Template"

--help or -

Displays help on the utility use

To view help on the use of the utility:

>client_template.exe --help

>client_template.exe -h

Option

Parameter

Description

Example

-new-name

Sets a new name for an existing client template.

To rename the client template from

Sample Template 1 to Sample Template 2:

>client_template.exe --update "Sample Template 1" -new-name "Sample Template 2"

>client_template.exe -u "Sample Template 1" -new-name "Sample Template 2"

-cp_access

true|false

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

Is true by default.

To prohibit clients created with the template Sample Template from accessing to Plesk CP:

>client_template.exe -u "Sample Template" -cp_access false

Options

40 Using Command Line Utilities

Option

Parameter

Description

Example

create_dom ains

true|false

Allows/Prohibits creating domains.

Is false by default.

To allow clients created with the template Sample Template to set up hosting accounts for new sites:

>client_template.exe -u "Sample Template" create_domains true

manage_pho sting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

To allow clients created with the template Sample Template to manage physical hosting:

>client_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 clients created with the template Sample Template to manage system access:

>client_template.exe -u "Sample Template" manage_sh_access true

manage_quo ta

true|false

Allows/Prohibits changing limit on using disk space.

Is false by default.

To allow clients created with the template Sample Template to change hard disk quota:

>client_template.exe -u "Sample Template" manage_quota true

manage_sub domains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

To allow clients created with the template Sample Template to manage subdomains:

>client_template.exe -u "Sample Template" manage_subdomains true

manage_dom ain_aliase s

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

To allow clients created with the template Sample Template to manage domain aliases:

>client_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 clients created with the template Sample Template to manage log rotation:

>client_template.exe -u "Sample Template" -manage_log true

manage_ano nftp

true|false

Allows/Prohibits managing Anonymous FTP.

Is false by default.

To allow clients created with the template Sample Template to manage Anonymous FTP:

>client_template.exe -u "Sample Template" manage_anonftp true

Using Command Line Utilities 41

Option

Parameter

Description

Example

manage_sub ftp

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

To allow clients created with the template Sample Template to manage additional FTP accounts:

>client_template.exe -u "Sample Template" manage_subftp true

manage_cro ntab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

To allow clients created with the template Sample Template to manage task scheduler:

>client_template.exe -u "Sample Template" manage_crontab true

change_lim its

true|false

Allows/Prohibits changing domain limits.

Is false by default.

To allow clients created with the template Sample Template to change domain limits:

>client_template.exe -u "Sample Template" change_limits true

manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

To allow clients created with the template Sample Template to manage DNS:

>client_template.exe -u "Sample Template" -manage_dns true

manage_web apps

true|false

Allows/Prohibits managing Tomcat web applications.

Is false by default.

To allow clients created with the template Sample Template to manage Tomcat web applications:

>client_template.exe -u "Sample Template" manage_webapps true

manage_mai llists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

To allow clients created with the template Sample Template to manage mailing lists:

>client_template.exe -u "Sample Template" manage_maillists true

manage_vir usfilter

true|false

Allows/Prohibits managing server-side antivirus protection.

Is false by default.

To allow clients created with the template Sample Template to manage antivirus:

>client_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 clients created with the template Sample Template to back up and restore domains:

>client_template.exe -u "Sample Template" -make_dumps true

42 Using Command Line Utilities

Option

Parameter

Description

Example

remote_acc ess_interf ace

true|false

Allows/Prohibits using Plesk API.

Is false by default.

To allow clients created with the template Sample Template to use Plesk API:

>client_template.exe -u "Sample Template" remote_access_interface true

site_build er

true|false

Allows/Prohibits using Sitebuilder.

Is false by default.

To allow clients created with the template Sample Template to use Sitebuilder

>client_template.exe -u "Sample Template" site_builder true

manage_per formance

true|false

Allows/Prohibits managing hosting performance.

Is false by default.

To allow clients created with the template Sample Template to manage hosting performance:

>client_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 clients created with the template Sample Template to manage IIS application pool:

>client_template.exe -u "Sample Template" manage_iis_app_pool true

manage_das hboard

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:

>client_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 clients created with the template Sample Template from using desktop view:

>client_template.exe -u "Sample Template" -dashboard false

manage_web

stat

true|false

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

Is false by default.

Available since Plesk

8.2.

To allow clients created with the template Sample Template to manage web statistics:

>client_template.exe -u "Sample Template" manage_webstat true

Using Command Line Utilities 43

Option

Parameter

Description

Example

manage_add itional_pe

rmissions

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.

Available since Plesk

8.2.

To allow clients created with the template Sample Template to manage additional write/modify permissions:

>client_template.exe -u "Sample Template" manage_additional_permissions true

manage_sha red_ssl

true|false

Allows/Prohibits managing the Shared SSL feature: making one of the client'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.

Available since Plesk

8.2.

To allow clients created with the template Sample Template to manage shared SSL:

>client_template.exe -u "Sample Template" manage_shared_ssl true

-stdgui

true|false

Allows/Prohibits using Plesk standard view.

Can be set to false only if the dashboard option is set to true.

Is true by default.

To prohibit clients created with the template Sample Template from using Plesk standard view:

>client_template.exe -u "Sample Template" -stdgui false

44 Using Command Line Utilities

Option

Parameter

Description

Example

-max_dom

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 clients created with the template Sample Template to 50:

>client_template.exe -u "Sample Template" -max_dom 50

max_dom_al iases

Limits the number of available domain aliases.

Unlimited if set to -1.

To restrict the maximum number of domain aliases available to clients created with the template Sample Template to 3

>client_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 clients created with the template Sample Template to 100 MB:

>client_template.exe -u "Sample Template" -disk_space 100

max_traffi c

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:

>client_template.exe -u "Sample Template" max_traffic 10240

-max_box

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available to clients created with the template Sample Template to 50:

>client_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 clients created with the template Sample Template to 10 MB:

>client_template.exe -u "Sample Template" -mbox_quota 10240

total_mbox es_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 clients created with the template Sample Template to 500 MB:

>client_template.exe -u "Sample Template" total_mboxes_quota 500

Using Command Line Utilities 45

Option

Parameter

Description

Example

-max_redir

Limits the number of available mail redirects.

Unlimited if set to -1.

To restrict the number of mail redirects available to clients created with the template Sample Template to 3:

>client_template.exe -u "Sample Template" -max_redir 3

-max_mg

Limits the number of available mail groups.

Unlimited if set to -1.

To restrict the number of mail groups available to clients created with the template Sample Template to 10:

>client_template.exe -u "Sample Template" -max_mg 10

-max_resp

Limits the number of available mail auto responders.

Unlimited if set to -1.

To restrict the number of mail auto responders available to clients created with the template Sample Template to 5:

>client_template.exe -u "Sample Template" -max_resp 5

-max_wu

Limits the number of available web users.

Unlimited if set to -1.

To set the number of web users available to clients created with the template Sample Template to unlimited:

>client_template.exe -u "Sample Template" -max_wu -1

max_fpse_u sers

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 clients created with the template Sample Template to 50:

>client_template.exe -u "Sample Template" max_fpse_users 50

max_subftp _users

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:

>client_template.exe -u "Sample Template" max_subftp_users 100

-max_db

Limits the number of available MySQL databases.

Unlimited if set to -1.

To restrict the number of MySQL databases available to clients created with the template Sample Template to 15:

>client_template.exe -u "Sample Template" -max_db 15

max_mssql_ db

Limits the number of available Microsoft SQL databases.

Unlimited if set to -1.

To restrict the number of Microsoft SQL databases available to clients created with the template Sample Template to 10:

>client_template.exe -u "Sample Template" max_mssql_db 10

46 Using Command Line Utilities

Option

Parameter

Description

Example

mysql_dbas e_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 clients created with the template Sample Template to unlimited:

>client_template.exe -u "Sample Template" mysql_dbase_space -1

mssql_dbas e_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 clients created with the template Sample Template to 100 MB:

>client_template.exe -u "Sample Template" mssql_dbase_space 100

max_mailli sts

Limits the number of available mailing lists.

Unlimited if set to -1.

To restrict the maximum number of mailing lists available to clients created with the template Sample Template to 100:

>client_template.exe -u "Sample Template" max_maillists 100

max_webapp s

Limits the number of available Tomcat applications.

Unlimited if set to -1.

To restrict the maximum number of Tomcat applications available to clients created with the template Sample Template to 100:

>client_template.exe -u "Sample Template" max_webapps 100

max_subdom

Limits the number of available subdomains.

Unlimited if set to -1.

To restrict the maximum number of subdomains available to clients created with the template Sample Template to 20:

>client_template.exe -u "Sample Template" -max_subdom 20

max_iis_ap p_pools

Limits the number of available IIS application pools.

Unlimited if set to -1.

To restrict the maximum number of IIS application pools available to clients created with the template Sample Template to 50:

>client_template.exe -u "Sample Template" max_iis_app_pools 50

max_shared _ssl_links

Limits the number of available shared SSL links.

Unlimited if set to -1.

To set the number of shared SSL links available to clients created with the template Sample Template to unlimited:

>client_template.exe -u "Sample Template" max_shared_ssl_links -1

Using Command Line Utilities 47

Option

Parameter

Description

Example

-max_odbc

Limits the number of available ODBC connections.

Unlimited if set to -1.

To set the number of ODBC connections available to clients created with the template Sample Template to unlimited:

>client_template.exe -u "Sample Template" -max_odbc 1

expiration

Limits the validity period of client accounts created with the template.

Unlimited if set to -1.

To restrict the validity period to clients created with the template Sample Template to 20 days:

>client_template.exe -u "Sample Template" -expiration 20D

To restrict the validity period to clients created with the template Sample Template to 1 year:

>client_template.exe -u "Sample Template" -expiration 1Y

-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 clients created with the template Sample Template:

>client_template.exe -u "Sample Template" -ip_pool add:192.0.2.12,192.0.2.32

excl_ip_nu m

Limits the number of available exclusive IP addresses.

To restrict the number of exclusive IP addresses available to clients created with the template Sample Template:

>client_template.exe -u "Sample Template" excl_ip_num 12

-use_sbnet

true|false

Creates/Doesn't create Sitebuilder user.

Is false by default.

To enable automatic creation of a Sitebuilder users to clients created with the template Sample Template

>client_template.exe -u "Sample Template" -use_sbnet true

max_cf_dsn

Limits the number of available Coldfusion DSN connections.

Unlimited if set to -1.

Available since Plesk

8.2.

To set the number of Coldfusion DSN connections available to clients created with the template Sample Template to unlimited:

>client_template.exe -u "Sample Template" -max_cf_dsn

-1

48 Using Command Line Utilities

Option

Parameter

Description

Example

select_db_ server

true|false

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

Is false by default.

Available since Plesk

8.6.

To allow the client created with the template Sample Template to choose a DB server when creating a database:

>client_template.exe --update "Sample Template" select_db_server true

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

Using Command Line Utilities 49

Control Panel Appearance:

Command

Parameter

Description

Example

--set-def-

locale

Sets a default locale.

To set the Italian locale as a default:

>server_pref.exe --setdef-locale it-IT

--locales-

list

Outputs a list of available locales.

>server_pref.exe -locales-list

--set-def-

skin

Sets a default skin.

To set the WinXP Olivegreen skin as default:

>server_pref.exe --setdef-skin “WinXP Olivegreen”

--skins-list

Outputs a list of available skins.

>server_pref.exe -skins-list

--help or -h

Displays help on the use of the utility.

>server_pref.exe --help

server_pref.exe

The server_pref.exe utility serves to modify the appearance of the Plesk Control Panel. This utility allows the following:

 viewing a list of available locales  viewing a list of available skins  setting locale default for all users  setting skin default for all users

Usage

server_pref.exe <command> [<locale|string>]

Example The following command sets the English (United States) locale and the WinXP

Olivegreen skin as default ones.

>server_pref.exe --set-def-locale en-US --set-def-skin “WinXP Olivegreen”

Commands

50 Using Command Line Utilities

Options

Option

Parameter

Description

Example

-blog-and-

photo

true|false

Enables creating blog and photo gallery subdomains by default.

Deprecated since Plesk 8.4.

To enable creating blog and photo gallery subdomains by default:

>server_pref.exe -update -blog-and-photo true

Using Command Line Utilities 51

Custom Buttons: custombutton.exe

The custombutton.exe utility is designed to create custom buttons, and to manage their properties (interface location, button names, context help messages, and other parameters).

Custom buttons of the following types can be created and managed by using this utility:

 custom button pointing to a URL  custom button linked to site applications

Note: This utility is available since Plesk 8.1.

Usage

custombutton.exe <command> [<param>][ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example 1 The following command creates custom button Statistics that opens URL

http://example.com/site-statistics, places the custom button on the domain administration pages, includes domain ID#, domain name, and client ID# in browser requests generated by clicking on the button, sets the context help message for the button as Click to go to site-statistics, and makes the button available in control panels of all domain users.

>custombutton.exe --create -text Statistics -url http://example.com/site-statistics -url_comp dom_id,dom_name,cl_id conhelp "Click to go to site-statistics" -place domain -public true

Example 2 The following command creates custom button named osCom linked to site application

osCommerce installed on the domain example.com, and sets the context help message for the button as Click to open osCommerce.

>custombutton.exe --create -siteapp-link -siteapp-domain example.com siteapp-name osCommerce -text osCom -conhelp "Click to open osCommerce"

52 Using Command Line Utilities

Commands

Command

Parameter

Description

Example

--create or

-c

Creates a new custom button.

Requires either -

siteapp-link or - url option.

To create the new custom button Statistics (to open URL http://example.com/sitestatistics) and print its database ID number:

>custombutton.exe --create -text Statistics -url http://example.com/sitestatistics -print-id

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -print-id

--info or -i

<ID>

Displays a custom button's properties.

Parameter ID is the custom button ID in Plesk database.

To view properties of a custom button which ID is 14:

>custombutton.exe --info 14

>custombutton.exe -i 14

--remove or

-r

<ID,ID,

...>

Deletes one or more custom buttons.

Parameter ID is the custom button ID in Plesk database.

To delete the custom buttons which ID numbers are 4 and 5:

>custombutton.exe --remove 4,5

>custombutton.exe -r 4,5

--list or -l

Displays a list of all custom buttons.

To view the list of all custom buttons:

>custombutton.exe --list

>custombutton.exe -l

--help or -h

Displays help on the use of the utility.

To view help on the use of the utility:

>custombutton.exe --help

>custombutton.exe -h

--man or -m

Displays detailed help on the use of the utility with examples.

To view detailed help with examples on the use of the utility:

>custombutton.exe --man

>custombutton.exe -m

Option

Parameter

Description

Example

-owner

admin|<user_ login_name>| <domain_name

Assigns ownership of a custom button to a Plesk client.

Is admin by default.

To set the client with the login name JohnDoe the owner of the custom button Statistics to be created:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -owner JohnDoe

Options

Using Command Line Utilities 53

Option

Parameter

Description

Example

-sort_key

Sets a custom button priority.

(The lower is the number – the higher is priority.)

Is 100 by default.

To set the priority of the custom button Statistics to 3:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -sort_key 3

-place

client|domai

n|navigation

Sets a custom button location.

The following locations are available: Client home page, Domain administrator home page, and Navigation pane.

Is client by default.

To set the custom button location to Domain administrator home page:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -place domain

-text

Specifies a text accompanying a custom button.

Required with -url option.

To set the text accompanying the custom button to Statistics:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics

-url

<URL>

Specifies a URL to which a custom button to be created will point.

Required with -create when custom button pointing to URLs is created.

Requires -text option.

To set the URL to which the custom button Statistics will point to example.com/site-statistics:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics

54 Using Command Line Utilities

Option

Parameter

Description

Example

-url_comp

Specifies various parameters to be included with a custom button's URL in browser requests.

The following parameters can be included:

dom_id - domain ID

dom_name -

domain name ftp_user - FTP

user name ftp_pass - FTP

user password

cl_id - client ID cname - client's

company name pname - client's

contact name email - client's

To include the domain ID, domain name, and client ID parameters in the browser requests generated by using the custom button Statistics:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -url_comp dom_id,dom_name,cl_id

-conhelp

Specifies a text of a contextual help message associated with a custom button.

To set the context help message for the custom button Statistics to Click to go to site-statistics:

>custombutton.exe -c -text Statistics -url http://example.com -conhelp "Click to go to sitestatistics"

-file

<path>

Specifies a path to an image file that will be used as a custom button icon.

To set the file Stat.gif as the custom button Statistics icon:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -file "C:\Program Files\Images\PleskInterface\S tat.gif"

-public

true|false

Specifies whether a custom button appears in control panels of users subordinate to the custom button's owner.

Is false by default.

To display custom button Statistics that has the Domain Administrator home page location in control panels of all users on this domain:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -place domain public true

Using Command Line Utilities 55

Option

Parameter

Description

Example

-internal

true|false

Specify if a button's URL is opened in Plesk own frame or in a new window.

Is false by default.

To enable opening the custom button's URL in the Plesk own frame:

>custombutton.exe -c -text Statistics -url http://example.com/sitestatistics -place domain internal true

-print-id

Prints the Plesk database ID of a created custom button.

To create the new custom button

Statistics (to open example.com/sitestatistics) and print its Plesk database

ID:

>custombutton.exe --create text Statistics -url http://example.com/sitestatistics -print-id

-siteapplink

Links a custom button with a site application installed on a domain.

Required with -create when custom button linked to site applications is created.

Used only with siteapp-domain option.

To create the custom button osCom linked to a site application installed on the domain example.com (if there is only a single application installed on a domain):

>custombutton.exe -c -text osCom -siteapp-link -siteappdomain example.com

If there are more than one application installed on a domain, specify more options to identify the site application of interest.

-siteappdomain

Specifies a domain on which a site application to be linked to a custom button is installed.

Required with siteapp-link option.

To create the custom button osCom linked to a site application

osCommerce installed on the domain example.com:

>custombutton.exe -c -text osCom -siteapp-link -siteappdomain example.com -siteappname osCommerce

-siteappid

<ID>

Specifies the Plesk database ID of a site application to be linked to a custom button.

Used only with siteapp-link option.

To create the custom button which ID is 12 linked to the site application installed on the domain example.com:

>custombutton.exe -c siteapp-link -siteapp-domain example.com -siteapp-id 12

56 Using Command Line Utilities

Option

Parameter

Description

Example

-siteappname

<name>

Specifies a name of a site application to be linked to a custom button.

Used only with siteapp-link option.

To create the custom button osCom linked to the site application

osCommerce installed on the domain example.com:

>custombutton.exe -c -text osCom -siteapp-link -siteappdomain example.com -siteappname osCommerce

-siteappversion

Specifies a version of a site application to be linked to a custom button.

Used only with siteapp-link option.

To create the custom button linked to a site application osCommerce v.1.1 installed on the domain example.com:

>custombutton.exe -c siteapp-link -siteapp-domain example.com -siteapp-name osCommerce -siteapp-version

1.1

-siteapprelease

Specifies a release number of a site application to be linked to a custom button.

Used only with siteapp-link option.

To create the custom button osCom linked to the site application osCommerce with release number 10 installed on the domain example.com:

>custombutton.exe -c -text osCom -siteapp-link -siteappdomain example.com -siteappname osCommerce -siteapprelease 10

-siteappprefix

Specifies a path to a directory where the application is installed relative to the httpdocs directory.

Used only with siteapp-link option.

To create the custom button osCom linked to the site application osCommerce which is installed in directory /httpdocs/siteapplication/OSC on the domain example.com:

>custombutton.exe -c -text osCom -url http://example.com/osCommerce

-siteapp-link -siteapp-domain example.com -siteapp-name osCommerce -siteapp-prefix osCommerce/OSC

-siteappsubdomain

<subdomain_n

ame>

Specifies a name of a subdomain if a site application is installed on the subdomain.

Used only with siteapp-link option.

To create the custom button osCom linked to the site application osCommerce which is installed on the subdomain webstore of the domain example.com:

>custombutton.exe -c -text osCom -url http://webstore.example.com/o sCommerce -siteapp-link siteapp-domain example.com siteapp-name osCommerce siteapp-subdomain webstore

Using Command Line Utilities 57

Database Servers: database-server.exe

Command

Parameter

Description

Example

--createserver

<host[:port]>

Adds a database server record to Plesk.

Requires -type, admin, -passwd options.

To create the MySQL database server available at 192.0.2.33, with database server administrator's login admin and password setup:

>database-server.exe -create-server 192.0.2.33 type mysql -admin admin passwd setup

--updateserver

<host[:port]>

Changes configuration settings for the specified database server in Plesk.

To set password for administrator of a remote MySQL server available at

192.0.2.16:3838 to newdbapass:

>database-server.exe -update-server

192.0.2.16:3838 -resetpasswd newdbapass

The database-server.exe utility is designed to manage database servers. The utility allows performing the following tasks:

 adding and removing database servers to Plesk  changing database servers properties and connection settings  changing password of the database server administrator  setting default database server of a particular database type

Note: This utility is available since Plesk 8.1.

Usage

database-server.exe <command> [<host[:port]>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command sets new password newpass for administrator with the login

dbadmin on the remote Microsoft SQL database server mssqlserver available at

192.0.2.44.

>database-server.exe --update-server 192.0.2.16:3838 -type mssql admin dbadmin -reset-passwd newpass

Commands

58 Using Command Line Utilities

Command

Parameter

Description

Example

--remove-

server

<host[:port]>

Removes a database server record from Plesk.

To remove the MySQL database server available at 192.0.2.33:

>database-server.exe -remove-server 192.0.2.33

--setdefault-

server

<host[:port]>

Makes a database server primary among servers of the same type, meaning that if in Plesk a database is created for a domain, it is created on this, default DB server.

To set the MySQL database server available at 192.0.2.33 as default for newly created MySQL databases:

>database-server.exe --setdefault-server 192.0.2.33

--help or -

Displays help on the use of the utility.

>database-server.exe --help

>database-server.exe -h

Option

Parameter

Description

Example

-type

mysql|mssql

Specifies a type of a database server.

Used only with the -

-create-server. Required with --

create-server.

To create the MySQL database server available at 192.0.2.33, with database server administrator's login admin and password setup:

>database-server.exe --createserver 192.0.2.33 -type mysql admin admin -passwd setup

-set

Specifies a database server host, port number, or a combination of the parameters.

To change the port on which the local MySQL database server listens to from default 3306 to 22222:

>database-server.exe --updateserver localhost:3306 -set 22308

-admin

<login_name>

Specifies a database server administrator's login name.

Required with -create-server.

To create the MySQL database server available at 192.0.2.33, with database server administrator's login admin and password setup:

>database-server.exe --createserver 192.0.2.33 -type mysql admin admin -passwd setup

Options

Using Command Line Utilities 59

Option

Parameter

Description

Example

-passwd

Specifies database server administrator's password.

Used only with -create-server.

Required with -create-server.

To create MySQL database server available at 192.0.2.33, with database server administrator's login admin and password setup:

>database-server.exe --createserver 192.0.2.33 -type mysql admin admin -passwd setup

-resetpasswd

Changes password of the database server administrator.

To change administrator's password to 123456 for the local Microsoft SQL Database server:

>database-server.exe --updateserver localhost -type mssql reset-passwd 123456

60 Using Command Line Utilities

Databases: database.exe

Command

Parameter

Description

Example

--create or -c

<database_

name>

Creates a database with a specified name.

Requires domain option.

To create the jdoe-gallery database on example.com:

>database.exe --create jdoegallery -domain example.com type mysql

>database.exe -c jdoe-gallery domain example.com -type mysql

--update or -u

<database_

name>

Updates a database: adds, edits, removes a database user.

To update the jdoe-gallery database with the new user JohnDoe:

>database.exe --update jdoegallery -add_user JohnDoe passwd sample

>database.exe –u jdoe-gallery add_user JohDoe -passwd sample

The database.exe utility serves to manage databases and database user accounts used by Plesk domains. The utility allows the following operations:

 creating and removing databases  adding and removing database user accounts  editing database user credentials

Usage

database.exe <command> [<database_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command creates the MySQL database jdoe-gallery on the domain

example.com.

>database.exe --create jdoe-gallery -domain example.com -type mysql

Commands

Using Command Line Utilities 61

Command

Parameter

Description

Example

--remove or -r

<database_

name>

Deletes a specified database.

To remove the jdoe-gallery database from example.com:

>database.exe --remove jdoegallery -domain example.com

>database.exe -r jdoe-gallery domain example.com

--help or -h

Displays help on the use of the utility.

To view the help info on the use of this utility:

>database.exe -–help

>database.exe –h

Option

Parameter

Description

Example

-domain

<domain_name>

Specifies a domain name.

Required with -create.

To create the MySQL database jdoe-gallery on example.com.

>database.exe --create jdoe-gallery -domain example.com -type mysql

-type

mssql|mysql

Specifies a type of a database.

Either the -type or the -server option is required with -create.

To create the MySQL database jdoe-gallery on example.com.

>database.exe --create jdoe-gallery -domain example.com -type mysql

-server

<host[:port]>

Specifies a database server on which the database resides.

Either -type or server option is required with --create.

To create the MySQL database jdoe-gallery of example.com on the local MySQL server.

>database.exe --create jdoe-gallery -domain example.com -server localhost:3306

-passwd

Specifies a database user password.

Required with add_user.

Used with either the

-add_user or update_user

option.

To set password of jdoe-gallery user with the login name JohnDoe to 123456:

>database.exe --update jdoe-gallery -update_user JohnDoe -passwd 123456

Options

62 Using Command Line Utilities

Option

Parameter

Description

Example

-add_user

<login_name>

Creates a database user.

Requires -passwd option.

To create the jdoe-gallery database user with the login name JohnDoe:

>database.exe --update jdoe-gallery -add_user JohnDoe -passwd 12345

update_user

<login_name>

Changes a database user credentials (password and/or login name).

To set password of jdoe-gallery user with the login name JohnDoe to 123456:

>database.exe --update jdoe-gallery -update_user JohnDoe -passwd 123456

remove_user

<login_name>

Removes a database user with a specified name from the specified database.

To remove the JohnDoe user from jdoe-gallery database:

>database.exe --update jdoe-gallery -remove_user JohnDoe

-user_name

<login_name>

Sets a login name for a database user.

Used with update_user option only.

To rename jdoe-gallery database user from JohnDoe to John:

>database.exe --update jdoe-gallery -update_user JohnDoe -user_name John

Using Command Line Utilities 63

Desktop Presets: desktop.exe

Command

Parameter

Description

Example

--set-admin or -

Changes type of an existing desktop preset to the Administrator's desktop preset type.

Requires -

desktop-

preset option.

To set existing desktop preset named AdminDesktop as an administrator's desktop preset:

>desktop.exe --set-admin desktop-preset AdminDesktop

>desktop.exe -sa -desktoppreset AdminDesktop

--update-

preset or -up

<preset_ name>

Updates properties of a desktop preset.

Requires type option.

To change the type of desktop preset named AdminDesktop to Domain owner's desktop preset:

>desktop.exe --update-preset desktop-preset AdminDesktop type domain

>desktop.exe -up AdminDesktop type domain

--preset-lists or -pl

Displays a list of existing desktop presets.

To display the list of available desktops:

>desktop.exe --preset-lists

>desktop.exe -pl

The desktop.exe utility serves to manage Plesk desktop presets.

Note: The utility is available since Plesk 8.1.

Usage

desktop.exe <command> [<param>] [ <option 1> <param> [<option 2> <param> … [<option N> <param>] ]

Example The following command adds desktop preset AdminDesktop to the administrator's

repository of desktop presets and allows overwriting of the preexisting desktop with the same name.

>desktop.exe --add-preset C:\Program Files\Parallels\Plesk\AdminDesktop.xml -overwrite true

Commands

64 Using Command Line Utilities

Command

Parameter

Description

Example

--add-preset or

-ap

<file_na me>

Adds a preset to administrator's repository of desktop presets.

To add a desktop preset AdminDesktop to the administrator's repository of desktop presets from a desktop preset file AdminDesktop.xml:

>desktop.exe --add-preset C:\Program Files\Parallels\Plesk\AdminDesk top.xml

>desktop.exe --ap C:\Program Files\Parallels\Plesk\AdminDesk top.xml

--remove-

preset or -rp

<preset_ name>

Deletes a desktop preset from administrator's repository of desktop presets.

To add a desktop preset to the administrator's repository of desktop presets from a desktop preset file AdminDesktop.xml:

>desktop.exe --remove-preset AdminDesktop

>desktop.exe -rp AdminDesktop

--help or -h

Displays help on the use of the utility.

To view help on the use of the utility:

>desktop.exe --help

>desktop.exe -h

Option

Parameter

Description

Example

-desktop-

preset

<preset_name>

Sets desktop preset.

Required with -set-admin.

To set existing desktop preset named AdminDesktop as an administrator's desktop preset:

>desktop.exe -sa -desktoppreset AdminDesktop

-default

true|false

Renders desktop preset the default preset for the Plesk users category specified by the option type.

To set desktop AdminDesktop as the default desktop for Plesk administrators:

>desktop.exe -up AdminDesktop

-default true -type admin

Options

Using Command Line Utilities 65

Option

Parameter

Description

Example

overwrite

true|false

Allows overwriting of a desktop preset with another desktop with the same name.

Used with --add- preset.

To add the desktop preset AdminDesktop to the administrator's repository of desktop presets from a desktop preset file AdminDesktop.xml and replace existing desktop with the same name in Plesk:

>desktop.exe --add-preset "C:\Program Files\Parallels\Plesk\AdminDes ktop.xml" -overwrite true

-type

admin|client| domain

Sets desktop preset type:

admin - Default Administrator's desktop, domain Default domain owner desktop, client - Default client desktop.

To change the type of desktop preset named AdminDesktop to Domain owner's desktop preset:

>desktop.exe --update-preset desktop-preset AdminDesktop type domain

66 Using Command Line Utilities

Domain Accounts: domain.exe

Command

Parameter

Description

Example

--create or -c

<domain_name>

Creates a domain.

Requires -

clogin and - ip options.

To create the domain example.com for client with the login name JohnDoe:

>domain.exe --create example.com -clogin JohnDoe

-ip 192.0.2.54

>domain.exe -c example.com

-clogin JohnDoe -ip

192.0.2.54

The domain.exe utility serves to manage domains and allows the following operations:

 creating, renaming, and removing domain accounts  enabling/disabling the existing domains  managing domain user accounts  managing domain hosting parameters like scripting languages support, log settings,

hard disk limits, etc.

Usage

domain.exe <command> [<domain_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command creates for a client account JohnDoe a domain with name

example.com and disables the domain administrator account. Then, the command makes the domain available when accessing it with the www prefix, enables physical hosting for the domain, sets FTP login to John with a password sample, binds the domain with IP address 192.0.2.54 (since not specified explicitly, physical hosting is used). Then, the command enables CGI support on the domain and disables sending the domain created notification to Plesk administrator.

>domain.exe --create example.com -clogin JohnDoe -dom_user false -www true -hosting true -login John -passwd sample -ip 192.0.2.54 -cgi true

-notify false

Commands

Using Command Line Utilities 67

Command

Parameter

Description

Example

--update or -u

<domain_name>

Changes properties of an existing domain.

To limit the amount of disk space that example.com can occupy to 200 MB:

>domain.exe --update example.com -hard_quota 200

>domain.exe -u example.com

-hard_quota 200

--remove or -r

<domain_name>

Removes a domain.

To remove example.com:

>domain.exe --remove example.com

>domain.exe -r example.com

--info or -i

<domain_name>

Retrieves domain info.

To retrieve information about example.com:

>domain.exe --info example.com

>domain.exe --i example.com

--on

<domain_name>

Enables a domain.

To enable example.com:

>domain.exe --on example.com

--off

<domain_name>

Disables a domain.

To disable example.com:

>domain.exe --off example.com

--help or -h

Displays help on the use of the utility.

To output the help info on the use of this utility:

>domain.exe --help

>domain.exe -h

Option

Parameter

Description

Example

-status

true|false

Enables/Disables a domain.

Is true by default.

To enable example.com:

>domain.exe --update example.com -status true

-new_name

Renames a specified domain.

To rename the domain from example.com to sample.com:

>domain.exe --update example.com -new_name sample.com

Options

68 Using Command Line Utilities

Option

Parameter

Description

Example

-dom_user

true|false

Enables/Disables domain administrator account.

Is false by default. Requires -

du_passwd option.

To enable the domain user account for example.com with password mypass:

>domain.exe --update example.com -dom_user true -du_passwd mypass

-du_passwd

Sets password for the domain administrator.

Required with dom_user.

To enable the domain user account with password mypass for example.com:

>domain.exe --update example.com -dom_user true -du_passwd mypass

-du_pname

Sets personal name of domain administrator.

To set the name for the example.com user to John:

>domain.exe --update example.com -du_pname John

-du_email

Sets email address of domain administrator.

To set the email address for the example.com user to john@example.com:

>domain.exe --update example.com -du_email john@example.com

-du_language

Sets the CP interface language for domain administrator.

String should contain the first two letters of the language name and first two letters of the country name.

To set Italian as the interface language for the example.com user:

(consult ISO-3166 for the language code)

>domain.exe --update example.com -du_language it-IT

-dns

true|false

Enables/Disables DNS zone.

By default, settings from the current server-wide DNS template are used.

To enable the DNS zone for example.com:

>domain.exe -u example.com -dns true

-www

true|false

Allows/Prohibits accessing the domain using URL with the www prefix.

Is true by default.

To remove the www prefix from example.com:

>domain.exe --update example.com -www false

-hosting

true|false

Enables/Disables hosting.

Is false by default. To enable hosting -

ip, -login options are required.

To enable hosting for the domain example.com:

>domain.exe --update example.com -hosting true -ip 192.0.2.54 login John -passwd sample

Using Command Line Utilities 69

Option

Parameter

Description

Example

-hst_type

phys|std|fr

Sets up the type of hosting.

Here, phys means physical hosting, std standard forwarding hosting, and frm frame forwarding hosting.

Default value is phys.

To set up standard forwarding hosting on the domain example.com:

>domain.exe --update example.com -hst_type std -login JohnDoe

-target_url

<URL>

Sets the target URL for forwarding hosting types.

Required if the hst_type option is set to std or frm.

To set up standard forwarding to the target URL sample.com for the domain example.com:

>domain.exe --update example.com -hst_type std -target_url www.sample.com

-ip

<ip_address

Specifies the IP address to be associated with new domain.

If the domain is configured for physical hosting, the specified IP address will be used for physical hosting.

To associate IP address

192.0.2.33 with example.com configured for physical hosting:

>domain.exe --create example.com -hosting true -ip 192.0.2.33

-login

<login_name

Sets the login name for the FTP user having access to the domain files structure.

Required if physical

To create the FTP user‟s login

for the example.com user, provided that the domain is configured to use physical hosting:

>domain.exe --update

-passwd

Sets the FTP password.

No password is set by default.

To setup password newpass for accessing example.com files structure via FTP:

>domain.exe --update example.com -passwd newpass

-shell

"Login Disabled"|" Login

Enabled"

Enables/Disables access to the system via remote desktop panel (RDP).

Is "Login Disabled" by default.

To enable access to the system via RDP:

>domain.exe --update example.com -shell "Login Enabled"

70 Using Command Line Utilities

Option

Parameter

Description

Example

-hard_quota

<MB>

Sets the maximum amount of disk space available for the domain files.

Unlimited if set to 0.

To set the 100 MB disk quota for example.com:

>domain.exe --update example.com -hard_quota 100

-sb_publish

true|false

Enables/Disables the creation and publishing of an empty site by Sitebuilder when creating a new domain for the client with SB support.

Is true by default. Used with --create

only.

Available since Plesk

7.5.6.

Not to create and publish an empty site when creating example.com:

>domain.exe --create example.com -clogin johndoe -sb_publish false

-fp

true|false

Enables/Disables FrontPage support.

Is false by default.

To enable FrontPage support on example.com:

>domain.exe --update example.com -fp true

-fp_ssl

true|false

Enables/Disables FrontPage Over SSL support.

Is false by default.

To enable FrontPage Over SSL support on example.com:

>domain.exe --update example.com -fp_ssl true

-fpauth

true|false

Enables/Disables FrontPage authorization.

Is false by default.

To enable FrontPage authorization on example.com:

>domain.exe --update example.com -fpauth true

-fp_no_index

true|false

Defines whether FrontPage uses native WAIS search engine, or IIS Index Server for indexing web sites.

Is false by default. If on Virtuozzo, is

true by default.

Available since Plesk

8.1.1.

To make FrontPage use IIS Index Service on example.com:

>domain.exe -u example.com -fp_no_index false

-ssi

true|false

Enables/Disables SSI support.

Is false by default.

To enable SSI support on example.com:

>domain.exe --update example.com -ssi true

Using Command Line Utilities 71

Option

Parameter

Description

Example

-ssi_html

true|false

Enables/Disables SSI support for HTML and HTM files.

Is false by default.

To enable SSI support for HTML and HTM files on example.com:

>domain.exe -u example.com -ssi_html true

-php

true|false

Enables/Disables PHP support.

Is false by default.

To enable PHP support on example.com:

>domain.exe --update example.com -php true

-php_version

4|5

Specifies PHP version.

Is 4 by default.

To set PHP v.5 default on domain example.com:

>domain.exe -u example.com -php_version 5

-php_isapi

true|false

Enables/Disables running PHP as an ISAPI extension.

Is false by default.

Deprecated since Plesk 8.3. Use php_handler_type instead.

To enable running PHP as an ISAPI extension on domain example.com:

>domain.exe -u example.com -php-isapi true

php_handler_ty

<cgi|fastcg

i|isapi>

Specifies PHP support mode.

Is cgi by default.

To enable running PHP as

ISAPI extension on example.com:

>domain.exe -u example.com php_handler_type isapi

-cgi

true|false

Enables/Disables CGI support.

Is false by default.

To enable CGI support on example.com:

>domain.exe --update example.com -cgi true

-perl

true|false

Enables/Disables Perl support.

Is false by default.

To enable Perl support on example.com:

>domain.exe --update example.com -perl true

-asp

true|false

Enables/Disables ASP support.

Is false by default.

To enable ASP support on example.com:

>domain.exe --update example.com -asp true

-python

true|false

Enables/Disables Python support.

Is false by default.

To enable Python support on example.com:

>domain.exe --update example.com -python true

-coldfusion

true|false

Enables/Disables ColdFusion support.

Is false by default.

To enable ColdFusion support on example.com:

>domain.exe --update example.com -coldfusion true

72 Using Command Line Utilities

Option

Parameter

Description

Example

-miva

true|false

Enables/Disables Miva support.

Is false by default.

To enable Miva support on example.com:

>domain.exe --update example.com -miva true

-ssl

true|false

Enables/Disables accessing a domain via SSL.

Is false by default.

To enable SSL support on example.com:

>domain.exe --update example.com -ssl true

-webstat

none|webali zer|awstats |smartersta

ts|urchin

Sets up which web statistics tool should be used on a domain.

Is none by default.

To set Webalizer used on example.com:

>domain.exe --update example.com -webstat webalizer

-err_docs

true|false

Allows/Prohibits using custom HTTP error messages on a domain.

Is false by default (meaning standard error messages).

To allow custom error documents on example.com:

>domain.exe --update example.com -err_docs true

-write_modify

true|false

Allows/Prohibits granting to the Plesk IIS User the Full access permission for the domain

httpdocs/ and httpsdocs/ files

and subfolders (may be required for web applications correct functioning, but is insecure).

Is false by default.

Available since Plesk

8.1.1.

To allow Plesk IIS User to write and modify files and subfolders in httpdocs/ and httpsdocs/ folders of example.com:

>domain.exe --update example.com write_modify true

-iis_app_pool

true|false

Allows/Prohibits using dedicated IIS application pool for a domain.

Is false by default.

To allow using dedicated IIS application pool on example.com:

>domain.exe --update example.com iis_app_pool true

-cpu_usage

Defines the maximum CPU usage by domain (in %).

To limit the maximum CPU usage by example.com to 3%:

>domain.exe -u example.com -cpu_usage 3

Using Command Line Utilities 73

Option

Parameter

Description

Example

-log_rotate

true|false

Enables/Disables log rotation.

Is true by default.

To disable log rotation on example.com:

>domain.exe --update example.com -log_rotate false

-log_bysize

<KB>

Enables/Disables the processing of log files by size (the processing starts once the specified size is achieved).

To enable the processing of example.com log files when their size comes up to 200 KB:

>domain.exe --update sampledomain.com log_bysize 200

-log_bytime

daily|weekl

y|monthly

Enables the processing of log files by time.

Is daily by default.

To set up weekly log rotation on example.com:

>domain.exe --update example.com -log_bytime weekly

-log_max_num

Specifies the maximum number of stored log files.

Is 3 by default.

To set the maximum number of log files on example.com to 5:

>domain.exe --update exampe.com -log_max_num 5

-log_compress

true|false

Enables/Disables log file compression.

Is true by default.

To disable log file compression on example.com:

>domain.exe --update example.com log_compress false

-log_email

<email>

Enables sending log files to the specified email address.

To enable sending the log file of example.com to JohnDoe@example.com:

>domain.exe --update example.com -log_email JohnDoe@example.com

-clogin

<login_name

Specifies the login name of an existing client who possesses a domain.

Required with -create.

To change an owner of example.com to Jane:

>domain.exe --update example.com -clogin Jane

-mail_service

true|false

Enables/Disables running mail service.

Is false by default.

To disable mail service on example.com:

>domain.exe --update example.com mail_service false

-notify

true|false

Enables/Disables

sending the „domain created‟ notification to

Plesk administrator. Is true by default.

To disable sending the notification:

>domain.exe --create example.com -notify false

74 Using Command Line Utilities

Option

Parameter

Description

Example

-asp.net

true|false

Enables/Disables supporting Microsoft ASP.NET framework.

Is false by default.

To enable Microsoft ASP.NET framework support on example.com:

>domain.exe -u example.com -asp.net true

asp.net_versio

1.1|2.0

Sets the default version of Microsoft ASP.NET framework.

Is 1.1 by default.

Available since Plesk

7.5.6.

To make .NET v.2.0.x default on example.com:

>domain.exe -u example.com asp.net_version 2.0

sb_subdomains_ create

true|false

When creating a new domain for the client with Sitebuilder 3.x support, this option enables/disables creating and publishing two subdomains (blog and photo gallery) by SB.

Is false by default. Used with --create

only.

Available since Plesk

7.6. Deprecated since

Plesk 8.4.

To enable creating and publishing blog, and photo gallery subdomains when creating example.com for a client with SB 3.x support:

>domain.exe --create example.com sb_subdomains_create true

-fp_smtp_host

<host_name>

Specifies Microsoft FrontPage SMTP server.

By default, the mail server address defined by MX record in the domain's DNS zone is set.

If the MX record is not specified, the parameter is set to localhost.

To set mail.example.com as the FrontPage SMTP server for domain sample.com:

>domain.exe -u sample.com -fp_smtp_host mail.example.com

Using Command Line Utilities 75

Option

Parameter

Description

Example

-fp_mail_from

<email>

Specifies Microsoft FrontPage From address.

By default, the address is set to domain administrator email address. If the domain administrator account is not configured or their email address is not specified, the domain owner's email address is used. If the client's e-mail address is not specified, then the Plesk administrator's address is used.

To set the Microsoft FrontPage From address to admin@example.com:

>domain.exe -u sample.com -fp_mail_from admin@example.com

fp_mail_reply_ to

<email>

Specifies Microsoft FrontPage Reply to address.

By default, the address is set to domain administrator email address. If the domain administrator account is not configured or their email address is not specified, the domain owner's e-mail address is used. If the client's email address is not specified, then the Plesk administrator's address is used.

To set the Microsoft FrontPage mail settings: Reply to address to admin@example.com:

>domain.exe -u sample.com fp_mail_reply_to admin@example.com

76 Using Command Line Utilities

Domain Administrator Accounts:

Command

Parameter

Description

Example

--update or -u

<domain_n

ame>

Updates a configuration of the existing domain administrator's account with data specified in the options.

To set a password of the administrator's account on the domain example.com to adminpass:

>domadmin.exe --update example.com -passwd adminpass

>domadmin.exe -u example.com passwd newpassword

--info or

-i

<domain_n

ame>

Displays information about the specified domain administrator's account.

To view the information about the administrator's account on the domain example.com:

>domadmin.exe --info example.com

>domadmin.exe -i example.com

domadmin.exe

The domadmin.exe utility is designed to manage domain administrators via CLI. The utility allows the following operations:

 editing domain administrator's personal information  viewing the information about the domain  changing the domain management preferences (control panel access and interface

features) and permissions

Note: This utility and all its commands and options are available since Plesk 8.1.

Usage

domadmin.exe <command> [<domain_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command sets the personal name John Doe for the example.com

administrator, allows the use of the standard user interface only, sets the administrator's password to log in to mypass, sets the interface language to Russian, and allows the domain content management by the domain administrator.

>domadmin.exe --update example.com -pname "John Doe" -dashboard false

-stdgui true -passwd mypass -locale ru-RU -manage_phosting true

Commands

Using Command Line Utilities 77

Command

Parameter

Description

Example

--help or

-h

Displays help on the use of the utility.

To view the help info on the use of this utility:

>domadmin.exe –help

>domadmin.exe -h

Option

Parameter

Description

Example

-status

true|false

Enables/Disables a domain administrator's access to control panel.

Is false by default.

To enable example.com administrator access to control panel:

>domadmin.exe --update example.com -status true

-passwd

Specifies a domain administrator's password.

To set a password of the administrator's account on the domain example.com to adminpass:

>domadmin.exe -u example.com passwd adminpass

-pname

Specifies a domain administrator's personal name.

To set the example.com administrator's personal name to John:

>domadmin.exe -u example.com pname John

-company

Specifies a domain administrator's company name.

To change the example.com administrator's company name to MegaCompany:

>domadmin.exe -u example.com company "MegaCompany"

-phone

Specifies a domain administrator's phone number.

To change the example.com administrator's phone number to 123123123:

>domadmin.exe -u example.com phone 123123123

-fax

Specifies a domain administrator's fax number.

To change the example.com administrator's fax number to 123123123:

>domadmin.exe -u example.com fax 123123123

-email

<email>

Specifies a domain administrator's email address.

To set the example.com administrator's email to John@example.com:

>domadmin.exe -u example.com email John@example.com

-address

Specifies a domain administrator's street address.

To set the example.com administrator's address to 17 Elm str.:

>domadmin.exe -u example.com address "17 Elm str."

Options

78 Using Command Line Utilities

Option

Parameter

Description

Example

-city

Specifies a domain administrator's city.

To set the example.com administrator's city to New York:

>domadmin.exe -u example.com city "New York"

-state

Specifies a domain administrator's state.

To change the example.com administrator's State/Province to NY:

>domadmin.exe -u example.com state NY

-zip

Specifies a domain administrator's ZIP/postal code.

To change the example.com administrator's Postal/ZIP code to 13808:

>domadmin.exe -u example.com zip 13808

-country

Specifies a domain administrator's country.

To change the example.com administrator's country to United States:

(consult ISO-3166 for the country code)

>domadmin.exe -u example.com country US

-locale

Specifies which language is used in a client's control panel interface.

String should contain the first two letters of the language name and first two letters of the country name.

To set Italian language as default for the example.com administrator's account:

(consult ISO-3166 for the language code)

>domadmin.exe -u example.com locale it-IT

-multiplesessions

true|false

Allows/Prohibits having several simultaneous sessions in the control panel.

Is false by default.

To allow example.com administrator to have several simultaneous sessions in the control panel:

>domadmin.exe -u example.com multiple-sessions true

-maxbuttonlength

Limits button label length for the domain administrator's control panel interface.

To restrict the maximum button label length for the example.com administrator's control panel interface to 10:

>domadmin.exe -u example.com max-button-length 10

-skin

Specifies which skin is used in a domain administrator's control panel interface.

To set the example.com administrator's control panel interface skin to WinXP Reloaded:

>domadmin.exe -u example.com skin "WinXP Reloaded"

-lockscreen

true|false

Prevents/Allows working with Plesk until page is completely loaded.

Is true by default.

To allow example.com administrator to work with the control panel even if control panel screens are not completely loaded:

>domadmin.exe -u example.com lock-screen false

Using Command Line Utilities 79

Option

Parameter

Description

Example

-desktoppreset

Specifies the desktop preset for the domain administrator's control panel interface.

To preset the example.com administrator's desktop to the New Domain Owner Desktop:

>domadmin.exe -u example.com desktop-preset "New Domain Owner Desktop"

manage_pho sting

true|false

Allows/Prohibits managing physical hosting.

Is false by default.

To allow example.com administrator to manage physical hosting:

>domadmin.exe -u example.com manage_phosting true

manage_sh_ access

true|false

Allows/Prohibits managing access to the system through remote desktop.

Is false by default.

To allow example.com administrator to manage system access:

>domadmin.exe -u example.com manage_sh_access true

manage_quo ta

true|false

Allows/Prohibits changing limits on using disk space.

Is false by default.

To allow example.com administrator to set hard disk quota:

>domadmin.exe -u example.com manage_quota true

manage_sub domains

true|false

Allows/Prohibits managing subdomains.

Is false by default.

To allow example.com administrator to manage subdomains:

>domadmin.exe -u example.com manage_subdomains true

manage_dom ain_aliase s

true|false

Allows/Prohibits managing domain aliases.

Is false by default.

To allow example.com administrator to manage domain aliases:

>domadmin.exe -u example.com 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 example.com administrator to manage log rotation:

>domadmin.exe -u example.com manage_log true

manage_ano nftp

true|false

Allows/Prohibits managing Anonymous FTP.

Is false by default.

To allow example.com administrator to manage Anonymous FTP:

>domadmin.exe -u example.com manage_anonftp true

manage_sub ftp

true|false

Allows/Prohibits managing additional FTP accounts.

Is false by default.

To allow example.com administrator to manage additional FTP accounts:

>domadmin.exe -u example.com manage_subftp true

manage_cro ntab

true|false

Allows/Prohibits managing task scheduler.

Is false by default.

To allow example.com administrator to manage task scheduler:

>domadmin.exe -u example.com manage_crontab true

80 Using Command Line Utilities

Option

Parameter

Description

Example

manage_dns

true|false

Allows/Prohibits managing DNS.

Is false by default.

To allow example.com administrator to manage DNS:

>domadmin.exe -u example.com manage_crontab -manage_dns true

manage_web apps

true|false

Allows/Prohibits managing Tomcat web applications.

Is false by default.

To allow example.com administrator to manage Tomcat web applications:

>domadmin.exe -u example.com manage_webapps true

manage_mai llists

true|false

Allows/Prohibits managing mailing lists.

Is false by default.

To allow example.com administrator to manage mailing lists:

>domadmin.exe -u example.com manage_maillists true

manage_vir usfilter

true|false

Allows/Prohibits managing server-side antivirus protection.

Is false by default.

To allow example.com administrator to manage antivirus:

>domadmin.exe -u example.com manage_virusfilter true

make_dumps

true|false

Allows/Prohibits backing up and restoring domain.

Is false by default.

To allow example.com administrator to back up and restore the domain:

>domadmin.exe -u example.com make_dumps true

site_build er

true|false

Allows/Prohibits using Sitebuilder.

Is false by default.

To allow example.com administrator to manage Sitebuilder:

>domadmin.exe -u example.com site_builder true

manage_per formance

true|false

Allows/Prohibits managing hosting performance.

Is false by default.

To allow example.com administrator to manage hosting performance:

>domadmin.exe -u example.com manage_performance true

manage_iis _app_pool

true|false

Allows/Prohibits managing IIS application pool.

Is false by default.

To allow example.com administrator to manage IIS application pool:

>domadmin.exe -u example.com manage_iis_app_pool true

manage_web

stat

true|false

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

Is false by default.

Available since Plesk

8.1.1.

To allow example.com administrator to manage web statistics:

>domadmin.exe -u example.com manage_webstat true

Using Command Line Utilities 81

Option

Parameter

Description

Example

manage_add itional_pe rmissions

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.

Available since Plesk

8.1.1.

To allow example.com administrator to manage additional write/modify permissions:

>domadmin.exe -u example.com manage_additional_permissions true

manage_spa mfilter

true|false

Allows/Prohibits configuring spam filter on the mail account level (if the correspondent option is enabled in the server-wide configuration).

Is false by default.

Available since Plesk

8.1.1.

To allow example.com administrator to configure spam filter:

>domadmin.exe --update example.com -manage_spamfilter true

manage_das hboard

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 example.com administrator from managing desktop view:

>domadmin.exe -u example.com 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 example.com administrator from using desktop view:

>domadmin.exe -u example.com dashboard false

82 Using Command Line Utilities

Option

Parameter

Description

Example

-stdgui

true|false

Allows/Prohibits using Plesk standard view.

Can be set to false only if the dashboard option is set to true.

Is true by default.

Available since Plesk

8.1.1.

To prohibit example.com administrator from using Plesk standard view:

>domadmin.exe -u example.com stdgui false

select_db_ server

true|false

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

Is false by default.

Available since Plesk

8.6.

To allow example.com administrator to choose a DB server on which a database is to be created:

>domadmin.exe -u example.com select_db_server true

Using Command Line Utilities 83

Domain Aliases: domalias.exe

Command

Parameter

Description

Example

--create or

-c

<alias_na me>

Creates a new domain alias.

Requires -domain option.

To create a new domain alias example.com for domain example.net

>domalias.exe --create example.com -domain example.net

--update or

-u

<alias_na me>

Updates configuration of an existing domain alias with the data specified in the options.

To enable mail service on domain alias example.com:

>domalias.exe --update example.com -mail true

>domalias.exe -u example.com mail true

--remove or

-r

<alias_na me>

Deletes a domain alias.

To delete domain alias example.com:

>domalias.exe --remove example.com

>domalias.exe -r example.com

The domalias.exe utility is designed to manage domain aliases. The utility allows the following operations:

 creating and deleting domain aliases  viewing information about domain aliases

enabling and disabling Web and mail services on domain aliases Note: This utility is available only since Plesk 8.1.

Usage

domalias.exe <command> [<param>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command creates domain alias example.com for domain example.net,

sets the status of the domain alias to that of the parent domain example.net, and enables mail service on the domain alias.

>domalias.exe --create example.com -domain example.net -status parent

-mail true

Commands

84 Using Command Line Utilities

Command

Parameter

Description

Example

--remove-

all or -ra

<parent_d omain>

Deletes all domain aliases for specified domain.

To delete all domain aliases for domain example.net:

>domalias.exe --remove-all example.net

>domalias.exe -ra example.net

--info or -

<alias_na me>

Displays information about domain alias.

To view information about domain alias example.com:

>domalias.exe --info example.com

>domalias.exe --i example.com

--on

<alias_na me>

Enables a domain alias.

To enable domain alias example.com:

>domalias.exe --on example.com

--off

<alias_na me>

Disables a domain alias.

To disable domain alias example.com:

>domalias.exe --off example.com

--rename

<alias_na me>

Renames a domain alias.

Requires new- name option.

To change the name of domain alias example.com to example.org:

>domalias.exe --rename example.com -new-name example.org

--help or –

Displays help on the use of the utility

To view help on the use of this utility:

>domalias.exe –help

>domalias.exe -h

Option

Parameter

Description

Example

-newname

<FQDN>

Sets a new name for an existing domain alias.

Required with -rename.

To change the name of domain alias example.com to example.org:

>domalias.exe --rename example.com -new-name example.org

-mail

true|false

Enables or disables mail service on the domain alias.

To enable mail service on domain alias example.com:

>domalias.exe -u example.com mail true

-web

true|false

Enables or disables web service on the domain alias.

To enable Web service on domain alias example.com:

>domalias.exe -u example.com web true

Options

Using Command Line Utilities 85

Option

Parameter

Description

Example

-domain

<FQDN>

Specifies the name of the domain for which domain alias is to be created.

Required with -create.

To create a new domain alias example.com for domain example.net

>domalias.exe --create example.com -domain example.net

-status

enabled|di

sabled

Enables or disables domain alias.

To enable domain alias example.com:

>domalias.exe -u example.com status enabled

86 Using Command Line Utilities

Domain Limits and Preferences:

Command

Parameter

Description

Example

--update or -u

<domain_name>

Sets the domain preferences.

To change preferences of example.com:

>domain_pref.exe --update example.com -disk_space 1024 -max_traffic 500

>domain_pref.exe -u example.com -disk_space 1024 -max_traffic 500

domain_pref.exe

The domain_pref.exe utility serves to set up domain limits and preferences. The utility allows the following:

 setting up limits on domain resources usage, like the maximum number of

mailboxes, databases, autoresponders, etc.

 managing domain-level preferences, like web users scripting support, webmail use,

etc.

Usage

domain_pref.exe <command> [<domain_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command modifies preferences of example.com domain as follows: the

maximum allowed disk space for this domain is restricted to 1 GB, the domain is

accessible at the domain's URL with “www” prefix, the maximum number of MySQL

databases used on this domain is set to 4, the maximum number of mail groups used on this domain is set to 15, and the maximum number of mail boxes allowed for this domain is set to 50.

>domain_pref.exe --update example.com -disk_space 1024 -www true max_db 4 -max_mg 15 -max_box 50

Commands

Using Command Line Utilities 87

Command

Parameter

Description

Example

--info or -i

<domain_name>

Retrieves information about domain preferences.

To retrieve information about example.com preferences:

>domain_pref.exe --info example.com

>domain_pref.exe –i example.com

--help or -h

Displays help on the utility use.

>domain_pref.exe --help

>domain_pref.exe -h

Option

Parameter

Description

Example

-max_dom_aliases

Restricts the maximum number of available domain aliases.

Unlimited if set to -1.

To allow example.com to have maximum 2 aliases:

>domain_pref.exe -update example.com max_dom_aliases 2

-disk_space

<MB>

Restricts the maximum amount of available disk space.

Unlimited if set to -1.

To allow example.com to occupy maximum 1 GB:

>domain_pref.exe -update example.com disk_space 1024

-max_traffic

<MB>

Restricts the maximum monthly traffic usage.

Unlimited if set to -1.

To allow example.com to use up to 10 GB per month:

>domain_pref.exe -update example.com disk_space 10240

-max_box

Restricts the maximum number of mail boxes.

Unlimited if set to -1.

To restrict the number of mailboxes for example.com to 5:

>domain_pref.exe -u example.com -max_box 5

-mbox_quota

<KB>

Restricts the maximum amount of disk space allotted to a single mailbox on a domain.

Unlimited if set to -1.

To restrict the use of disk space for a single mailbox on example.com to 20 MB:

>domain_pref.exe -u example.com -mbox_quota 20480

Options

88 Using Command Line Utilities

Option

Parameter

Description

Example

total_mboxes_quo

<MB>

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

Unlimited if set to -1. Not available if the

mail server software used with Plesk does not support handling cumulative mailbox quota.

To restrict the use of disk space for all mailboxes on example.com to 20 GB:

>domain_pref.exe -u example.com total_mboxes_quota 20480

-max_redir

Restricts the maximum number of available mail redirects.

Unlimited if set to -1.

To restrict the number of mail redirects on example.com to 5:

>domain_pref.exe -u example.com -max_redir 5

-max_mg

Restricts the maximum number of available mail groups.

Unlimited if set to -1.

To restrict the number of mail groups on example.com to 7:

>domain_pref.exe -u example.com -max_mg 7

-max_resp

Restricts the maximum number of mail autoresponders (mail replies being sent automatically).

Unlimited if set to -1.

To restrict the number of mail autoresponders on example.com to 10:

>domain_pref.exe -u example.com -max_resp 10

-max_wu

Restricts the maximum number of web users.

Unlimited if set to -1.

To restrict the number of web users on example.com to 50:

>domain_pref.exe -u example.com -max_wu 50

-max_db

Restricts the maximum number of MySQL databases that can be used by a domain.

Unlimited if set to -1.

To restrict the number of MySQL databases on example.com to 5:

>domain_pref.exe -u example.com -max_db 5

-max_mssql_db

Restricts the maximum number of Microsoft SQL databases that can be used by a domain.

Unlimited if set to -1.

To restrict the number of Microsoft SQL databases on example.com to 7:

>domain_pref.exe -u example.com max_mssql_db 7

Using Command Line Utilities 89

Option

Parameter

Description

Example

mysql_dbase_spac

<MB>

Restricts the maximum amount of disk space allotted to MySQL databases.

Unlimited if set to -1.

To restrict the disk space occupied by all MySQL databases of example.com to 500 MB:

>domain_pref.exe -u example.com mysql_dbase_space 500

mssql_dbase_spac

<MB>

Restricts the maximum amount of disk space allotted to Microsoft SQL Server databases.

Unlimited if set to -1.

To restrict the disk space occupied by Microsoft SQL Server databases of example.com to 700 MB:

>domain_pref.exe -u example.com mssql_dbase_space 700

-max_maillists

Restricts the maximum number of mailing lists.

Unlimited if set to -1.

To restrict the number of mailing lists on example.com to 3:

>domain_pref.exe -u example.com max_maillists 3

-max_webapps

Restricts the maximum number of web applications.

Unlimited if set to -1.

To restrict the number of web applications on example.com to 10:

>domain_pref.exe -update example.com max_webapps 10

-max_subdom

Restricts the maximum number of subdomains.

Unlimited if set to -1.

To restrict the number of subdomains on example.com to 2:

>domain_pref.exe -update example.com max_subdom 2

max_shared_ssl_l

inks

Restricts the number of shared SSL links.

Unlimited if set to -1.

To restrict the number of shared SSL links for example.com to 3:

>domain_pref.exe -u max_shared_ssl_links 3

-expiration

<YYYY-MM-

DD>

Defines the date when a domain account expires.

Unlimited if set to -1.

To set April 1, 2009 as the expiration date for example.com:

>domain_pref.exe -update example.com expiration 2009-04-01

-max_cf_dsn

Limits the number of available Coldfusion DSN connections.

Unlimited if set to -1.

Available since Plesk

8.2.

To set the number of Coldfusion DSN connections available for the domain example.com to unlimited:

>domain_pref.exe -u example.com -max_cf_dsn

-1

90 Using Command Line Utilities

Option

Parameter

Description

Example

-max_odbc_dsn

Limits the number of available ODBC DSN connections.

Unlimited if set to -1.

Available since Plesk

8.4.1.

To set the number of ODBC connections available for the domain example.com to 5:

>domain_pref.exe -u example.com max_odbc_dsn 5

-www

true|false

Allows accessing a domain using URL with the www prefix.

Is true by default.

To make example.com accessible with the "www" prefix:

>domain_pref.exe -update example.com -www true

-wuscripts

true|false

Enables/Disables using scripts for web users.

To enable scripting support for web users of example.com:

>domain_pref.exe -u example.com -wuscripts true

-webmail

<horde|mew embail|mer akwebmail| smwebmail| cgpwebmail

|none>

Specifies an available Webmail.

Several of the following Webmails or none are available:

Horde IMP H3 (4.1.4) (horde), CommuniGate Pro Web Client (cgpwebmail), IceWarp Web Mail

5.6.7 (merakwebmail), MailEnable Web Client (mewembail), SmarterMail Web Client (smwebmail).

Is none by default.

To set the Webmail Horde IMP

H3 on the domain example.com:

>domain_pref.exe -update example.com webmail horde

-max_fpse_users

Limits the maximum number of additional Microsoft FrontPage accounts that can be created on a domain.

Unlimited if set to -1.

Available since Plesk

7.6.

To allow unlimited number of additional Microsoft FrontPage accounts limit on example.com:

>domain_pref.exe -u example.com max_fpse_users -1

Using Command Line Utilities 91

Option

Parameter

Description

Example

max_subftp_users

Limits the maximum number of additional FTP accounts.

Unlimited if set to -1.

Available since Plesk

7.6.

To allow maximum 100 additional FTP accounts on example.com:

>domain_pref.exe -u example.com max_subftp_users 100

-no_usr

bounce:<tx t>|email|i

p|discard

Sets the mode of automatic action toward mail messages addressed to non-existent users.

To have messages addressed to non-existent users bounced back with text No such mailbox

on the server on the domain example.com:

>domain_pref.exe -u example.com -no_usr bounce:"No such mailbox on the server"

To have messages addressed to non-existent users forwarded to mail address admin@example.com on the domain example.com:

>domain_pref.exe -u example.com -no_usr admin@example.com

To have messages addressed to non-existent users redirected to external mail server with IP address 192.0.2.43 on the domain example.com:

>domain_pref.exe -u example.com -no_usr

192.0.2.43

To have messages addressed to non-existent users silently rejected on the domain example.com:

>domain_pref.exe -u example.com -no_usr discard

sign_outgoing_ma

true|false

Allows/Prohibits using DomainKeys spam protection to sign outgoing email messages.

Is false by default.

Available since Plesk

8.4.

To use DomainKeys spam protection to sign outgoing mail on the domain example.com:

>domain_pref.exe -u example.com sign_outgoing_mail true

92 Using Command Line Utilities

Option

Parameter

Description

Example

-keep_traf_stat

<number_of _months>

Defines the number of months during which the system keeps traffic usage statistics.

Keeping statistics during unlimited period if set to -0.

To make the system retain example.com traffic statistics during 5 months:

>domain_pref.exe -update example.com keep_traf_stat 5

Using Command Line Utilities 93

Domain Templates: domain_template.exe

Command

Parameter

Description

Example

--create or

-c

<template_nam

Creates a new domain template.

To create the template named DomainTemplate:

>domain_template.exe --create DomainTemplate

>domain_template.exe -c DomainTemplate

--update or

-u

<template_nam

Sets various properties of an existing domain template.

To update the template named

DomainTemplate with the new name DomainTemplate 1:

>domain_template.exe --update DomainTemplate -new-name "DomainTemplate 1"

>domain_template.exe -u DomainTemplate -new-name "DomainTemplate 1"

The domain_template.exe utility serves to set and edit domain template preferences and limits. The utility allows the following operations:

 creating, renaming, and deleting domain templates  setting up domain template limits and preferences  setting up various domain template hosting parameters like scripting languages

support, log settings, hard disk limits, etc.

Note: This utility is available since Plesk 8.1.

Usage

domain_template.exe <command> [<template_name>] [ <option 1> <param> [<option 2> <param>] … [<option N> <param>] ]

Example The following command changes the properties of domain template Sample Domain

Template: specifies that mail messages addressed to non-existing users are forwarded to email address admin@example.com, sets the monthly domain traffic limit to 10 GB/month, enable Python and ASP.NET v. 1.1 support.

>domain_template.exe --update "Sample Domain Template" -no_usr admin@example.com -max_traffic 10240 -python true -asp.net true

Commands

94 Using Command Line Utilities

Command

Parameter

Description

Example

--remove or

-r

<template_nam

Deletes a domain template.

To remove the template DomainTemplate:

>domain_template.exe --remove DomainTemplate

>domain_template.exe -r DomainTemplate

--info or -i

<template_nam

Displays information about a domain template.

To display information about the template DomainTemplate:

>domain_template.exe --info DomainTemplate

>domain_template.exe -i DomainTemplate

--help or -h

Displays help on the use of the utility.

To view help on the use of the utility:

>domain_template.exe --help

>domain_template.exe -h

Option

Parameter

Description

Example

-new-name

Sets a new name for an existing domain template.

To rename the template from

DomainTemplate 1 to DomainTemplate 2:

>domain_template.exe -u "DomainTemplate 1" -newname "DomainTemplate 2"

-clogin

<client_log in_name>

Assigns a domain template to a client account.

To assign the template DomainTemplate to the client with Plesk login name JohnDoe:

>domain_template.exe -u DomainTemplate -clogin JohnDoe

Options

Using Command Line Utilities 95

Option

Parameter

Description

Example

-no_usr

bounce:<txt >|email|ip| discard

Sets the mode of automatic action toward mail messages addressed to non-existent users.

To have messages addressed to non-existent users bounced back with text No such mailbox on the server on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -no_usr bounce:"No such mailbox on the server"

To have messages addressed to non-existent users forwarded to mail address admin@example.com on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -no_usr admin@example.com

To have messages addressed to non-existent users redirected to external mail server with IP address

192.0.2.43 on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -no_usr

192.0.2.43

To have messages addressed to non-existent users silently rejected on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -no_usr discard

-webmail

Specifies a Webmail. The following

Webmails or none are available:

Horde IMP H3 (4.1.4) (horde), CommuniGate Pro Web Client (cgpwebmail), IceWarp Web Mail

5.6.7 (merakwebmail), MailEnable Web Client (mewembail), SmarterMail Web Client (smwebmail).

Is none by default.

To set the Webmail CommuniGate Pro Web Client on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -webmail cgpwebmail

96 Using Command Line Utilities

Option

Parameter

Description

Example

max_dom_alia ses

Limits the number of available domain aliases.

Unlimited if set to -1.

To set the number of domain aliases available for domains created with the template DomainTemplate to unlimited:

>domain_template.exe -u DomainTemplate max_dom_aliases -1

-disk_space

<MB>

Limits the amount of available disk space.

Unlimited if set to -1.

To restrict the maximum amount of disk space available for domains created with the template DomainTemplate to 100 MB:

>domain_template.exe -u DomainTemplate -disk_space 100

-max_traffic

Limits the monthly traffic usage.

Unlimited if set to -1.

To restrict the maximum amount of traffic available for domains created with the template DomainTemplate to 1 GB/month:

>domain_template.exe -u DomainTemplate max_traffic 1024

-max_box

Limits the number of available mailboxes.

Unlimited if set to -1.

To restrict the maximum number of mailboxes available for domains created with the template DomainTemplate to 50:

>domain_template.exe -u DomainTemplate -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 single mailbox quota for domains created with the template DomainTemplate to 10 MB:

>domain_template.exe -u DomainTemplate -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 for domains created with the template DomainTemplate to 500 MB:

>domain_template.exe -u DomainTemplate total_mboxes_quota 500

-max_redir

Limits the number of available mail redirects.

Unlimited if set to -1.

To set the number of mail redirects available for domains created with the template DomainTemplate to unlimited:

>domain_template.exe -u DomainTemplate -max_redir

-1

-max_mg

Limits the number of available mail groups.

Unlimited if set to -1.

To restrict the maximum number of mail groups available for domains created with the template DomainTemplate to 100:

>domain_template.exe -u DomainTemplate -max_mg 100

Using Command Line Utilities 97

Option

Parameter

Description

Example

-max_resp

Limits the number of available mail autoresponders.

Unlimited if set to -1.

To restrict the maximum number of mail autoresponders available for domains created with the template DomainTemplate to 20:

>domain_template.exe -u DomainTemplate -max_resp 20

-max_wu

Limits the number of available web users.

Unlimited if set to -1.

To restrict the maximum number of web users available for domains created with the template DomainTemplate to 100:

>domain_template.exe -u DomainTemplate -max_wu 100

max_fpse_use rs

Limits the number of available additional Microsoft FrontPage accounts.

Unlimited if set to -1.

To restrict the maximum number of Microsoft additional FrontPage accounts available for domains created with the template DomainTemplate to 5:

>domain_template.exe -u DomainTemplate max_fpse_users 5

max_subftp_u sers

Limits the number of available additional FTP accounts.

Unlimited if set to -1.

To restrict the maximum number of additional FTP accounts available for domains created with the template DomainTemplate to 10:

>domain_template.exe -u DomainTemplate max_subftp_users 10

-max_db

Limits the number of available MySQL databases.

Unlimited if set to -1.

To set the maximum number of MySQL databases available for domains created with the template DomainTemplate to unlimited:

>domain_template.exe -u DomainTemplate -max_db -1

max_mssql_db

Limits the number of available Microsoft SQL Server databases.

Unlimited if set to -1.

To restrict the maximum number of Microsoft SQL Server databases available for domains created with the template DomainTemplate to 5:

>domain_template.exe -u DomainTemplate max_mssql_db 5

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 for domains created with the template DomainTemplate to unlimited:

>domain_template.exe -u DomainTemplate mysql_dbase_space -1

98 Using Command Line Utilities

Option

Parameter

Description

Example

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 for the domains created with the template DomainTemplate to 10 MB:

>domain_template.exe -u DomainTemplate mssql_dbase_space 10

max_maillist s

Limits the number of available mailing lists.

Unlimited if set to -1.

To restrict the maximum number of mailing lists available for domains created with the template DomainTemplate to 20:

>domain_template.exe -u DomainTemplate max_maillists 20

-max_webapps

Limits the number of available Tomcat applications.

Unlimited if set to -1.

To restrict the maximum number of Tomcat applications available for domains created with the template DomainTemplate to 100:

>domain_template.exe -u DomainTemplate max_webapps 100

-max_subdom

Limits the number of available subdomains.

Unlimited if set to -1.

To restrict the maximum number of subdomains available for domains created with the template DomainTemplate to 2:

>domain_template.exe -u DomainTemplate -max_subdom 2

max_shared_s sl_links

Limits the number of available shared SSL links.

Unlimited if set to -1.

To set the number of shared SSL links available for domains created with the template DomainTemplate to unlimited:

>domain_template.exe -u DomainTemplate max_shared_ssl_links -1

-max_odbc

Limits the number of available ODBC connections.

Unlimited if set to -1.

To set the number of ODBC connections available for domains creates with the template DomainTemplate to unlimited:

>domain_template.exe -u DomainTemplate -max_odbc 1

Using Command Line Utilities 99

Option

Parameter

Description

Example

-expiration

Limits the domain validity period.

Unlimited if set to -1.

To restrict the validity period for domains created with the template DomainTemplate to 20 days:

>domain_template.exe -u DomainTemplate -expiration 20D

To restrict the validity period for domains created with template DomainTemplate to 1 year:

>domain_template.exe -u DomainTemplate -expiration 1Y

-log_rotate

true|false

Enables/Disables log rotation.

Is false by default.

To enable log rotation on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -log_rotate true

-log_bysize

<KB>

Enables/Disables log rotation once a current log file reaches certain size.

To enable log rotation on domains created with the template DomainTemplate once a log file size reaches 20 KB:

>domain_template.exe -u DomainTemplate -log_bysize 20

-log_bytime

daily|weekl y|monthly

Enables/Disables log on a timely basis.

Is daily by default.

To enable daily log rotation on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -log_bytime daily

-log_max_num

Limits the maximum number of stored log file instances.

To restrict the maximum number of stored log file instances for domains created with the template DomainTemplate to 5:

>domain_template.exe -u DomainTemplate log_max_num 5

log_compress

true|false

Enables/Disables log files compression.

Is false by default.

To enable log files compression for domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate log_compress false

-log_email

<email>

Enables/Disables sending processed log files to specified email address.

To enable sending the log files for domains created with template DomainTemplate to domainadmin@example.com :

>domain_template.exe -u DomainTemplate -log_email domainadmin@example.com

100 Using Command Line Utilities

Option

Parameter

Description

Example

keep_traf_st at

Sets the system to retain traffic statistics for specified amount of months.

All statistics retained on domain if set to 0.

To retain traffic statistics on domains created with the template DomainTemplate for 5 months:

>domain_template.exe -u DomainTemplate keep_traf_stat 5

-maillist

true|false

Enables/Disables managing mailing lists.

Is false by default.

To enable managing mailing lists on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -maillist true

dns_zone_typ e

master|slav e

Specifies whether Plesk DNS server should act as master or slave for domain's DNS zone.

Is master by default.

To set the Plesk DNS server to act as slave DNS server on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate dns_zone_type slave

-hosting

true|false

Enables/Disables managing physical hosting.

Is false by default.

To enable managing physical hosting on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -hosting true

-quota

<MB>

Limits the amount of available disk space.

Unlimited if set to 0.

To restrict the disk quota available for domains created with the template DomainTemplate to 100 MB:

>domain_template.exe -u DomainTemplate -quota 100

-sb_publish

true|false

Allows/Prohibits publishing sites with Sitebuilder.

Is false by default.

To allow publishing sites with Sitebuilder on domains created with the template DomainTemplate :

>domain_template.exe -u DomainTemplate -sb_publish true

sb_subdomain s_create

true|false

Allows/Prohibits subdomains blog and photo gallery to be automatically created.

Is false by default.

Deprecated since Plesk 8.4.

To allow creation of the blog and photo subdomains on domains

created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate sb_subdomains_create true

-ssl

true|false

Enables/Disables SSL support.

Is false by default.

To enable SSL support on domains created with the template DomainTemplate:

>domain_template.exe -u DomainTemplate -ssl true

Parallels Plesk Panel Reference Guide

Specifications and Main Features

Frequently Asked Questions

User Manual