You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

19 KiB

Ubiquiti AirOS by SNMP

Overview

This template is designed for the effortless deployment of Ubiquiti AirOS monitoring by Zabbix via SNMP and doesn't require any external scripts.

Known issues

  • Description: 'UBNT unifi reports speed: like IF-MIB::ifSpeed.1 = Gauge32: 4294967295 for all interfaces'
    • version: 'Firmware: BZ.ar7240.v3.7.51.6230.170322.1513'
    • device: UBNT UAP-LR
  • Description: 'UBNT AirMax(NanoStation, NanoBridge etc) reports ifSpeed: as 0 for VLAN and wireless(ath0) interfaces'
    • version: 'Firmware: XW.ar934x.v5.6-beta4.22359.140521.1836'
    • device: NanoStation M5
  • Description: 'UBNT AirMax(NanoStation, NanoBridge etc) reports always return ifType: as ethernet(6) even for wifi,vlans and other types'
    • version: 'Firmware: XW.ar934x.v5.6-beta4.22359.140521.1836'
    • device: NanoStation M5
  • Description: ifXTable is not provided in IF-MIB. So Interfaces Simple Template is used instead
    • version: all above
    • device: NanoStation, UAP-LR

Requirements

Zabbix version: 7.0 and higher.

Tested versions

This template has been tested on:

  • Ubiquiti AirOS

Configuration

Zabbix should be configured according to the instructions in the Templates out of the box section.

Setup

Refer to the vendor documentation.

Macros used

Name Description Default
{$MEMORY.UTIL.MAX} 90
{$CPU.UTIL.CRIT} 90
{$SNMP.TIMEOUT} 5m
{$ICMP_LOSS_WARN} 20
{$ICMP_RESPONSE_TIME_WARN} 0.15
{$IFCONTROL} 1
{$IF.UTIL.MAX} 95
{$NET.IF.IFNAME.MATCHES} ^.*$
{$NET.IF.IFNAME.NOT_MATCHES}

Filter out loopbacks, nulls, docker veth links and docker0 bridge by default

Macro too long. Please see the template.
{$NET.IF.IFOPERSTATUS.MATCHES} ^.*$
{$NET.IF.IFOPERSTATUS.NOT_MATCHES}

Ignore notPresent(6)

^6$
{$NET.IF.IFADMINSTATUS.MATCHES}

Ignore notPresent(6)

^.*
{$NET.IF.IFADMINSTATUS.NOT_MATCHES}

Ignore down(2) administrative status

^2$
{$NET.IF.IFDESCR.MATCHES} .*
{$NET.IF.IFDESCR.NOT_MATCHES} CHANGE_IF_NEEDED
{$NET.IF.IFTYPE.MATCHES} .*
{$NET.IF.IFTYPE.NOT_MATCHES} CHANGE_IF_NEEDED
{$IF.ERRORS.WARN} 2

Items

Name Description Type Key and additional info
Ubiquiti AirOS: CPU utilization

MIB: FROGFOOT-RESOURCES-MIB

5 minute load average of processor load.

SNMP agent system.cpu.util[loadValue.2]
Ubiquiti AirOS: Free memory

MIB: FROGFOOT-RESOURCES-MIB

SNMP agent vm.memory.free[memFree.0]

Preprocessing

  • Custom multiplier: 1024

Ubiquiti AirOS: Total memory

MIB: FROGFOOT-RESOURCES-MIB

The total memory expressed in bytes.

SNMP agent vm.memory.total[memTotal.0]

Preprocessing

  • Custom multiplier: 1024

Ubiquiti AirOS: Memory (buffers)

MIB: FROGFOOT-RESOURCES-MIB

Memory used by kernel buffers (Buffers in /proc/meminfo).

SNMP agent vm.memory.buffers[memBuffer.0]

Preprocessing

  • Custom multiplier: 1024

Ubiquiti AirOS: Memory (cached)

MIB: FROGFOOT-RESOURCES-MIB

Memory used by the page cache and slabs (Cached and Slab in /proc/meminfo).

SNMP agent vm.memory.cached[memCache.0]

Preprocessing

  • Custom multiplier: 1024

Ubiquiti AirOS: Memory utilization

Memory utilization in %.

Calculated vm.memory.util[memoryUsedPercentage]
Ubiquiti AirOS: Hardware model name

MIB: IEEE802dot11-MIB

A printable string used to identify the manufacturer's product name of the resource. Maximum string length is 128 octets.

SNMP agent system.hw.model

Preprocessing

  • Discard unchanged with heartbeat: 1d

Ubiquiti AirOS: Firmware version

MIB: IEEE802dot11-MIB

Printable string used to identify the manufacturer's product version of the resource. Maximum string length is 128 octets.

SNMP agent system.hw.firmware

