role: User Roles

The role utility is used for managing roles for auxiliary Control Panel users.

Usage
role <command> [<login_name>] [
<option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]

Example

The following command creates a user role named webmaster for the customer with the username JDoe. The role allows the customer's users created by that role to manage websites under the customer's subscription.

plesk bin role --create webmaster -owner JDoe -webSitesAndDomainsManagement true

Commands
Command Parameter Description Example

--create or -c

<role name>

Creates a user role.

Requires the -owner option.

To create a role named webmaster for the customer with the username JDoe:

plesk bin role --create webmaster -owner JDoe -webSitesAndDomainsManagement true

or

plesk bin role -c webmaster -owner JDoe -webSitesAndDomainsManagement true

--update or -u

<role name>

Updates user role properties.

To revoke the permission to manage websites from the role webmaster created for the customer with the username JDoe:

plesk bin role --update webmaster -owner JDoe -webSitesAndDomainsManagement false

or

plesk bin role -u webmaster -owner JDoe -webSitesAndDomainsManagement false

--info or -i

<role name>

Displays information about a user role.

To retrieve information about a user role named webmaster created for the customer with the username JDoe:

plesk bin role --info webmaster -owner JDoe

or

plesk bin role -i webmaster -owner JDoe

--delete or -d

<role name>

Removes a user role.

To remove a user role named webmaster that was created for the customer with the username JDoe:

plesk bin role --delete webmaster -owner JDoe

or

plesk bin role -d webmaster -owner JDoe

--list-sp or -l

 

Shows the information about applications installed on a user's subscription.

The XML-formatted output contains the <permission-id> tags which enclose the ID number of the permission. You should use that ID number if you want to allow access to the application for a user role.

To view the information about applications installed on the subscription of the customer with username JDoe:

plesk bin role -l -owner JDoe

 

--update-sp or -s

<role name>

Updates permissions to access installed applications for a user role.

To allow the user role webmaster created for the customer with username JDoe to access the application with ID 3:

plesk bin role --update-sp webmaster -owner JDoe -servicePermissionId 3 -servicePermissionState true

--help or -h

 

Displays help on the utility use.

To view help on the use of this utility:

plesk bin role --help

or

plesk bin role -h

 

Options
Option Parameter Description Example

-servicePermissionId

<number>

ID of a permission to access and manage an installed application. Can be retrieved with the command --list-sp.

To allow the user role webmaster created for the customer with username JDoe to access the application with ID 3:

plesk bin role --update-sp webmaster -owner JDoe -servicePermissionId 3 -servicePermissionState true

-servicePermissionState

true|false

State of a permission (granted or prohibited).

-owner

<username>

The Panel user for which the role is created, modified, or removed.

To view the information about a user role named webmaster created for the customer with the username JDoe:

plesk bin role --info webmaster -owner JDoe

-userManagement

true|false

The permission to manage users and roles through Control Panel.

To grant the permission to manage users and roles to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - userManagement true

-webSitesAndDomainsManagement

true|false

The permission to create and manage websites through Control Panel.

To grant the permission to create and manage websites to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - webSitesAndDomainsManagement true

-logRotationManagement

true|false

The permission to manage log files and log recycling settings.

To grant the permission to manage log files to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - logRotationManagement true

-anonymousFtpManagement

true|false

The permission to set up FTP shares accessible to the Internet users without password authentication. Available only for subscriptions on dedicated IP addresses.

To grant the permission to set up an FTP share accessible without password to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - anonymousFtpManagement true

-scheduledTasksManagement

true|false

The permission to schedule execution of scripts on the server.

To grant the permission to schedule execution of scripts to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - scheduledTasksManagement true

-spamfilterManagement

true|false

The permission to configure spam filtering settings for individual accounts.

To grant the permission to adjust spam filter setting to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -spamfilterManagement true

-antivirusManagement

true|false

The permission to configure antivirus settings for individual accounts.

To grant the permission to configure antivirus settings to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -antivirusManagement true

-databasesManagement

true|false

The permission to create and manage databases.

To grant the permission to create and manage databases to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -databasesManagement true

-backupRestoreManagement

true|false

The permission to back up and restore websites by using the Control Panel's backup and restore functions.

To grant the permission to back up and restore sites to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -backupRestoreManagement true

-browseStats

true|false

The permission to view various statistics and account information shown on the Statistics tab of Control Panel.

To grant the permission to view statistics and account information to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -browseStats true

-applicationsManagement

true|false

The permission to install applications on websites.

To grant the permission to install applications to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -applicationsManagement true

-sitebuilderManagement

true|false

The permission to create and update sites with Presence Builder.

To grant the permission to create and update sites with Presence Builder to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -sitebuilderManagement true

-filesManagement

true|false

The permission to upload and manage files through Control Panel's File Manager.

To grant the permission to manage site files through File Manager to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - filesManagement true

-ftpAccountsManagement

true|false

The permission to set up and manage additional FTP accounts for access to the webspace.

To grant the permission to set up and manage additional FTP accounts to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - ftpAccountsManagement true

-dnsManagement

true|false

The permission to change DNS zone settings for websites.

To grant the permission to change DNS settings to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - dnsManagement true

-javaApplicationsManagement

true|false

The permission to install third-party Java applications packaged in WAR format.

To grant the permission to install Java applications to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - javaApplicationsManagement true

-mailManagement

true|false

The permission to create and manage mail accounts.

To grant the permission to create and manage mail accounts to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - mailManagement true

-mailListsManagement

true|false

The permission to create and manage mailing lists.

To grant the permission to create and manage mailing lists to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe - mailListsManagement true

-publishFilesOnTheWeb

true|false

The permission to share files with other users or anyone on the Web.

To grant the permission to share files to the role webmaster created for the customer with the username JDoe:

plesk bin role -u webmaster -owner JDoe -publishFilesOnTheWeb true

 

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.