Client NUT pour ESXi 5, 6, 7 et 8

Dans le but de pouvoir stopper proprement un hyperviseur VMware et ses machines virtuelles en cas d’alerte onduleur, voici une solution pour intégrer un client NUT (Network UPS Tools) natif à vSphere Hypervisor (ESXi 5.0, 5.1, 5.5, 6.0, 6.5, 6.7, 7.0, 8.0 testés). Le client NUT est installé dans l’hyperviseur et peut être contrôlé et paramétré depuis l’interface de configuration de ESXi ou depuis le vCenter s’il est géré.

Mise en garde 01/11/2023 : Sous ESXi 8.0 et à partir de la version 2.5.0 du client Nut, dans l’interface client HTML, vous ne verrez pas les descriptions associées aux UserVars du client NUT à jour tant que le host ESXi n’aura pas rebooté.

Mise à jour du 19/10/2022 : ESXi 8.0 est sorti ce 11/10/2022, seules les versions du module avec un numéro de version supérieur à 2.3.2 pourront s’installer sur cette nouvelle version de ESXi (abandon du support des binaires 32-bits et checksum SHA256 requis dans la signature du module).

Principe

La procédure consiste à installer dans l’hyperviseur les binaires et scripts nécessaires à la réception des alertes onduleur. Le schéma classique minimal des connexions entre les éléments d’un réseau électrique protégé par un onduleur est le suivant :

Câblage Onduleur

Câblage Onduleur

Cette solution n’est pas officiellement supportée par VMware et elle ne s’applique qu’à des hyperviseurs standalone. Elle ne peut pas convenir pour des fermes d’hyperviseurs en cluster de haute disponibilité sous le contrôle d’un vCenter. Seul le client NUT est ajouté à l’hyperviseur, l’onduleur doit être surveillé par un serveur NUT indépendant.

Caractéristiques et fonctionnalités

  • La méthode d’installation utilise un fichier VIB (vSphere Installation Bundle). Il n’y a rien d’autre ce qui permet une installation rapide et sûre et une désinstallation propre en utilisant les standards de VMware.
  • La compatibilité du module a été assurée pour qu’il fonctionne sur toutes les versions de ESXi entre 5.0 et 8.0. Cependant pour les versions 5.x l’installation automatique par déploiement de ViB n’est pas possible, il faut l’installer manuellement en suivant les instructions ci-dessous et passer outre les avertissements de sécurité. A partir de la version 6.0 de ESXi il n’y a plus ce soucis.
  • C’est un client NUT 2.8.1 qui est inclus dans le paquetage. Il peut se connecter aux serveurs avec une version plus ancienne (disons 2.6.4 mais je n’ai pas testé les serveurs plus anciens).
  • Actuellement seule la version pour processeur x86 est disponible. Il n’y a pas de version pour ESXi ARM (je n’ai ni le besoin ni la plateforme de test/développement pour ça).
  • Le client (secondary dans la terminologie NUT) peut se connecter au serveur (primary) en privilégiant une connexion SSL/TLS si elle est disponible. Il ne sera pas fait de vérification de validité de certificat serveur et il n’y a pas de certificat client configurable.
  • Le client peut envoyer un mail très succinct à une adresse configurable lors de la réception d’un évènement onduleur (perte du secteur, batterie faible, engagement de l’arrêt, retour du secteur). L’outil mail est très simple et il récupère les informations pour l’envoi des messages du DNS (enregistrements MX). Vous pouvez aussi utiliser un relais SMTP personnel.
  • Le client peut se connecter à plusieurs serveurs NUT s’il y a plusieurs onduleurs (cas des serveurs avec une redondance d’alimentation). Il utilisera le même compte et le même mot de passe pour se connecter aux différents serveurs NUT. A vous de déclarer ce compte sur tous les serveurs NUT.
  • Normalement il est possible de préciser le port TCP de connexion au serveur NUT sous la forme onduleur@serveur:port mais ESXi impose des règles de firewall pour le trafic sortant et seul le port 3493 est autorisé. C’est le port par défaut des serveurs NUT.
  • Il est possible de demander l’arrêt du système ESXi après un laps de temps sur batterie configurable. Le client reste à l’écoute de l’évènement batterie faible et le système entamera sa procédure d’arrêt soit après le temps imparti soit sur évènement de batterie faible, au premier des deux qui surviendra quand le système est sur batterie. L’attente est interrompue si le courant secteur est rétabli entre temps, mais si la procédure d’arrêt a déjà été initiée, elle ira jusqu’à l’extinction du host ESXi.
  • Le redémarrage du serveur après une coupure de courant est aussi une phase importante mais c’est à vous de le prévoir avec d’autres outils. Personnellement (mais ce n’est qu’une suggestion) j’aime bien l’idée d’un chef d’orchestre qui redémarre automatiquement. Il surveille le retour des services tels que le réseau, le serveur NUT etc… et il envoie des trames WOL pour réveiller les machines dans l’ordre désiré. Configurez votre serveur NUT pour qu’il ordonne à l’onduleur de couper effectivement le courant pendant un petit laps de temps même si le courant est revenu pendant la procédure d’arrêt. La plupart des onduleurs ont cette fonction avec les libellés « Interval to wait after shutdown with delay command » et « Interval to wait before (re)starting the load ». Certains onduleurs ont aussi une valeur « Minimum battery level for restart after power off » qui est interessante pour attendre que l’onduleur ait suffisamment rechargé ses batteries avant de faire redémarrer le système. Le risque est de se retourner dans une situation où un second arrêt propre serait impossible si une nouvelle coupure de secteur se produit juste après le redémarrage (ce qui est plutôt fréquent).
  • Le client tourne avec le compte root. C’est habituellement déconseillé par la documentation du projet NUT mais l’hyperviseur a un nombre très limité de comptes locaux. Ce nombre de compte s’est beaucoup réduit au fil des versions. Des comptes restants, root est le seul encore utilisable.

