The client.exe utility is designed for the purpose of managing Plesk client accounts. The utility allows the following:
Syntax
client.exe <command> [<login_name>] [
<option1> <param> [<option2> <param>] … [<option N> <param>]
]
Example
The following command creates 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
Command |
Parameter |
Description |
Example |
|---|---|---|---|
|
|
creates client account |
To create an account for John Doe with login name johndoe and password sample: >client.exe --create johndoe -name "John Doe" -passwd "sample" |
|
|
updates client account |
To change John Doe's login to johnny and password to 12345: >client.exe --update johndoe -login "johnny" -passwd 12345 |
|
|
removes client account |
To remove John Doe's account: >client.exe --remove johndoe |
|
|
outputs client info |
To retrieve the info on the johndoe account: >client.exe --info johndoe |
|
|
enables client account |
To enable the johndoe account: >client.exe --on johndoe |
|
|
disables client account |
To disable the johndoe account: >client.exe --off johndoe |
|
|
displays help on the utility use |
>client.exe --help |
Options
Option |
Parameter |
Description |
Example |
|---|---|---|---|
|
|
enables/disables a client account (true by default) used with -- duplicates |
To disable John Doe's account: >client.exe --update johndoe -status false |
|
string |
specifies the name of client's company used with |
To update John Doe's info with company name: >client.exe --update johndoe -company "MegaCompany Inc." |
|
string |
specifies the client's contact name required by |
see the Example above |
|
|
specifies the client's login name used to entering Plesk control panel. used with |
To change John Doe's login to johnny: >client.exe --update johndoe -login "johnny" |
|
|
sets client password used to entering Plesk control panel required with |
To create the johndoe account for John Doe with the Sample password: >client.exe --create johndoe -name "John Doe" -passwd Sample |
|
|
sets client's phone number |
To change the phone number in the personal info of the johndoe account: >client.exe --update johndoe -phone 5552345678 |
|
|
sets client's fax number |
To change the fax number in the personal info of the johndoe account: >client.exe --update johndoe -fax 5556676677 |
|
|
sets client's email address |
To change the email address in the personal info of the johndoe account: >client.exe --update johndoe -email jd@jd.com |
|
|
sets client's postal address |
To change the postal address in the personal info of the johndoe account: >client.exe --update johndoe -addr "Elm str. 17" |
|
|
sets client's city |
To change the city in the personal info of the johndoe account: >client.exe --update johndoe -city "New York" |
|
|
sets client's state/province |
To change the state in the personal info of the johndoe account: >client.exe --update johndoe -state NY |
|
|
sets client's zip/postal code |
To change the zip code in the personal info of the johndoe account: >client.exe --update johndoe -pcode 77381 |
|
|
sets client's country: a two-letters upper-case code in compliance with ISO 3166
|
To change the country in the personal info of the johndoe account: >client.exe --update johndoe -country US |
|
|
enables/disables sending a notification on the client account creation used with |
see the Example above |
|
|
specifies whether the dedicated IIS application pool is provided for the client false by default |
To grant dedicated IIS application pool to the johndoe account: >client.exe --update johndoe -iis_app_pool true |
|
|
sets the maximum percent of CPU usage for the client's IIS application pool. used only if the 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 johndoe account to 5%: >client.exe --update johndoe -iis_app_pool true -cpu_usage 5 |
|
|
enables/disables synchronization with SiteBuilder 3.x when creating a new client set to used with available in Plesk 7.6 and later |
To create an account not synchronized with SiteBuilder 3.x: >client.exe --create johndoe -name "John Doe" -passwd MyPass -sb_sync false |