Skip to main content

IP Fabric API

Pack Assets​

Templates​

The Centreon Plugin Pack IP Fabric API brings a host template:

  • App-Ipfabric-Api-custom

It brings the following service template:

Service AliasService TemplateService DescriptionDefault
Path-VerificationApp-Ipfabric-Path-Verification-ApiCheck paths' statusX

Discovery rules​

The IP Fabric Plugin Pack includes a Host discovery provider to automatically discover network hosts registered in IP Fabric.

image

Collected metrics & status​

Metric NameUnit
total.path.all.countcount
total.path.error.countcount
total.path.none.countcount
total.path.part.countcount
total.path.mismatch.countcount
total.path.countcount
status#status

Prerequisites​

Ensure you have a IP Fabric API Key with required privileges and IP Fabric's API address.

Setup​

  1. Install the plugin package on every Centreon poller expected to monitor IP Fabric resources:
yum install centreon-plugin-Applications-Ipfabric-Api
  1. On the Centreon web interface, on page Configuration > Plugin Packs, install the IP Fabric API Centreon Plugin Pack.

Configuration​

Host​

  • Log into Centreon and add a new host through Configuration > Hosts.
  • Fill the Name, Alias & IP Address/DNS fields according to your IP Fabric server settings.
  • Apply the App-Ipfabric-Api-custom template to the host.
  • Once the template is applied, fill in the corresponding macros. Some macros are mandatory.
MandatoryMacroDescription
XAPIHOSTNAMEIP Fabric's API address.
XAPIKEYIP Fabric's API Key used to authenticate to IP Fabric API.
CUSTOMMODE(Default: 'api')
DUMMYOUTPUT(Default: 'This is a dummy check')
DUMMYSTATUS(Default: 'OK')
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 is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine) and test the plugin by running the following command:

/usr/lib/centreon/plugins//centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--mode=path-verification \
--custommode='' \
--api-key='' \
--hostname='' \
--warning-status='' \
--critical-status='%{expected_state} ne %{state}' \
--warning-total-path='' \
--critical-total-path='' \
--warning-total-mismatch='' \
--critical-total-mismatch='' \
--warning-error-path='' \
--critical-error-path='' \
--warning-none-path='' \
--critical-none-path='' \
--warning-part-path='' \
--critical-part-path='' \
--warning-all-path='' \
--critical-all-path='' \
--http-backend=curl\
--use-new-perfdata

The expected command output is shown below:

OK: Total number of paths: 10 Total mismatch: 0 Number of paths in All state: 8 Number of paths in Part state: 1 Number of paths in None state: 1 Number of paths in Error state: 0  | 'total.path.count'=10;;;0; 'total.path.mismatch.count'=0;;;0; 'total.path.all.count'=8;;;0; 'total.path.part.count'=1;;;0; 'total.path.none.count'=1;;;0; 'total.path.error.count'=0;;;0; 

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

/usr/lib/centreon/plugins//centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--mode=path-verification \
--help

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins//centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--list-mode

Troubleshooting​

Please find the troubleshooting documentation for the API-based plugins in this chapter.