OpenVPN OMI
Pack Assetsβ
Templatesβ
The Centreon Monitoring Connector OpenVPN OMI brings 1 host template :
- App-Openvpn-OMI-custom
It brings the following Service Template:
Service Alias | Service Template | Default |
---|---|---|
Server-Usage | App-Openvpn-Server-Usage-OMI | X |
Collected metrics & statusβ
- Server-Usage
Metric name | Description | Unit |
---|---|---|
clients.current.count | Number of current Clients | count |
server.traffic.in.bitspersecond | Server traffic in | b/s |
server.traffic.out.bitspersecond | Server traffic out | b/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β
- Online License
- Offline License
- Install the Centreon package on every Centreon poller expected to monitor your Open VPN server:
yum install centreon-plugin-Applications-Openvpn-Omi
- On the Centreon Web interface, install the OpenVPN OMI Centreon Monitoring Connector on the Configuration > Monitoring Connectors Manager page
- Install the Centreon package on every Centreon poller expected to monitor your Open VPN server:
yum install centreon-plugin-Applications-Openvpn-Omi
- Install the OpenVPN OMI Centreon Monitoring Connector RPM on the Centreon Central server:
yum install centreon-pack-applications-openvpn-omi
- On the Centreon Web interface, install the OpenVPN OMI Centreon Monitoring Connector on the Configuration > Monitoring Connectors Manager 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.
Mandatory | Name | Description |
---|---|---|
OMIEXTRAOPTIONS | ||
X | OMIPASSWORD | |
X | OMIPORT | 7505 |
EXTRAOPTIONS | Any 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