[How-to] Use the openmediavault-nut plugin

  • Plugin functionality:


    Openmediavault-nut provides control and configuration of the UPS (Uninterruptible Power Supply). The controller support is based on NUT (Network Ups Tools), more information can be found here The main objective is to achieve a clean shutdown of the server in case of a power failure.


    Before using this plug-in you should check the compatibility of your UPS with NUT. You can check your model here


    If your manufacturer has provided the drivers to the community you will probably be able to control all the functions of your UPS. Otherwise, the community could have developed drivers through reverse engineering or other techniques, in this case the functionality could be limited, or if it is not on the list there are probably no compatible drivers. You can try in this case the most generic drivers or approximate to your model and check if your UPS responds in any way.


    A remote control can be configured to control the clean shutdown of other servers on the LAN. This can be useful in case another server is connected to a non-NUT compliant UPS.


    Plugin use:

    • To install the plugin: In the OMV GUI go to System> Plugins> find and select the openmediavault-nut plugin and click on Install. Go to Services> UPS> to configure your UPS

    GENERAL SETTINGS

    • In the OMV GUI go to Services> UPS> Click "Enable"
    • Mode: Choose Standalone or Netclient
      • Standalone: Unique operation. A UPS connected to OMV directly.
      • Netclient: Select this option if you want to configure this server as a client of another server that is the one that has the UPS and remote control configured. See below Configuration of a client.
    • Identifier: A name to identify your UPS in the system. Must be unique.
    • Driver configuration directives: You should consult which is the driver that works with your UPS and the configuration options of this driver. See here. As a general rule, you must specify at least two fields, the driver to use and the connection port with the UPS. You can check other optional parameters for each driver. If you configure the wrong driver, an error message will appear automatically. An example of a basic configuration could be:

    driver = usbhid-ups

    port = auto

    • Shutdown mode: Choose between:
      • UPS is using battery: This will shut down the server when there is a power outage regardless of the UPS battery charge
      • UPS has low battery: This will shut down the server when the UPS discharges the battery to a defined point. Your UPS must support this feature.
    • Shutdown timer: Sets the time in seconds until the server shutdown begins. If power is restored during this period, the server shutdown order will be canceled. Make sure there is enough time to shut down your server before the UPS runs out of battery. This will depend on the power of your UPS and the consumption of your hardware. Consult your UPS manual.

    REMOTE CONTROL

    • Activate remote control if you want your server to act as a UPS SERVER on the LAN, sending information to control the shutdown of other servers. Set here the username and password that will be used to connect the clients.
    • User: Choose an arbitrary user to configure the client server that will receive the information from the UPS. This user is an internal NUT configuration, independent from the rest of the system users. It is stored in /etc/nut/upsd.users
    • Password: Choose a password for the user from the previous point.

    CONFIGURATION OF A CLIENT

    • In General Settings go to the mode field and select Netclient
    • In Netclient hostname write the hostname of the server that has the UPS connected and acts as UPS SERVER.
    • In Netclient username write the user that you configured on the server that has the UPS connected and acts as UPS SERVER.
    • In Netclient password, enter the password that you configured on the server that has the UPS connected and acts as a UPS SERVER.
    • The rest of the options will be configured in the same way as in Standalone mode.


    WHEN YOU'VE FINISHED SETTING UP YOUR UPS, TEST IT. SIMULATE A POWER OUTAGE BY UNPLUGGING THE UPS AND CHECK THAT YOUR SERVER TURNS OFF CLEANLY.


    Lastly, be sure to configure OMV email alerts to receive alerts from the openmediavault-NUT plugin.

  • chente

    Approved the thread.

Participate now!

Don’t have an account yet? Register yourself now and be a part of our community!