IP Fabric API
Contenu du pack​
Modèles​
Le connecteur de supervision IP Fabric API apporte un modèle d'hôte :
- App-Ipfabric-Api-custom
Le connecteur apporte le modèle de service suivant (classé selon le modèle d'hôte auquel il est rattaché) :
- App-Ipfabric-Api-custom
| Alias | Modèle de service | Description |
|---|---|---|
| Path-Verification | App-Ipfabric-Path-Verification-Api-custom | Contrôle permettant de vérifier l'état des routes |
Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-Ipfabric-Api-custom est utilisé.
Règles de découverte​
Découverte d'hôtes​
| Nom de la règle | Description |
|---|---|
| IP Fabric network devices | Discover network devices through IP Fabric API |
Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.
Métriques & statuts collectés​
Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.
- Path-Verification
| Métrique | Unité |
|---|---|
| paths.detected.count | count |
| paths.mismatch.count | count |
| paths.state.all.count | count |
| paths.state.part.count | count |
| paths.state.none.count | count |
| paths.state.error.count | count |
| paths#status | N/A |
Prérequis​
Assurez-vous d'avoir une clef API avec les droits suffisants ainsi que l'adresse de l'API IP Fabric.
Installer le connecteur de supervision​
Pack​
- Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11
- CentOS 7
dnf install centreon-pack-applications-ipfabric-api
dnf install centreon-pack-applications-ipfabric-api
apt install centreon-pack-applications-ipfabric-api
yum install centreon-pack-applications-ipfabric-api
- Quel que soit le type de la licence (online ou offline), installez le connecteur IP Fabric API depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.
Plugin​
À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.
Plus d'informations dans la section Installer le plugin.
Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11
- CentOS 7
dnf install centreon-plugin-Applications-Ipfabric-Api
dnf install centreon-plugin-Applications-Ipfabric-Api
apt install centreon-plugin-applications-ipfabric-api
yum install centreon-plugin-Applications-Ipfabric-Api
Utiliser le connecteur de supervision​
Utiliser un modèle d'hôte issu du connecteur​
- Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
- Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
- Appliquez le modèle d'hôte App-Ipfabric-Api-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
- Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
| Macro | Description | Valeur par défaut | Obligatoire |
|---|---|---|---|
| APIHOSTNAME | Set hostname, it is mandatory | X | |
| APIKEY | Set API key to request IP Fabric API | X | |
| APIEXTRAOPTIONS | Any extra option you may want to add to every command (E.g. a --verbose flag). Toutes les options sont listées ici |
- Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.
Utiliser un modèle de service issu du connecteur​
- Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
- Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
- Path-Verification
| Macro | Description | Valeur par défaut | Obligatoire |
|---|---|---|---|
| FILTERSRCIP | Filter paths by source ip (regexp can be used) | ||
| FILTERSRCPORT | Filter paths by source port (regexp can be used) | ||
| FILTERDSTIP | Filter paths by destionation ip (regexp can be used) | ||
| FILTERDSTPORT | Filter paths by destionation port (regexp can be used) | ||
| WARNINGPATHSDETECTED | Thresholds | ||
| CRITICALPATHSDETECTED | Thresholds | ||
| WARNINGPATHSMISMATCH | Thresholds | ||
| CRITICALPATHSMISMATCH | Thresholds | ||
| WARNINGPATHSSTATEALL | Thresholds | ||
| CRITICALPATHSSTATEALL | Thresholds | ||
| WARNINGPATHSSTATEERROR | Thresholds | ||
| CRITICALPATHSSTATEERROR | Thresholds | ||
| WARNINGPATHSSTATENONE | Thresholds | ||
| CRITICALPATHSSTATENONE | Thresholds | ||
| WARNINGPATHSSTATEPART | Thresholds | ||
| CRITICALPATHSSTATEPART | Thresholds | ||
| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. (Default: '%{expected_state} ne %{state}'). Can use special variables like: %{state}, %{expected_state} For example, if you want a critical alert when the path state is in 'error' then the option would be: --critical-status="%{state} eq 'all'" | %{expected_state} ne %{state} | |
| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. Can use special variables like: %{state}, %{expected_state} For example, if you want a warning alert when the path state is in 'error' then the option would be: --warning-status="%{state} eq 'all'" | ||
| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici | --http-backend=curl |
- Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.
Comment puis-je tester le plugin et que signifient les options des commandes ?​
Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne
de commande depuis votre collecteur Centreon en vous connectant avec
l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester
que le connecteur arrive bien à superviser une ressource en utilisant une commande
telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :
/usr/lib/centreon/plugins/centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--mode=path-verification \
--api-key='****' \
--hostname='demo1.eu.ipfabric.io' \
--verbose
La commande devrait retourner un message de sortie similaire à :
CRITICAL: source 10.35.119.172:- destination 10.193.0.132:- [protocol: icmp] state: none [expected state: all] - source 10.72.126.112:1024-65535 destination 10.66.121.110:80,443 [protocol: tcp] state: none [expected state: all] - source 10.66.126.112:10000 destination 10.38.115.190:443 [protocol: tcp] state: none [expected state: all] | 'paths.detected.count'=6;;;0; 'paths.mismatch.count'=3;;;0; 'paths.state.all.count'=0;;;0; 'paths.state.part.count'=0;;;0; 'paths.state.none.count'=6;;;0; 'paths.state.error.count'=0;;;0;
source 10.35.119.172:- destination 10.193.0.132:- [protocol: icmp] state: none [expected state: all]
source 10.35.119.172/26:1024-65535 destination 10.193.0.132:1-60000 [protocol: tcp] state: none [expected state: none]
source 10.35.119.172/24:1024-65535 destination 10.193.0.132:80 [protocol: tcp] state: none [expected state: none]
source 10.72.126.112:1024-65535 destination 10.66.121.110:80,443 [protocol: tcp] state: none [expected state: all]
source 10.66.126.112:10000 destination 10.38.115.190:443 [protocol: tcp] state: none [expected state: all]
source 10.35.119.172/28:1024-65535 destination 10.193.0.132/28:1-60000 [protocol: tcp] state: none [expected state: none]
Diagnostic des erreurs communes​
Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.
Modes disponibles​
Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.
Tous les modes disponibles peuvent être affichés en ajoutant le paramètre
--list-mode à la commande :
/usr/lib/centreon/plugins/centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--list-mode
Le plugin apporte les modes suivants :
| Mode | Modèle de service associé |
|---|---|
| discovery [code] | Used for host discovery |
| path-verification [code] | App-Ipfabric-Path-Verification-Api-custom |
Custom modes disponibles​
Ce connecteur offre plusieurs méthodes pour se connecter à la ressource (CLI, bibliothèque, etc.), appelées custom modes.
Tous les custom modes disponibles peuvent être affichés en ajoutant le paramètre
--list-custommode à la commande :
/usr/lib/centreon/plugins/centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--list-custommode
Le plugin apporte les custom modes suivants :
- api
Options disponibles​
Options des custom modes​
Les options spécifiques aux custom modes sont listées ci-dessous :
- api
| Option | Description | Type |
|---|---|---|
| --hostname | Set hostname, it is mandatory. | Api |
| --snapshot-id | Specify snapshot id from which you want to base monitoring. If no snapshot id is specified, the last one is set by default. | Api |
| --port | Port used (Default: 443) | Api |
| --proto | Specify http if needed (Default: 'https') | Api |
| --api-key | Set API key to request IP Fabric API. | Api |
| --timeout | Set timeout in seconds (Default: 10). | Api |
| --http-peer-addr | Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution. | Http global |
| --proxyurl | Proxy URL. Eg: http://my.proxy:3128 | Http global |
| --proxypac | Proxy pac file (can be a URL or a local file). | Http global |
| --insecure | Accept insecure SSL connections. | Http global |
| --http-backend | Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl. | Http global |
| --ssl-opt | Set SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE"). | Backend lwp |
| --curl-opt | Set CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ). | Backend curl |
Options des modes​
Les options disponibles pour chaque modèle de services sont listées ci-dessous :
- Path-Verification
| Option | Description |
|---|---|
| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). |
| --dyn-mode | Specify a mode with the module's path (advanced). |
| --list-mode | List all available modes. |
| --mode-version | Check minimal version of mode. If not, unknown error. |
| --version | Return the version of the plugin. |
| --custommode | When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option. |
| --list-custommode | List all available custom modes. |
| --multiple | Multiple custom mode objects. This may be required by some specific modes (advanced). |
| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
| --verbose | Display extended status information (long output). |
| --debug | Display debug messages. |
| --filter-perfdata | Filter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. |
| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. |
| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;; |
| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent() |
| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)' |
| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' |
| --change-exit | Replace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. |
| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. |
| --filter-uom | Mask the units when they don't match the given regular expression. |
| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. |
| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. |
| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...' |
| --output-xml | Return the output in XML format (to send to an XML API). |
| --output-json | Return the output in JSON format (to send to a JSON API). |
| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). |
| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. |
| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). |
| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. |
| --float-precision | Define the float precision for thresholds (default: 8). |
| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. IP Fabric API module. |
| --hostname | Set hostname, it is mandatory. |
| --snapshot-id | Specify snapshot id from which you want to base monitoring. If no snapshot id is specified, the last one is set by default. |
| --port | Port used (Default: 443) |
| --proto | Specify http if needed (Default: 'https') |
| --api-key | Set API key to request IP Fabric API. |
| --timeout | Set timeout in seconds (Default: 10). |
| --http-peer-addr | Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution. |
| --proxyurl | Proxy URL. Eg: http://my.proxy:3128 |
| --proxypac | Proxy pac file (can be a URL or a local file). |
| --insecure | Accept insecure SSL connections. |
| --http-backend | Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl. |
| --ssl-opt | Set SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE"). |
| --curl-opt | Set CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ). |
| --filter-src-ip | Filter paths by source ip (regexp can be used). |
| --filter-src-port | Filter paths by source port (regexp can be used). |
| --filter-dst-ip | Filter paths by destionation ip (regexp can be used). |
| --filter-dst-port | Filter paths by destionation port (regexp can be used). |
| --warning-status | Define the conditions to match for the status to be WARNING. Can use special variables like: %{state}, %{expected_state} For example, if you want a warning alert when the path state is in 'error' then the option would be: --warning-status="%{state} eq 'all'" |
| --critical-status | Define the conditions to match for the status to be CRITICAL. (Default: '%{expected_state} ne %{state}'). Can use special variables like: %{state}, %{expected_state} For example, if you want a critical alert when the path state is in 'error' then the option would be: --critical-status="%{state} eq 'all'" |
| --warning- --critical- | Thresholds. Can be: 'paths-detected', 'paths-mismatch', 'paths-state-all', 'paths-state-part', 'paths-state-none', 'paths-state-error'. |
Pour un mode, la liste de toutes les options disponibles et leur signification peut être
affichée en ajoutant le paramètre --help à la commande :
/usr/lib/centreon/plugins/centreon_ipfabric_api.pl \
--plugin=apps::ipfabric::plugin \
--mode=path-verification \
--help