# Proxmox

# Introduction

Ver. 29-11-2022

Plugin to monitor proxmox, being able to extract API data from nodes, backups, virtual machines, lxc containers and storage.  
  
Type: Server plug-in

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha" style="width: 642px;"><tbody><tr><td style="width: 234px;">**Systems where tested**</td><td style="width: 408px;">CentOS 7, Fedora, rocky linux

</td></tr><tr><td style="width: 234px;">**Systems where it should work** </td><td style="width: 408px;">Any linux system

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

# Pre requisites

- Pandora FMS Data Server enabled
- Have Pandora FMS Plugin Server enabled.

# Parámeters

 **Proxmox parameters**

<table border="1" id="bkmrk-%C2%A0-%C2%A0-%C2%A0-%C2%A0-%C2%A0-%C2%A0-%C2%A0-%C2%A0-%C2%A0-%C2%A0-" style="border-collapse: collapse; width: 100%; height: 290px;"><tbody><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--host</td><td style="width: 50%; height: 29px;">Ip or proxmox host</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--user</td><td style="width: 50%; height: 29px;">Name of the proxmox user who will perform the queries</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--password</td><td style="width: 50%; height: 29px;">Password of the proxmox user who will perform the queries</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--port</td><td style="width: 50%; height: 29px;">Default 8006</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--vm</td><td style="width: 50%; height: 29px;">To obtain data from the virtual machines, 1 to activate 0 to deactivate</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--lxc</td><td style="width: 50%; height: 29px;">Get data from lxc containers, 1 to activate 0 to deactivate</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--backups</td><td style="width: 50%; height: 29px;">Extract data from backups, 1 for on 0 for off</td></tr><tr style="height: 29px;"><td style="width: 50%; height: 29px;">--nodes</td><td style="width: 50%; height: 29px;">Get data from nodes, 1 to activate 0 to deactivate</td></tr><tr><td style="width: 50%;">--discard\_node</td><td style="width: 50%;">Discard a node name for vm and lxc monitoring</td></tr></tbody></table>

**Pandora configuration parameters**

<table border="1" id="bkmrk-par%C3%A1metro-descripci%C3%B3" style="height: 162px; width: 807px;"><tbody><tr><td style="width: 170px;">--transfer\_mode</td><td style="width: 637px;">Tentacle or local, default : local</td></tr><tr style="height: 29px;"><td style="width: 170px; height: 29px;">--tentacle\_port</td><td style="width: 637px; height: 29px;">Tentacle port (default 41121) (optional)</td></tr><tr style="height: 29px;"><td style="width: 170px; height: 29px;">--tentacle\_address</td><td style="width: 637px; height: 29px;">Ip of the tentacle server to send the data to (optional)</td></tr><tr style="height: 29px;"><td style="width: 170px; height: 29px;">-g,--group</td><td style="width: 637px; height: 29px;">Pandora FMS target group (optional)</td></tr><tr style="height: 29px;"><td style="width: 170px; height: 29px;">--data\_dir</td><td style="width: 637px; height: 29px;">Pandora FMS data directory. By default it is /var/spool/pandora/data\_in/ (optional)</td></tr><tr><td style="width: 170px;">--as\_discovery\_plugin</td><td style="width: 637px; height: 46px;">To be executed in 'discovery' mode, the execution will display a json in the output with information about the monitoring.</td></tr></tbody></table>

<p class="callout info">Monitorable backups are at cluster level, backups at vm or lxc container level will be included in a future update.</p>

# Manual execution

```shell
./pandora_proxmox \ 
--host < host >  \
--user < user > \
--password < password > \
[ --port < port > ] \
[ --vm < 1 or 0 > ] \
[ --lxc < 1 or 0 > ] \
[ --backups < 1 or 0 > ] \
[ --nodes < 1 or 0 > ] \
[ --transfer_mode < local o tentacle > ] \
[ --tentacle_port < tentacle_port > ] \
[ --tentacle_address < tentacle_address > ] \
[ -g < group > ] \
[ --data_dir < data dir > ] \
[ --as_discovery_plugin < 1 o 0 > ] \
[ --discard_node < node name > ]
```

**Normal execution**

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

**Discovery execution**

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

# Configuration in PandoraFMS

As server plugin

Manual installation

Go to servers &gt; plugins:

[![image-1689159088296.png](https://pandorafms.com/guides/public/uploads/images/gallery/2023-07/scaled-1680-/image-1689159088296.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2023-07/image-1689159088296.png)

Click on "add plugin":

[![image-1689159095782.png](https://pandorafms.com/guides/public/uploads/images/gallery/2023-07/scaled-1680-/image-1689159095782.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2023-07/image-1689159095782.png)

  
We put in name and the description that is preferred.

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

<div id="bkmrk-%2Fpath_pandora_proxmo"><div><div><div><div><div><div><div>```
<span role="presentation">/path_pandora_proxmox</span>
```

</div></div></div></div></div></div><div></div><div><div></div></div></div></div><p class="callout info align-center">Remember that the recommended path for the use of the server plugins is: /usr/share/pandora\_server/util/plugin/</p>

And in parameters of the plugin we will introduce these followed by the macro "\_field&lt;N&gt;\_", the parameters of connection, --host, --user and --password are obligatory, by default the plugin has activated the extraction of data of lxc\_containers,VMs, nodes and backups, can be deactivated for custom monitorization.

Once this is done, we will click on "create".

Once this is done, the only thing left to do is to call it, so we will go to some agent's view and create an add-in module:

[![image-1689159120014.png](https://pandorafms.com/guides/public/uploads/images/gallery/2023-07/scaled-1680-/image-1689159120014.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2023-07/image-1689159120014.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.

# Modules generated by the plugin

The plugin with all parameters enabled will return the following:

One agent for each node with the following modules:

<table border="1" id="bkmrk-maxdisk-uptime-statu" style="border-collapse: collapse; width: 100%; height: 261px;"><tbody><tr style="height: 29px;"><td style="width: 100%; height: 29px;">maxdisk</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">uptime</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">status</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">maxcpu</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">disk</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">mem</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">maxmem</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">cpu</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;"><div><div>ssl_fingerprint</div></div></td></tr></tbody></table>

One agent for each virtual machine and for each lxc container of the node with the following modules:

<table border="1" id="bkmrk-status-netout-diskre" style="border-collapse: collapse; width: 100%; height: 348px;"><tbody><tr style="height: 29px;"><td style="width: 100%; height: 29px;">status</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">netout</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">diskread</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">cpu</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">disk</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">mem</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">netin</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">uptime</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">maxmem</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">maxdisk</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">diskwrite</td></tr><tr style="height: 29px;"><td style="width: 100%; height: 29px;">cpus</td></tr></tbody></table>

A backup agent that will have a module for each backup with the following data (general information):

Name: vmid,node\_backup\_info.  
Description: next\_run,schedule,storage,backup\_id,repeat-missed  
value: enabled or disabled

And also has another module that will show how much time is left for the next backup in seconds:

Name: vmid, node\_backup\_info  
Description: Time in seconds for the next backup  
value: seconds left for the next backup