# Plugin Kemp Loadmaster

# Introduction

<div id="bkmrk-"></div>Ver. 08-06-2022  
  
With this plugin you can pull performance statistics data from Kemploadmaster.

<div id="bkmrk-tipo%3A-plug-in-server"><div>**Tipo**: Plug-in server</div></div>

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha" style="height: 70px; width: 597px;"><tbody><tr style="height: 35px;"><td style="height: 35px; width: 291.719px;">**Systems where tested**</td><td style="height: 35px; width: 304.281px;">CentOS 7, Fedora, rocky linux

</td></tr><tr style="height: 35px;"><td style="height: 35px; width: 291.719px;">**Systems where it should work**</td><td style="height: 35px; width: 304.281px;">Any linux system

</td></tr></tbody></table>

# Pre requisites

- Pandora FMS Data Server enabled
- Pandora FMS Plugin Server enabled

# Previous configuration

It is necessary to enable kemp's Rest API interface in order to use the plugin. The following link specifies how to do it.  
  
[https://support.kemptechnologies.com/hc/en-us/articles/201640799-How-to-Enable-Kemp-LoadMaster-RESTful-API-interface](https://support.kemptechnologies.com/hc/en-us/articles/201640799-How-to-Enable-Kemp-LoadMaster-RESTful-API-interface)

<p class="callout info align-center">Remember that the data server and plugin server must be enabled, but this is the default.</p>

# Parameters

<table border="1" id="bkmrk-par%C3%A1metro-descripci%C3%B3" style="border-collapse: collapse; width: 100%; height: 370px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">**Parámetro**</td><td style="width: 50%; height: 29px;">**Descripción**</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--tentacle\_port</td><td style="width: 50%; height: 29px;">Tentacle port Default 41121(optional)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--tentacle\_address</td><td style="width: 50%; height: 29px;">Ip del servidor tentacle al que mandar los datos(opcional)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--agent\_name</td><td style="width: 50%; height: 29px;">To name the agent that will contain the modules, by default : "Kemp". (optional)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--prefix\_module</td><td style="width: 50%; height: 29px;">To prefix the modules in case you want to differentiate them from other executions (optional).</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--url</td><td style="width: 50%; height: 29px;">Host or IP of your Kemp Load master server</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--user</td><td style="width: 50%; height: 29px;">User of kemp loadmaster (required)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--password</td><td style="width: 50%; height: 29px;">Password de kemp loadmaster (obligatorio)</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">-g,--group</td><td style="width: 50%; height: 29px;">Pandora FMS target group (optional)</td></tr><tr style="height: 46px;"><td style="width: 50%; height: 46px;">--data\_dir</td><td style="width: 50%; height: 46px;">Pandora FMS data directory. By default it is /var/spool/pandora/data\_in/ (optional)</td></tr><tr style="height: 63px;"><td style="width: 50%; height: 63px;">--as\_agent\_plugin</td><td style="width: 50%; height: 63px;">It is optional, if you want the plugin to be an agent plugin and put the modules in the pandora agent, execute this with a 1 (optional)</td></tr></tbody></table>

# Manual execution

**Example of manual execution in server mode**

```
python pandora_kemploadmaster.py -u <user> -us <user> -p <pass> --tentacle_address <ip> --data_dir <path>
```

[![kemp_sever.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-06/scaled-1680-/kemp-sever.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-06/kemp-sever.png)

**Example execution in agent mode**

```
python pandora_kemploadmaster.py -u <user> -us <user> -p <pass> --as_agent_plugin 1
```

[![kemp_manual.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-06/scaled-1680-/kemp-manual.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-06/kemp-manual.png)

# Configuration in PandoraFMS

As a server plugin

Installation from console

To register the plugin, from the console, go to the "register plugin" section.

**[![register_plugin.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register-plugin.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register-plugin.png)**

Click on select file.

**[![register_plugin2.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/register-plugin2.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/register-plugin2.png)**

Select the pspz2 file containing the plugin.

  
We will see a message that will indicate if it has been registered correctly.

  
Once the plugin is registered, we will see it in the plugins section.

[![serversingles.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/scaled-1680-/serversingles.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-04/serversingles.png)

Clicking in the title we will accede to the menu of the plugin.

  
In parameters, we will see all the parameters of the plugin, remember that not all of them are mandatory, only in those that are specified.

  
Below, in the macros of the parameters we will be able to add the required value.

Manual installation

Go to servers &gt; plugins:

[![image-1629974405286.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/scaled-1680-/image-1629974405286.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/image-1629974405286.png)

Click on add:

[![image-1629974430627.png](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/scaled-1680-/image-1629974430627.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2021-08/image-1629974430627.png)

We put in name and the description that is preferred:

We put as command the execution with the path of the plugin:

  
And in plugin parameters we will introduce these followed by the macro "\_field\_", the mandatory ones for the plugin to work are -c and --as\_agent\_plugin (in case we want to run it as a server plugin, otherwise the latter is not essential.

We will define these with the macros below.

Once this is done, click on "create".

You can check that you have entered the values correctly by executing the preview command in the terminal.

If it does not give errors is that it has been entered well.

Once this is done, the only thing left to do is to call it, so we will go to the view of some agent and we will create a module of complements:

[![image-1646741530197.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-03/scaled-1680-/image-1646741530197.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-03/image-1646741530197.png)

We will give it a name and in the section "plugin" we will put the one we have just configured.

Once this is done, click on create.

If the module is shown with 1, it means that it is running correctly.

# Módules generated by the plugin

The plugin execution will create an agent with the following modules:

<div id="bkmrk---user---system---id"><div>- User</div><div>- System</div><div>- Idle</div><div>- IOWaiting</div><div>- Mbtotal</div><div>- memused</div><div>- Mbused</div><div>- percentmemused</div><div>- memfree</div><div>- Mbfree</div><div>- percentmemfree</div><div>- CurrentConnections</div><div>- CurrentConnectionsBlocked</div><div>- SuccessfulConnectionAttempts</div><div>- SuccessfulRequestAttempts</div><div>- SuccessfulMatchedRuleAttempts</div><div>- ConnectionAttemptsBlocked</div><div>- RequestAttemptsBlocked</div><div>- MatchedRulesBlocked</div><div>- DifferentCountries</div><div>- LastHour</div><div>- LastDay</div><div>- ConnsPerSec</div><div>- TotalConns</div><div>- BitsPerSec</div><div>- TotalBits</div><div>- BytesPerSec</div><div>- TotalBytes</div><div>- PktsPerSec</div><div>- TotalPackets</div><div>- tps_total</div><div>- tps_ssl</div><div>- Sec</div><div>- Usec</div><div>- Period</div></div>**Example in the agent view of the modules**

[![image-1654701506200.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-06/scaled-1680-/image-1654701506200.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-06/image-1654701506200.png)