opnsense-zabbix

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

opnsense-zabbix

★ 29

Zabbix Template for OPNSense

opnsense-zabbix Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Introduction
Out of pure personal need I adapted **R. Bicelli's** _pfSense Zabbix Template_ after the **Home+Lab** License Issue *encouraged* me to migrate to OPNSense.

This is provided as is and some keys and functionalities can have errors.

Feel free to contribute by reporting bugs or submitting PRs!

Original Zabbix pfSense Template by **R. Bicelli**
<https://github.com/rbicelli/pfsense-zabbix-template>

*Tested on Zabbix 6.0-7.0 LTS*

### Contributors
[See the CONTRIBUTORS.md file](./CONTRIBUTORS.md).

### Would you like to support me?
<a href='https://ko-fi.com/E1E2YQ4TG' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi2.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

## Functionalities

* Service Discovery
* OpenVPN Server Discovery and Statistics
* OpenVPN Server Clients Discovery
* All default FreeBSD Items
* Network Statistics
* Gateway Discovery
* IPSec (SWAN)
* P2P TLS OpenVPN Server Remote Address Item Monitoring

## Installation

### OPNSense Configuration
First you need to download the PHP Script onto your OPNSense.
Login with SSH and execute the following command:

`curl --create-dirs -o /root/scripts/opnsense_zbx.php https://raw.githubusercontent.com/dblanque/opnsense-zabbix/main/opnsense_zbx.php`

### Zabbix Configuration

To enable this template you must add the following custom keys in the Zabbix Service Configuration.
`Services → Zabbix Agent → Settings`

You may also copy paste it into the config file:
`/usr/local/etc/zabbix_agentd.conf`

```
UserParameter=opnsense.mbuf.current,netstat -m | grep "mbuf clusters" | cut -f1 -d ' ' | cut -d '/' -f1
UserParameter=opnsense.mbuf.cache,netstat -m | grep "mbuf clusters" | cut -f1 -d ' ' | cut -d '/' -f2
UserParameter=opnsense.mbuf.max,netstat -m | grep "mbuf clusters" | cut -f1 -d ' ' | cut -d '/' -f4
UserParameter=opnsense.discovery[*],sudo /usr/local/bin/php /root/scripts/opnsense_zbx.php discovery $1
UserParameter=opnsense.interfaces[*],sudo /usr/local/bin/php /root/scripts/opnsense_zbx.php interfaces $1
UserParameter=opnsense.value[*],sudo /usr/local/bin/php /root/scripts/opnsense_zbx.php $1 $2 $3
UserParameter=opnsense.states.max,grep "limit states" /tmp/rules.limits | cut -f4 -d ' '
UserParameter=opnsense.states.current,sudo /usr/local/bin/php /root/scripts/opnsense_zbx.php states
```

You may also enable Root by allowing it in the Zabbix Settings and add the keys on the *Advanced* tab.

![opnsense_zbx_01](https://github.com/dblanque/opnsense-zabbix/assets/68660667/9fd17b20-3c7c-4a09-a816-9e422137d1c6)

Do not forget to add the **Zabbix Server** or **Zabbix Proxy** *IP Address* to your 
**Active Check Servers** Field in the `Zabbix Features` tab as well as your
**Zabbix Servers** field in the `Main Settings` tab.

### Enable System Version Cron

Please add the following cronjob to your `/etc/cron.d/opnsense_sysversion`

```
# Example of job definition:
# .---------------- minute (0 - 59)
# |  .------------- hour (0 - 23)
# |  |  .---------- day of month (1 - 31)
# |  |  |  .------- month (1 - 12) OR jan,feb,mar,apr ...
# |  |  |  |  .---- day of week (0 - 6) (Sunday=0 or 7) OR sun,mon,tue,wed,thu,fri,sat
# |  |  |  |  |
# *  *  *  *  * user-name command to be executed
0 9,21	* * *	root	sudo /usr/local/bin/php /root/scripts/opnsense_zbx.php sysversion_cron
```

Then restart cron with `/etc/rc.d/cron restart`

### Disable Syslog Logging for Zabbix Script (OPTIONAL)
If you've noticed that Zabbix is spamming your system logs with all it's sudo
calls, and wish to disable it, you may write the following content onto the file
`/usr/local/etc/sudoers.d/opnsense_zabbix_agent_nolog`

```sudo
Cmnd_Alias ZBX_SCRIPT = /usr/local/bin/php /root/scripts/opnsense_zbx.php *

# Disable Sudo Logging
Defaults!ZBX_SCRIPT !syslog
```

Then make sure it is parsed properly and has the correct permissions:
```bash
chmod 0440 /usr/local/etc/sudoers.d/opnsense_zabbix_agent_nolog
visudo -c
```

### Et Voilá

Happy monitoring!

![opnsense_zbx_02](https://github.com/dblanque/opnsense-zabbix/assets/68660667/d801d0b8-2b48-4b0e-b494-a6478123ce3e)

opnsense-zabbix

opnsense-zabbix Download

Today's picks

Was this content helpful?

Recent Feedback

opnsense-zabbix

opnsense-zabbix Download

Today's picks

Was this content helpful?

Recent Feedback

Download README