Aller au contenu principal

VMware ESX

VMWare est une solution de virtualisation et d'infrastructure de Cloud Computing.

Le connecteur de supervision Centreon s'appuie sur le SDK Centreon VMWare Connecteur pour requêter l'API du vCenter.

Avec le connecteur, Centreon peut superviser les VMs, Datastores, ESXs, Clusters, etc.

Ce connecteur de supervision fonctionne avec les versions 6 et 7 de l'API VMware.

Contenu du pack​

Modèles​

Le connecteur de supervision VMware ESX apporte un modèle d'hôte :

  • Virt-VMWare2-ESX-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
Esx-CpuVirt-VMWare2-ESX-Cpu-Generic-customContrôle permettant de vérifier le taux d'utilisation CPU d'un serveur ESX
Esx-HealthVirt-VMWare2-ESX-Health-Generic-customContrôle permettant de vérifier les sondes matériels et processeurs d'un serveur ESX
Esx-MemoryVirt-VMWare2-ESX-Memory-Generic-customContrôle permettant de vérifier le taux d'utilisation mémoire d'un serveur ESX
Esx-StatusVirt-VMWare2-ESX-Status-Generic-customContrôle permettant de vérifier l'état global d'un serveur ESX
Esx-SwapVirt-VMWare2-ESX-Swap-Generic-customContrôle permettant de vérifier si une machine virtuelle swappe sur le serveur ESX
Esx-Vm-CountVirt-VMWare2-ESX-Vm-Count-Generic-customContrôle permettant de vérifier le nombre de machines virtuelles allumées/éteintes/suspendues sur un serveur ESX

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

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
VMWare ESXDiscover VMWare ESX

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.

Découverte de services​

Nom de la règleDescription
Virt-VMWare2-Esx-Datastores-Latency-Name
Virt-VMWare2-Esx-Nics-Traffic-NameDiscover network interfaces and monitor bandwidth utilization

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

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

MétriqueUnité
datastore.read.usage.bytespersecondB/s
datastore.write.usage.bytespersecondB/s
datastore#statusN/A
datastore#datastore.read.usage.bytespersecondB/s
datastore#datastore.write.usage.bytespersecondB/s

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

Prérequis​

Configuration du connecteur Centreon VMWare​

Pour la supervision VMWare, Centreon utilise un daemon pour se connecter et requêter le vCenter.

Installer le daemon sur tous les collecteurs :

yum install centreon-plugin-Virtualization-VMWare-daemon

Allez à la page Configuration > Configurations supplémentaires de connecteurs pour configurer la connexion à votre vCenter.

Pour démarrer le daemon et l'activer au démarrage :

systemctl start centreon_vmware
systemctl enable centreon_vmware

Vous pouvez vérifiez que votre configuration est fonctionelle en consultant les journaux dans /var/log/centreon/centreon_vmware.log.

Balises et Attributs personnalisés​

Pour découvrir les balises et les attributs personnalisés, vous devez utiliser la version 3.2.5 de centreon-vmware-daemon et ajouter --tags dans les options supplémentaires de découverte. Allez à la page Configuration > Hôtes > Découverte, et à la 3ème étape (Définir les paramètres de découverte), dans la section Paramètres supplémentaires, dans le champ Options supplémentaires, saisissez --tags.

Flux réseau​

Le Collecteur Centreon avec le connecteur VMWare d'installé doit accéder en HTTPS (TCP/443) au vCenter.

Les Collecteurs requêtant le Collecteur avec le connecteur VMWare doivent accéder en TCP/5700 au Collecteur avec le Connecteur VMWare.

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-virtualization-vmware2-esx
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur VMware ESX 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 :

