# Synology

# Introduction

**Ver.** 07-09-2022

This plug-in is used to monitor a Synology device using SNMP checks.

**Type:** Server or agent plug-in

# Compatibility matrix

<table border="1" id="bkmrk-sistemas-donde-se-ha" style="width: 743px;"><tbody><tr><td style="width: 202px;">**Systems where tested**</td><td style="width: 541px;">Rocky linux

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

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

# Pre requisites

- Pandora FMS Data Server enabled
- Have the Pandora FMS Plugin Server enabled.
- Have a synology device

# Configuration

**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:

```
/path_synology.sh 
```

<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 plugin parameters we will enter the device ip, community and agent name using the macro "\_field&lt;N&gt;\_".

<p class="callout warning">The third parameter allows us to customize the name of the agent that will contain the modules created for each customized query. </p>

As this plugin has three parameters, we will create three macros.

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

**IP-device**

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

**Community**

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

**Name-agent**

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

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-1665394510473.png](https://pandorafms.com/guides/public/uploads/images/gallery/2022-10/scaled-1680-/image-1665394510473.png)](https://pandorafms.com/guides/public/uploads/images/gallery/2022-10/image-1665394510473.png)

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

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

Once this is done, click on create.

If the module is shown with 1, it means that it is being executed correctly and the agent with the modules will have been created.

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

# Manual execution

**Parameters**

<table border="1" id="bkmrk-%3Cip-device%3E-ip-del-d"><tbody><tr><td>&lt;ip-device&gt;</td><td>Device IP</td></tr><tr><td>&lt;community&gt;</td><td>snmp community, only works in v2c</td></tr><tr><td>&lt;name-agent&gt;</td><td>Agent's name</td></tr></tbody></table>

**Manual execution**

<div id="bkmrk-.%2Fsynology.sh-%3Cip-de"><div><div>```
<span role="presentation">./synology.sh <ip-device> <community> <name-agent></span>
```

</div></div></div>

# Modules generated by the plugin

The plugin will create an agent, to which we will define the name with the third positional parameter with the following modules:

<table border="1" id="bkmrk-system-status-estado"><tbody><tr><td><div><div>System Status</div></div></td><td><div><div>Synology system status Each meanings of status represented describe below. Normal(1): System functionals normally. Failed(2): Volume has crashed.</div></div></td></tr><tr><td><div><div>System Temperature</div></div></td><td><div><div>Synology system temperature The temperature of Disk Station uses Celsius degree.</div></div></td></tr><tr><td><div><div>System Power</div></div></td><td><div><div>Synology power status Each meanings of status represented describe below. Normal(1): All power supplies functional normally. Failed(2): One of power supply has failed.</div></div></td></tr><tr><td><div><div>System Fan Status</div></div></td><td><div><div>Synology system fan status Each meanings of status represented describe below. Normal(1): All Internal fans functional normally. Failed(2): One of internal fan stopped.</div></div></td></tr><tr><td><div><div>CPU Fan Status</div></div></td><td>E <div><div>Synology cpu fan status Each meanings of status represented describe below. Normal(1): All CPU fans functional normally. Failed(2): One of CPU fan stopped.</div></div></td></tr><tr><td><div><div>Model name</div></div></td><td><div><div>The Model name of this NAS</div></div></td></tr><tr><td><div><div>OS version</div></div></td><td><div><div>The version of this DSM</div></div></td></tr><tr><td><div><div>Disk &lt;disk_id&gt;-&lt;disk_name&gt; Status</div></div></td><td><div><div>Synology disk status Each meanings of status represented describe below. Normal(1): The hard disk functions normally. Initialized(2): The hard disk has system partition but no data. NotInitialized(3): The hard disk does not have system in system partition. SystemPartitionFailed(4): The system partitions on the hard disks are damaged. Crashed(5): The hard disk has damaged.</div></div></td></tr><tr><td><div><div>Disk &lt;disk_id&gt;-&lt;disk_name&gt;</div></div></td><td><div><div>Synology disk temperature The temperature of each disk uses Celsius degree.</div></div></td></tr><tr><td><div><div>RAID &lt;raid_name&gt; Status</div></div></td><td><div><div>It shows the RAID status right now</div></div></td></tr><tr><td><div><div>RAID &lt;raid_name&gt; Free</div></div></td><td><div><div>Percentage of free space on RAID</div></div></td></tr></tbody></table>