# Plugin Digital Ocean

# Introduction

Ver. 240521

With this plug-in we can see the data of your digital ocean account and your droplets.

It connects to the account via a token.

Type: Server plug-in

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha" style="border-collapse: collapse; width: 100%; height: 84px;"><tbody><tr style="height: 28px;"><td style="width: 50%; height: 28px;">**Systems where it has been tested**</td><td style="width: 50%; height: 28px;">CentOS 7

</td></tr><tr style="height: 28px;"><td style="width: 50%; height: 28px;">**Systems where it should work**</td><td style="width: 50%; height: 28px;">Any linux system

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

# Prerequisites

Required :

- Digital Ocean account
- Generate an API read token from digital ocean
- Have the Pandora FMS Data Server enabled.
- Pandora FMS Plugin Server enabled.

# Configuration

We will have to generate a token, which will be the key that will access through the api to the data of our account, this is generated in the following way.

Go to api from the digital ocean menu:

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

Click on generate new token :

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

We give it a name and the permissions we are interested in and we generate it:

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

Recuerda guardar bien el token porque solo saldrá una vez, si se extravía siempre se puede crear otro nuevo.

# General plugin parameters

```
./pandora_digitalocean -t <token> [ -g <group> ] [ --data_dir <data_dir > ]
```

If the execution was successful we will see a '1' when the plugin is executed.

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

# Plugin-specific parameters

The plug-in has the following parameters:

<table id="bkmrk-par%C3%A1metro-descripci%C3%B3"><tbody><tr><td>**Parámetro**

</td><td><span style="font-weight: 400;">Descripción</span>

</td></tr><tr><td><span style="font-weight: 400;">-h, --help</span>

</td><td>Displays a short help message

</td></tr><tr><td><span style="font-weight: 400;">-t TOKEN, --token TOKEN</span>

</td><td>It is mandatory. To enter the token we have generated in digital ocean

</td></tr><tr><td><span style="font-weight: 400;">-g GROUP, --group GROUP</span>

</td><td>Pandora FMS Target Group

</td></tr><tr><td><span style="font-weight: 400;">--data\_dir DATA\_DIR</span>

</td><td>Pandora FMS data directory. By default it is /var/spool/pandora/data\_in/

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

Help example :

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

# Manual execution

We can test the plugin from the terminal to see if it works, to check it, we run the plugin:

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

From windows, we can check it with the following command, calling the .exe:

```
pandora_digitalocean.exe -t <token> --data_dir <direction>
```

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

# Configuration in Pandora

The best way to manage server plugins in Pandora is from "/usr/share/pandora\_server/util/plugin" so we will send it by pscp to that path:

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

If it does not let us run it because we do not have permissions, we must give them with the following command :

```
chmod 755 pandora_digitalocean
```

Once this is done, let's proceed to install it in the Pandora console:

Go to servers &gt; plugins:

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

Click on "add":

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

We give it a name and, if we want, a description:

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

We put in plugin command the path in which we have located previously and in parameters what we want to get, as in this case I only want to generate the agents and the address is already configured only put \_field1\_, if we want to put another address where to save the data generated by the plugin, we would add --data\_dir \_field2\_ in plugin parameters. We will put a description (token, for example) and in default value we will put the token generated before. Once this is done, two agents with their respective modules will have been created.

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

# Modules generated by the plugin

Two new agents will be created:

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

In the first one, information about your droplets will be displayed, in the second one, information about your digital ocean account.

**Digital Account droplets**

<table border="1" id="bkmrk-droplet_disk-info-de" style="border-collapse: collapse; width: 100%; height: 145px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Droplet\_disk</td><td style="width: 50%; height: 29px;">Disk info</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Droplet\_memory</td><td style="width: 50%; height: 29px;">Memory info</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Droplet\_name</td><td style="width: 50%; height: 29px;">Droplet name</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Droplet\_status</td><td style="width: 50%; height: 29px;">To find out if the droplet is active</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Droplet\_vcpus</td><td style="width: 50%; height: 29px;">Information about vcpus</td></tr></tbody></table>

Example on console :

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

**Digital\_Ocean\_Account &lt;email&gt;**

<table border="1" id="bkmrk-account_balance-bala" style="border-collapse: collapse; width: 100%; height: 87px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Account\_balance</td><td style="width: 50%; height: 29px;">Account balance in $</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Digital\_Ocean\_Status</td><td style="width: 50%; height: 29px;">The status of the digital ocean account</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">Month\_to\_date\_balance</td><td style="width: 50%; height: 29px;">Balance of the month to date</td></tr></tbody></table>

Example in the Pandora console :

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