Téléchargement du module

Pour toutes les versions de ESXi, l’installation peut se faire en ligne de commande sur l’hyperviseur : un fichier TAR compressé doit être déposé sur l’hyperviseur.

Téléchargez ici le fichier
Télécharger “NutClient-ESXi (binaires)” NutClient-ESXi-2.8.1-2.6.1.x86_64.tar.gz – 868,91 Ko

A partir de ESXi 6.0 vous pouvez utiliser le bundle offline pour une installation en ligne de commande en appelant la commande « esxcli software vib install -d » . Ou par le manager de mises à jour du vCenter si vous en avez un.

Téléchargez ici le bundle offline.
Télécharger “NutClient-ESXi (offline bundle)” NutClient-ESXi-2.8.1-2.6.1-offline_bundle.zip – 870,81 Ko

Vous pouvez créer votre propre package personnalisé à partir des sources. Elles sont distribuées sous licence GPLv3 (GNU Public License version 3). Utilisez un environnement de développement linux 64 bits tel que CentOS 7 avec les outils de compilation et développement C habituels. Un fichier INSTALL décrit la procédure. Les sources sont disponibles également dans un dépot git publique : NutClient-ESXi

Téléchargez ici les sources
Télécharger “NutClient-ESXi (sources)” NutClient-ESXi-2.8.1-2.6.1-src.tar.gz – 121,92 Ko

Installation

Activez l’accès ssh à votre host ESXi si ce n’est pas déjà fait. Cela est fait à partir de l’interface d’administration ESXi ou de la console DCUI. A partir de l’interface d’administration : dans la rubrique gérer de votre hôte, onglet services, dans la liste sélectionnez TSM-SSH et démarrez le service. Le service ssh sera actif jusqu’au prochain reboot de l’hyperviseur ou pendant un temps limité selon la version de votre ESXi.

Copiez le fichier NutClient-ESXi-2.8.1-2.6.1.x86_64.tar.gz dans le répertoire /tmp du host ESXi. Ici je vous  donne l’exemple  depuis une machine linux (remplacez 10.0.0.8 par l’adresse IP du host ESXi ou son nom FQDN). Depuis Windows vous pouvez utiliser l’outil gratuit WinSCP.

