Create nut.rst (#287)

pull/302/head
Johan Josua Storm 3 years ago committed by GitHub
parent 85c23ca4dd
commit b36c2d0503
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

@ -0,0 +1,48 @@
==========================
NUT - Network UPS Tools
==========================
--------------------------
What is NUT
--------------------------
NUT is a tool that enables the use of a UPS device via either USB or Network communication.
--------------------------
Installation
--------------------------
NUT is available as a plugin in OPNSense via the plugin **os-nut**. You can install the plugin via **System > Firmware > Plugins > os-nut**.
--------------------------
How to Setup - Netclient
--------------------------
1. Navigate to the NUT services page and fill in the following values, then click apply:
==================== ============================================
Enable NUT Checked
Service Mode netclient
Name <choose a name>
Listen Address <interface ip on which the server lives>
==================== ============================================
2. Click on the arrow down next to **UPS Type** and choose **Netclient**.
.. image:: images/nut_netclient_dropdown.png
3. Fill in these values, then click apply:
==================== ============================================
Enable Checked
IP Address <ip of NUT Server>
Username <username, if applicable>
Password <password, if applicable>
==================== ============================================
4. Click on **Diagnostics** in the left menubar. If configured correctly this page will show, after waiting a few seconds, information about the UPS. Look for **device.mfr** and **device.model** to check if the correct UPS is detected.
.. image:: images/nut_diagnostics.png
--------------------------
References
--------------------------
- `Official website of NUT <https://networkupstools.org/>`__
Loading…
Cancel
Save