> For the complete documentation index, see [llms.txt](https://docs.enginsight.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.enginsight.com/docs/manual/english/platform-usage/hosts/management/plugins/add-plugin.md). # Add Plugin :computer-mouse: Click :plus: **Add Plugin** in the upper-right corner of the [plugin overview](/docs/manual/english/platform-usage/hosts/management/plugins.md#plugin-overview) to create a new plugin. The **Hosts** → **Plugins** → **Add** view opens.
:computer-mouse: Click **Add Plugin** after configuring all settings to create the new plugin. :computer-mouse: Click **Back** to return to the overview. {% hint style="danger" %} **Please note:** If you leave this view without clicking **Add Plugin**, all settings configured so far will be lost permanently. {% endhint %} *** ## General Settings Here you can configure various basic settings.
The following options are available:
OptionDescription
NameEnter a meaningful name for the plugin.
Description

Provide a more detailed description of the plugin.

This field is optional.

Scripting Language

Define the scripting language for the plugin script.

The default scripting language is Bash (Shell).

:computer-mouse: Click the Scripting Language field to show a list of all available scripting languages.

The following scripting languages are available:

  • Bash (Shell)
  • Python 3
  • PowerShell
Code Field

Paste the script into the code field.

Please note: The script code must match the selected scripting language.

*** ## Extracted Fields Optionally, you can extract fields from the plugin script that can be visualized as [custom metrics](/docs/manual/english/platform-usage/host-detail-view/monitoring/custom-metrics.md) in the host detail view.
You can find templates for the three available scripting languages here: * [PowerShell](https://github.com/enginsight/powershell-cm-template/blob/master/setup.ps1) * [Bash](https://github.com/enginsight/bash-cm-template/blob/master/setup.sh) * [Python](https://github.com/enginsight/python-cm-template/blob/master/setup.py) Once a plugin has been executed, the name and type of the extracted fields are shown in the respective [plugin edit view](/docs/manual/english/platform-usage/hosts/management/plugins.md#plugin-edit-view).
:pen: Optionally add a description for each extracted field and click **Save Changes** to apply the changes. *** ## Advanced Settings :computer-mouse: Click the **Advanced Settings** field to show further options.
### Scheduled Execution This setting allows the plugin to be executed automatically at regular intervals according to a custom schedule. :computer-mouse: Select the checkbox :square: next to **Scheduled Execution** to run the plugin automatically at a defined interval. This opens the time interval selection (see below), which allows you to create a custom execution schedule.
The following options are available:
OptionDescription
Time Zone

Define the time zone that you want to use for the selected time interval.

:computer-mouse: Click the Time Zone field to expand a list of all available time zones, and select a time zone.

Cron Expression (Vixie/Unix)Shows the defined interval as a cron expression. The cron expression is updated automatically whenever you configure a time interval manually.

:computer-mouse: Click the Cron Expression field to edit the cron expression manually.
Next Execution (Local Time Zone)Shows the exact date and time of the next execution in your browser’s local time zone.
DescriptionShows the defined interval for recurring execution as a plain-language description.
Time Interval Selection

Define a custom execution interval.


Select the relevant minutes, hours, days of the month, months, or days of the week.

### Assigned Hosts Here you can define the hosts or groups of hosts to which the configured settings should apply.
The following options are available:
OptionDescription
Hosts

Define the hosts to which the configured settings should apply.

:computer-mouse: Click the Hosts field to expand a list of all available hosts, then select one or more hosts. Alternatively, use the free-text search to find hosts in the list more quickly.

:computer-mouse: Click the Remove icon :circle-xmark: next to an added host to remove it from the Hosts field.

Tag Logic

Define how many tags an assigned host must have for the settings to apply to it.

The default tag logic is All Tags are Present in the Reference.

:computer-mouse: Click the Tag Logic field to expand a list of all available options.

The following options are available:

  • All Tags are Present in the Reference: An assigned host must have all specified tags for the settings to apply to it.
  • At Least One of the Specified Tags is Present: An assigned host must have at least one of the specified tags for the settings to apply to it.
Tags

Define tags for groups of hosts to which the configured settings should apply.

:computer-mouse: Click the Tags field to expand a list of all available tags, then select one or more tags. Alternatively, use the free-text search to find tags in the list more quickly.

:computer-mouse: Click the Remove icon :circle-xmark: next to an added tag to remove it from the Tags field.

#### Excluded Hosts Here you can define which hosts or groups of hosts should be explicitly excluded from the configured settings. {% hint style="info" %} Defining excluded hosts is optional. {% endhint %} :computer-mouse: Click :plus: **Define Exceptions** next to **Assigned Hosts** to show the options for **Excluded Hosts**.
:gear: Configure all settings as described for an assigned host. *** ### Unprivileged Plugin Execution This setting allows you to run plugins in unprivileged mode, meaning without administrator privileges on Windows or root privileges on Linux. To do this, corresponding accounts with limited permissions are created on the host. :computer-mouse: Select the checkbox :square: next to **Unprivileged Plugin Execution** and confirm the prompt that appears with **Confirm** to execute the plugin with limited permissions. {% hint style="success" icon="lightbulb" %} For more information on how plugin execution in unprivileged mode works, see our Knowledge Base: [How can I execute plugins in unprivileged mode in Enginsight?](https://docs.enginsight.com/docs/knowledge-base/english/plugins/how-can-i-run-plugins-in-unprivileged-mode-in-enginsight) {% endhint %} *** ## Further Resources **Knowledge Base** * [How can I execute plugins in unprivileged mode in Enginsight?](https://docs.enginsight.com/docs/knowledge-base/english/plugins/how-can-i-run-plugins-in-unprivileged-mode-in-enginsight) ***