Aller au contenu principal

Microsoft WSUS CMA

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Microsoft WSUS CMA depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision Microsoft WSUS CMA apporte 2 modèles d'hôte :

  • App-Wsus-CMA-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
Computers-StatusApp-Wsus-Computers-Status-CMA-customContrôle le nombre d'ordinateurs dans chacun des statuts
Server-StatisticsApp-Wsus-Server-Statistics-CMA-customContrôle plusieurs statistiques du serveur WSUS
Synchronisation-StatusApp-Wsus-Synchronisation-Status-CMA-customContrôle le statut de la synchronisation des mises à jour avec le serveur WSUS
Update-StatusApp-Wsus-Update-Status-CMA-customContrôle le statut des mises à jour

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

Métriques & statuts collectés​

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

NomUnité
up-to-dateN/A
needing-updatesN/A
with-update-errorsN/A
not-contactedN/A
unassignedN/A

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

Prérequis​

Flux réseau​

Un flux TCP doit être ouvert depuis l'hôte supervisé vers le collecteur.

SourceDestinationProtocolePortObjet
Hôte superviséCollecteurTCP4317Obtention de la configuration et envoi des données au format OpenTelemetry.

Prérequis système pour le collecteur​

Rappel: pour pouvoir utiliser l'agent Centreon Monitoring Agent, vous devez utiliser un collecteur ayant au minimum la version 24.04.6 ou 24.10.0 pour les utilisateurs On Prem de centreon-engine. L'agent récupérera sa configuration en se connectant à Centreon Engine.

Configuration de la communication collecteur/agent​

Configurez la communication entre le collecteur et l'agent.

Prérequis système pour l'hôte à superviser​

La procédure d'installation et de configuration de Centreon Monitoring Agent pour Windows est détaillée sur cette page dédiée

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-applications-wsus-cma
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Microsoft WSUS CMA depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin​

Ce connecteur de supervision s'appuie sur une intégration prise en charge par Centreon Engine et ne requiert pas de plugin.

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 App-Wsus-CMA-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
CENTREONAGENTPLUGINSPath where the centreon_plugins.exe plugin can be foundC:/Program Files/Centreon/PluginsX
SYSTEMLANGUAGELanguage installed on the Windows systemen
  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
NOTUPDATEDSINCETime in days to count computers not updated since (default: 30)
FILTERCOUNTERSOnly display some counters (regexp can be used). Example: --filter-counters='errors'
WARNINGNEEDINGUPDATESThreshold
CRITICALNEEDINGUPDATESThreshold
WARNINGNOTCONTACTEDThreshold
CRITICALNOTCONTACTEDThreshold
WARNINGUNASSIGNEDThreshold
CRITICALUNASSIGNEDThreshold
WARNINGUPTODATEThreshold
CRITICALUPTODATEThreshold
WARNINGWITHUPDATEERRORSThreshold
CRITICALWITHUPDATEERRORSThreshold
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.--verbose
  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 ?​

Vous pouvez tester que le plugin parvient bien à superviser votre serveur Windows en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

"C:\Program Files\Centreon\Plugins\centreon_plugins.exe" --plugin=apps::microsoft::wsus::local::plugin \
    --mode=updates-status \
	--wsus-server="" \
	--wsus-port="" \
	--filter-counters="" \
	--warning-with-client-errors="" \
	--critical-with-client-errors="" \
	--warning-with-server-errors="" \
	--critical-with-server-errors="" \
	--warning-needing-files="" \
	--critical-needing-files="" \
	--warning-needed-by-computers="" \
	--critical-needed-by-computers="" \
	--warning-up-to-date="" \
	--critical-up-to-date="" \
	--verbose

La commande devrait retourner un message de sortie similaire à :

OK: With Client Errors: 32694 With Server Errors: 3648 Needing Files: 40252 Needed By Computers: 5327 Up-to-date: 70835 | 'with-client-errors'=32694;;;0; 'with-server-errors'=3648;;;0; 'needing-files'=40252;;;0; 'needed-by-computers'=5327;;;0; 'up-to-date'=70835;;;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 :

cd "C:/Program Files/Centreon/Plugins/".\centreon_plugins.exe `
	--plugin=apps::microsoft::wsus::local::plugin 
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
computers-status [code]App-Wsus-Computers-Status-CMA-custom
server-statistics [code]App-Wsus-Server-Statistics-CMA-custom
synchronisation-status [code]App-Wsus-Synchronisation-Status-CMA-custom
updates-status [code]App-Wsus-Update-Status-CMA-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. Example: 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). 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-maxCreate 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-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 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()' =back
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 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()' =back
--extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 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()' =back
--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,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]] regex: regular expression <names-of-new-metrics>: 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 <new-unit-of-mesure> (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: =over 4 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(traffic_(in|out)_$1)' =back
--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). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-short-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). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--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). Example: 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. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--change-output-advReplace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result.
--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. Example: '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). Example: --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'. =head1 DESCRIPTION B<output>. =cut

Options des modes​

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

OptionDescription
--filter-countersOnly display some counters (regexp can be used). Example: --filter-counters='errors'
--timeoutSet timeout time for command execution (default: 30 sec)
--no-psDon't encode powershell. To be used with --command and 'type' command.
--commandCommand to get information (default: 'powershell.exe'). Can be changed if you have output in a file. To be used with --no-ps option.
--command-pathCommand path (default: none).
--command-optionsCommand options (default: '-InputFormat none -NoLogo -EncodedCommand').
--ps-displayDisplay powershell script.
--ps-exec-onlyPrint powershell output.
--wsus-serverSet WSUS hostname/IP.
--wsus-portSet WSUS port.
--not-updated-sinceTime in days to count computers not updated since (default: 30).
--use-sslSet if WSUS use ssl.
--warning-* --critical-*Thresholds. Can be: 'needing-updates', 'with-update-errors', 'up-to-date', 'not-contacted', 'unassigned'

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 :

cd "C:/Program Files/Centreon/Plugins/"
.\centreon_plugins.exe `
	--plugin=apps::microsoft::wsus::local::plugin \
	--mode=updates-status \
	--help