Skip to main content

Ubiquiti UniFi SNMP

Pack Assets​

Monitored Objects​

The Pack Ubiquiti UniFi collects metrics for:

  • Cpu
  • Disks
  • Interfaces
  • Load
  • Memory
  • Swap
  • Uptime
  • Virtual Access Points

Discovery rules​

Rule nameDescription
Net-Ubiquiti-Unifi-SNMP-Interface-NameDiscover network interfaces and monitor bandwidth utilization

Collected Metrics​

Metric nameDescriptionUnit
cpu.user.utilization.percentageCPU User utilization%
cpu.nice.utilization.percentageCPU Nice utilization%
cpu.system.utilization.percentageCPU System utilization%
cpu.idle.utilization.percentageCPU Idle utilization%
cpu.wait.utilization.percentageCPU Wait utilization%
cpu.kernel.utilization.percentageCPU Kernel utilization%
cpu.interrupt.utilization.percentageCPU Interrupt utilization%
cpu.softirq.utilization.percentageCPU SoftIrq utilization%
cpu.steal.utilization.percentageCPU Steal utilization%
cpu.guest.utilization.percentageCPU Guest utilization%
cpu.guestnice.utilization.percentageCPU Guest Nice utilization%

Prerequisites​

To monitor your Ubiquiti UniFi, the SNMP must be configured. The Poller should be able to perform SNMP requests toward the Ubiquiti device over SNMP UDP/161 port.

Setup​

  1. Install the Centreon Plugin on every Poller:
yum install centreon-plugin-Network-Ubiquiti-Unifi-Snmp
  1. On the Centreon Web interface in Configuration > Plugin packs > Manager, install the Ubiquiti UniFi SNMP Pack

Host configuration​

  • Add a new Host and fill the IP Address/FQDN, SNMP Version and SNMP Community fields according to the device's configuration
  • Apply the Net-Ubiquiti-Unifi-SNMP-custom Host Template

When using SNMP v3, use the SNMPEXTRAOPTIONS Macro to add specific authentication parameters More information in the Troubleshooting SNMP section.

MandatoryNameDescription
SNMPEXTRAOPTIONSConfigure your own SNMPv3 credentials combo

How to test the Plugin and what are the main options for?​

Once the plugin installed, log into your Centreon Poller CLI using the centreon-engine user account and test the Plugin by running the following command:

/usr/lib/centreon/plugins/centreon_ubiquiti_unifi_snmp.pl \
    --plugin=network::ubiquiti::unifi::snmp::plugin \
    --mode=disks \
    --hostname=10.30.2.114 \
    --snmp-version='2c' \
    --snmp-community='ubiquiti_ro' \
    --filter-disk-path='^/$' \
    --warning-usage-prct='90' \
    --critical-usage-prct='95' \
    --verbose

Expected command output is shown below:

OK: Partition '/' usage total: 46.82 GB used: 26.41 GB (56.40%) free: 20.41 GB (43.60%), Inodes used: 2 % | 'storage.partitions.count'=1;;;0; '/#storage.space.usage.bytes'=28356739072B;;;0;50273779712 '/#storage.space.free.bytes'=21917040640B;;;0;50273779712 '/#storage.space.usage.percentage'=56.40%;0:90;0:95;0;100 '/#storage.inodes.usage.percentage'=2%;;;0;100
Partition '/' usage total: 46.82 GB used: 26.41 GB (56.40%) free: 20.41 GB (43.60%), Inodes used: 2 %

The command above monitors Ubiquiti UniFi (--plugin=network::ubiquiti::unifi::snmp::plugin --mode=disks) identified by the IP address 10.30.2.114 (--hostname=10.30.2.114). As the Plugin is using the SNMP protocol to request the device, the related community and version are specified (--snmp-version='2c' --snmp-community='ubiquiti_ro').

This command would trigger a WARNING alarm if disk utilization over 90% (--warning-usage-prct='90') and a CRITICAL alarm over 95% (--critical-usage-prct='95').

All the options as well as all the available thresholds can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_ubiquiti_unifi_snmp.pl \
    --plugin=network::ubiquiti::unifi::snmp::plugin \
    --mode=disks \
    --help

Troubleshooting​

Troubleshooting plugins