dnf install centreon-plugin-Virtualization-Vmware2-Connector-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 Virt-VMWare2-ESX-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
CENTREONVMWAREPORTConnector port (default: 5700)5700
CENTREONVMWARECONTAINERContainer to use (it depends on the connector's configuration)default
CENTREONVMWAREHOSTConnector hostname (required)localhost
ESXNAMEHostnames of the ESX to monitor. If not set, we check all ESX
CENTREONVMWAREEXTRAOPTIONSAny 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
UNKNOWNSTATUSDefine the conditions to match for the status to be UNKNOWN (Default: '%{accessible} !~ /^true|1$/i'). You can use the following variables: %{accessible}%{accessible} !~ /^true|1$/i
DATASTORENAMEThe connector will only take into account alerts coming from the datastores listed here
WARNINGREADWarning threshold
CRITICALREADCritical threshold
WARNINGSTATUSDefine the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %{accessible}
CRITICALSTATUSDefine the conditions to match for the status to be CRITICAL (Default: ''). You can use the following variables: %{accessible}
WARNINGTOTALREADWarning threshold
CRITICALTOTALREADCritical threshold
WARNINGTOTALWRITEWarning threshold
CRITICALTOTALWRITECritical threshold
WARNINGWRITEWarning threshold
CRITICALWRITECritical threshold
EXTRAOPTIONSAny extra option you may want to add to the command (e.g. a --verbose flag). 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_vmware_connector_client.pl \
    --plugin=apps::vmware::connector::plugin \
    --mode=countvm-host \
    --custommode=connector \
    --connector-hostname='localhost' \
    --connector-port='5700' \
    --container='default'  \
    --esx-hostname='' \
    --unknown-status='%{status} !~ /^connected$/i' \
    --warning-status='' \
    --critical-status='' \
    --warning-total-on='' \
    --critical-total-on='' \
    --warning-total-off='' \
    --critical-total-off='' \
    --warning-total-suspended='' \
    --critical-total-suspended='' \
    --warning-on='' \
    --critical-on='' \
    --warning-off='' \
    --critical-off='' \
    --warning-suspended='' \
    --critical-suspended=''

La commande devrait retourner un message de sortie similaire à :

OK: 51 VM(s) poweredon 93 VM(s) poweredoff 18 VM(s) suspended All ESX Hosts are ok | 'host.vm.poweredon.current.count'=51;;;0;total'host.vm.poweredoff.current.count'=93;;;0;total'host.vm.suspended.current.count'=18;;;0;total'*host*#host.vm.poweredon.current.count'=;;;0;total'*host*#host.vm.poweredoff.current.count'=;;;0;total'*host*#host.vm.suspended.current.count'=;;;0;total

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/lib/centreon/plugins/centreon_vmware_connector_client.pl \
    --plugin=apps::vmware::connector::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
alarm-datacenter [code]Not used in this Monitoring Connector
alarm-host [code]Virt-VMWare2-ESX-Alarms-Generic-custom
countvm-host [code]Virt-VMWare2-ESX-Vm-Count-Generic-custom
cpu-cluster [code]Not used in this Monitoring Connector
cpu-host [code]Virt-VMWare2-ESX-Cpu-Generic-custom
cpu-vm [code]Not used in this Monitoring Connector
datastore-countvm [code]Virt-VMWare2-Datastore-Vm-Count-Generic-custom
datastore-host [code]Virt-VMWare2-ESX-Datastores-Latency-Generic-custom
datastore-io [code]Virt-VMWare2-Datastore-Io-Generic-custom
datastore-iops [code]Virt-VMWare2-Datastore-Iops-Generic-custom
datastore-snapshot [code]Virt-VMWare2-Datastore-Snapshots-Generic-custom
datastore-usage [code]Virt-VMWare2-Datastore-Usage-Generic-custom
datastore-vm [code]Not used in this Monitoring Connector
device-vm [code]Not used in this Monitoring Connector
discovery [code]Used for host discovery
getmap [code]Not used in this Monitoring Connector
health-host [code]Virt-VMWare2-ESX-Health-Generic-custom
licenses [code]Not used in this Monitoring Connector
limit-vm [code]Not used in this Monitoring Connector
list-clusters [code]Not used in this Monitoring Connector
list-datacenters [code]Not used in this Monitoring Connector
list-datastores [code]Used for service discovery
list-nichost [code]Used for service discovery
maintenance-host [code]Virt-VMWare2-ESX-Maintenance-Generic-custom
memory-host [code]Virt-VMWare2-ESX-Memory-Generic-custom
memory-vm [code]Not used in this Monitoring Connector
net-host [code]Virt-VMWare2-ESX-Traffic-Generic-custom
net-vm [code]Not used in this Monitoring Connector
service-host [code]Virt-VMWare2-ESX-Service-Generic-custom
snapshot-vm [code]Not used in this Monitoring Connector
stat-connectors [code]Not used in this Monitoring Connector
status-cluster [code]Not used in this Monitoring Connector
status-host [code]Virt-VMWare2-ESX-Status-Generic-custom
status-vm [code]Not used in this Monitoring Connector
storage-host [code]Virt-VMWare2-ESX-Storage-Generic-custom
swap-host [code]Virt-VMWare2-ESX-Swap-Generic-custom
swap-vm [code]Not used in this Monitoring Connector
thinprovisioning-vm [code]Not used in this Monitoring Connector
time-host [code]Virt-VMWare2-ESX-Time-Generic-custom
tools-vm [code]Not used in this Monitoring Connector
uptime-host [code]Virt-VMWare2-ESX-Uptime-Generic-custom
vmoperation-cluster [code]Not used in this Monitoring Connector
vsan-cluster-usage [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.
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommodeList all available custom modes.
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).
--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=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-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'.
--connector-hostnameConnector hostname (required).
--connector-portConnector port (default: 5700).
--containerContainer to use (it depends on the connector's configuration).
--vsphere-addressAddress of vpshere/ESX to connect.
--vsphere-usernameUsername of vpshere/ESX connection (with --vsphere-address).
--vsphere-passwordPassword of vpshere/ESX connection (with --vsphere-address).
--timeoutSet global execution timeout (Default: 50)
--sampling-periodChoose the sampling period (can change the default sampling for counters). Should be not different than 300 or 20.
--time-shiftCan shift the time. We the following option you can average X counters values (default: 0).
--case-insensitiveSearchs are case insensitive.
--unknown-connector-statusSet unknown threshold for connector status (Default: '%{code} \< 0 || (%{code} > 0 && %{code} \< 200)'). You can use the following variables: %{code}, %{short_message}, %{extra_message}.
--warning-connector-statusSet warning threshold for connector status (Default: ''). You can use the following variables: %{code}, %{short_message}, %{extra_message}.
--critical-connector-statusSet critical threshold for connector status (Default: ''). You can use the following variables: %{code}, %{short_message}, %{extra_message}.

Options des modes​

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

OptionDescription
--datastore-nameThe connector will only take into account alerts coming from the datastores listed here
--filterDatastore name is a regexp.
--scope-datacenterSearch in following datacenter(s) (can be a regexp).
--unknown-statusDefine the conditions to match for the status to be UNKNOWN (Default: '%{accessible} !~ /^true|1$/i'). You can use the following variables: %{accessible}
--warning-statusDefine the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %{accessible}
--critical-statusDefine the conditions to match for the status to be CRITICAL (Default: ''). You can use the following variables: %{accessible}
--warning-*Warning threshold. Can be: 'total-read', 'total-write', 'read', 'write'.
--critical-*Critical threshold. Can be: 'total-read', 'total-write', 'read', 'write'.

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_vmware_connector_client.pl \
    --plugin=apps::vmware::connector::plugin \
    --mode=countvm-host \
    --help