reseller.exe: Reseller Accounts

The reseller.exe utility is used to manage resellers - the Plesk users who can host their own sites and resell hosting services to their own customers. By using this utility, you can perform the following tasks:

  • creating and removing reseller accounts
  • enabling and disabling existing reseller accounts
  • updating reseller's personal information, login name and password
  • converting a reseller account into a customer account

 

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, Plesk login name JDoe, and password sample, specifies the Unites States as the reseller’s country, and subscribes the reseller to the reseller plan Gold.

reseller.exe --create JDoe -name "John Doe" -passwd sample -country US -service-plan "Gold"

Commands
Command Parameter Description Example

--create or -c

<login_name>

Creates a reseller account.

Requires -name and -passwd options.

You should also use the option -service-plan <plan name> if you want to subscribe a reseller to an existing reseller plan. If you omit the option -service-plan <plan name>, a reseller account will be created, but will be assigned a custom service subscription that does not provide any resources and permissions for operations in Plesk.

Note: Reseller accounts created with this command do not have their own service plans. To create the plans, use the service_plan.exe utility. For example, run >service_plan.exe -def -owner <reseller_name> to create the Default Domain plan.

The following command creates the reseller account with the contact name John Doe, Panel login name JDoe, and password sample, specifies the Unites States as the reseller's country, and subscribes the reseller to the reseller plan Gold.

reseller.exe --create JDoe -name "John Doe" -passwd sample -country US -service-plan "Gold"

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

--lock-subscription

<login_name>

Locks reseller's subscription for syncing with a service plan.

To prevent a subscription of the reseller with username John from synchronization with a service plan:

reseller.exe --lock-subscription John

--unlock-subscription

<login_name>

Unlocks reseller's subscription and enables synchronization with associated service plans.

To unlock a subscription of reseller with username John and enable synchronization with a service plan:

reseller.exe --unlock-subscription John

--no-subscription

<login_name>

Unbinds a reseller's subscription from service plan and makes it a custom subscription.

To unbind a subscription of reseller with username John from a service plan:

reseller.exe --no-subscription John

--switch-subscription

<login_name>

Subscribes a reseller to the specified plan.

To subscribe a reseller with username John to a service plan Gold:

reseller.exe --switch-subscription John -service-plan "Gold"

--sync-subscription

<login_name>

Synchronizes reseller's subscription with a plan.

To synchronize the subscription of a reseller with username John with the associated service plan:

reseller.exe --sync-subscription John

--convert-to-customer

<login_name>

Converts a reseller account into customer account.

To convert into customer the reseller account that has the username JDoe:

>reseller --convert-to-customer JDoe

--enable-aps-filter

<login_name>

Enables the APS applications filter for the specified reseller account. A filter restricts the number of applications available for installation on websites.

If an applications filter is not enabled (configured), then the reseller can install all applications available from the Application Catalog + those that were uploaded to the server by the administrator and marked as available for installation.

 

To switch on the application filter and restrict the number of applications available for installation by reseller JDoe to a single application named WordPress, use the following two commands:

reseller.exe --enable-aps-filter "JDoe"

 

reseller.exe --add-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "wordpress"

--add-aps-filter-item

<login_name>

Adds an application to the list of applications allowed for installation.

This command can be used with the following options:

-aps-filter-item-name

-aps-filter-item-value

To add the application AdvancedPoll identified by the system by the name "advancedpoll" to the list of applications allowed for installation by reseller JDoe:

reseller.exe --add-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--remove-aps-filter-item

<login_name>

Removes an APS application from the list of applications available for installation.

To remove the application named "advancedpoll" from the list of applications available for installation by reseller JDoe:

reseller.exe --remove-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--disable-aps-filter

<login_name>

Disables the APS applications filter and removes all its items.

To let the reseller JDoe to install all available applications without restrictions:

reseller.exe --disable-aps-filter "JDoe"

--show-aps-filter-info

<login_name>

Shows information on the active APS applications filter. If an applications filter is disabled, then the subscriber can install all applications available from the Application Catalog + those that were uploaded to the server by the administrator and marked as available for installation.

To check if application filtering is enabled for the reseller JDoe:

reseller.exe --show-aps-filter-info "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

-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

-passwd_type

plain|encrypted

Specifies type of reseller password.

Requires -passwd option.

Is plain by default.

To set the type of the password for the reseller account with the login name JDoe and password sample to encrypted:

reseller.exe -u JDoe -passwd_type encrypted -passwd '$1$R0x0hAmB$haReJwgGDaGOuFETdjv3P0'

-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

-address

<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

-zip

<string>

Specifies reseller's zip/postal code.

To set the postal code for the reseller with the login name JDoe to 52345:

reseller.exe --update JDoe -zip 52345

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

-service-plan

<plan_name>

Specifies a reseller plan to be used for a reseller account creation.

 

The following command creates a reseller account for John Doe based on Reseller Plan 1, sets the username JDoe and password sample:

reseller.exe -c JDoe -name "John Doe" -passwd sample -service-plan "Reseller Plan 1"

-force

 

Creates subscription to the specified service plan even if the system does not currently provide sufficient amount of resources.

Used only with the --create command.

The following command forces creation of a reseller account for John Doe based on Reseller Plan 1, sets the username JDoe and password sample:

reseller.exe -c JDoe -name "John Doe" -passwd sample -service-plan "Reseller Plan 1" -force

-force-lock

 

Creates subscription to the specified service plan even if the system does not currently provide sufficient amount of resources. After creating, the subscription is locked for syncing with the plan (prevented from synchronization with it).

The following command forces creation of a reseller account for John Doe based on Reseller Plan 1, sets the username JDoe and password sample, and locks the subscription for syncing with plan:

reseller.exe -c JDoe -name "John Doe" -passwd sample -service-plan "Reseller Plan 1" -force-lock

-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

-plan-name

<string>

Specifies the service plan that will be used for a customer account that was converted from a reseller account.

To convert the reseller account that has the username JDoe into a customer account and to assign the plan Default Domain to the new customer account:

reseller.exe --convert-to-customer JDoe -plan "Default Domain"

-description

<string>

Specifies the description of the reseller that will be displayed in Plesk and visible to the Plesk administrator.

To add a description to the reseller account JDoe:

>reseller -u JDoe -description "Notes about John Doe"

-aps-filter-item-name

<name|URL>

Specifies identifier of APS applications filter item: whether the filtered app is identified in Plesk by name or URL.

The option to identify an application by URL is reserved for future uses and is not currently available.

To add an application AdvancedPoll identified by the system by the name "advancedpoll" to the list of applications allowed for installation by the reseller JDoe:

reseller.exe --add-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

-aps-filter-item-value

<value>

Specifies the actual name or URL of the filtered APS app.

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.