Nut-ups - Revision history

Ingrate one: Add information for setup of network server/clients includes the following configuration files nut.conf, upsd.users and mupsmon.conf. Finally to perform Live shutdown to hosts with matching users and ups fields.

2026-04-17T08:25:39Z

Add information for setup of network server/clients includes the following configuration files nut.conf, upsd.users and mupsmon.conf. Finally to perform Live shutdown to hosts with matching users and ups fields.

@@ Line 43: / Line 43: @@
 To instruct NUT to make the UPS status available on the network, create the {{Path|/etc/nut/nut.conf}} file with content as follows: {{Cat|/etc/nut/nut.conf|<nowiki>MODE=netserver</nowiki>}}
 The content of {{Path|/etc/nut/ups.conf}} defines the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB-attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided that it is a USB-attached UPS. Create the file {{Path|/etc/nut/ups.conf}} with content as follows: {{Cat|/etc/nut/ups.conf|<nowiki>[SmartUPS_1000]
      driver = usbhid-ups
@@ Line 50: / Line 52: @@
 {{Tip| Replace 0.0.0.0 with the network address of a specific interface if none of the interfaces are appropriate for your situation.}}
 === Configure udev rules ===
@@ Line 79: / Line 124: @@
 [[#Verifying running state|Verify the running state]] before proceeding to configure the automatic startup of the {{ic|nut-upsd}}. If everything looks good, go ahead and set the service to auto-start when the system is booted:{{Cmd|# rc-update add nut-upsd
    * service nut-upsd added to runlevel default}}
 == Using NUT ==

Antiz: Add a note about adding the udev-trigger service to a runlevel for the udev rule to automatically apply at boot

2026-03-01T22:16:46Z

Add a note about adding the udev-trigger service to a runlevel for the udev rule to automatically apply at boot

← Older revision		Revision as of 22:16, 1 March 2026
Line 60:		Line 60:
	# udevadm trigger</nowiki>}}		# udevadm trigger</nowiki>}}

			{{Tip\|Make sure that the {{ic\|udev-trigger}} service is added to a runlevel for the udev rule to automatically apply at boot: {{ic\|# rc-update add udev-trigger}}.}}
	{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}		{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}

Antiz: Update udev rule: Add SUBSYSTEM=="usb" and remove the MODE parameter (which is not needed here)

2026-03-01T22:10:48Z

Update udev rule: Add SUBSYSTEM=="usb" and remove the MODE parameter (which is not needed here)

← Older revision		Revision as of 22:10, 1 March 2026
Line 53:		Line 53:
	=== Configure udev rules ===		=== Configure udev rules ===

	To avoid [[#Insufficient permissions on everything\|permission errors]], configure '''udev''' for giving NUT access to the USB-attached Smart-UPS 1000. Create the file {{Path\|/etc/udev/rules.d/62-nut-usbups.rules}} as follows:{{Cat\|/etc/udev/rules.d/62-nut-usbups.rules\|<nowiki>ATTR{idVendor}=="051d", ATTR{idProduct}=="0002~~", MODE="664~~", GROUP="nut"		To avoid [[#Insufficient permissions on everything\|permission errors]], configure '''udev''' for giving NUT access to the USB-attached Smart-UPS 1000. Create the file {{Path\|/etc/udev/rules.d/62-nut-usbups.rules}} as follows:{{Cat\|/etc/udev/rules.d/62-nut-usbups.rules\|<nowiki>SUBSYSTEM=="usb", ATTR{idVendor}=="051d", ATTR{idProduct}=="0002", GROUP="nut"</nowiki>}}
	</nowiki>}}
	The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.		The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.

Antiz: Update udevadm commands to actually apply the rule

2026-03-01T22:08:59Z

Update udevadm commands to actually apply the rule

← Older revision		Revision as of 22:08, 1 March 2026
Line 57:		Line 57:
	The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.		The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.

	Use the {{ic\|udevadm}} command to tell '''udev''' to read in the changes:{{Cmd\|# udevadm control --reload~~-rules~~}}		Use the {{ic\|udevadm}} command to tell '''udev''' to read in and apply the changes:
			{{Cmd\|<nowiki># udevadm control --reload
			# udevadm trigger</nowiki>}}

	{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}		{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}

Antiz: Add instructions to find the "idVendor" and "idProduct" parameters via 'lsusb'

2026-03-01T22:06:08Z

Add instructions to find the "idVendor" and "idProduct" parameters via 'lsusb'

← Older revision		Revision as of 22:06, 1 March 2026
Line 17:		Line 17:

	From this output, we can see a Smart-UPS 1000 has been detected. We can also see two important parameters: '''idVendor=051d''' and '''idProduct=0002'''. These will be used later in the udev rules, so keep them handy.		From this output, we can see a Smart-UPS 1000 has been detected. We can also see two important parameters: '''idVendor=051d''' and '''idProduct=0002'''. These will be used later in the udev rules, so keep them handy.

			These parameters can also simply be retrieved from {{ic\|lsusb}}. See the example below.{{Cmd\|<nowiki># lsusb
			Bus 001 Device 001: ID 1d6b:0002 Linux 6.12.67-0-rpi dwc_otg_hcd DWC OTG Controller
			Bus 001 Device 003: ID 0424:2514
			Bus 001 Device 002: ID 0424:2514
			Bus 001 Device 004: ID 0463:ffff EATON Ellipse ECO
			Bus 001 Device 005: ID 0424:7800</nowiki>}}

			From this output, we can see a EATON Ellipse ECO UPS has been detected. We can also see the two important parameters from the ID field, with '''0463''' being the '''idVendor''' and '''ffff''' being the '''idProduct'''.

	== Installation ==		== Installation ==

FreeWilly: Corrected wrong filename in code-box (nut.conf -> ups.conf)

2026-01-16T23:11:17Z

Corrected wrong filename in code-box (nut.conf -> ups.conf)

← Older revision		Revision as of 23:11, 16 January 2026
Line 34:		Line 34:
	To instruct NUT to make the UPS status available on the network, create the {{Path\|/etc/nut/nut.conf}} file with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>MODE=netserver</nowiki>}}		To instruct NUT to make the UPS status available on the network, create the {{Path\|/etc/nut/nut.conf}} file with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>MODE=netserver</nowiki>}}

	The content of {{Path\|/etc/nut/ups.conf}} defines the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB-attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided that it is a USB-attached UPS. Create the file {{Path\|/etc/nut/ups.conf}} with content as follows: {{Cat\|/etc/nut/~~nut~~.conf\|<nowiki>[SmartUPS_1000]		The content of {{Path\|/etc/nut/ups.conf}} defines the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB-attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided that it is a USB-attached UPS. Create the file {{Path\|/etc/nut/ups.conf}} with content as follows: {{Cat\|/etc/nut/ups.conf\|<nowiki>[SmartUPS_1000]
	driver = usbhid-ups		driver = usbhid-ups
	port = auto</nowiki>}}		port = auto</nowiki>}}

John3-16: 1. Added See also: Apcupsd; 2. Added categories: System Administration, Networking; 3. Amended style, grammar

2025-12-20T05:45:28Z

1. Added See also: Apcupsd; 2. Added categories: System Administration, Networking; 3. Amended style, grammar

← Older revision		Revision as of 05:45, 20 December 2025
Line 1:		Line 1:
	This wiki page shows how to install and configure the Network UPS Tools (NUT) package to monitor and report the statistics for a USB attached Uninterruptible Power Supply (UPS) and make the UPS status available over the network, so it can be monitored and used to trigger actions in a home automation system like [https://www.home-assistant.io/ Home Assistant].		This wiki page shows how to install and configure the Network UPS Tools (NUT) package to monitor and report the statistics for a USB-attached Uninterruptible Power Supply (UPS) and make the UPS status available over the network, so that it can be monitored and used to trigger actions in a home automation system like [https://www.home-assistant.io/ Home Assistant].

	The UPS model used in the examples is an APC SmartUPS 1000, but any UPS on the [https://networkupstools.org/stable-hcl.html list of compatible models] should work.		The UPS model used in the examples is an APC SmartUPS 1000, but any UPS on the [https://networkupstools.org/stable-hcl.html list of compatible models] should work.
Line 5:		Line 5:
	== Determine UPS USB parameters ==		== Determine UPS USB parameters ==

	The first step is to plug in the USB cable between your UPS and your Alpine host to see how it appears to the system. Information about the UPS can be seen with the {{ic\|dmesg}} command. See the example below.{{Cmd\|<nowiki># dmesg		The first step is to plug in the USB cable between your UPS and your Alpine Linux host to see how it appears to the system. Information about the UPS can be seen with the {{ic\|dmesg}} command. See the example below.{{Cmd\|<nowiki># dmesg
	[400269.428612] usb 1-3: new low-speed USB device number 3 using xhci_hcd		[400269.428612] usb 1-3: new low-speed USB device number 3 using xhci_hcd
	[400269.580728] usb 1-3: New USB device found, idVendor=051d, idProduct=0002, bcdDevice= 0.06		[400269.580728] usb 1-3: New USB device found, idVendor=051d, idProduct=0002, bcdDevice= 0.06
Line 30:		Line 30:
	# mv /etc/nut/upsd.conf /etc/nut/upsd.bak</nowiki>}}		# mv /etc/nut/upsd.conf /etc/nut/upsd.bak</nowiki>}}

	Proceed to create the three files with only the configuration parameters needed for our example USB attached APC Smart-UPS.		Proceed to create the three files with only the configuration parameters needed for our example USB-attached APC Smart-UPS.

	To instruct NUT to make the UPS status available on the network, create the {{Path\|/etc/nut/nut.conf}} file with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>MODE=netserver</nowiki>}}		To instruct NUT to make the UPS status available on the network, create the {{Path\|/etc/nut/nut.conf}} file with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>MODE=netserver</nowiki>}}

	The content of {{Path\|/etc/nut/ups.conf}} ~~define~~ the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided it is a USB attached UPS. Create the file {{Path\|/etc/nut/ups.conf}} with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>[SmartUPS_1000]		The content of {{Path\|/etc/nut/ups.conf}} defines the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB-attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided that it is a USB-attached UPS. Create the file {{Path\|/etc/nut/ups.conf}} with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>[SmartUPS_1000]
	driver = usbhid-ups		driver = usbhid-ups
	port = auto</nowiki>}}		port = auto</nowiki>}}
Line 40:		Line 40:
	To tell NUT to make the UPS info available on all network interfaces instead of the default i.e localhost only, which is not very useful, create the {{Path\|/etc/nut/upsd.conf}} file with content as follows: {{Cat\|/etc/nut/upsd.conf\|<nowiki>LISTEN 0.0.0.0 3493</nowiki>}}		To tell NUT to make the UPS info available on all network interfaces instead of the default i.e localhost only, which is not very useful, create the {{Path\|/etc/nut/upsd.conf}} file with content as follows: {{Cat\|/etc/nut/upsd.conf\|<nowiki>LISTEN 0.0.0.0 3493</nowiki>}}

	{{Tip\| Replace 0.0.0.0 with the network address of a specific interface if ~~all~~ interfaces ~~is not~~ appropriate for your situation.}}		{{Tip\| Replace 0.0.0.0 with the network address of a specific interface if none of the interfaces are appropriate for your situation.}}

	=== Configure udev rules ===		=== Configure udev rules ===

	To avoid [[#Insufficient permissions on everything\|permission errors]] configure udev for giving NUT access to the USB attached Smart-UPS 1000. Create the file {{Path\|/etc/udev/rules.d/62-nut-usbups.rules}} as follows:{{Cat\|/etc/udev/rules.d/62-nut-usbups.rules\|<nowiki>ATTR{idVendor}=="051d", ATTR{idProduct}=="0002", MODE="664", GROUP="nut"		To avoid [[#Insufficient permissions on everything\|permission errors]], configure '''udev''' for giving NUT access to the USB-attached Smart-UPS 1000. Create the file {{Path\|/etc/udev/rules.d/62-nut-usbups.rules}} as follows:{{Cat\|/etc/udev/rules.d/62-nut-usbups.rules\|<nowiki>ATTR{idVendor}=="051d", ATTR{idProduct}=="0002", MODE="664", GROUP="nut"
	</nowiki>}}		</nowiki>}}
	The ''idVendor'' and ''idProduct'' in first part i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells udev what permissions and group ownership to use and should be the same regardless of the UPS make and model.		The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.

	Use the {{ic\|udevadm}} command to tell udev to read in the changes:{{Cmd\|# udevadm control --reload-rules}}		Use the {{ic\|udevadm}} command to tell '''udev''' to read in the changes:{{Cmd\|# udevadm control --reload-rules}}

	{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}		{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}

	== Service configuration ==		== Service configuration ==
Line 56:		Line 56:
	The service is called {{ic\|nut-upsd}} and can be managed using the standard start\|stop\|restart commands using standard [[OpenRC]] commands.		The service is called {{ic\|nut-upsd}} and can be managed using the standard start\|stop\|restart commands using standard [[OpenRC]] commands.

	{{Tip\|Remember to [[#Configure udev rules\|configure udev rules]] and [[#Testing the configuration\|test the configuration]] before proceeding further.}}		{{Tip\|Remember to [[#Configure udev rules\|configure '''udev''' rules]] and to [[#Testing the configuration\|test the configuration]] before proceeding further.}}

	Proceed to start the service as follows: {{Cmd\|# rc-service nut-upsd start		Proceed to start the service as follows: {{Cmd\|# rc-service nut-upsd start
Line 71:		Line 71:
	== Using NUT ==		== Using NUT ==

	Now the {{ic\|upsc}} command can be run against the name added in {{Path\|/etc/nut/ups.conf}} to gather all status information about your UPS. Based on the example used on this wiki page:{{Cmd\|$ upsc SmartUPS_1000}}		Now, the {{ic\|upsc}} command can be run against the name added in {{Path\|/etc/nut/ups.conf}} to gather all status information about your UPS. Based on the example used on this wiki page:{{Cmd\|$ upsc SmartUPS_1000}}
	One can also gather specific status information by passing them as an argument: {{Cmd\|$ upsc SmartUPS_1000 battery.charge}} This is useful to monitor specific values and/or initiate actions (e.g. from a script) when specific thresholds are reached.		One can also gather specific status information by passing them as an argument: {{Cmd\|$ upsc SmartUPS_1000 battery.charge}} This is useful to monitor specific values and/or to initiate actions (e.g. from a script) when specific thresholds are reached.

	[[#See also\|See also]] section has documentation links to configure NUT to do useful things ~~like send~~ an email ~~or initiate~~ a graceful shutdown when the main power is lost. and to use Home Assistant to keep tabs on your UPS.		The [[#See also\|See also]] section has documentation links about how to configure NUT to do useful things, such as sending an email, initiating a graceful shutdown when the main power is lost, and how to use Home Assistant to keep tabs on your UPS.

	== Troubleshooting ==		== Troubleshooting ==
Line 80:		Line 80:
	=== Testing the configuration ===		=== Testing the configuration ===

	Unplug the UPS USB cable from the host, wait a moment, and then reinsert it. Check '''dmesg''' again to make sure it was detected and the idVendor and idProduct are correct.		Unplug the UPS USB cable from the host, wait a moment, and then reinsert it. Check '''dmesg''' again to make sure that it was detected and that the ''idVendor'' and ''idProduct'' are correct.

	Check the permissions on the files in the {{Path\|/dev/bus/usb}} subdirectories. One of these represents your UPS. If the udev rules work correctly, it should be the ~~file~~ with a group owner of ''nut'' and permissions of 0664. An example is shown below.{{Cmd\|# ls -l /dev/bus/usb/001/003		Check the permissions on the files in the {{Path\|/dev/bus/usb}} subdirectories. One of these represents your UPS. If the '''udev''' rules work correctly, the file should be the one with a group owner of ''nut'' and permissions of 0664. An example is shown below.{{Cmd\|# ls -l /dev/bus/usb/001/003
	crw-rw-r-- 1 root nut 189, 2 Oct 10 00:53 /dev/bus/usb/001/003}}		crw-rw-r-- 1 root nut 189, 2 Oct 10 00:53 /dev/bus/usb/001/003}}

Line 91:		Line 91:
	=== Verifying running state ===		=== Verifying running state ===

	A couple quick commands will ensure the NUT service is actually running as expected. These are shown in the example below.		A couple of quick commands will ensure that the NUT service is actually running as expected. These are shown in the example below.

	alpine:/# rc-service nut-upsd status		alpine:/# rc-service nut-upsd status
Line 108:		Line 108:
	Driver failed to start (exit status=1)</nowiki>		Driver failed to start (exit status=1)</nowiki>

	The ~~above~~ error message is due to the USB device having the wrong ownership and permissions. [[#Configure udev rules\|Configure udev rules]] and restart the [[#Service configuration\|service]].		The error message above is due to the USB device having the wrong ownership and permissions. [[#Configure udev rules\|Configure '''udev''' rules]] and restart the [[#Service configuration\|service]].

	== See also ==		== See also ==
Line 115:		Line 115:
	* [https://networkupstools.org/stable-hcl.html list of NUT compatible models]		* [https://networkupstools.org/stable-hcl.html list of NUT compatible models]
	* [https://www.home-assistant.io/integrations/nut/ NUT integration for Home Assistant]		* [https://www.home-assistant.io/integrations/nut/ NUT integration for Home Assistant]
			* [[Apcupsd]]

	[[Category:Monitoring]]		[[Category:Monitoring]]
			[[Category:System Administration]]
			[[Category:Networking]]

Prabuanand: minor rewording

2025-09-29T06:13:06Z

minor rewording

← Older revision		Revision as of 06:13, 29 September 2025
Line 24:		Line 24:
	== Configuration ==		== Configuration ==

	All of the configuration files delivered with the package will be in the {{Path\|/etc/nut}} subdirectory. The following commands rename ~~the~~ original ~~configuration file and then write a new file with only the configuration parameters needed. Proceed to rename three default~~ configuration files ~~and replace them with the parameters needed for our example USB attached APC Smart-UPS~~. {{Cmd\|<nowiki># mv /etc/nut/nut.conf /etc/nut/nut.bak		All of the configuration files delivered with the package will be in the {{Path\|/etc/nut}} subdirectory.

			The following commands rename three original configuration files. {{Cmd\|<nowiki># mv /etc/nut/nut.conf /etc/nut/nut.bak
	# mv /etc/nut/ups.conf /etc/nut/ups.bak		# mv /etc/nut/ups.conf /etc/nut/ups.bak
	# mv /etc/nut/upsd.conf /etc/nut/upsd.bak</nowiki>}}		# mv /etc/nut/upsd.conf /etc/nut/upsd.bak</nowiki>}}

	To instruct NUT to make the UPS status available on the network, the ~~content of~~ {{Path\|/etc/nut/nut.conf}} ~~should be~~ as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>MODE=netserver</nowiki>}}		Proceed to create the three files with only the configuration parameters needed for our example USB attached APC Smart-UPS.

			To instruct NUT to make the UPS status available on the network, create the {{Path\|/etc/nut/nut.conf}} file with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>MODE=netserver</nowiki>}}

	The content of {{Path\|/etc/nut/ups.conf}} define the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided it is a USB attached UPS. ~~It should be~~ as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>[SmartUPS_1000]		The content of {{Path\|/etc/nut/ups.conf}} define the name (in square brackets), the driver used to communicate with the UPS, and the port. For USB attached UPSs, it's almost always going to be a driver of ''usbhid-ups'' and a port of ''auto''. Make and model should not make any difference here provided it is a USB attached UPS. Create the file {{Path\|/etc/nut/ups.conf}} with content as follows: {{Cat\|/etc/nut/nut.conf\|<nowiki>[SmartUPS_1000]
	driver = usbhid-ups		driver = usbhid-ups
	port = auto</nowiki>}}		port = auto</nowiki>}}

	To tell NUT to make the UPS info available on all network interfaces instead of the default i.e localhost only, which is not very useful, the ~~content of~~ {{Path\|/etc/nut/upsd.conf}} ~~should be~~ as follows: {{Cat\|/etc/nut/upsd.conf\|<nowiki>LISTEN 0.0.0.0 3493</nowiki>}}		To tell NUT to make the UPS info available on all network interfaces instead of the default i.e localhost only, which is not very useful, create the {{Path\|/etc/nut/upsd.conf}} file with content as follows: {{Cat\|/etc/nut/upsd.conf\|<nowiki>LISTEN 0.0.0.0 3493</nowiki>}}

	{{Tip\| Replace 0.0.0.0 with the network address of a specific interface if all interfaces is not appropriate for your situation.}}		{{Tip\| Replace 0.0.0.0 with the network address of a specific interface if all interfaces is not appropriate for your situation.}}

Prabuanand: minor rewording

2025-09-29T05:59:24Z

minor rewording

← Older revision		Revision as of 05:59, 29 September 2025
Line 1:		Line 1:
	This wiki page shows how to install and configure the Network UPS Tools (NUT) package to monitor and report the statistics for a USB attached Uninterruptible Power Supply (UPS)~~. The UPS model used in the examples is an APC SmartUPS 1000, but any UPS on the [https://networkupstools.org/stable-hcl.html list of compatible models] should work.~~		This wiki page shows how to install and configure the Network UPS Tools (NUT) package to monitor and report the statistics for a USB attached Uninterruptible Power Supply (UPS) and make the UPS status available over the network, so it can be monitored and used to trigger actions in a home automation system like [https://www.home-assistant.io/ Home Assistant].

	~~The end goal is to~~ make the UPS status available over the network so it can be monitored and used to trigger actions in a home automation system like [https://www.home-assistant.io/ Home Assistant].

			The UPS model used in the examples is an APC SmartUPS 1000, but any UPS on the [https://networkupstools.org/stable-hcl.html list of compatible models] should work.

	== Determine UPS USB parameters ==		== Determine UPS USB parameters ==
Line 71:		Line 70:
	One can also gather specific status information by passing them as an argument: {{Cmd\|$ upsc SmartUPS_1000 battery.charge}} This is useful to monitor specific values and/or initiate actions (e.g. from a script) when specific thresholds are reached.		One can also gather specific status information by passing them as an argument: {{Cmd\|$ upsc SmartUPS_1000 battery.charge}} This is useful to monitor specific values and/or initiate actions (e.g. from a script) when specific thresholds are reached.

	NUT ~~itself can also be configured~~ to do useful things like send an email or initiate a graceful shutdown when the main power is lost. ~~The [https://networkupstools.org/ NUT home page] is your source for documentation on how~~ to ~~do this.~~		[[#See also\|See also]] section has documentation links to configure NUT to do useful things like send an email or initiate a graceful shutdown when the main power is lost. and to use Home Assistant to keep tabs on your UPS.

	~~There is also a [https://www.home-assistant.io/integrations/nut/ NUT integration for~~ Home Assistant~~] that can be installed~~ to keep tabs on your UPS.

	== Troubleshooting ==		== Troubleshooting ==
Line 111:		Line 108:
	== See also ==		== See also ==

			* [https://networkupstools.org/ NUT home page]
	* [https://networkupstools.org/stable-hcl.html list of NUT compatible models]		* [https://networkupstools.org/stable-hcl.html list of NUT compatible models]
	* [https://www.home-assistant.io/integrations/nut/ NUT integration for Home Assistant]		* [https://www.home-assistant.io/integrations/nut/ NUT integration for Home Assistant]


	[[Category:Monitoring]]		[[Category:Monitoring]]

Prabuanand: added category, changed headings and added wikitags and wikilinks. removed the todo based on entry made by Antiz

2025-09-29T05:01:02Z

added category, changed headings and added wikitags and wikilinks. removed the todo based on entry made by Antiz

Show changes

← Older revision		Revision as of 22:08, 1 March 2026
Line 57:		Line 57:
	The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.		The ''idVendor'' and ''idProduct'' in the first part – i.e ''ATTR{idVendor}=="051d", ATTR{idProduct}=="0002"'' – are unique to your UPS. They were found earlier in the [[#Determine UPS USB parameters\| Determining UPS USB parameters]] section. The rest of the line tells '''udev''' what permissions and group ownership to use, and these should be the same regardless of the UPS make and model.

	Use the {{ic\|udevadm}} command to tell '''udev''' to read in the changes:{{Cmd\|# udevadm control --reload~~-rules~~}}		Use the {{ic\|udevadm}} command to tell '''udev''' to read in and apply the changes:
			{{Cmd\|<nowiki># udevadm control --reload
			# udevadm trigger</nowiki>}}

	{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}		{{Note\|There is also a file {{Path\|/lib/udev/rules.d/62-nut-usbups.rules}} that has information for all of the UPS models that NUT knows about. You may be able to simply copy this rather than constructing your own rules.}}