table of contents
UPSDRVCTL(8) | NUT Manual | UPSDRVCTL(8) |
NAME¶
upsdrvctl - UPS driver controllerSYNOPSIS¶
upsdrvctl -hDESCRIPTION¶
upsdrvctl provides a uniform interface for controlling your UPS drivers. You should use upsdrvctl instead of direct calls to the drivers whenever possible.OPTIONS¶
-hDisplay the help text.
-r directory
If starting a driver, this value will direct
it to chroot(2) into directory. This can be useful when securing
systems.
Enable testing mode. This also enables debug
mode. Testing mode makes upsdrvctl display the actions it would execute
without actually doing them. Use this to test out your configuration without
actually doing anything to your UPS drivers. This may be helpful when defining
the sdorder directive in your ups.conf(5).
-u username
If starting a driver, this value will direct
it to setuid(2) to the user id associated with username.
Raise the debug level. Use this multiple times
for additional details.
COMMANDS¶
upsdrvctl supports three commands - start, stop and shutdown. They take an optional argument which is a UPS name from ups.conf(5). Without that argument, they operate on every UPS that is currently configured. startStart the UPS driver(s).
stop
Stop the UPS driver(s).
shutdown
Command the UPS driver(s) to run their
shutdown sequence. Drivers are stopped according to their sdorder value - see
ups.conf(5).
ENVIRONMENT VARIABLES¶
NUT_CONFPATH is the path name of the directory that contains upsd.conf and other configuration files. If this variable is not set, upsdrvctl the driver use a built-in default, which is often /usr/local/ups/etc.DIAGNOSTICS¶
upsdrvctl will return a nonzero exit code if it encounters an error while performing the desired operation. This will also happen if a driver takes longer than the maxstartdelay period to enter the background.SEE ALSO¶
nutupsdrv(8), upsd(8), ups.conf(5)Internet resources:¶
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/05/21/2012 | Network UPS Tools |