reseller: Reseller Accounts

The reseller 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
  • editing reseller's personal information, login name and password
  • converting a reseller account to a customer account

 

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

plesk bin reseller --create JDoe -name "John Doe" -passwd sample -country US -service-plan "Gold"

Commands
Command Parameter Description Example

--create or -c

<login>

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 utility. For example, run ./service_plan -def -owner <reseller_name> to create the Default Domain plan.

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.

plesk bin reseller --create JDoe -name "John Doe" -passwd sample -country US -service-plan "Gold"

 

--update or -u

<login>

Updates settings of an existing reseller account.

To change reseller login name to John and set password to mypass for the reseller with the current login name JDoe :

plesk bin reseller --update JDoe -login John -passwd mypass

or

plesk bin reseller -u JDoe -login John -passwd mypass

--remove or -r

<login>

Deletes a reseller account.

To remove the reseller account with the login name JDoe:

plesk bin reseller --remove JDoe

or

plesk bin reseller -r JDoe

--info or -i

<login>

Displays information about reseller account settings.

To view information about the reseller account with the login name John:

plesk bin reseller --info John

or

plesk bin reseller -i John

--on

<login>

Enables a reseller account.

To enable the reseller account with the login name John:

plesk bin reseller --on John

--off

<login>

Disables a reseller account.

To disable the reseller account with the login name John:

plesk bin reseller --off John

--lock-subscription

<login>

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:

plesk bin reseller --lock-subscription John

--unlock-subscription

<login>

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:

plesk bin reseller --unlock-subscription John

--no-subscription

<login>

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:

plesk bin reseller --no-subscription John

--switch-subscription

<login>

Subscribes a reseller to the specified plan.

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

plesk bin reseller --switch-subscription John -service-plan "Gold"

--sync-subscription

<login>

Synchronizes reseller's subscription with a plan.

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

plesk bin reseller --sync-subscription John

--convert-to-customer

<login_name>

Converts a reseller account into a customer account. If no plan specified, the Custom plan will be used for the new customer.

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

plesk bin reseller --convert-to-customer JDoe

--enable-aps-filter

<login>

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:

plesk bin reseller --enable-aps-filter "JDoe"

 

plesk bin reseller --add-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "wordpress"

--add-aps-filter-item

<login>

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:

plesk bin reseller --add-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--remove-aps-filter-item

<login>

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:

plesk bin reseller --remove-aps-filter-item "JDoe" -aps-filter-item-name name -aps-filter-item-value "advancedpoll"

--disable-aps-filter

<login>

Disables the APS applications filter and removes all its items.

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

plesk bin reseller --disable-aps-filter "JDoe"

--show-aps-filter-info

<login>

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:

plesk bin reseller --show-aps-filter-info "JDoe"

--help or -h

 

Displays help on the use of the utility.

To view help on the utility:

plesk bin reseller --help

or

plesk bin reseller -h

Options
Option Parameter Description Example

-company

<string>

Specifies reseller's company name.

To set the company name in the personal info of the reseller with the login name John to MegaCompany Inc.:

plesk bin reseller -u John -company "MegaCompany Inc."

-name

<string>

Specifies reseller's contact name.

Required with --create.

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

plesk bin reseller -c JDoe -name "John Doe" -passwd sample

-login

<login>

Specifies reseller's login name used to entering Plesk.

Used with --update only.

To set reseller login name to John for the reseller account with current login name JDoe:

plesk bin reseller -u JDoe -login John

-passwd

<password>

Specifies reseller's password used to entering Plesk.

Required with the --create command.

Required with -passwd_type option.

For additional comments, see the Note below.

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

plesk bin reseller -c 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:

plesk bin reseller -u JDoe -passwd_type encrypted -passwd '$1$R0x0hAmB$haReJwgGDaGOuFETdjv3P0'

-phone

<number>

Specifies reseller's phone number.

To set the phone number for the reseller with the login name JDoe to 5552345:

plesk bin reseller -u JDoe -phone 5552345

-fax

<number>

Specifies reseller's fax number.

To set the fax number for the reseller with the login name JDoe to 5552337:

plesk bin reseller -u JDoe -fax 5552337

-email

<string>

Specifies reseller's email address.

To set the email address for the reseller with the login name JDoe to JDoe@example.com:

plesk bin reseller -u JDoe -email JDoe@example.com

-address

<string>

Specifies reseller's postal address.

To set the postal address for the reseller with the login name JDoe to 8 Main street:

plesk bin reseller -u JDoe -address "8 Main street"

-city

<string>

Specifies reseller's city.

To set the city address for the reseller with the login name JDoe to New York:

plesk bin reseller -u JDoe -city "New York"

-state

<string>

Specifies reseller's state/province.

To set the state for the reseller with the login name JDoe to NY:

plesk bin reseller -u 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:

plesk bin reseller -u JDoe -zip 52345

-country

<country_code>

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

To set the country for the reseller with the login name JDoe to United States:

plesk bin reseller -u JDoe -country US

-notify

true|false

Allows/Prevents standard email notifications on reseller account creation.

Used with the --create only.

To prevent sending standard email notifications on creating John Doe reseller account with the login name JDoe and password sample:

plesk bin reseller -c JDoe -name "John Doe" -passwd sample -notify false

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

plesk bin reseller -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:

plesk bin reseller -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:

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

-creation-date

<YYYY-MM-DD>

Sets the reseller account creation date (can be arbitrary).

Used only with the --create command.

To set the creation date for the new John Doe reseller account with the login name JDoe and password sample to 2008-12-30:

plesk bin reseller -c JDoe -name "John Doe" -passwd sample -creation-date 2008-12-30

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

plesk bin reseller --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.

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

plesk bin reseller --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:

plesk bin reseller -u JDoe -description "Notes about John Doe"

Note: Use of the -passwd option is not recommended. Passing passwords through CLI as parameters of this option may potentially compromise the system's security as command line can be observed by other users of the system. It is more secure to pass passwords through the environment variables. You can transfer non-encrypted passwords by using environment variable PSA_PASSWORD while using single quotes to specify the empty values in the command line for the argument of the -passwd option.
Similarly, you can transfer encrypted passwords through the environment variable PSA_CRYPTED_PASSWORD while using single quotes to specify the empty values in the command line for the argument of the -passwd option.

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.