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. superb!
    its possible to use it with a pair (redundancy) UPS ??
    e.g. i can define 2 UPS’s on master like

    MONITOR ups-alpha@myhost 2 monuser mypass master
    MONITOR ups-beta@myhost 2 monuser mypass master
    MINSUPPLIES 2

    How i config the « client » on esxi this way? any ideas?

  2. Hi Rene,

    Could you please help me with the following ?
    Setting the service as « Start and stop with host » does not survive a reboot.
    Restarting the ESXi the service returns to « Start and stop manually » and Network UPS Tools client isn’t working.
    After manual starting the tool works fine.
    ESXi 5.1.0, NutClient-ESXi500-1.3.0.tar.gz

    Thank you for sharing this very helpful tool.

    Yiannis

    • No, you can’t do it using the provided ViB. You may modify the ViB to include your own SHUTDOWNCMD script but this is not as easy as using tar. I have already explained how to extract files and recreate the ViB in another comment but if you add an executable script this will not be enough. You will also need to change security parameters in upsmon-fileLabels file and insert added files in descriptor.xml

  3. Ping : Synology Network UPS (NUT) and ESXi 5.5 | Piszki Lab | EN

  4. Hello
    Thank you for developing this project.

    FEATURE REQUEST
    Could you add SHUTDOWNCMD to UserVariables? I would like to use halt instead of poweroff. I cant edit it manualy but I think it would be nice if configurable via variables.

    This is because I run ESXi on Mac mini and for it to automatically start, power has to be cut off instead of complet power off.

    • I will not do that. halt and power commands are part of a busybox binary. poweroff calls halt and then shuts off the power. This is what most people want because on real power failure your server will be completely powered off. Then configure the system board to auto power on when power supply is back. I guess this is not configurable on apple mac mini but you can edit ViB file to change poweroff with halt to match your need.

      • Ok. Thank you for response.
        I ment SHUTDOWNCMD to be ‘poweroff’ by default of course. Adding SHUTDOWNCMD to uservariables would help lazy people like me so they don’t have to edit your vib package 🙂

        I will edit it then.

      • I still think that path to custom shutdown script in UserVariables (with ‘poweroff’ as default) is good idea.

        I’ve spend 2 hours repackaging .vib package just to change shutdown command to shutdown.sh
        At least I learned something new 🙂

  5. Hello.
    Thank you for this package. Could you also include upssched in the package? We use the following scheme to shutdown servers:
    – not critical – after 20 minutes on UPS battery
    – more critical – after 30 minutes on UPS battery
    – crirical – after 40 minutes on UPS battery

    The issue is that with such plan upsmon server can be shutted down before UPS is in « Low battery » state. And I as VMWare servers are in « not critical » group I’d like to shut them down after 20 minutes on UPS battery…

    • This will not be possible as you will not be allowed to create a configuration file for upssched. ESXi is very strict on file you can create or modify on the ESXi filesystem. It’s not a standard linux distribution.

  6. Ping : Configuration du client Nut pour ESXi | Babash

  7. Hi,
    Just love this plugin. But now I had to upgrade my ESXi 5.5 server to patch level 201501001 and had to remove the upsmon vib. I can’t install it anymore. It says:
    esxcli software vib install -v « /vmfs/volumes/vmware_sto
    rage1/patches/nutclient/upsmon-2.7.2-1.3.0vmw.500.x86_64.vib »
    [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’]
    Please refer to the log file for more details.

    Could you please fix this?

    • Use the force 😉 ! Add the -f switch to the esxcli software vib install command. You can also use the provided upsmon-install.sh script.
      If you use the esxcli command to install an esxi patch you can also add -f to install the patch without removing the upsmon vib.

      • Thanks, it was indeed installed succesfully the first time. Althought the outcome of the install command was « VIBs skipped ».
        Just ran the command « esxcli software vib list » to confirm the upsmon vib was actually installed.

  8. Hi, thanks for NUT for ESXi! It’s been very useful to me.
    I recently installed an ESXi 6.0 instance and I noticed that the user variables in « Advanced Settings » don’t show up at all. I had to set them manually (via esxcfg-advcfg –set « ups@somewhere » /UserVars/NutUpsName and so forth). I don’t know if this method will survive rebooting yet. Using the « –set-user-var » option of advcfg didn’t work correctly, as the options I set there were not pulled into the /etc/ups/upsmon.conf file. I’m wondering if this is normal for ESXi 6.

    • I have tested with ESXi 6.0 RC. Using the vCenter Server Appliance UserVars were present. I have not tested with ESXi 6.0 final version. Are you using vSphere Client (if it is still available in 6.0) ?

  9. Salut,

    Serait il possible pour toi d’ajouter le support SSL ? Ta version de NUT ne semble pas etre compilee avec le support OpenSSL car il n’y a pas moyen de se connecter au master via SSL. Il n’y a rien de special a ajouter a part le openssl-devel (ou equivalent) avant de compiler car c’est detecte pendant le « ./configure ». Pour la configuration cote ESXi, un simple UserVars.NutSSL a mettre a 1 se contenterait d’ajouter « CERTVERIFY 0 » et « FORCESSL 1 » a upsmon.conf et le tour est joue ! Merci d’avance.

    • Par le passé j’avais déjà testé la possibilité d’ajouter le support SSL. Malheureusement cela tirait beaucoup de librairies additionnelles et elles n’étaient pas toutes disponibles dans ESXi. Je souhaite avant tout que le package reste le plus léger possible pour ne pas consommer de ressources sur l’hyperviseur.

      • Pour eviter le probleme des libs non dispos sur ESXi, il suffit de compiler le package en statique et plus de probleme de dependances. ESXi ne s’installe pas sur une machine ayant moins de 4Go et le client UPSMon sur mes serveurs en full SSL consomme moins de 3Mo, donc pour la legerete on y est parfaitement 🙂

        Si tu ne souhaites pas t’y atteler ce n’est pas genant mais je suis dans l’obligation d’utiliser du SSL partout dans le reseau de mon client. Te serait il possible de donner un acces aux sources de ton package que je puisse au moins avoir une chance de le mettre en oeuvre.

        Je te fournis par la suite un patch que tu pourras proposer sur le site pour toute personne qui voudra le faire de son cote sans que tu aies eu a investir du temps sur le sujet. Merci.

        • Il n’y a rien d’autre que les sources officielles de NUT compilées sur un système de type CentOS 5 32 bits. La seule difficulté vient de la création du ViB en lui-même.
          Je dois prochainement refaire le package pour prendre en compte la dernière version de NUT. Je referai l’expérience de compiler avec le support SSL. Ce n’est pas la RAM que je tente d’économiser mais l’espace disque occupé.

Laisser un commentaire

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