> 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.md).

# Plugins

Plugins allow you to execute custom scripts on assigned hosts either in response to a specific system event or according to a defined schedule.

Script execution is handled by the Pulsar installed on the respective host.

{% hint style="danger" %}
**Please note:** To execute custom scripts on your hosts, you must first enable the **Plugins** option either in the [settings of individual hosts](/docs/manual/english/platform-usage/host-detail-view/settings.md#core-feature) or via a [corresponding policy](/docs/manual/english/platform-usage/hosts/management/policy-manager/add-policy-manager.md#plugins) under **Hosts** → **Policy Manager**.
{% endhint %}

{% hint style="success" icon="lightbulb" %}
Various plugin templates are also available in the [Enginsight Github](https://github.com/enginsight) repository.
{% endhint %}

***

<i class="fa-compass">:compass:</i> Navigate to **Hosts** → **Plugins** to show a list of all configured plugins. If you have not yet created any plugins, this view will be empty.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FdqKWu5uXHXVfSY4x4c93%2FEnginsight-EN-Hosts-Plugins-Full.jpg?alt=media&amp;token=3a0e9811-1f9d-458c-ac3f-14b8e7683d50" alt=""><figcaption></figcaption></figure>

The [plugin overview](#plugins-overview) provides information such as:

* which plugin is executed on which hosts and at what interval.
* which fields are extracted from the plugin and can be visualized as [custom metrics](/docs/manual/english/platform-usage/host-detail-view/monitoring/custom-metrics.md) in the host detail view.
* which scripting language is used by the plugin.

You can also [create new plugins](/docs/manual/english/platform-usage/hosts/management/plugins/add-plugin.md).

***

## Navigation

<i class="fa-magnifying-glass">:magnifying-glass:</i> Click the **Text Search** field above the list and enter a search term of your choice to find specific list items more quickly.

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Refresh** icon <i class="fa-arrows-rotate-reverse">:arrows-rotate-reverse:</i> above the list to update all list items.

<i class="fa-computer-mouse-scrollwheel">:computer-mouse-scrollwheel:</i> Scroll down the list or adjust the number of results shown per page ![](https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FfjKACCt2SKXcFd3S7Xb5%2FEnginsight-EN-Results%20per%20Page.jpg?alt=media\&token=e1650160-7a41-4965-aaca-6975db758dbe) to view additional entries. Use the page navigation ![](https://content.gitbook.com/content/V7OrHgKXA0t1jankQBYf/blobs/wnxVw06QGoSsYjhwMJRF/Enginsight-Seitennavigation-2.jpg) to switch between pages.&#x20;

### Filtering the List

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Filter** icon <i class="fa-filter">:filter:</i> above the list to filter the list by predefined parameters.

<details>

<summary>Available Filters</summary>

<table><thead><tr><th width="206.60546875">Parameter</th><th width="116.515625">Type</th><th>Description</th></tr></thead><tbody><tr><td>Extracted Fields</td><td>String</td><td>Filter for plugins that contain specific fields extracted from the plugin script, or exclude them from the results. All available extracted fields are shown.</td></tr><tr><td>Scheduled Execution</td><td>Boolean</td><td><p>Filter based on whether a scheduled execution has been configured.<br><br>The following values are available:</p><ul><li><strong>True</strong>: A schedule has been configured.</li><li><strong>False</strong>: No schedule has been configured.</li></ul></td></tr><tr><td>Scripting Language</td><td>String</td><td>Filter for plugins that use a specific scripting language, or exclude them from the results. All available scripting languages are shown.</td></tr></tbody></table>

</details>

### Sorting List Items

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Sort** icon <i class="fa-sort">:sort:</i> next to a column name in the table header to sort by that column in ascending <i class="fa-angle-up">:angle-up:</i> or descending order <i class="fa-chevron-down">:chevron-down:</i> .

<i class="fa-computer-mouse">:computer-mouse:</i> Click the sort icon <i class="fa-bars-sort">:bars-sort:</i> above the list to adjust the priority of the applied sorting. A menu opens that shows all columns by which the list is currently sorted. Drag and drop the shown items to change the sorting priority.

### Deleting List Items

<i class="fa-computer-mouse">:computer-mouse:</i> Select the checkbox <i class="fa-square">:square:</i> next to a list item to select the corresponding item. Alternatively, select the checkbox in the table header to select all list items.

The number of selected list entries is now displayed next to the search field.

The **Delete** button <i class="fa-trash">:trash:</i> also appears in the upper-right corner. Click it, then confirm the message that appears by clicking **Delete**.

{% hint style="danger" %}
**Please note:** Deleted items cannot be restored.
{% endhint %}

***

## Plugins: Overview

The plugin overview is structured as a table.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FSDJEmxNTAiSdBj1waTuk%2FEnginsight-EN-Hosts-Plugins-Overview.jpg?alt=media&amp;token=23671e82-cac8-4ae4-9734-a504fab3a7b5" alt=""><figcaption></figcaption></figure>

The following information is shown:

<table><thead><tr><th width="200.37890625">Column</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>Displays the custom name of the plugin and an additional description, if available. The date and time it was created and it was last edited are also shown.<br><br>If a <a href="/docs/manual/english/platform-usage/hosts/management/plugins/add-plugin.md#scheduled-execution">scheduled execution</a> has been configured, the associated cron expression and time zone are shown as well.<br><br><i class="fa-computer-mouse">:computer-mouse:</i> Click the plugin name to open the respective <a href="#plugin-edit-view">edit view</a>, where you can adjust configured settings and delete the plugin. You can also see an <a href="#plugin-execution-overview">overview of previous plugin executions</a>.</td></tr><tr><td>Assigned Hosts</td><td><p>Shows the names of hosts on which the plugin should be executed, or hosts excluded from plugin execution, as well as the tags that reference the corresponding host groups.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Whether host names, tags, or both are shown depends on the <a href="/docs/manual/english/platform-usage/hosts/management/plugins/add-plugin.md#zugeordnete-hosts">assigned host settings</a> configured for the plugin.</p></div><p><i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a host to open the respective <a href="/docs/manual/english/platform-usage/host-detail-view.md">host detail view</a>.</p></td></tr><tr><td>Extracted Fields</td><td>Shows the fields extracted from the plugin script, if available. These can be visualized as <a href="/docs/manual/english/platform-usage/host-detail-view/monitoring/custom-metrics.md">custom metrics</a> in the host detail view.</td></tr><tr><td>Scripting Language</td><td>Shows the scripting language used by the plugin.</td></tr></tbody></table>

***

## Adding a Plugin

<i class="fa-computer-mouse">:computer-mouse:</i> Click <i class="fa-plus">:plus:</i> **Add Plugin** in the upper-right corner to [create a new plugin](#plugin-hinzufugen).&#x20;

***

## Plugin: Edit View

<i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a plugin to open the respective edit view. Here, you can adjust [configured settings](/docs/manual/english/platform-usage/hosts/management/plugins/add-plugin.md#basic-settings) and delete the plugin. You can also see an [overview of previous plugin executions](#plugin-execution-overview).

The following actions are available:

<table><thead><tr><th width="200.39453125">Option</th><th>Description</th></tr></thead><tbody><tr><td>Save Changes</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Save Changes</strong> after adjusting any settings.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note:</strong> Unsaved changes cannot be recovered.</p></div></td></tr><tr><td>Back</td><td><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Back</strong> to return to the list overview.</td></tr><tr><td>Remove</td><td><p><i class="fa-computer-mouse">:computer-mouse:</i> Click <strong>Remove</strong>, then confirm the prompt that appears to delete the object that you are editing.</p><div data-gb-custom-block data-tag="hint" data-style="danger" class="hint hint-danger"><p><strong>Please note:</strong> Deleted objects cannot be recovered.</p></div></td></tr></tbody></table>

### Plugin Execution: Overview

Once a plugin has been executed, the **Scheduled Execution** section appears in the corresponding plugin edit view. This section is structured as a table.

<i class="fa-computer-mouse">:computer-mouse:</i> Click **Refresh** to update the list of plugin executions.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FksG5aksEGZfzDO1oc7as%2FEnginsight-EN-Hosts-Plugins-Plugin%20Executions-1.jpg?alt=media&amp;token=fb4b4082-bcd7-4654-a509-f133c3d5db37" alt=""><figcaption></figcaption></figure>

The following information is shown:

<table><thead><tr><th width="199.734375">Column</th><th>Description</th></tr></thead><tbody><tr><td>Host</td><td><p>Shows the name of the host on which the plugin was executed, as well as the execution status that is represented by a colored icon.<br><br>The following statuses are available:</p><ul><li><i class="fa-circle-check" style="color:green;">:circle-check:</i> : The plugin was executed successfully.</li><li><i class="fa-circle-exclamation" style="color:$danger;">:circle-exclamation:</i> : An error occurred during plugin execution.</li></ul><p></p><p><i class="fa-computer-mouse">:computer-mouse:</i> Click the name of a host to navigate to the corresponding <a href="/docs/manual/english/platform-usage/host-detail-view.md">host detail view</a>.<br><br><i class="fa-computer-mouse">:computer-mouse:</i> Click the <strong>Analyze</strong> icon <i class="fa-magnifying-glass-waveform">:magnifying-glass-waveform:</i> to open a <a href="#plugin-execution-detail-view">window that contains more detailed information</a> about the plugin execution.</p></td></tr><tr><td>Created at</td><td>Shows the date and time when the plugin was executed.</td></tr></tbody></table>

### Plugin Execution: Detail View

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Analyze** icon <i class="fa-magnifying-glass-waveform">:magnifying-glass-waveform:</i> next to a host name to open a window that contains more detailed information about the plugin execution.

<figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FJPb1PS4PqfN6R6q4mj4G%2FEnginsight-EN-Hosts-Plugins-Plugin%20Execution-2.jpg?alt=media&amp;token=3e947889-cf91-4515-8e3d-eff8ff9415ad" alt=""><figcaption></figcaption></figure>

The following information is shown:

<table><thead><tr><th width="200.08984375">Information</th><th>Description</th></tr></thead><tbody><tr><td>Executing Host</td><td>Shows the name of the host on which the plugin was executed.</td></tr><tr><td>Banner</td><td>Shows a message that indicates whether the plugin was executed successfully (<strong>green</strong>) or whether the execution failed (<strong>red</strong>).</td></tr><tr><td>Standard Output (stdout)</td><td>Shows an excerpt from the respective log file that contains detailed information about the execution.</td></tr><tr><td>Error Output (stderr)</td><td><i class="fa-eye">:eye:</i> This section is only visible if plugin execution failed.<br><br>Shows an excerpt from the respective log file that contains detailed information about the error.</td></tr></tbody></table>

### Testing the Plugin

{% hint style="danger" %}
**Please note:** To execute custom scripts on your hosts, you must first enable the **Plugins** option either in the [settings of individual hosts](/docs/manual/english/platform-usage/host-detail-view/settings.md#core-feature) or via a [corresponding policy](/docs/manual/english/platform-usage/hosts/management/policy-manager/add-policy-manager.md#plugins) under **Hosts** → **Policy Manager**.
{% endhint %}

<i class="fa-computer-mouse">:computer-mouse:</i> Click  <i class="fa-slider">:slider:</i> **Test Plugin** in the upper-right corner after configuring all settings to test the plugin. The **Executing Host** window opens.

<div align="left"><figure><img src="https://2423388680-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV7OrHgKXA0t1jankQBYf%2Fuploads%2FqSh8L2sxjZ1lYjdUebUV%2FEnginsight-EN-Hosts-Plugins-Testing%20Plugin.jpg?alt=media&amp;token=d42621c8-6b38-4ee5-a1a8-cde14b72617e" alt="" width="563"><figcaption></figcaption></figure></div>

<i class="fa-computer-mouse">:computer-mouse:</i> Click the **Hosts** field to show a list of all hosts that are online and that are authorized to execute plugins.

Select the host on which the plugin should be executed for testing purposes and confirm your selection by clicking **Test Plugin**.

***

## Further Resources

**Plugin Templates**

* [Enginsight Github](https://github.com/enginsight)

**Knowledge Base**

* [How can I run multiple plugins simultaneously on one host in Enginsight?](https://docs.enginsight.com/docs/knowledge-base/english/plugins/how-can-i-run-multiple-plugins-simultaneously-on-one-host-in-enginsight)
* [How can I completely disable plugin execution by the Enginsight Pulsar?](https://docs.enginsight.com/docs/knowledge-base/english/pulsar/how-can-i-completely-disable-plugin-execution-by-the-enginsight-pulsar)
* [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)

***