[root@linux ~]# scp NutClient-ESXi-2.8.1-2.6.1.x86_64.tar.gz root@10.0.0.8:/tmp
The authenticity of host '10.0.0.8 (10.0.0.8)' can't be established.
RSA key fingerprint is 89:49:ce:6d:... ...:40:76:7a:4a:fe.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '10.0.0.8' (RSA) to the list of known hosts.
Password: (saisir le mot de passe administrateur ESXi)
NutClient-ESXi-2.8.1-2.6.1.x86_64.tar.gz          100%  869KB  1.9MB/s   00:00

Passez votre hyperviseur au niveau d’acceptance Communauté si ce n’est pas déjà fait !

Connectez-vous root en ssh à l’hôte ESXi et tapez la suite de commandes suivantes pour installer le VIB (l’opération peu être longue si votre système est installé sur une clé USB lente) :

~ # cd /tmp
/tmp # tar -xzf NutClient-ESXi-2.8.1-2.6.1.x86_64.tar.gz
/tmp # sh upsmon-install.sh
Installation Result
   Message: Operation finished successfully.
   Reboot Required: false
   VIBs Installed: Margar_bootbank_upsmon_2.8.1-2.6.1
   VIBs Removed:
   VIBs Skipped:

Vous n’avez pas besoin de rebooter pour commencer à utiliser le client NUT sur votre système. Vous devez toutefois le configurer avant son premier lancement.

Vous pouvez supprimer les fichiers qui ont été créés dans /tmp et désactiver le service SSH

Configuration

A l’aide de l’interface d’administration du ESXi, rendez-vous dans la rubrique gérer de l’hôte. Sélectionnez les paramètres avancés de l’onglet Système et filtrez la liste sur UserVars.Nut, vous avez 8 variables à configurer :

ESXi7-NutParam

Configuration du client NUT sous ESXi7

  • UserVars.NutUpsName : Nom de l’onduleur sur le serveur NUT (sous la forme nom_onduleur@nom_ou_ip_serveur). Plusieurs onduleurs peuvent être saisis séparés par un espace. Il n’y aura pas d’arrêt système tant que le dernier onduleur encore debout n’aura pas donné l’ordre d’arrêt.
  • UserVars.NutUser : Nom du compte de connexion au serveur NUT
  • UserVars.NutPassword : Mot de passe du compte de connexion au serveur NUT
  • UserVars.NutFinalDelay : Secondes qu’il faudra attendre après la réception de l’événement batterie faible pour procéder à l’arrêt du système
  • UserVars.NutOnBatteryDelay : Délai en secondes après le début du passage sur batterie de l’onduleur pour stopper le système. Si la valeur est 0 alors le client NUT attendra l’évènement batterie faible pour stopper le système. La valeur par défaut est 0, c’est le fonctionnement normal pour garder le système en fonctionnement le plus longtemps possible. Si l’onduleur repasse sur secteur avant la fin du délai, le système ne sera pas stoppé.
  • UserVars.NutSendMail : A mettre à 1 pour que le client NUT envoie un e-mail à chaque évènement important de l’onduleur. La valeur 2 permet d’avoir dans le mail l’état des l’onduleurs lors de l’évènement.
  • UsersVars.NutSmtpRelay : Nom ou IP d’un relai SMTP pour y faire transiter le mail. Laisser vide ou saisissez none pour ne pas utiliser de relai (none par défaut).
  • UserVars.NutMailTo : Adresse e-mail à laquelle envoyer les évènements de l’onduleur
  • UserVars.NutMinSupplies : Pour les systèmes multi onduleurs. Le nombre d’onduleurs qui doivent être en capacité d’alimenter le système avant d’entamer un arrêt. Ce nombre doit être inférieur ou égal au nombre d’onduleurs définis dans UserVars.NutUpsName. Si vous ne respectez pas cette contrainte, le client ne démarrera pas. Avec un seul onduleur, laissez la valeur à 1.

Notez qu’à chaque modification de ces paramètres il sera nécessaire de faire un arrêt/relance du service pour leur prise en compte.

