.TH UPSSCHED.CONF 5 "Wed Oct 16 2002" "" "Network UPS Tools (NUT)"
.SH NAME
upssched.conf \- Configuration for upssched timer program

.SH DESCRIPTION

This file controls the operations of \fBupssched\fR(8), the timer-based
helper program for \fBupsmon\fR(8).

.SH CONFIGURATION DIRECTIVES

.IP "CMDSCRIPT \fIscriptname\fR"
Required.  This must be above any AT lines.  This script is used to 
invoke commands when your timers are triggered.  It receives a single
argument which is the name of the timer that caused it to trigger.

.IP "PIPEFN \fIfilename\fR"
This sets the file name of the FIFO that will pass communications between
processes to start and stop timers.  This should be set to some path where
normal users can't create the file, due to the possibility of symlinking
and other evil.
.IP
NOTE: if you are running Solaris or similar, the permissions that upssched
sets on this file \fBare not enough\fR to keep you safe.  If your OS 
ignores the permissions on a FIFO, then you MUST put this in a protected
directory!
.IP
Another thing to think about: upsmon doesn't run the NOTIFYCMD as root
unless you run it with -p.  So, upssched will probably run as nobody
or similar unless you give upsmon another user with -u or RUN_AS_USER
in \fBupsmon.conf\fR(5).  Either way, you have to set PIPEFN to
something that ONLY the monitoring upsmon user can access.
.IP
The stock version of this file ships with PIPEFN disabled to make you
visit this portion of the documentation and think about how your system
works before potentially opening a security hole.

.IP "AT \fInotifytype\fR \fIupsname\fR \fIcommand\fR"
Define a handler for a specific event \fInotifytype\fR on UPS
\fIupsname\fR.  \fIupsname\fR can be the special value * to apply this
handler to every UPS.
.IP
This will perform the command \fIcommand\fR when the \fInotifytype\fR
and \fIupsname\fR match the current activity.  Possible values for
\fIcommand\fR are:
.IP
START-TIMER \fItimername\fR \fIinterval\fR
.IP
.nf
	Start a timer of \fIinterval\fR seconds.  When it triggers, it
	will pass the argument \fItimername\fR as an argument to your
	CMDSCRIPT.
.fi
.LP
.IP
Example:
.IP
.nf
	Start a timer that'll execute when any UPS (*) has been 
	gone for 10 seconds

	AT COMMBAD * START-TIMER upsgone 10
.fi
.LP

.IP
CANCEL-TIMER \fItimername\fR [cmd]
.IP
.nf
	Cancel a running timer called <timername>, if possible. 
        If the timer has passed then pass the optional argument
        <cmd> to CMDSCRIPT.
.fi
.LP

.IP
Example:
.IP
.nf
	If a specific UPS (myups@localhost) comes back online, then 
	stop the timer before it triggers

	AT COMMOK myups@localhost CANCEL-TIMER upsgone
.fi
.LP

.IP
EXECUTE \fIcommand\fR
.IP
.nf
	Immediately pass <command> as an argument to CMDSCRIPT.
.fi
.LP

.IP
Example:
.IP
.nf
	If any UPS (*) reverts to utility power, then execute
	'ups-back-on-line' via CMDSCRIPT.

	AT ONLINE * EXECUTE ups-back-on-line
.fi
.LP

.IP
Note that any AT that matches both the \fInotifytype\fR and the
\fIupsname\fR for the current event will be used.

.SH SEE ALSO
\fBupssched\fR(8), \fBupsmon\fR(8)

.SS Internet resources:
The NUT (Network UPS Tools) home page: http://www.exploits.org/nut/

NUT mailing list archives and information: http://lists.exploits.org/