Puppet Module for LibreNMS SNMP Agents
Description
Puppet Module to configure and distribute LibreNMS_SNMP_Agents.
(Server configuration will come in a future version also)
Dependencies
This Modul doesn't modify configuration of services the Agents are for. So please ensure the services you want to monitor match the requirements. Details for what to do are described or linked per Agent.
General Information
It's recommended to use puppet-hiera for configuration
Usage
Define Source of LibreNMS Agent Scripts
class { 'librenms':
use_local_agents => true,
}
-
use_local_agents
If set to false Agent Scripts will be copied directly from Github. Default: true
Discovery Trigger Configuration
Configuration of Discovery Trigger for LibreNMS. It's called everytime a LibreNMS Agent is installed.
class {'librenms::discovery':
librenms_server => 'librenms.local.domain',
api_token => 'myAdminApiToken',
transport_protocol => 'http',
}
-
librenms_server
The FQDN or IP Address on which LibreNMS is listen -
api_token
is the API Token generated in LibreNMS from an Admin User -
transport_protocol
defines the used transportprotocol. Can behttp
orhttps
Which Agent Scripts should be installed
class {'librenms::application':
apache2 => false,
asterisk => false,
backupninja => false,
bind => false,
certificate => false,
chip => false,
dhcp => false,
distribution => false,
entropy => false,
exim => false,
freeradius => false,
freeswitch => false,
gpsd => false,
mdadm => false,
icecast => false,
memcached => false,
mysql => false,
nfs_client => false,
nfs_server => false,
nginx => false,
ntp_client => false,
ntp_server => false,
nvidia => false,
open_grid_scheduler => false,
opensips => false,
osupdate => false,
php_fpm => false,
pi_hole => false,
portactivity => false,
postfix => false,
powerdns => false,
powerdns_recursor => false,
puppet_agent => false,
pureftpd => false,
redis => false,
sdfsinfo => false,
seafile => false,
smartmontools => false,
squid => false,
ups_apcups => false,
ups_nut => false,
voipmon => false,
zfs => false,
}
-
<Agent Name>
A boolean on whether or not the agent has to be installed. Default: false
LibreNMS Agent Configuration
- Apache - SNMP extend
- Asterisk - SNMP extend
- Backupninja - SNMP extend
- BIND9/named - SNMP extend
- C.H.I.P - SNMP extend
- Certificate - SNMP extend
- DHCP Stats - SNMP extend
- Distribution - SNMP extend
- Entropy - SNMP extend
- Exim - SNMP extend
- FreeRADIUS - SNMP extend
- FreeSwitch - SNMP extend
- GPSD - SNMP extend
- Icecast - SNMP extend
- Mailcow-dockerized Postfix - SNMP extend
- Mailscanner - SNMP extend
- Mdadm - SNMP extend
- Memcached - SNMP extend
- MySQL - SNMP extend
- NFS Client - SNMP extend
- NFS Server - SNMP extend
- Nginx - SNMP extend
- NTP Client - SNMP extend
- NTP Server/NTPD - SNMP extend
- Nvidia GPU - SNMP extend
- Open Grid Scheduler - SNMP extend
- Opensips - SNMP extend
- OS Updates - SNMP extend
- PHP FPM - SNMP extend
- Pi-Hole - SNMP extend
- Portactivity - SNMP extend
- Postfix - SNMP extend
- PowerDNS - SNMP extend
- PowerDNS Recursor - SNMP extend
- Puppet Agent - SNMP extend
- PureFTPd - SNMP extend
- Redis - SNMP extend
- SDFSinfo - SNMP extend
- Seafile - SNMP extend
- SMART - SNMP extend
- Squid - SNMP extend
- UPS APCUPS - SNMP extend
- UPS Nut - SNMP extend
- Voip Monitor - SNMP extend
- ZFS - SNMP extend
Apache
class { 'librenms::applications::apache2':
}
Ensure all depending configurations are done. For Details take a look here Apache2
Asterisk
class { 'librenms::applications::asterisk':
}
No further configurations needed.
Backupninja
class { 'librenms::applications::backupninja':
}
No further configurations needed.
Bind
class { 'librenms::applications::bind':
rndc => '/usr/sbin/rndc',
call_rndc => true,
stats_file => '/var/run/named/stats',
agent => false,
zero_stats => false,
}
-
rndc
The path to rndc -
call_rndc
A boolean on whether or not to call rndc stats. Suggest to set to false if using netdata. Default: true -
stats_file
The path to the named stats file. Default: /var/cache/bind/stats -
agent
A boolean for if this is being used as a LibreNMS agent or not. Default: false -
zero_stats
A boolean for if the stats file should be zeroed first. Default: false (true if guessed)
Ensure all depending configurations are done. For Details take a look here Bind
Certificate
class { 'librenms::applications::certificate':
certificates = {},
}
-
certificates
A Hash of certificates to check Default: {}
Example:
{'domains' => [
{'fqdn' => 'www.mydomain.com'},
{'fqdn' => 'some.otherdomain.org',
'port' => 8443},
{'fqdn' => 'personal.domain.net'}
]
}
-
fqdn
the domain to check -
port
If port differs from 443 you can specify it with this optional argument
Chip
class { 'librenms::applications::chip':
}
No further configurations needed.
DHCP-Stats
class { 'librenms::applications::dhcp':
lease_file => '/var/lib/dhcp/dhcpd.leases',
}
-
lease_file
Lease File of DHCP Stats. Default: /var/lib/dhcp/dhcpd.leases
Distribution
This Agent returns Operation System Details to LibreNMS
class { 'librenms::applications::distribution':
}
No further configurations needed.
Entropy
class { 'librenms::applications::entropy':
}
No further configurations needed.
Exim
class { 'librenms::applications::exim':
}
No further configurations needed.
Fail2ban
class { 'librenms::applications::fail2ban':
cache => true,
}
-
true
If you want to cache results. Default: true
FreeRadius
class { 'librenms::applications::bind':
radius_server => 'localhost',
radius_port => 18121,
radius_key => 'adminsecret',
}
-
radius_server
IP or Domain Radius Server is listen on. Default: localhost -
radius_port
Port on which Radius Server is listening. Default: 18121 -
radius_key
Key for authentication.
Ensure all depending configurations are done. For Details take a look here FreeRadius
Freeswitch
class { 'librenms::applications::freeswitch':
}
No further configurations needed.
GPSD
class { 'librenms::applications::gpsd':
}
No further configurations needed.
Icecast
class { 'librenms::applications::icecast':
}
No further configurations needed.
Mailcow-dockerized postfix
class { 'librenms::applications::mailcow_dockerized_postfix':
}
No further configurations needed.
Mailscanner
class { 'librenms::applications::mailscanner':
}
No further configurations needed.
Mdadm
class { 'librenms::applications::mdadm':
}
No further configurations needed.
Memcached
class { 'librenms::applications::memcached':
}
No further configurations needed.
MySQL
class { 'librenms::applications::mysql':
user => 'root',
pass => 'root',
host => 'localhost',
port => 3306,
}
-
user
Username. Default: root -
pass
Password. Default: root -
host
IP or Hostname Database Server is listening on. Default: localhost -
port
Port Database Server is listening on. Default 3306
NFS Client
Only FreeBSD Version present
class { 'librenms::applications::nfs_client':
}
No further configurations needed.
NFS Server
class { 'librenms::applications::nfs_server':
}
No further configurations needed.
Nginx
class { 'librenms::applications::nginx':
}
Ensure all depending configurations are done. For Details take a look here Nginx
NTP-Client
class { 'librenms::applications::ntp_client':
}
No further configurations needed.
NTP-Server aka NTPd
class { 'librenms::applications::ntp_server':
}
No further configurations needed.
Nvidia GPU
class { 'librenms::applications::nvidia':
}
No further configurations needed.
Open Grid Scheduler
class { 'librenms::applications::open_grid_scheduler':
}
No further configurations needed.
Opensips
class { 'librenms::applications::opensips':
}
No further configurations needed.
OS-Updates
class { 'librenms::applications::osupdate':
}
No further configurations needed.
PHP FPM
class { 'librenms::applications::php_fpm':
}
No further configurations needed.
Pi Hole
class { 'librenms::applications::pi_hole':
api_auth_key => 'someapiauthkey'
}
-
api_auth_key
To get all data you must configure your API auth token from Pi-hole server.
Portactivity
class { 'librenms::applications::portactivity':
services => [],
}
-
services
List of Services to be monitored
Example:
['http, 'ldap', 'imap']
Services should be listed in /etc/services
Postfix
class { 'librenms::applications::postfix':
}
No further configurations needed.
Postgres
class { 'librenms::applications::postgres':
}
No further configurations needed.
PowerDNS
class { 'librenms::applications::powerdns':
}
No further configurations needed.
PowerDNS dnsdist
class { 'librenms::applications::powerdns_dnsdist':
}
No further configurations needed.
PowerDNS Recursor
class { 'librenms::applications::powerdns_recursor':
}
Add to the LibreNMS config.php
file such options:
$config['apps']['powerdns-recursor']['api-key']
required, this is defined in the Recursor config
$config['apps']['powerdns-recursor']['port']
numeric, defines the port to connect to PowerDNS Recursor on. The default is 8082
$config['apps']['powerdns-recursor']['https']
true or false, defaults to use http.
Proxmox
class { 'librenms::applications::proxmox':
}
No further configurations needed.
Puppet Agent
class { 'librenms::applications::puppet_agent':
}
Ensure all depending configurations are done. For Details take a look here Puppet_Agent
PureFTPd
class { 'librenms::applications::pureftpd':
}
No further configurations needed.
Raspberry Pi
class { 'librenms::applications::raspberry_pi':
}
No further configurations needed.
Redis
class { 'librenms::applications::redis':
}
No further configurations needed.
SDFS info
class { 'librenms::applications::sdfsinfo':
}
No further configurations needed.
Seafile
class { 'librenms::applications::seafile':
url => 'seafile.mydomain.local',
login => 'somelogin',
password => 'somepassword',
identifier => 'name',
hide_monitoring_account => true,
}
-
url
Url how to get access to Seafile Server. Default: '' -
login
Login to Seafile Server. It is important that used Login has admin privileges. Otherwise most API calls will be denied. Default: '' -
password
Password to the configured login. Default: '' -
identifier
Defines how user accounts are listed in RRD Graph. Options are: name, email. Default: name -
hide_monitoring_account
With this Boolean you can hide the Account which you use to access Seafile API. Default: true
Smart
class { 'librenms::applications::seafile':
cache => '/var/cache/smart',
use_sn => true,
smart_options => {},
}
-
cache
File in which Smart Values should be cached. Default: /var/cache/smart -
use_sn
A Boolean which defines if Serial Number of Device or Block Device Name should be used. Default: true -
smart_options
A Hash to add additional Smartctl Parameters to specified Block Devices. Default: {}
Example:
{'da5' => '-d sat',
'twl0,0' => '/dev/twl0 - 3ware,0',
'twl0,1' => '/dev/twl0 - 3ware,1',
'twl0,2' => '/dev/twl0 - 3ware,2',
}
Squid
class { 'librenms::applications::squid':
snmp_community => 'squid_snmp_community',
}
-
snmp_community
SNMP Community Squid uses to publish it's data
Ensure all depending configurations are done. For Details take a look here Squid
Unbound
class { 'librenms::applications::unbound':
}
Ensure all depending configurations are done. For Details take a look here Unbound
UPS APCUPS
class { 'librenms::applications::ups_apcups':
}
No further configurations needed.
UPS Nut
class { 'librenms::applications::ups_nut':
}
No further configurations needed.
Voipmon
class { 'librenms::applications::voipmon':
}
No further configurations needed.
ZFS
class { 'librenms::applications::zfs':
}
No further configurations needed.