Previous page Previous page

Next page Next page

Locate page Locate page

Print this page

Reseller Accounts: reseller.exe

The reseller.exe CL utility is used to manage Plesk resellers - Parallels Plesk Panel users who can own and administrate Parallels Plesk Panel domain and client accounts. By using this utility, you can perform the following tasks:

 

Location

%plesk_cli%

Usage

reseller.exe <command> [<login_name>] [
<option_1> [<param>]
[<option_2> [<param>]]
… [<option_N> [<param>]]

Example

The following command creates the reseller account with the contact name John Doe, Parallels Plesk Panel login name JDoe, and password sample, specifies the Unites States as the client's country, and prevents automatic sending of standard Parallels Plesk Panel mail notifications (if they are enabled) about the account creation.

>reseller.exe --create JDoe -name "John Doe" -passwd sample -country US -notify false

Commands

Command

Parameter

Description

Example

--create or -c

<login_name>

Creates a reseller account.

Requires -name and -passwd options.

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

>reseller.exe --create JDoe -name "John Doe" -passwd "sample"

or

>reseller.exe -c JDoe -name "John Doe" -passwd "sample"

--update or -u

<login_name>

Updates reseller account settings.

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

>reseller.exe --update JDoe -login John -passwd 12345

or

>reseller.exe -u JDoe -login John -passwd 12345

--remove or -r

<login_name>

Removes a reseller account.

To remove the reseller account with the login name JDoe:

>reseller.exe --remove JDoe

or

>reseller.exe -r JDoe

--info or -i

<login_name>

Displays reseller account general settings, and information on reseller's clients and domains.

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

>reseller.exe --info JDoe

or

>reseller.exe -i JDoe

--on

<login_name>

Enables a reseller account.

To enable the account with the login name JDoe:

>reseller.exe --on JDoe

--off

<login_name>

Disables a reseller account.

To disable the account with the login name JDoe:

>reseller.exe --off JDoe

--convert-to-client

or -t

<login_name>

Downgrades a specified reseller account to client account.

Note: A reseller account can be downgraded only if it doesn't have any client accounts.

To convert JDoe reseller account to client account:

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

or

>reseller.exe -t JDoe

--create-gapps-account

<login_name>

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

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

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

--link-gapps-account

<login_name>

Associates an existing Google Apps account with the specified reseller.

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

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

>reseller.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 reseller's account.

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

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

--remove-gapps-account

<login_name>

Removes a Google Apps account for the specified reseller.

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

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

--help or -h

 

Displays help on the utility use.

To view help on the use of this utility:

>reseller.exe --help

or

>reseller.exe -h

 

Options

Option

Parameter

Description

Example

-status

enabled|disabled|admin, expired

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

Disables a reseller account and sets the account status to "Account is disabled by administrator" (admin), or "Account is expired" (expired).

Is enabled by default.

To disable the reseller account with the login name JDoe, and set account status to "Account is disabled by administrator" :

>reseller.exe --update JDoe -status admin

-company

<string>

Specifies a reseller's company name.

To set company name in the personal info of the JDoe account to MegaCompany Inc.:

>reseller.exe --update JDoe -company "MegaCompany Inc."

-name

<string>

Specifies reseller's contact name.

Required with the --create command.

See the Example above.

-login

<login_name>

Specifies reseller's login name.

Used with the--update command only.

To change the account login name from JohnDoe to John:

>reseller.exe --update JohnDoe -login John

-passwd

<password>

Specifies reseller's password

Required with the --create command.

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

>reseller.exe --create JDoe -name "John Doe" -passwd sample

-phone

<number>

Specifies reseller's phone number.

To set phone number in the personal info of the reseller with the login name JDoe to 5552345678:

>reseller.exe --update JDoe -phone 5552345678

-fax

<number>

Specifies reseller's fax number.

To set fax number in the personal info of the reseller with the login name JDoe to 5556676677:

>reseller.exe --update JDoe -fax 5556676677

-email

<email>

Specifies reseller's email address.

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

>reseller.exe --update JDoe -email jd@example.com

-addr

<string>

Specifies reseller's postal address.

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

>reseller.exe --update JDoe -addr "Elm str. 17"

-city

<string>

Specifies reseller's city.

To set city in the personal info of the reseller with the login name JDoe to New York:

>reseller.exe --update JDoe -city "New York"

-state

<string>

Specifies reseller's state/province.

To set state in the personal info of the of the reseller with the login name JDoe to NY:

>reseller.exe --update JDoe -state NY

-country

<string>

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

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

>reseller.exe --update JohnDoe -country US

-notify

true|false

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

Used with the --create command only.

See the Example above.

-creation-date

<YYYY-MM-DD>

Specifies arbitrary date of reseller account creation.

To set date of the JDoe reseller account creation to February 5, 2008:

>reseller.exe -u JDoe -creation-date 2008-02-05

-sb-user

true|false

Creates Sitebuilder user account for a reseller account.

To create Sitebuilder user account for the JDoe reseller account:

>reseller.exe --update JDoe -sb-user true

-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 reseller with the login name JDoe:

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

-gapps-passwd

<gapps_password>

Google Apps account password.

Required with --link-gapps-account.