webuser.exe: Web User Accounts

The webuser utility is used to manage web users accounts through CLI. By using this utility, you can perform the following tasks:

  • creating and removing web user accounts
  • viewing the information about web user accounts
  • changing the web user account limits and preferences such as disk space limit, scripting languages support, and login data.

    Note:You can change scripting preferences (PHP support, CGI support, etc.) only if execution of scripts is allowed for web users by domain administrator and if web hosting settings on the domain allow to modify these preferences. For details on how to adjust web hosting settings and web users scripting permissions, refer to the Domain Accounts: domain.exe section.

Location

%plesk_cli%

Usage
webuser.exe <command> [<login name>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
]

Example

The following command creates the web user account with login name johndoe and password userpass on the domain example.com, enables the PHP support for the web user, and restricts amount of disk space for the web user to 100 MB.

webuser.exe --create johndoe -domain example.com -passwd userpass -php true -quota 100M

Commands
Command Parameter Description Example

--create or -c

<login_name>

Creates a web user account.

Requires the -passwd and -domain options.

To create the web user account with the login name johndoe and password userpass on the domain example.com:

webuser.exe --create johndoe -domain example.com -passwd userpass

or

webuser.exe -c johndoe -domain example.com -passwd userpass

--update or -u

<login_name>

Updates an existing web user account with data specified by the options.

To enable PHP support for the web user account with the login name johndoe:

webuser.exe --update johndoe -php true

or

webuser.exe -u johndoe -php true

--remove or -r

<login_name>

Removes a web user account.

To remove the johndoe account:

webuser.exe --remove johndoe

or

webuser.exe -r johndoe

--info or -i

<login_name>

Displays information about a web user account.

To view information about the web user account with the login name johndoe:

webuser.exe --info johndoe

or

webuser.exe -i johndoe

--help or -h

 

Displays help on the use of the utility.

To view the help info on the use of this utility:

webuser.exe --help

or

webuser.exe -h

Options

Note: These options except for -domain are used with --update and --create operations only. The -domain option is used with --create only.

Option Parameter Description Example

-domain

<domain_name>

Specifies name of a domain to which a web user account belongs.

Required with --create.

To create the web user with the login name johndoe and password userpass on the domain example.com:

webuser.exe -c johndoe -domain example.com -passwd userpass

-passwd

<password>

Sets web user password.

Required with --create.

See additional comments in the Note below the table.

To change the password for the web user account with the login name johndoe to sample:

webuser.exe -u johndoe -domain example.com -passwd sample

-passwd_type

plain|
encrypted

Specifies the type of a web user password.

Is plain by default.

To set the type of web user password for the web user with the login name johndoe on the domain example.com to encrypted:

webuser.exe -u johndoe -domain example.com -passwd_type encrypted

-quota

<number>[B|K|M|G|T]

Sets the hard disk quota for a web user account.

Unlimited if set to 0.

A number without a letter is interpreted as the number of megabytes.

To set 50 MB hard disk quota for the web user with login name Michael:

webuser.exe -u Michael -domain example.com -quota 50M

or

webuser.exe -u Michael -domain example.com -quota 50

-ssi

true|false

Enables or disables SSI support on a web user account.

Is false by default.

To enable SSI support for johndoe :

webuser.exe -u johndoe -ssi true

-php

true|false

Enables or disables PHP support on a web user account.

Is false by default.

To enable PHP support for johndoe:

webuser.exe -u johndoe -php true

-cgi

true|false

Enables or disables CGI support on a web user account.

Is false by default.

To enable CGI support for johndoe:

webuser.exe -u johndoe -cgi true

-perl

true|false

Enables or disables Perl support on a web user account.

Is false by default.

To enable Perl support for johndoe:

webuser.exe -u johndoe -perl true

-python

true|false

Enables or disables Python support on a web user account.

Is false by default.

To enable Python support for johndoe:

webuser.exe -u johndoe -python true

-asp

true|false

Enables or disables support of ASP applications on a web user account.

Is false by default.

To enable ASP support for johndoe:

webuser.exe -u johndoe -asp true

-miva

true|false

Enables or disables the support for Miva on a web user account.

Is false by default.

To enable the support for Miva for the johndoe account:

webuser.exe -u johndoe -miva true

-write_modify

true|false

Enables or disables the additional write/modify permissions on a web user account.

If enabled, means granting the Plesk IIS user and IIS application pool user the full access permission for the httpdocs/ and httpsdocs/ files and subfolders of the corresponding domain.

This permission might be required for correct functioning of web applications. Note that this permission, when granted, might seriously compromise website security.

Is false by default.

To enable additional permissions for the johndoe account:

webuser.exe -u johndoe -write_modify true

-asp_dot_net

true|false

Enables or disables the support for APS.net applications on a web user account.

Is false by default.

To enable APS.net support for johndoe:

webuser.exe -u johndoe -asp_dot_net true

Note: Use of this option is not recommended. Passing passwords through CLI as parameters of the -passwd 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 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.