Aller au contenu principal

Microsoft Active Directory NSClient++ API

Contenu du pack​

Modèles​

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

  • Infra-ActiveDirectory-NSClient-05-Restapi-custom

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

AliasModèle de serviceDescription
Ad-Domain-ControllerInfra-ActiveDirectory-Domain-Controller-NSClient05-Restapi-customContrô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-NSClient-05-Restapi-custom est utilisé.

Métriques & statuts collectés​

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

MétriqueUnité
domain controller statusN/A

Prérequis​

Centreon NSClient++​

Pour superviser une ressource via NSClient++ API, installez la version Centreon de l'agent NSClient++. Veuillez suivre notre documentation officielle et assurez-vous que la configuration du serveur Web / RestAPI 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 :
dnf install centreon-pack-infrastructure-active-directory-nsclient-05-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Active Directory API 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 :

dnf install centreon-plugin-Operatingsystems-Windows-Restapi

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-NSClient-05-Restapi-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.
MacroDescriptionValeur par défautObligatoire
NSCPRESTAPILEGACYPASSWORDPassword used (configured in the prerequisites section)PASSWORD
NSCPRESTAPIPROTOProtocol usedhttps
NSCPRESTAPIPORTPort used by the REST API NSClient++8443
NSCPRESTAPIEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). All options are listed here.
  1. 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.
MacroDescriptionValeur par défautObligatoire
LANGUAGESet the language used in config fileen
CONFIGFILEThe command can be localized by using a configuration file. This parameter can be used to specify an alternative location for the configuration file.
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. 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_nsclient_restapi.pl \
    --plugin=apps::nsclient::restapi::plugin \
    --mode=query \
    --hostname='10.0.0.1' \
    --port='8443' \
    --proto='https' \
    --legacy-password='PASSWORD'  \
    --command=check_centreon_plugins \
    --arg='apps::microsoft::activedirectory::local::plugin' \
    --arg='dfsr-backlog' \
    --arg=' \
    --sending-member="" \
    --replication-group="" \
    --replicated-folder="" \
    --warning-backlog="" \
    --critical-backlog="" '

La commande devrait retourner un message de sortie similaire à :

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

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_nsclient_restapi.pl \
    --plugin=apps::nsclient::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
dcdiag [code]Infra-ActiveDirectory-Domain-Controller-NSClient05-Restapi-custom
dfsr-backlog [code]Infra-ActiveDirectory-Dfsr-Backlog-NSClient05-Restapi-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 :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--pass-managerDefine 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 :

OptionDescription
--configThe command can be localized by using a configuration file. This parameter can be used to specify an alternative location for the configuration file.
--languageSet the language used in config file (default: 'en').
--dfsrSpecifies that SysVol replication uses DFS instead of FRS (Windows 2008 or later)
--noeventlogDon't run the dc tests kccevent, frsevent and dfsrevent.
--nomachineaccountDon't run the dc tests machineaccount.
--timeoutSet timeout time for command execution (default: 30 sec).

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_nsclient_restapi.pl \
    --plugin=apps::nsclient::restapi::plugin \
    --mode=query \
    --help