Microsoft Active Directory NRPE

Ce connecteur de supervision utilise NSClient++ et le protocole NRPE v2 pour superviser les contrôleurs de domaines Active Directory.

Contenu du pack

Modèles

Le connecteur de supervision Active Directory apporte un modèle d'hôte :

• Infra-ActiveDirectory-NRPE-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

Infra-ActiveDirectory-NRPE-custom

Alias	Modèle de service	Description
Ad-Domain-Controller	Infra-ActiveDirectory-Domain-Controller-NRPE-custom	Contrôle permettant de diagnostiquer le contrôleur de domaine. Exécute la commande "dcdiag"

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Infra-ActiveDirectory-NRPE-custom est utilisé.

Non rattachés à un modèle d'hôte

Alias	Modèle de service	Description
Dfsr-Backlog	Infra-ActiveDirectory-Dfsr-Backlog-NRPE-custom	Contrôle du backlog de réplication des Distributed File Systems.

Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, créez un service manuellement et appliquez le modèle de service souhaité.

Métriques & statuts collectés

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

Ad-Domain-Controller

Métrique	Unité
domain controller status	N/A

Dfsr-Backlog

Métrique	Unité
backlog.file.count	count

Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.

Prérequis

Centreon NSClient++

Pour superviser les ressources Windows via NRPE, installez la version Centreon de l'agent NSClient++. Veuillez suivre notre documentation officielle et assurez-vous que la configuration du serveur NRPE est correcte.

Installer le connecteur de supervision

Pack

1. 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

dnf install centreon-pack-infrastructure-active-directory-nrpe

Alma / RHEL / Oracle Linux 9

dnf install centreon-pack-infrastructure-active-directory-nrpe

Debian 11 & 12

apt install centreon-pack-infrastructure-active-directory-nrpe

CentOS 7

yum install centreon-pack-infrastructure-active-directory-nrpe

2. Quel que soit le type de la licence (online ou offline), installez le connecteur Active Directory depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

Alma / RHEL / Oracle Linux 8

dnf install nagios-plugins-nrpe

Alma / RHEL / Oracle Linux 9

dnf install nagios-plugins-nrpe

Debian 11 & 12

apt install nagios-nrpe-plugin

CentOS 7

yum install nagios-plugins-nrpe

Utiliser le connecteur de supervision

Utiliser un modèle d'hôte issu du connecteur

1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
3. Appliquez le modèle d'hôte Infra-ActiveDirectory-NRPE-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.
4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.

Macro	Description	Valeur par défaut	Obligatoire
NRPECLIENT	NRPE client used to perform the check.	check_nrpe
NRPEPORT	NRPE port of the monitored server	5666
NRPETIMEOUT	Timeout value	30
NRPEEXTRAOPTIONS	Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.	-u -2 -P 8192

5. 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

1. 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.
2. 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.

Ad-Domain-Controller

Macro	Description	Valeur par défaut	Obligatoire
LANGUAGE	Define the language to use in the configuration file	en
CONFIGFILE	The command can be localized by using a configuration file. This parameter can be used to specify an alternative location for the configuration file.
EXTRAOPTIONS	Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.

Dfsr-Backlog

Macro	Description	Valeur par défaut	Obligatoire
SENDINGMEMBER	Name of the member that is sending the replication data		X
REPLICATIONGROUP	Name of the replication group		X
REPLICATEDFOLDER	Name of the replicated folder		X
WARNINGBACKLOG	Warning threshold
CRITICALBACKLOG	Critical threshold
EXTRAOPTIONS	Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.

3. 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/lib64/nagios/plugins/check_nrpe -H 10.0.0.1 -p 5666 -t 30 -u -2 -P 8192 -c check_centreon_plugins -a 'apps::microsoft::activedirectory::local::plugin' 'dfsr-backlog'  ' \
    --sending-member="" \
    --replication-group="" \
    --replicated-folder="" \
    --warning-backlog="" \
    --critical-backlog="" '

La commande devrait retourner un message de sortie similaire à :

OK: Backlog File Count : 76 | 'backlog.file.count'=76;;;0;

Diagnostic des erreurs communes

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

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/lib64/nagios/plugins/check_nrpe -H 10.0.0.1 -p 5666 -u -2 -P 8192 -t 30  -c check_centreon_plugins -a 'apps::microsoft::activedirectory::local::plugin' 'dfsr-backlog'  '\
       --sending-member="" \
    --list-mode \
    '

Le plugin apporte les modes suivants :

Mode	Modèle de service associé
dcdiag [code]	Infra-ActiveDirectory-Domain-Controller-NRPE-custom
dfsr-backlog [code]	Infra-ActiveDirectory-Dfsr-Backlog-NRPE-custom
netdom [code]	Not used in this Monitoring Connector

Options disponibles

Options génériques

Les options génériques sont listées ci-dessous :

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.
--pass-manager	Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.

Options des modes

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

Ad-Domain-Controller

Option	Description
--config	The command can be localized by using a configuration file. This parameter can be used to specify an alternative location for the configuration file.
--language	Set the language used in config file (default: 'en').
--dfsr	Specifies that SysVol replication uses DFS instead of FRS (Windows 2008 or later)
--noeventlog	Don't run the dc tests kccevent, frsevent and dfsrevent.
--nomachineaccount	Don't run the dc tests machineaccount.
--timeout	Set timeout time for command execution (default: 30 sec).

Dfsr-Backlog

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.
--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. Example: 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). Example: 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). Example: 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). Example: 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. Example: 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. Example: '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'.
--sending-member	Name of the member that is sending the replication data. (mandatory)
--receiving-member	Name of the member that is receiving the replication data. (NOT Mandatory)
--replication-group	Name for the replication group. (mandatory)
--replicated-folder	Name name for the replicated folder. (mandatory)
--timeout	Timeout in seconds for the command (default: 30).
--warning-backlog	Warning threshold.
--critical-backlog	Critical threshold.

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/lib64/nagios/plugins//check_nrpe -H 10.0.0.1 -p 5666 -t 30 -u -2 -P 8192 -c check_centreon_plugins -a 'apps::microsoft::activedirectory::local::plugin' 'dfsr-backlog'  ' \
    --sending-member="" \
    --replication-group="" \
    --help