webuser: Web Users

The webuser utility is used to manage web users 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

Usage
webuser <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 the disk space for the web user to 100 MB.

plesk bin webuser --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 option.

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

plesk bin webuser --create johndoe -domain example.com -passwd userpass

or

plesk bin webuser -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 on the domain example.com:

plesk bin webuser --update johndoe -domain example.com -php true

or

plesk bin webuser -u johndoe -domain example.com -php true

--remove or -r

<login_
name>

Deletes a web user account.

To delete the web user account with the login name johndoe from domain example.com:

plesk bin webuser --remove johndoe -domain example.com

or

plesk bin webuser -r johndoe -domain example.com

--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 on the domain example.com:

plesk bin webuser --info johndoe -domain example.com

or

plesk bin webuser -i johndoe -domain example.com

--help or -h

 

Displays help on the use of the utility.

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

plesk bin webuser --help

or

plesk bin webuser -h

Options

Note: Options except for -domain are used with --create and --update operations only. Option -domain is required with all operations except for --help.

Option Parameter Description Example

-domain

<domain_
name>

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

Required for all commands, except for --help.

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

plesk bin webuser -c johndoe -domain example.com -passwd userpass

-passwd

<password>

Sets a 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 on domain example.com to sample:

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

plesk bin webuser -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 bytes.

To set 50 MB hard disk quota for the web user with login name Michael on domain example.com:

plesk bin webuser -u Michael -domain example.com -quota 50M

or

plesk bin webuser -u Michael -domain example.com -quota 50000K

-ssi

true|false

Enables/Disables SSI support on a web user account.

Is false by default.

To enable SSI support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -ssi true

-php

true|false

Enables/Disables PHP support on a web user account.

Is false by default.

To enable PHP support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -php true

-cgi

true|false

Enables/Disables CGI support on a web user account.

Is false by default.

To enable CGI support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -cgi true

-perl

true|false

Enables/Disables Perl support on a web user account.

Is false by default.

To enable Perl support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -perl true

-asp

true|false

Enables/Disables Apache ASP support on a web user account.

Is false by default.

To enable Apache ASP support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -asp true

-python

true|false

Enables/Disables Python support on a web user account.

Is false by default.

To enable Python support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -python true

-miva

true|false

Enables/Disables Miva support on a web user account.

Is false by default.

To enable Miva support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -miva true

-fastcgi

true|false

Enables/Disables FastCGI support on a web user account.

Is false by default.

To enable FastCGI support on the web user account with the login name johndoe on the domain example.com:

plesk bin webuser -u johndoe -domain example.com -fastcgi 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.