Lancement du service

A l’aide de l’interface d’administration du ESXi, rendez-vous dans la rubrique gérer de l’hôte. Sélectionnez l’onglet Services, trouvez et sélectionnez le service NutClient dans la liste:

Services-ESXi7

Client NUT dans les services ESXi7

Dans les actions du service, choisissez la stratégie démarrage (Démarrer et arrêter avec l’hôte me semble un bon choix). Vous pouvez également le démarrer immédiatement ou l’arrêter.

NutClientService-ESXi7

Configuration du lancement de NUT Client

Astuces

Utilisez la rubrique démarrage automatique de l’onglet Système de l’hôte ESXi pour décider de l’ordre de démarrage et d’arrêt (ou suspension) des machines virtuelles. Cet ordre sera respecté par la procédure d’arrêt sur alerte onduleur. Un bug de ESXi fait que les valeurs par défaut ne sont pas respectées. Vous devez configurer ces paramètre pour chaque VM au moins une fois (quitte à la dé-configurer ce qui la fera réellement suivre les règles par défaut).

Important : L’arrêt propre des OS dans les machines virtuelles n’est possible que si les vmware tools sont installées. Sinon l’arrêt sera brutal, préférez alors une suspension dans la configuration d’arrêt de la VM.

Là encore je rappelle que cette solution n’est pas adaptées aux fermes cluster avec haute disponibilité. Si HA est activé sur la machine hôte le mécanisme d’arrêt propre des VM n’est plus respecté et l’arrêt sera brutal pour toutes les VM.

UEFI secure boot

Si votre hôte ESXi est configuré pour booter en mode UEFI secure boot, l’installation du ViB restera compatible avec cette configuration. En revanche vous ne pouvez pas descendre le niveau d’acceptation à CommunitySupported quand secure boot est activé. Vous devrez :

  • rebooter pour aller dans les paramètres UEFI de votre carte mère
  • désactiver le secure boot dans les paramètres UEFI de votre carte-mère
  • booter (sans secure boot)
  • descendre le niveau d’acceptation à CommunitySupported
  • Rebooter une seconde fois pour retourner dans les paramètres UEFI
  • réactiver le secure boot
  • booter (avec secure boot).

Vous aurez secure boot actif et le niveau d’acceptation minimal à CommunitySupported.

Désinstallation

Pour désinstaller le client NUT, utilisez le script upsmon-remove qui se trouve dans le fichier que vous avez téléchargé :

/tmp # sh upsmon-remove

Test

Pour estimer le temps nécessaire au serveur pour s’éteindre sur alerte onduleur tapez la commande « /opt/nut/sbin/upsmon -c fsd » sur le host ESXi (par ssh ou sur la console). La procédure d’arrêt est immédiatement lancée (ne faites pas ça si vous n’aviez pas prévu d’arrêter votre machine).

