Skip to main content

OpenVPN OMI

Pack Assets​

Templates​

The Centreon Plugin Pack OpenVPN OMI brings 1 host template :

  • App-Openvpn-OMI-custom

It brings the following Service Template:

Service AliasService TemplateDefault
Server-UsageApp-Openvpn-Server-Usage-OMIX

Collected metrics & status​

Metric nameDescriptionUnit
clients.current.countNumber of current Clientscount
server.traffic.in.bitspersecondServer traffic inb/s
server.traffic.out.bitspersecondServer traffic outb/s

Prerequisites​

The Open VPN server must have an management interface running and available. A user and password dedicated to monitoring is needed for security reasons.

Setup​

  1. Install the Centreon Plugin package on every Centreon poller expected to monitor your Open VPN server:
yum install centreon-plugin-Applications-Openvpn-Omi
  1. On the Centreon Web interface, install the OpenVPN OMI Centreon Plugin Pack on the Configuration > Plugin Packs page

Configuration​

Host​

  • Log into Centreon and add a new Host through Configuration > Hosts.
  • Fill the "Name", "Alias" & "IP Address / DNS" fields according to your Open VPN server settings
  • Select the Applications-Openvpn-Omi-custom template to apply to the Host
  • Once the template applied, some Macros marked as 'Mandatory' hereafter have to be configured.
MandatoryNameDescription
OMIEXTRAOPTIONS
XOMIPASSWORD
XOMIPORT7505
EXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)

How to check in the CLI that the configuration is OK 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_openvpn_omi.pl \
--plugin=apps::openvpn::omi::plugin \
--mode=server-usage \
--omi-hostname='10.0.0.1' \
--omi-password='' \
--omi-port='7505' \
--warning-num-clients='' \
--critical-num-clients='' \
--warning-traffic-in='' \
--critical-traffic-in='' \
--warning-traffic-out='1000000' \
--critical-traffic-out='2000000' \
--use-new-perfdata

Expected command output is shown below:

OK : Current Clients: 9000 Traffic In: 900 kb/s Traffic Out: 900 kb/s | 'clients.current.count'=9000;;;0; 'server.traffic.in.bitspersecond'=900000b/s;;;0; 'server.traffic.out.bitspersecond'=900000b/s;1000000;2000000;0; 

This command would trigger a WARNING alarm if the traffic out is reported as over 1000000b/s (--warning-traffic-out=1000000) and a CRITICAL alarm if over than 2000000b/s (--critical-traffic-out='2000000').

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins//centreon_openvpn_omi.pl \
--plugin=apps::openvpn::omi::plugin \
--mode=server-usage \
--help

All available options for a given mode can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins//centreon_openvpn_omi.pl \
--plugin=apps::openvpn::omi::plugin \
--list-mode

Troubleshooting​

Please find all the troubleshooting documentation for the Centreon Plugins in the dedicated page