Preprocessing

  • Discard unchanged with heartbeat: 1d

Ubiquiti AirOS: Uptime (network)

MIB: SNMPv2-MIB

The time (in hundredths of a second) since the network management portion of the system was last re-initialized.

SNMP agent system.net.uptime[sysUpTime.0]

Preprocessing

  • Custom multiplier: 0.01

Ubiquiti AirOS: Uptime (hardware)

MIB: HOST-RESOURCES-MIB

The amount of time since this host was last initialized. Note that this is different from sysUpTime in the SNMPv2-MIB [RFC1907] because sysUpTime is the uptime of the network management portion of the system.

SNMP agent system.hw.uptime[hrSystemUptime.0]

Preprocessing

  • Check for not supported value

    Custom on fail: Set value to: 0

  • Custom multiplier: 0.01

Ubiquiti AirOS: SNMP traps (fallback)

The item is used to collect all SNMP traps unmatched by other snmptrap items

SNMP trap snmptrap.fallback
Ubiquiti AirOS: System location

MIB: SNMPv2-MIB

The physical location of this node (e.g., `telephone closet, 3rd floor'). If the location is unknown, the value is the zero-length string.

SNMP agent system.location[sysLocation.0]

Preprocessing

  • Discard unchanged with heartbeat: 12h

Ubiquiti AirOS: System contact details

MIB: SNMPv2-MIB

The textual identification of the contact person for this managed node, together with information on how to contact this person. If no contact information is known, the value is the zero-length string.

SNMP agent system.contact[sysContact.0]

Preprocessing

  • Discard unchanged with heartbeat: 12h

Ubiquiti AirOS: System object ID

MIB: SNMPv2-MIB

The vendor's authoritative identification of the network management subsystem contained in the entity. This value is allocated within the SMI enterprises subtree (1.3.6.1.4.1) and provides an easy and unambiguous means for determiningwhat kind of box' is being managed. For example, if vendorFlintstones, Inc.' was assigned the subtree1.3.6.1.4.1.4242, it could assign the identifier 1.3.6.1.4.1.4242.1.1 to its `Fred Router'.

SNMP agent system.objectid[sysObjectID.0]

Preprocessing

  • Discard unchanged with heartbeat: 12h

Ubiquiti AirOS: System name

MIB: SNMPv2-MIB

An administratively-assigned name for this managed node.By convention, this is the node's fully-qualified domain name. If the name is unknown, the value is the zero-length string.

SNMP agent system.name

Preprocessing

  • Discard unchanged with heartbeat: 12h

Ubiquiti AirOS: System description

MIB: SNMPv2-MIB

A textual description of the entity. This value should

include the full name and version identification of the system's hardware type, software operating-system, and

networking software.

SNMP agent system.descr[sysDescr.0]

Preprocessing

  • Discard unchanged with heartbeat: 12h

Ubiquiti AirOS: SNMP agent availability

Availability of SNMP checks on the host. The value of this item corresponds to availability icons in the host list.

Possible value:

0 - not available

1 - available

2 - unknown

Zabbix internal zabbix[host,snmp,available]
Ubiquiti AirOS: ICMP ping Simple check icmpping
Ubiquiti AirOS: ICMP loss Simple check icmppingloss
Ubiquiti AirOS: ICMP response time Simple check icmppingsec

Triggers

Name Description Expression Severity Dependencies and additional info
Ubiquiti AirOS: High CPU utilization

The CPU utilization is too high. The system might be slow to respond.

min(/Ubiquiti AirOS by SNMP/system.cpu.util[loadValue.2],5m)>{$CPU.UTIL.CRIT} Warning
Ubiquiti AirOS: High memory utilization

The system is running out of free memory.

min(/Ubiquiti AirOS by SNMP/vm.memory.util[memoryUsedPercentage],5m)>{$MEMORY.UTIL.MAX} Average
Ubiquiti AirOS: Firmware has changed

Firmware version has changed. Acknowledge to close the problem manually.

last(/Ubiquiti AirOS by SNMP/system.hw.firmware,#1)<>last(/Ubiquiti AirOS by SNMP/system.hw.firmware,#2) and length(last(/Ubiquiti AirOS by SNMP/system.hw.firmware))>0 Info Manual close: Yes
Ubiquiti AirOS: Host has been restarted

Uptime is less than 10 minutes.

(last(/Ubiquiti AirOS by SNMP/system.hw.uptime[hrSystemUptime.0])>0 and last(/Ubiquiti AirOS by SNMP/system.hw.uptime[hrSystemUptime.0])<10m) or (last(/Ubiquiti AirOS by SNMP/system.hw.uptime[hrSystemUptime.0])=0 and last(/Ubiquiti AirOS by SNMP/system.net.uptime[sysUpTime.0])<10m) Warning Manual close: Yes
Depends on:
  • Ubiquiti AirOS: No SNMP data collection
Ubiquiti AirOS: System name has changed

The name of the system has changed. Acknowledge to close the problem manually.

last(/Ubiquiti AirOS by SNMP/system.name,#1)<>last(/Ubiquiti AirOS by SNMP/system.name,#2) and length(last(/Ubiquiti AirOS by SNMP/system.name))>0 Info Manual close: Yes
Ubiquiti AirOS: No SNMP data collection

SNMP is not available for polling. Please check device connectivity and SNMP settings.

max(/Ubiquiti AirOS by SNMP/zabbix[host,snmp,available],{$SNMP.TIMEOUT})=0 Warning Depends on:
  • Ubiquiti AirOS: Unavailable by ICMP ping
Ubiquiti AirOS: Unavailable by ICMP ping

Last three attempts returned timeout. Please check device connectivity.

max(/Ubiquiti AirOS by SNMP/icmpping,#3)=0 High
Ubiquiti AirOS: High ICMP ping loss min(/Ubiquiti AirOS by SNMP/icmppingloss,5m)>{$ICMP_LOSS_WARN} and min(/Ubiquiti AirOS by SNMP/icmppingloss,5m)<100 Warning Depends on:
  • Ubiquiti AirOS: Unavailable by ICMP ping
Ubiquiti AirOS: High ICMP ping response time avg(/Ubiquiti AirOS by SNMP/icmppingsec,5m)>{$ICMP_RESPONSE_TIME_WARN} Warning Depends on:
  • Ubiquiti AirOS: High ICMP ping loss
  • Ubiquiti AirOS: Unavailable by ICMP ping

LLD rule Network interfaces discovery

Name Description Type Key and additional info
Network interfaces discovery

Discovering interfaces from IF-MIB.

SNMP agent net.if.discovery

Item prototypes for Network interfaces discovery

Name Description Type Key and additional info
Interface {#IFDESCR}: Operational status

MIB: IF-MIB

The current operational state of the interface.

- The testing(3) state indicates that no operational packet scan be passed

- If ifAdminStatus is down(2) then ifOperStatus should be down(2)

- If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic

- It should change todormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection)

- It should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state

- It should remain in the notPresent(6) state if the interface has missing(typically, hardware) components.

SNMP agent net.if.status[ifOperStatus.{#SNMPINDEX}]
Interface {#IFDESCR}: Bits received

MIB: IF-MIB

The total number of octets received on the interface,including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and another times as indicated by the value of ifCounterDiscontinuityTime.

SNMP agent net.if.in[ifInOctets.{#SNMPINDEX}]

Preprocessing

  • Change per second
  • Custom multiplier: 8

Interface {#IFDESCR}: Bits sent

MIB: IF-MIB

The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.

SNMP agent net.if.out[ifOutOctets.{#SNMPINDEX}]

Preprocessing

  • Change per second
  • Custom multiplier: 8

Interface {#IFDESCR}: Inbound packets with errors

MIB: IF-MIB

For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.

SNMP agent net.if.in.errors[ifInErrors.{#SNMPINDEX}]

Preprocessing

  • Change per second
Interface {#IFDESCR}: Outbound packets with errors

MIB: IF-MIB

For packet-oriented interfaces, the number of outbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of outbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.

SNMP agent net.if.out.errors[ifOutErrors.{#SNMPINDEX}]

Preprocessing

  • Change per second
Interface {#IFDESCR}: Outbound packets discarded

MIB: IF-MIB

The number of outbound packets which were chosen to be discarded

even though no errors had been detected to prevent their being deliverable to a higher-layer protocol.

One possible reason for discarding such a packet could be to free up buffer space.

Discontinuities in the value of this counter can occur at re-initialization of the management system,

and at other times as indicated by the value of ifCounterDiscontinuityTime.

SNMP agent net.if.out.discards[ifOutDiscards.{#SNMPINDEX}]

Preprocessing

  • Change per second
Interface {#IFDESCR}: Inbound packets discarded

MIB: IF-MIB

The number of inbound packets which were chosen to be discarded

even though no errors had been detected to prevent their being deliverable to a higher-layer protocol.

One possible reason for discarding such a packet could be to free up buffer space.

Discontinuities in the value of this counter can occur at re-initialization of the management system,

and at other times as indicated by the value of ifCounterDiscontinuityTime.

SNMP agent net.if.in.discards[ifInDiscards.{#SNMPINDEX}]

Preprocessing

  • Change per second
Interface {#IFDESCR}: Interface type

MIB: IF-MIB

The type of interface.

Additional values for ifType are assigned by the Internet Assigned Numbers Authority (IANA),

through updating the syntax of the IANAifType textual convention.

SNMP agent net.if.type[ifType.{#SNMPINDEX}]

Preprocessing

  • Discard unchanged with heartbeat: 1d

Interface {#IFDESCR}: Speed

MIB: IF-MIB

An estimate of the interface's current bandwidth in bits per second.

For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made,

this object should contain the nominal bandwidth.

If the bandwidth of the interface is greater than the maximum value reportable by this object then

this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interface's speed.

For a sub-layer which has no concept of bandwidth, this object should be zero.

SNMP agent net.if.speed[ifSpeed.{#SNMPINDEX}]

Trigger prototypes for Network interfaces discovery

Name Description Expression Severity Dependencies and additional info
Interface {#IFDESCR}: Link down

This trigger expression works as follows:
1. It can be triggered if the operations status is down.
2. {$IFCONTROL:"{#IFNAME}"}=1 - a user can redefine context macro to value - 0. That marks this interface as not important. No new trigger will be fired if this interface is down.
3. {TEMPLATE_NAME:METRIC.diff()}=1 - the trigger fires only if the operational status was up to (1) sometime before (so, do not fire for the 'eternal off' interfaces.)

WARNING: if closed manually - it will not fire again on the next poll, because of .diff.

{$IFCONTROL:"{#IFNAME}"}=1 and last(/Ubiquiti AirOS by SNMP/net.if.status[ifOperStatus.{#SNMPINDEX}])=2 and (last(/Ubiquiti AirOS by SNMP/net.if.status[ifOperStatus.{#SNMPINDEX}],#1)<>last(/Ubiquiti AirOS by SNMP/net.if.status[ifOperStatus.{#SNMPINDEX}],#2)) Average Manual close: Yes
Interface {#IFDESCR}: High bandwidth usage

The utilization of the network interface is close to its estimated maximum bandwidth.

(avg(/Ubiquiti AirOS by SNMP/net.if.in[ifInOctets.{#SNMPINDEX}],15m)>({$IF.UTIL.MAX:"{#IFNAME}"}/100)*last(/Ubiquiti AirOS by SNMP/net.if.speed[ifSpeed.{#SNMPINDEX}]) or avg(/Ubiquiti AirOS by SNMP/net.if.out[ifOutOctets.{#SNMPINDEX}],15m)>({$IF.UTIL.MAX:"{#IFNAME}"}/100)*last(/Ubiquiti AirOS by SNMP/net.if.speed[ifSpeed.{#SNMPINDEX}])) and last(/Ubiquiti AirOS by SNMP/net.if.speed[ifSpeed.{#SNMPINDEX}])>0 Warning Manual close: Yes
Depends on:
  • Interface {#IFDESCR}: Link down
Interface {#IFDESCR}: High error rate

It recovers when it is below 80% of the {$IF.ERRORS.WARN:"{#IFNAME}"} threshold.

min(/Ubiquiti AirOS by SNMP/net.if.in.errors[ifInErrors.{#SNMPINDEX}],5m)>{$IF.ERRORS.WARN:"{#IFNAME}"} or min(/Ubiquiti AirOS by SNMP/net.if.out.errors[ifOutErrors.{#SNMPINDEX}],5m)>{$IF.ERRORS.WARN:"{#IFNAME}"} Warning Manual close: Yes
Depends on:
  • Interface {#IFDESCR}: Link down
Interface {#IFDESCR}: Ethernet has changed to lower speed than it was before

This Ethernet connection has transitioned down from its known maximum speed. This might be a sign of autonegotiation issues. Acknowledge to close the problem manually.

change(/Ubiquiti AirOS by SNMP/net.if.speed[ifSpeed.{#SNMPINDEX}])<0 and last(/Ubiquiti AirOS by SNMP/net.if.speed[ifSpeed.{#SNMPINDEX}])>0 and ( last(/Ubiquiti AirOS by SNMP/net.if.type[ifType.{#SNMPINDEX}])=6 or last(/Ubiquiti AirOS by SNMP/net.if.type[ifType.{#SNMPINDEX}])=7 or last(/Ubiquiti AirOS by SNMP/net.if.type[ifType.{#SNMPINDEX}])=11 or last(/Ubiquiti AirOS by SNMP/net.if.type[ifType.{#SNMPINDEX}])=62 or last(/Ubiquiti AirOS by SNMP/net.if.type[ifType.{#SNMPINDEX}])=69 or last(/Ubiquiti AirOS by SNMP/net.if.type[ifType.{#SNMPINDEX}])=117 ) and (last(/Ubiquiti AirOS by SNMP/net.if.status[ifOperStatus.{#SNMPINDEX}])<>2) Info Manual close: Yes
Depends on:
  • Interface {#IFDESCR}: Link down

Feedback

Please report any issues with the template at https://support.zabbix.com

You can also provide feedback, discuss the template, or ask for help at ZABBIX forums