Aller au contenu principal

Windows NSClient API

NSClient++ Rest API fournit sa propre API Rest via le module Webserver et permet d'exploiter au maximum les données de monitoring des serveurs Windows à travers une connexion HTTP sécurisée.

Le connecteur permet de superviser :

  • Windows Server OS à partir de la version 2003 SP2
  • Windows (postes de travail) à partir de la version XP

Contenu du pack​

Modèles​

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

  • OS-Windows-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
CpuOS-Windows-NSClient05-Cpu-Restapi-customContrôle du taux d'utilisation du CPU de la machine. Ce contrôle pourra remonter la moyenne du taux d'utilisation des CPU ainsi que le taux par CPU pour les CPU multi-coeur
DisksOS-Windows-NSClient05-Disks-Restapi-customContrôle le taux d'utilisation des disques Windows
MemoryOS-Windows-NSClient05-Memory-Restapi-customContrôle du taux d'utilisation de la mémoire vive
Services-AutoOS-Windows-NSClient05-Services-Auto-Restapi-customContrôle permettant de vérifier si les services automatiques sont démarrés
SwapOS-Windows-NSClient05-Swap-Restapi-customContrôle du taux d'utilisation de la mémoire virtuelle

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte OS-Windows-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é
Sessions_valuecount

Prérequis​

Centreon NSClient++​

Pour superviser une ressource via NSClient++ API, installez la version Centreon de l'agent NSClient++ sur la ressource supervisée. Suivez notre documentation officielle et assurez-vous que la configuration du serveur Web / RestAPI est correcte.

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  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 > Connecteurs > 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-operatingsystems-windows-nsclient-05-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Windows NSClient API depuis l'interface web et le menu Configuration > Connecteurs > 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 OS-Windows-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
NSCPRESTAPILEGACYPASSWORDSpecify password for old authentification system
NSCPRESTAPIPROTOSpecify https if needed (Default: 'https')https
NSCPRESTAPIPORTPort used (Default: 8443)8443
NSCPRESTAPIEXTRAOPTIONSAny extra option you may want to add to every command (E.g. a --verbose flag). Toutes les options sont listées ici
  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
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici--arg=show-all
  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=''  \
	--command=check_centreon_plugins \
	--arg='os::windows::local::plugin' \
	--arg='updates' \
	--arg='\
	--filter-title="" \
	--exclude-title="" \
	--filter-mandatory="" \
	--warning-pending-updates="" \
	--critical-pending-updates="" \
	--verbose \
	--display-updates '

La commande devrait retourner un message de sortie similaire à :

OK: windows pending updates: 32 | 'windows.pending.updates.count'=32;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API si votre erreur ne correspond pas à l'un des cas suivants.

UNKNOWN: Cannot decode json response: malformed UTF-8 character in JSON string​

Si vous recevez ce message, activez le mode --debug pour visualiser l'exécution détaillée d'un mode:

/usr/lib/centreon/plugins//centreon_nsclient_restapi.pl \
  --plugin=apps::nsclient::restapi::plugin \
  --mode=query \
  --hostname='192.168.1.24' \
  --port='8443' \
  --proto='https' \
  --legacy-password='centreon' \
  --http-backend=curl  \
  --curl-opt="CURLOPT_SSL_VERIFYPEER => 0" \
  --timeout=30 \
  --command=check_centreon_plugins \
  --arg='os::windows::local::plugin' \
  --arg='sessions' \
  --arg='--filter-sessionname="" \
  --config="scripts/centreon/conf/qwinsta.xml" \
  --language="fr" \
  --debug

UNKNOWN: Cannot decode json response: malformed UTF-8 character in JSON string, at character offset 724 (before "\x{fffd}u0090RIPH\x{fffd}...") at /usr/lib/centreon/plugins//centreon_nsclient_restapi.pl line 133.
== Info: About to connect() to 192.168.1.24 port 8443 (#0)
== Info:   Trying 192.168.1.24...
== Info: Connected to 192.168.1.24 (192.168.1.24) port 8443 (#0)
.......
Cannot write statefile '/var/lib/centreon/centplugins/windows_sessions_a181a603769c1f98ad927e7367c7aa51_a181a603769c1f98ad927e7367c7aa51'. 
Need write/exec permissions on directory.
  • Le dossier /var/lib/centreon/centplugins n'existe pas sur votre serveur Windows, dans ce cas spécifiez un répertoire Windows existant via l'option --statefile-dir afin de stocker les fichiers de cache du Plugin.

"UNKNOWN: 500 Can't connect to x.x.x.x:8443"​

Si vous recevez ce message, ajoutez l'option '--http-backend=curl' dans la macro d'hôte NSCPRESTAPIEXTRAOPTIONS.

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é
certificates [code]Not used in this Monitoring Connector
cmd-return [code]Not used in this Monitoring Connector
list-certificates [code]Not used in this Monitoring Connector
list-storages [code]Not used in this Monitoring Connector
pending-reboot [code]OS-Windows-NSClient05-Pending-Reboot-Restapi-custom
query [code]OS-Windows-NSClient05-Counter-Active-Sessions-Restapi-custom
OS-Windows-NSClient05-Counter-Generic-Restapi-custom
OS-Windows-NSClient05-Cpu-Restapi-custom
OS-Windows-NSClient05-Disks-Restapi-custom
OS-Windows-NSClient05-Eventlog-Generic-restapi-custom
OS-Windows-NSClient05-Files-Generic-Restapi-custom
OS-Windows-NSClient05-Logfiles-Generic-Restapi-custom
OS-Windows-NSClient05-Memory-Restapi-custom
OS-Windows-NSClient05-Process-Generic-Restapi-custom
OS-Windows-NSClient05-Services-Auto-Restapi-custom
OS-Windows-NSClient05-Services-Generic-Name-Restapi-custom
OS-Windows-NSClient05-Swap-Restapi-custom
OS-Windows-NSClient05-Task-Generic-Restapi-custom
OS-Windows-NSClient05-Uptime-Restapi-custom
sessions [code]OS-Windows-NSClient05-Sessions-Restapi-custom
time [code]OS-Windows-NSClient05-Ntp-Restapi-custom
updates [code]OS-Windows-NSClient05-Updates-Restapi-custom

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.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter 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-maxCreate 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-perfdataChange 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-groupAdd 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-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace 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-perfdataRewrite 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-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite 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-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.

Options des modes​

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

OptionDescription
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Eg: http://my.proxy:3128
--proxypacProxy pac file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-optSet SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).
--hostnameIP Addr/FQDN of the host
--portPort used (Default: 8443)
--protoSpecify https if needed (Default: 'https')
--credentialsSpecify this option if you access webpage with authentication
--usernameSpecify username for authentication (Mandatory if --credentials is specified)
--passwordSpecify password for authentication (Mandatory if --credentials is specified)
--basicSpecify this option if you access a webpage over basic authentication and don't want a '401 UNAUTHORIZED' error to be logged on your webserver. Specify this option if you access the webpage over hidden basic authentication or you'll get a '404 NOT FOUND' error. (Use with --credentials)
--legacy-passwordSpecify password for old authentication system.
--timeoutThreshold for HTTP timeout (Default: 5)
--commandSet command.
--unknown-statusWarning threshold for http response code. (Default: '%{http_code} < 200 or %{http_code} >= 300')
--warning-statusWarning threshold for http response code.
--critical-statusCritical threshold for http response code.

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