upsdrvctl(8)

1UPSDRVCTL(8)                Network UPS Tools (NUT)               UPSDRVCTL(8)
2
3
4

NAME

6       upsdrvctl - UPS driver controller
7

SYNOPSIS

9       upsdrvctl -h
10
11       upsdrvctl [OPTIONS] {start | stop | shutdown} [ups]
12
13

DESCRIPTION

15       upsdrvctl  provides  a uniform interface for controlling your UPS driv‐
16       ers.  You should use upsdrvctl instead of direct calls to  the  drivers
17       whenever possible.
18
19       When  used  properly,  upsdrvctl  lets  you  maintain identical startup
20       scripts across multiple systems with different UPS configurations.
21
22

OPTIONS

24       -h     Display the help message.
25
26
27       -r directory
28              If starting a driver, this value will  direct  it  to  chroot(2)
29              into directory.  This can be useful when securing systems.
30
31              This may be set in the ups.conf with "chroot" in the global sec‐
32              tion.
33
34
35       -t     Enable testing mode.  This also  enables  debug  mode.   Testing
36              mode  makes upsdrvctl display the actions it would execute with‐
37              out actually doing them.  Use this to test out  your  configura‐
38              tion  without actually doing anything to your UPS drivers.  This
39              may be helpful when defining the  'sdorder'  directive  in  your
40              ups.conf(5).
41
42
43       -u username
44              If  starting a driver, this value will direct it to setuid(2) to
45              the user id associated with username.
46
47              If the driver is started as root without specifying this  value,
48              it  will  use  the  username  that was compiled into the binary.
49              This defaults to "nobody", and is far from ideal.
50
51              This may be set in ups.conf with "user" in the global section.
52
53
54       -D     Raise the debug level.  Use this multiple times  for  additional
55              details.
56
57

COMMANDS

59       upsdrvctl  supports  three  commands  ‐ start, stop and shutdown.  They
60       take an optional argument which is a UPS name from ups.conf(5).   With‐
61       out  that argument, they operate on every UPS that is currently config‐
62       ured.
63
64
65       start  Start the UPS driver(s).
66
67
68       stop   Stop the UPS driver(s).
69
70
71       shutdown
72              Command the UPS driver(s) to run their shutdown sequence.  Driv‐
73              ers   are  stopped  according  to  their  sdorder  value  ‐  see
74              ups.conf(5).
75
76              WARNING: this will probably power off your computers,  so  don't
77              play around with this option.  Only use it when your systems are
78              prepared to lose power.
79
80

ENVIRONMENT VARIABLES

82       NUT_CONFPATH is the path name of the directory that contains  ups.conf.
83       If  this  variable  is not set, upsdrvctl and the driver use a built‐in
84       default, which is often /usr/local/ups/etc.
85
86

DIAGNOSTICS

88       upsdrvctl will return a nonzero exit code if  it  encounters  an  error
89       while  performing  the  desired  operation.  This will also happen if a
90       driver takes longer than the maxstartdelay period to  enter  the  back‐
91       ground.
92
93