Previous page

Next page

Locate page

--create or -c

<login_name>

Creates a client account.

Requires -name and -passwd options.

If client owner is not specified, a created client belongs to Parallels Plesk Panel administrator.

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

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

or

>client.exe -c JohnDoe -name "John Doe" -passwd "sample" -owner RichardRoe

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

or

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

--remove or -r

<login_name>

Removes a client account.

To remove the client account with the login name JohnDoe:

>client.exe --remove JohnDoe

or

>client.exe -r 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

or

>client.exe -i 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

--convert-to-reseller or -t

<login_name>

Upgrades a specified client to a reseller.

Note: This command is available only for client accounts whose owner is Parallels Plesk Panel administrator.

Available since Plesk 9.0.

To upgrade the client with the login name JohnDoe to the reseller:

>client.exe --convert-to-reseller JDoe

or

>client.exe -t JDoe

--change-owner or -co

<login_name>

Assigns a new owner for a client.

Requires -owner option.

Available since Plesk 9.0.

To change the owner of the JDoe client account to the reseller with the login name RichardRoe:

>client.exe --change-owner JDoe -owner RichardRoe

or

>client.exe -co JDoe -owner RichardRoe

--create-gapps-account

<login_name>

Creates a Google Apps account with generated login and password for the specified client.

To create a Google Apps account for the client with the login name JDoe:

>client.exe --create-gapps-account JDoe

--link-gapps-account

<login_name>

Associates an existing Google Apps account with the specified client.

Requires -gapps-login and -gapps-passwd options.

To associate a Google Apps account with the login name JohnDoe and password userpass with the client with the login name JDoe:

>client.exe --link-gapps-account JDoe -gapps-login JohnDoe -gapps-passwd userpass

--unlink-gapps-account

<login_name>

Removes association of a Google Apps account with the specified client's account.

To dissociate a Google Apps account from the client with the login name JDoe:

>client.exe --unlink-gapps-account JDoe

--remove-gapps-account

<login_name>

Removes a Google Apps account for the specified client.

To remove a Google Apps account associated with the client with the login name JDoe:

>client.exe --remove-gapps-account JDoe

--help or -h

Displays help on the utility use.

To view help on the utility:

>client.exe --help

or

>client.exe -h

-status

enabled|disabled|admin,expired,reseller

Enables/Disables a client account (the enabled or disabled parameters, respectively).

Disables a client account and sets the account status to "Account is disabled by administrator" (admin), "Account is expired" (expired), or "Account is disabled by reseller" (reseller). These statuses can be used independently or combined (admin,expired or reseller,expired).

Is enabled by default.

To disable the client account with the login name JDoe and assign status "Account is disabled by administrator" to the account:

>client.exe -u JDoe -status admin,expired

To disable the client account with the login name JDoe and assign status "Account is disabled by reseller. Account is expired" to the account:

>client.exe -u JDoe -status reseller,expired

-company

<string>

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

<string>

Specifies a client's contact name.

Required with --create.

See the Example above.

-login

<login_name>

Specifies a client's login name.

Used with --update only.

To change the account login name from JohnDoe to John:

>client.exe --update JohnDoe -login John

-passwd

<password>

Specifies a client's password.

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

<number>

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

<number>

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

<string>

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

<string>

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

<string>

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

-pcode

<string>

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

<string>

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.

-template

<template_name>

Specifies a client template to be used for a client creation.

Used with the --create only.

To specify the template Client Template to create the John Doe client account with the login name JDoe and password sample for the reseller with the login name RichardRoe:

>client.exe -c JDoe -name "John Doe" -passwd sample -template "Client Template" -owner RichardRoe

-force

Forces the use of a client template to create a client account even if some of the template options cannot be implemented.

Used only with the --create command.

To force the use of the template Client Template to create the John Doe client account with the login name JDoe and password sample for Parallels Plesk Panel administrator:

>client.exe -c JDoe -name "John Doe" -passwd sample -template "Client Template" -force

-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

<number>

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

true|false

Allows/Prohibits creating a corresponding user account in Sitebuilder.

Is false by default.

To allow client with the login name JDoe to create user account in Sitebuilder:

>client.exe -u JDoe -sb-user true

-owner

<login_name>

Specifies the client owner login name.

Required with the --change-owner command.

Available since Parallels Plesk Panel 9.0.

To create a client account named John Doe with the login name JDoe and password sample for the reseller RichardRoe:

>client.exe -c JDoe -name "John Doe" -passwd sample -owner RichardRoe

To change the owner of the JDoe client account to Parallels Plesk Panel administrator:

>client.exe -co JDoe -owner admin

-gapps-login

<gapps_login>

Google Apps account login.

Required with --link-gapps-account.

To associate a Google Apps account with the login name JohnDoe and password userpass with the client with the login name JDoe:

>client.exe --link-gapps-account JDoe -gapps-login JohnDoe -gapps-passwd userpass

-gapps-passwd

<gapps_password>

Google Apps account password.

Required with --link-gapps-account.