The components utility allows you to manage Windows server components.

You can use this utility to enable and disable components, as well as assign application packages to a component.

You can also use this utility to update an application package.

Location

%plesk_cli%

Usage 

components <command> [
<option_1> [<param>]
[<option_2> [<param>]]
]

Examples

The following command lists all components and their associated packages:

plesk bin components --list

The following command assigns the drweb package to the antivirus component, so that subscriptions can use Dr. Web’s Premium Antivirus as their antivirus.

plesk bin components --set-package -component antivirus -package drweb

The following command shows all configuration parameters for the smartermail_remote package:

plesk bin components --show-package-parameters -package smartermail_remote

The following command configures the SmarterMail package to accept the example credentials:

plesk bin components --set-package-parameters -package smartermail_remote 'host=localhost' 'login=example' 'password=123456'

Commands

Command Parameter Description Example
--help or -h   Displays help on the utility usage.

To view help on the use of this utility:

plesk bin components --help

--list or -l   Lists all information from all components.

To list all components’ information:

plesk bin components --list

--show-package-parameters   Shows all available configuration parameters for a specific package.

To show all configuration parameters for the smartermail_remote package:

plesk bin components --show-package-parameters -package smartermail_remote

--set-package-parameters   Sets the parameters of a specific package.

To configure the SmarterMail package to accept the following credentials:

plesk bin components --set-package-parameters -package smartermail_remote 'host=localhost' 'login=example' 'password=123456'

--set-package or -s   Assigns a specific package to a component.

To assign the drweb package to the antivirus component, so that subscriptions can use Dr. Web’s Premium Antivirus as their antivirus.

plesk bin components --set-package -component antivirus -package drweb

Options

Option Parameter Description Example
-component  

Specifies the component to modify.

Used with --set-package.

To assign the drweb package to the antivirus component, so that subscriptions can use Dr. Web’s Premium Antivirus as their antivirus.

plesk bin components --set-package -component antivirus -package drweb

-package  

Specifies the package to modify.

Used with --set-package, --show-package-parameters, --set-package-parameters.

To disable the drweb package globally:

plesk bin components --set-package -package drweb -disable

-enable  

Enables a package. If a component is not specified, the component is enabled globally.

Used with --set-package.

To enable the smartermail_remote package for the email component:

plesk bin components --set-package -package smartermail_remote -enable

-disable  

Disables a package. If a component is not specified, the component is disabled globally.

Used with --set-package.

To disable the smartermail_remote package globally:

plesk bin components --set-package -package smartermail_remote -disable

Package-Specific Parameters

The --show-package-parameters parameter returns package-specific parameters, including both required and optional parameters. The return will resemble the following example:

plesk bin components --show-package-parameters -package smartermail_remote

Required parameters:

  • host (string) - Hostname (current: localhost)
  • login (string) - User login (current: example)
  • password (string) - Login Password (current: ***)
  • port (int) - Port (current: 111)

Optional parameters:

  • ssl (bool) - HTTPS protocol (current: false)
  • ssl_cert_failure_check (bool) - Check SSL certificate (current: true)

These parameters show their data types and current statuses. They can be modified with the --set-package-parameters parameter by adding an updated value of the correct data type.

For example, the following command modifies the smartermail_remote package to use the HTTPS protocol to connect securely:

plesk bin components --set-package-parameters -package smartermail_remote 'ssl:true'