Skip to main content

Pfsense Fauxapi

Overview​

At its core FauxAPI simply reads the core pfSense config.xml file, converts it to JSON and returns to the API caller. FauxAPI provides easy backup and restore API interfaces that by default store configuration backups on all configuration write operations thus it is very easy to roll-back even if the API user manages to deploy a “very broken” configuration.

Plugin-Pack Assets​

Monitored Objects​

  • Gateways
  • Rules
  • System
  • Backup-files

Collected Metrics​

More information about collected metrics is available in the official Pfsense Fauxapi documentation: https://github.com/ndejong/pfsense_fauxapi

Metric nameDescriptionUnit
backups.total.countTotal number of backupscount
backups.time.last.secondsLast backup time in seconds.s

Prerequisites​

A service account is required to request the Pfsense Fauxapi. It needs to have sufficient reading privileges in the environment. In terms of API rights, your configuration file must contain at least:

permit = config_backup_list, gateway_status, rule_get, system_stats

More infomation is avaible in official Pfsense Fauxpi documentation : https://github.com/ndejong/pfsense_fauxapi/blob/master/README.md

Setup​

  1. Install the Centreon Plugin on every poller monitoring Pfsense Fauxapi resources:
yum install centreon-plugin-Applications-Pfsense-Fauxapi.noarch
  1. On the Centreon Web interface in "Configuration > Plugin packs > Manager", install the Pfsense Fauxapi Plugin-Pack

Configuration​

The Plugin-Pack is designed to monitor resources based on one host per Pfsense Fauxapi environment. Adding a host into Centreon, link it to the template named App-Pfsense-Fauxapi-custom. Once the template applied, some Macros have to be configured:

MandatoryNameDescription
XAPIPORTPort used (Default: 443)
XAPIPROTOSpecify https if needed (Default: 'https')
XAPIKEYPfsense Fauxapi key
XAPISECRETPfsense Fauxapi secret
APIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --verbose flag)

FAQ​

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 poller using the centreon-engine user account and test by running the following command (Parameters such as api-key or api-secrethave to be adjusted):

/usr/lib/centreon/plugins/centreon_pfsense_fauxapi.pl \
    --plugin=apps::pfsense::fauxapi::plugin \
    --mode=gateways \
    --hostname='10.0.0.1' \
    --port='443' \
    --proto='https' \
    --api-key='myapikey' \
    --api-secret='myapisecret' \
    --filter-name='WAN_DHCP' \
    --critical-status='%{status} !~ /none/i' \
    --warning-packets-loss=5 \ 
    --critical-packets-loss=10 \
    --verbose

OK: Gateway 'WAN_DHCP' packets status: none, delay: 1.00 ms, loss: 9.00 %, stddev: 7.00 ms | 'WAN_DHCP#gateway.packets.delay.milliseconds'=1.00ms;;120;300; 'WAN_DHCP#gateway.packets.loss.percentage'=9.00%;;;5;10 'WAN_DHCP#gateway.packets.stddev.milliseconds'=7.00ms;;360;480;
Gateway 'WAN_DHCP' packets status: none, delay: 1.00 ms, loss: 9.00 %, stddev: 7.00 ms

The command above gets the status of a gateway Pfsense using Fauxapi (--mode=gateways) named WAN_DHCP (--filter-name='WAN_DHCP'). It uses api-key (--api-key='myapikey'), an api-secret (--api-secret='myapisecret') and it connects to the host 10.0.0.1 (--hostname='10.0.0.1') on the port 443 (--port='443') using https (--proto='https').

This command would trigger a CRITICAL alert if the returned status of the gateway is different from none (--critical-status='%{status} !~ /none/i').

This command will also trigger a WARNING alarm if the packets loss increase to 5% (--warning-packets-loss='5') and a CRITICAL alarm if it increases to 10% (--critical-packets-loss='10').

Thresholds can be set on all of the device metrics using the syntax --warning-*metric* --critical-*metric*.

All the options that can be used with this plugin can be found over the --help command:

/usr/lib/centreon/plugins//centreon_pfsense_fauxapi.pl --plugin=apps::pfsense::fauxapi::plugin \
--mode=gateways --help

Why do I get the following error:​

UNKNOWN: 500 Can't connect to mypfsense.com:443​

This error message means that the Centreon Plugin couldn't successfully connect to the Pfsense Fauxapi. Check that no third party device (such as a firewall) is blocking the request. A proxy connection may also be necessary to connect to the API. This can be done by using the --proxyurl='http://proxy.mycompany:8080' option in the command.

UNKNOWN: 501 Protocol scheme 'connect' is not supported |​

When using a proxy to connect to the Pfsense Fauxapi, this error message means that the Centreon Plugin library does not support the proxy connection protocol.

In order to prevent this issue, use the curl HTTP backend by adding the following option to the command: --http-backend='curl'.

How do I remove the count perfdatas if I want to filter on just one application ?​

The Plugin adds the count of objects by default. This can be useless if the objects are filtered with the --filter-name parameter. Therefore, these useless perfdatas can be omitted by adding a perfdata filter : --filter-perfdata='^$'.