PLESK COMMAND LINE INTERFACE

Section 3.1.1 Managing Client Accounts 

3.1.1.1  Creating and modifying client accounts

3.1.1.1.1 Purpose

The client.sh and client_pref.sh utilities may be used for creating or removing client accounts, and for updating client properties.

3.1.1.1.2 Usage

Usage: client.sh command <login_name> [options]

Available commands and options:

Command Parameter Action
--create or -c <login_name> creates a new client account
--update or -u <login_name> updates a client account
--remove or -r <login_name> removes a client account
--info or -i <login_name> retrieves client information
--on <login_name> enables a client account
--off <login_name> disables a client account
--help or -h   displays help on the utility usage
Option Parameter Note
-status <true|false> enables/disables a client account (default: true)
-company <string> company name
-name <string> contact name (required for creation)
-login <login_name> control panel login name (may be used only with the wupdate command)
-passwd_type <plain|crypt> control panel password type
-passwd <passwd> control panel password (required for creation)
-phone <number> phone number
-fax <number> fax
-email <string> e-mail address
-addr <string> street
-city <string> city
-state <string> state/province
-pcode <string> postal/zip code
-country <string> country code (two alphabetic characters (see the standard ISO 3166))
-notify <true|false> enables/disables notification of client account creation


Usage: client_pref.sh command <login_name> [options]

Available commands and options:

Command Parameter Action
--update or -u login_name updates an existing client account
--info or -i login_name retrieves client information
--skin-list or -sl   displays a list of all skins
--help or -h   displays help on the utility usage
Option Parameter Note
-create_domains <true | false> allows a client to create domains
-manage_phosting <true | false> allows managing physical hosting
-change_limits <true | false> allows changing domain limits
-manage_dns <true | false> allows managing DNS
-manage_log <true | false> allows managing log rotation
-manage_crontab <true | false> allows managing Crontab (Scheduler)
-manage_anonftp <true | false> allows managing Anonymous FTP
-manage_webapps <true | false> allows managing Tomcat web applications
-manage_maillists <true | false> allows managing mailing lists
-manage_sh_access <true | false> allows managing system access
-manage_subdomains <true | false> allows managing subdomains
-manage_quota <true | false> allows changing hard disk quota
-make_dumps <true | false> allows using backup/restore functions
-max_dom <number> limits the number of available domains (-1 is unlimited)
-disk_space <number> limits the amount of available disk space to the specified value (in Megabytes)
-max_traffic <number> limits the amount of available traffic to the specified value (in Megabytes)
-max_box <number> limits the allowed number of mailboxes to the specified value
-mbox_quota <number> limits the mailbox quota to the specified size (in Kilobytes)
-max_redir <number> limits the number of mail redirects
-max_mg <number> limits the number of mail groups
-max_resp <number> limits the number of mail autoresponders
-max_wu <number> limits the number of web users
-max_db <number> limits the number of databases
-max_maillists <number> limits the number of mailing lists
-max_webapps <number> limits the number of allowed Tomcat web applications
-max_subdom <number> limits the number of subdomains
-expiration <date> limits the validity period of a client account
-ip_pool <add|del>:<ip1>,<ip2>,..,<ipN> adds/deletes IP addresses to/from the client's IP pool.
-language <string> sets interface language (e.g. "it" for Italian (see ISO 639))
-skin <string> sets interface skin (e.g. "WinXP Reloaded")
-multiple-sessions <true|false> allows multiple sessions


3.1.1.1.3 Examples

Creating a client account:
./client.sh --create "client1" -name "Client 1 contact name" -passwd "client_password"

Changing client's limits:
./client_pref.sh --update "client1" -disk_space 10

Removing a client account:
./client.sh --remove "client1"

to top