715 réflexions sur « Client NUT pour ESXi 5, 6, 7 et 8 »

  1. Hi René, Thank you for this great article.
    can you show us the hidden part of this aricle?
    The needed configuration steps on the NUT-Server? This would be GREAT!
    Thank you!

    • The configuration is also available with the vCenter Web Client. Select the ESXi host, go to advanced system parameters and filter with « uservars.nut » to see only the configuration used by the NUT client.

  2. Bonjour,

    J’ai fait l’installation du client nut sur Vmware 6 ça marche super bien !!!

    J’ai juste un petit problème, à chaque fois que je redémarre mon serveur, le service ne redémarre pas !!! (j’ai bien activé « Démarrer et arrêter avec hôte »)

    Une idée d’où ça pourrait venir ?

    Cordialement
    Laurent

    • Vous avez bien fait « rafraichir » les services avant de consulter son état ? Il existait un but d’affichage sous le client vsphere 5 il est peut être toujours la en version 6. Je vais tester ça.

      • Oui j’ai bien fait « rafraîchir », le service démarre bien, quand je fais un test de coupure de courant mon serveur s’éteint bien mais quand il redémarre le service ne redémarre pas !!!

        • Je viens de faire le test sur un ESXi6 fraichement installé. Pour le configurer j’ai utilisé le client web embarqué qui a encore pas mal de bugs mais qui globalement fonctionne ( https://labs.vmware.com/flings/esxi-embedded-host-client ).
          upsmon activé et configuré pour se lancer avec l’hôte. Comme vous je le vois désactivé dans l’interface d’administration mais en réalité il est bien lancé. Une commande ps -cJ dans une session ssh sous ESXi me confirme la présence des deux processus upsmon. De plus le fichier /etc/ups/upsmon.conf existe, il n’est pas créé si le service n’a jamais été lancé depuis le dernier reboot. Il semble qu’il a ici encore un problème de remontée de l’état du service dans l’interface d’admin. Je vais investiguer plus loin pour déterminer l’origine du problème.

        • Avec le vSphere Client 6.0 (client lourd) l’état du service est correctement affiché. Je pense qu’il y a un bug dans le client web intégré (il est en version tech-preview).

          • Bonjour,

            Désolé pour la réponse tardive, moi j’utilises que la version client lourd, la version esxi 6.0.0, 2494585 et je n’arrive pas à faire redémarrer le service.
            Quand je redémarre mon serveur à chaque fois je suis obligé de le redémarrer à la main !!!

            Laurent

          • J’ai installé le client NUT sous la build 2494585 et je n’ai constaté aucun problème au lancement après reboot. J’ai ensuite fait une mise à jours vers la build 2809209 et je n’ai toujours pas constaté de problème. Je ne met pas en doute que vous rencontrez un problème, je dis que je n’arrive pas à le reproduire dans mon lab.

          • Oui je comprends et je vous remercie d’essayer de m’aider !!!

            Je vais essayer de désinstaller le client nut et de le réinstaller !!
            J’ai peut être un problème de droit pour démarrer le service mais je ne sais pas comment le vérifier !!!

            Merci
            Laurent

          • Bonsoir,

            J’ai désinstallé le client nut puis refait l’installation, et j’ai toujours le même problème.
            Par contre j’ai remarqué quand je sélectionne « Démarrer et arrêter avec hôte » puis je fais ok ça le garde bien en mémoire !!!
            Mais quand je redémarre le serveur il revient sur « Démarrer et arrêter manuellement » tout seul !!!

            Merci
            Laurent

          • Je ne pense pas que le client soit en cause. Il faudrait chercher du côté de l’hyperviseur. Connectez-vous en ssh à ESXi et tapez la commande suivante :
            chkconfig --list upsmon
            Le service est-il à « on » ?
            S’il est à off tapez la commande suivante :
            chkconfig upsmon on
            Cela ne lance pas le service mais dit qu’il faut le demarrer avec le systeme. Pour le lancer il faut taper la commande
            service upsmon start
            Pour connaitre l’état du service tapez
            service upsmon status

          • Bonsoir,

            Après redémarrage du serveur, dans le client lourd j’ai le processus « Network UPS Tools Client » qui est arrêté !!!

            Quand je fais la commande: chkconfig –list upsmon il est bien à ON

            Quand je fais les commandes: service upsmon start et service upsmon status il me dit: -sh: service: not found

            Il doit y avoir un problème de retour sur le client lourd !!!

            Vous en pensez quoi ?

            Merci

            Laurent

          • J’ai commis une erreur dans mon commentaire précédent. La commande service n’existe pas sous ESXi. Il faut taper :
            /etc/init.d/upsmon status
            Il vous indiquera l’état du service. S’il dit « NUT client is not running » alors dites moi s’il existe un fichier /etc/ups/upsmon.conf
            s’il existe copiez son contenu et envoyez-le moi (ne le postez pas ici, il risque d’y avoir votre mot de passe ups en clair).

  3. Bonjour,

    Quand je passe la commande:/etc/init.d/upsmon status j’ai bien : NUT client is running

    Tu veux quand même le fichier upsmon.conf ? si oui je te le communique comment ?

    Merci Laurent

    • Non, pas la peine. Le service fonctionne. C’est le client qui affiche un faux status. C’est le bug d’affichage dont je parlais. Il faut absolument faire un refresh en haut à groite des services de securité avant de consulter le status d’un service. Un vieux bug du client vSphere.

  4. Bonjour,

    Une fois l’installation faite.
    Installation Result
    Message: Operation finished successfully.
    Reboot Required: false
    VIBs Installed: Margar_bootbank_upsmon_2.7.2-1.3.0vmw.500
    VIBs Removed:
    VIBs Skipped:

    Je ne trouve pas les variables à changer…
    j’ai un esxi 6.00

    • Les variables sont à chercher sur le client vsphere comme indiqué dans l’article. Certains ont dit qu’il leur avait été nécessaire de rebooter pour voir ces variables avec le client web de vcenter. Personnellement je n’ai jamais eu besoin du reboot avec le client lourd (VMware vSphere Client). Il est même possible d’utiliser le client web embarqué (en beta) que l’on peut télécharger sur le lab flings de vmware (https://labs.vmware.com/flings/esxi-embedded-host-client)

      • Vous aviez raison.
        Je viens de redémarrer le serveur.Il est bien là et j’ai aussi le service lancée.
        ce qui m’étonnes est la conf si facile à faire…
        A quoi sert:
        UserVars.NutUser : Nom du compte de connexion au serveur NUT
        UserVars.NutPassword : Mot de passe du compte de connexion au serveur NUT

        • Cela n’a pas marché…
          le service était bien UP
          config remplie…
          redemarrage.
          Le service etait pas redemarré je relance :service UP
          la je tente.Coupure elec bip bip bip au bout de 5 min rien.

          • Est-il connecté au serveur nut? C’est à ça que servent le user/mot de passe dans la configuration. L’onduleur est bien connecté sur le serveur ?

  5. ESXi Embedded Host Client
    Le client web ne s’installe pas.
    [DependencyError]
    VIB Margar_bootbank_upsmon_2.7.2-1.3.0vmw.500 violates extensibility rule checks: [u'(line 27: col 0) Element vib failed to validate content’]
    VIB Margar_bootbank_upsmon_2.7.2-1.3.0vmw.500’s acceptance level is community, which is not compliant with the ImageProfile acceptance level partner
    To change the host acceptance level, use the ‘esxcli software acceptance set’ command.

      • Vous pouvez s’il vous plaît de partager plus de détails? Comment procédons nous? Devons nous utiliser la ligne de commande ou est-il possible tu utilisons VUM?

        • Je ne connais pas VUM. J’ai documenté l’installation en ligne de commande qui est très simple. Une fois installé il faudra préciser par la suite l’option force (-f) pour toute mise à) jour de VMware ou installation d’un autre ViB.

    • Avoir le serveur NUT dans une machine virtuelle sur un hyperviseur qui est client NUT n’est pas l’idéal. Il y a un soucis sur l’ordre des opérations. Ainsi le serveur NUT risque de ne pas avoir le temps de stopper correctement son système si l’hyperviseur lui donne l’ordre de mise en veille ou d’arrêt. Il faut jouer avec les temps d’arrêt (FinalDelay) pour laisser le temps aux VM de stopper ou entrer en veille tout en empêchant la VM serveur de stopper ou de se mettre en veille le tout pendant la pause en fin de procedure d’arrêt de l’hyperviseur même.
      Il n’y a pas de recette miracle il faudra chronométrer chaque opération et ajuster les temps manuellement. En espérant que ces temps restent valables quand une véritable coupure arrivera.

  6. Le truc que je n’arrive pas à comprendre, pourquoi cela coupe l’onduleur qu’il y a encore de l’autonomie d’environ 40% dessus !!!!

    Laurent

    • Il y a probablement dans la séquence d’arrêt du serveur NUT un ordre de type upsdrvctl shutdown qui est envoyé à l’onduleur pour qu’il coupe l’alimentation. C’est une configuration standard. La séquence d’arrêt recherche souvent la présence du fichier /etc/killpower posé par upsmon (paramètre POWERDOWNFLAG). Référez vous à la doc de NUT pour en savoir plus.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *