1,574
edits
Changes
From SME Server
Jump to navigationJump to searchUninterruptable Power Supply (view source)
Revision as of 14:07, 12 September 2019
, 14:07, 12 September 2019no edit summary
{{Languages}}
{{Languages}}
{{usefulnote}}
==Uninterruptable Power Supply==
==Uninterruptable Power Supply==
{{Level|Advanced}}
{{Level|Advanced}}
The default configuration of NUT, will keep your connected systems operational until a critical battery state is reached (ie battery is nearing exhaustion) and then power down your server/equipment in a controlled fashion. See http://www.networkupstools.org/
The default configuration of NUT, will keep your connected systems operational until a critical battery state is reached (ie battery is nearing exhaustion) and then power down your server/equipment in a controlled fashion. See http://www.networkupstools.org/
If you have an APC UPS, see also [[Uninterruptable_Power_Supply:APC]] for an alternative to the standard SME ''Nut'' implementation
If you have Dell UPS, this might Help [[Uninterruptable_Power_Supply:LatestGeekery]]
===Default Configuration (USB)===
===Default Configuration (USB)===
====Serial Connection====
====Serial Connection====
<ol></li><li>Find the configuration details for your model of UPS. Refer to: http://www.networkupstools.org/compat/stable.html and make note of the driver name and upstype number (if any) in the third column.
<ol><li>Find the configuration details for your model of UPS. Refer to: http://www.networkupstools.org/stable-hcl.html and make note of the driver name and upstype number (if any) in the third column.
{{Warning box|Always use the serial cable supplied with the UPS. Standard serial cables won't work with a serial UPS and have been known to cause damage to the UPS. Pay particular attention to any references to cable in in the UPS Model column.}}
{{Warning box|Always use the serial cable supplied with the UPS. Standard serial cables won't work with a serial UPS and have been known to cause damage to the UPS. Pay particular attention to any references to cable in in the UPS Model column.}}
</li><li>From the consol issue the following commands:
</li><li>From the console issue the following commands:
config setprop nut Model <model>
config setprop nut Model <model>
config setprop nut Device <device>
config setprop nut Device <device>
Alternatively, '''without''' NUT running or requiring a server reboot:
Alternatively, '''without''' NUT running or requiring a server reboot:
signal-event console-save
service nut start
</li><li>Confirm server is communicating with UPS:
</li><li>Confirm server is communicating with UPS:
upsc UPS@192.168.33.11
upsc UPS@192.168.33.11
====Conecting multiple UPS's====
====Connecting multiple UPS's====
To be added http://bugs.contribs.org/show_bug.cgi?id=629
To be added http://bugs.contribs.org/show_bug.cgi?id=629
= SME8 =
===UPS Variables and Commands===
===UPS Variables and Commands===
}}
}}
==Setting UPS Variables==
In order to set UPS variables it is necessary to have enabled a user with administrative privileges as above first.
In order to set UPS variables it is necessary to have enabled a user with administrative privileges as above first.
- Manual page: man upsrw
- Manual page: man upsrw
====Issuing UPS Commands====
====Issuing UPS Commands====
Issuing commands could shutdown your server unexpectedly!}}
Issuing commands could shutdown your server unexpectedly!}}
===Scheduling Events - Shutdown Time Delay===
= SME 9 =
{{Warning box|Be sure to have e-smith-nutUPS-2.4.0-9.el6.sme.noarch or higher to carry on with these instructions. If you get a lower version, just follow SME8 instruction.}}
rpm -qa e-smith-nutUPS
If you get NUT running with administrative privileges modification from sme8 instruction, you need to remove the custom template created for this. These variables are taken in charge by the new package.
First you need to delete the custom template file.( This command delete the directory, be sure you don't have personal file present. If the case, delete manualy the file created for administrative privileges )
rm -rf /etc/e-smith/templates-custom/etc/ups/upsd.users
Now, to get '''upsd''' to recognise the modification of user, we need to expand the template and reload the '''upsd''' configuration
/sbin/e-smith/expand-template /etc/ups/upsd.users
/usr/sbin/upsd -c reload
===UPS Variables and Commands===
In some cases you may wish to modify variables on the actual UPS such as the Low Charge/LOWBATTERY setting. This requires the use of the '''upsrw''' command and UPS administrative privileges.
You may also want to control the UPS directly from the command line by issuing UPS commands. This requires use of the '''upscmd''' command and UPS administrative privileges.
{{Warning box|In general, the UPS data should be left protected and changes to it or issuing of commands well thought out. If you wish to make data changes or issue commands then the administrative privileges can be enabled as below and should then be disabled.}}
====UPS Administrative Privileges====
You should check your new password ( AdminPass ) to run '''upserw''' & '''upscmd'''. Of course, you could change your password for a easier one to use.
config show nut
To set new admin password in database. The new password would be admin ( change it to suit your need )
config setprop nut AdminPass admin
To enabled administrative privileges and run command to ups.
config setprop nut AdminUser enabled
Now, to get '''upsd''' to recognise admin modification for administrative privileges we expand the template and reload the '''upsd''' configuration
/sbin/e-smith/expand-template /etc/ups/upsd.users
/usr/sbin/upsd -c reload
{{Note box|To disabled the administrative privileges once you have changed the UPS parameters or issued commands as required, issue the commands
config setprop nut AdminUser disabled
/sbin/e-smith/expand-template /etc/ups/upsd.users
/usr/sbin/upsd -c reload
}}
==== UPS access ====
The access of the ups is controled by database properties. The default propertie is set to localhost and give permission to run '''upsrw''' & '''upscmd''' from localhost only if administrative privileges is set to enabled as above. No slave ups could be connected in this mode. Three choices is available to set access.
* localhost: the ups access is only from the local machine ( UPS master ).
* private: the ups access is from your local machine and local network as per define in server-manager panel.
* public: the ups access is similar to localhost.
To set access properties in the database ( example: localhost )
config setprop nut access localhost
/sbin/e-smith/expand-template /etc/ups/upsd.conf
/usr/sbin/upsd -c reload
In localhost or public mode ( no remote access ), access to your ups is ( UPS name is '''UPS''' )
UPS@localhost
In private mode, access to your ups is ( UPS name is '''UPS''' )
UPS@localhost or UPS@192.168.1.1 ( ups master IP )
slave ups get access with UPS@192.168.1.1 ( ups master IP )
==Setting UPS Variables==
In order to set UPS variables it is necessary to have enabled the administrative privileges as above first and you get the possibility to run command from slave ups if access is set to private as above.
In the examples below, it is assumed your UPS name is '''UPS''', that it is local, that the administrative user is '''admin''' and password '''admin'''. You can verify your UPS name via:
upsc -l
To view a complete list of the UPS variables, both informational and modifiable
upsc UPS
To determine the modifiable variables for your UPS, their current settings and their available setting values execute the command:
upsrw UPS
You can now modify the variables you wish using a command similar to the following (Note the order of the arguments is important, and you may need quotes around the value being set, "20"):
upsrw -s battery.charge.low=20 -u admin -p admin UPS
For remote host (slave UPS ), we need to add the IP from master UPS to run command.
upsrw -s battery.charge.low=20 -u admin -p admin UPS@192.168.2.1
Where the value after '''-s''' should be one of the parameters identified by the '''upsrw ups''' command. You can of course verify your changes using
upsrw UPS
or
upsc UPS
After you are done, clean up by disabling the '''upsc''' administrative privileges:
{{Warning box|Make sure you understand the meaning or the UPS variables and their available setting options. Verify that your changes meet your intended behaviour!}}
More information on upsrw can be found at:
- Manual page: man upsrw
====Issuing UPS Commands====
In order to issue UPS commands it is necessary to have enabled the administrative privileges as above first and you get the possibility to run command from slave ups if access is set to private as above.
In the examples below, it is assumed your UPS name is '''UPS''', that it is local, that the administrative user is '''admin''' and password '''admin'''. You can verify your UPS name via:
upsc -l
To view a complete list of available commands for your UPS:
upscmd -l UPS
You can now issue a command to the localhost UPS with similar to the following:
upscmd -u admin -p admin UPS test.battery.start
For remote host (slave UPS ), we need to add the IP from master UPS to run command.
upscmd -u admin -p admin UPS@192.168.2.1 test.battery.start
Where the command '''test.battery.start''' is a valid command for your UPS as previously determined by '''upscmd -l UPS'''. Depending upon the command issued you may get broadcast messages and emails relating to and confirming what the UPS is doing.
After you are done, clean up by disabling the '''upsc''' administrative privileges:
{{Warning box|Before issuing any commands verify what they do for your particular UPS via the relevant documentation and ensure that the command meets your intended behavioural requirement!
Issuing commands could shutdown your server unexpectedly!}}
<headertabs />
=Scheduling Events=
====Shutdown Time Delay Example====
By default NUT will issue a shutdown command as soon as it receives a low battery event from the UPS. There may be instances and installation configurations that require a shutdown sooner, or other events with timed or schedules outcomes. See the '''man''' pages etc for further info and example situations.
By default NUT will issue a shutdown command as soon as it receives a low battery event from the UPS. There may be instances and installation configurations that require a shutdown sooner, or other events with timed or schedules outcomes. See the '''man''' pages etc for further info and example situations.
Create and edit a new file called 'NOTIFYCMD' with the following content:
Create and edit a new file called 'NOTIFYCMD' with the following content:
NOTIFYCMD /usr/sbin/upssched
NOTIFYCMD /usr/sbin/upssched
Expand the template:
/sbin/e-smith/expand-template /etc/ups/upsmon.conf
Now create another a custom template directory
Now create another a custom template directory
AT ONBATT * START-TIMER shutdownnow 120
AT ONBATT * START-TIMER shutdownnow 120
to how many seconds after ONBATT signal you want to shut down
to how many seconds after ONBATT signal you want to shut down
Expand the template:
/sbin/e-smith/expand-template /etc/ups/upssched.conf
Create and edit a new script file at:
Create and edit a new script file at:
esac
esac
Now make it executable by '''nut''' user
chmod 754 /sbin/e-smith/nutUPS.cmd
chown root:nut /sbin/e-smith/nutUPS.cmd
Nut requires to use sudo for this process to work, so sudo needs configuring to enable the user nut. By default the /etc/sudoers file is not part of the SME Server template system. To workaround this create a custom template directory:
mkdir -p /etc/e-smith/templates-custom/etc/sudoers
cd /etc/e-smith/templates-custom/etc/sudoers
To preserve the content of the orginal /etc/sudoers file copy that into the custom template directory:
cp /etc/sudoers 10sudoers
Create and edit a new file called '30nut' with the following content:
Create and edit a new file called '30nut' with the following content:
nut ALL=NOPASSWD: ALL
nut ALL=NOPASSWD: ALL
Then run:
/sbin/e-smith/expand-template /etc/sudoers
Finally to complete the process:
signal-event post-upgrade
signal-event post-upgrade
signal-event reboot
signal-event reboot
===Aditional Information===
While testing with the SMEServer v9.1 (circa March 2016), the above <tt>nutUPS.cmd</tt> script with entries in <tt>01CONFIG</tt> template fails due to lack of permissions at the <tt>shutdownnow</tt> case at:
/usr/bin/sudo /sbin/e-smith/signal-event halt
Tweaking the <tt>/etc/sudoers</tt> did not mitigate it.
The error in the <tt>/var/log/messages</tt> is:
<pre>
Mar 14 13:22:16 svr01 upssched[3507]: Timer daemon started
Mar 14 13:22:16 svr01 upssched[3507]: New timer: shutdownnow (120 seconds)
Mar 14 13:25:16 svr01 upssched[3507]: Event: shutdownnow
Mar 14 13:25:16 svr01 wall[3539]: wall: user nut broadcasted 1 lines (70 chars)
Mar 14 13:25:16 svr01 upssched[3507]: exec_cmd(/sbin/e-smith/nutUPS.cmd shutdownnow) returned 1
</pre>
However, the '''nut''' user has the necessary shutdown permissions:
/usr/bin/sudo -u nut /usr/bin/sudo /sbin/e-smith/signal-event halt
=Configure Nut-cgi Monitor Scripts=
The nut-cgi rpm contains scripts that can be run via the webserver to monitor the UPS(s).
===Download and install===
There are template fragments in /etc/e-smith/templates/etc/ups that control the config files located in /etc/ups. The default settings should be OK for most situations.
You have to enable the '''[[epel]]''' repositories.
yum install --enablerepo=epel nut-cgi
Edit file /etc/ups/hosts.conf and add.
MONITOR UPS@localhost "local UPS"
The nut-cgi rpm contains three cgi scripts. The rpm does not install them correctly for SME however so the following modifications are needed.
mkdir -p /opt/nut-cgi-bin
chown root:www /opt/nut-cgi-bin
mv /var/www/nut-cgi-bin/upsstats.cgi /opt/nut-cgi-bin
mv /var/www/nut-cgi-bin/upsset.cgi /opt/nut-cgi-bin
mv /var/www/nut-cgi-bin/upsimage.cgi /opt/nut-cgi-bin
chown root:www /opt/nut-cgi-bin/*
chmod 750 /opt/nut-cgi-bin/*
mkdir -p /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf
cd /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf
Now edit and create a new file 92nutupscmon with the following content
{
$OUT = "";
my $allow = 'all';
my $pass = '0';
my $satisfy = 'all';
my $name = $nut{'Name'} || 'NUT UPS Daemon Monitoring';
for ('exit-if-none')
{
if ($nut{'PublicAccess'})
{
if ($nut{'PublicAccess'} eq 'none')
{
next;
}
elsif ($nut{'PublicAccess'} eq 'local')
{
$allow = $localAccess;
$pass = 0;
$satisfy = 'all';
}
elsif ($nut{'PublicAccess'} eq 'local-pw')
{
$allow = $localAccess;
$pass = 1;
$satisfy = 'all';
}
elsif ($nut{'PublicAccess'} eq 'global')
{
$allow = 'all';
$pass = 0;
$satisfy = 'all';
}
elsif ($nut{'PublicAccess'} eq 'global-pw')
{
$allow = 'all';
$pass = 1;
$satisfy = 'all';
}
elsif ($nut{'PublicAccess'} eq 'global-pw-remote')
{
$allow = $localAccess;
$pass = 1;
$satisfy = 'any';
}
}
$OUT .= "#------------------------------------------------------------\n";
$OUT .= "# nut multimon - $name\n";
$OUT .= "#------------------------------------------------------------\n";
{
if ((exists $nut{'URL'}) && ($nut{'URL'} ne <nowiki>''</nowiki>)) {
$OUT .= "Alias /$nut{'URL'} /opt/nut-cgi-bin\n";
}
}
$OUT .= "Alias /nut /opt/nut-cgi-bin\n";
$OUT .= "\n";
$OUT .= "<Directory /opt/nut-cgi-bin>\n";
$OUT .= " DirectoryIndex upsstats.cgi\n";
$OUT .= " Options +ExecCGI\n";
$OUT .= " order deny,allow\n";
$OUT .= " deny from all\n";
$OUT .= " allow from $allow\n";
if ($pass)
{
$OUT .= " AuthName $name\n";
$OUT .= " AuthType Basic\n";
$OUT .= " AuthExternal pwauth\n";
$OUT .= " require valid-user\n";
$OUT .= " Satisfy $satisfy\n";
}
$OUT .= "</Directory>\n";
}
}
Configure databases and expand the template
config setprop nut PublicAccess local
/sbin/e-smith/expand-template /etc/httpd/conf/httpd.conf
{{Note box|The above sets access to the scripts to ''local'' ip addresses only. See the [[Web_Application_RPM#New_DB_settings]] for further info and settings}}
Restart the web server
sv t httpd-e-smith
===Usage of Nut-cgi Scripts===
Now go to http://yourdomain.tld/nut to see the statistics and information for the UPS at localhost.
By editing <tt>/etc/ups/hosts.conf</tt> and adding additional network UPS details, nut-cgi can be used to monitor more than one UPS. By the modification above, only the localhost is monitored.
=Additional Information=
There are template fragments in /etc/e-smith/templates/etc/ups that control the config files located in /etc/ups. The default settings should be OK for most situations. The <tt>/etc/nut.conf</tt> file must be manually edited like <tt>mode=standalone</tt> as the templates do not touch this file. In this case it would be:
sed -e 's/^MODE.*/MODE=standalone/' -i /etc/ups/nut.conf
By default, NUT is configured for a USB connected UPS in Master mode, but is disabled. When enabled, NUT will monitor the UPS and take various actions when certain notifications are received. This is controlled by the '''/etc/ups/upsmon.conf''' file which among other things lists the notifications and the actions to be taken for each. For example an ''On Battery'' event is captured by the '''NOTIFYFLAG ONBATT''' entry and the following '''SYSLOG+WALL+EXEC''' command string. This string tells '''upsmon''' to write the event to the System Log, broadcast a message to all users via Wall, and execute the command denoted by the '''NOTIFYCMD''' entry.
By default, NUT is configured for a USB connected UPS in Master mode, but is disabled. When enabled, NUT will monitor the UPS and take various actions when certain notifications are received. This is controlled by the '''/etc/ups/upsmon.conf''' file which among other things lists the notifications and the actions to be taken for each. For example an ''On Battery'' event is captured by the '''NOTIFYFLAG ONBATT''' entry and the following '''SYSLOG+WALL+EXEC''' command string. This string tells '''upsmon''' to write the event to the System Log, broadcast a message to all users via Wall, and execute the command denoted by the '''NOTIFYCMD''' entry.
man upsd
man upsd
man nutupsdrv
man nutupsdrv
==Timeout Issues==
If you have comms problems like this you can add a custom timeout:
"USBDEVFS_CONTROL failed cmd blazer_usb rqt 33 rq 9 len 8 ret -110"
Add a new config item. The default is 2
config setprop nut pollInterval 4
Modify the template
mkdir -p /etc/e-smith/templates-custom/etc/ups/ups.conf
cp /etc/e-smith/templates/etc/ups/ups.conf/UPS /etc/e-smith/templates-custom/etc/ups/ups.conf/UPS
nano /etc/e-smith/templates-custom/etc/ups/ups.conf/UPS
Add the bits between the # comments
{
my $model = $nut{Model} || "usbhid-ups";
my $device = $nut{Device} || "/var/lib/ups/hiddev0";
my $type = $nut{Type};
my $mfr = $nut{mfr};
my $mdl = $nut{mdl};
# Add this
my $poll = $nut{pollInterval} || '2';
if ($poll ne '2') {
$OUT .= "pollinterval = $poll\n";
}
# ends here
$OUT .= "[UPS]\n";
$OUT .= "\tdriver = $model\n";
expand-template /etc/ups/ups.conf
cat /etc/ups/ups.conf
You should see something like this:
# Copyright (C) 1999-2006 Mitel Networks Corporation
#------------------------------------------------------------
pollinterval = 4
[UPS]
Restart nut
service nut restart
Now check to see the correct timeout:
upsc UPS | grep driver.parameter.pollinterval
driver.parameter.pollinterval: 4
To reset either delete the key, or set it to the default of 2
==Further reading==
The NUT website is here: [http://www.networkupstools.org/ NUT]
The NUT website is here: [http://www.networkupstools.org/ NUT]
An example of doing this can be found in the forum [http://forums.contribs.org/index.php?topic=40668.0] and in the section above for UPS Administrative Privileges
An example of doing this can be found in the forum [http://forums.contribs.org/index.php?topic=40668.0] and in the section above for UPS Administrative Privileges
See also [[KnownProblems#Restarting_NUT]]
See also [[KnownProblems#Restarting_NUT| Known Problem - Restarting Nut]]
----
===Documentation===
----
Nut is a Software well documented, you can find the [http://www.networkupstools.org/docs/user-manual.chunked/index.html TOC here] and with [http://www.networkupstools.org/docs/user-manual.chunked/ar01s02.html an overview]
<noinclude>[[Category:Howto]]</noinclude>
<noinclude>
<noinclude>[[Category:Administration]]</noinclude>
[[Category:Howto]]
</noinclude>
<noinclude>
[[Category:Administration]]
</noinclude>
__FORCETOC__
