upsset.cgi(8)

1upsset.cgi(8)               Network UPS Tools (NUT)              upsset.cgi(8)
2
3
4

NAME

6       upsset.cgi - Web‐based UPS administration program
7

SYNOPSIS

9       upsset.cgi
10
11

NOTE

13       As  a  CGI program, this should be invoked through your web server.  If
14       you run it from the command line, it will sit there until you  give  it
15       input resembling a POST request.
16
17

DESCRIPTION

19       upsset.cgi lets you access many administrative functions within the UPS
20       software from your web browser.  You can  change  settings  and  invoke
21       instant commands where available.
22
23

CHANGING SETTINGS

25       Some  UPS hardware allows you to change certain variables to other val‐
26       ues.  To see what's available, pick a UPS from the chooser  and  select
27       "settings", then select "View" to update the page.
28
29       You  should  see a list of items with the descriptions on the left side
30       and the possible options or input spaces on the right.  After  changing
31       something, be sure to "Save changes" to update the values in your UPS.
32
33       If  your  UPS  doesn't  support any read/write variables, there will be
34       nothing to do on this page.
35
36       Setting values in read/write variables can also be done from  the  com‐
37       mand line with upsrw(8).
38
39

INSTANT COMMANDS

41       Some UPS hardware also has provisions for performing certain actions at
42       the user's command.  These include battery tests, battery  calibration,
43       front  panel  tests  (beep!)  and  more.  To access this section, do as
44       above, but pick "Commands" as the function.
45
46       If your UPS supports any instant commands, they will  be  listed  in  a
47       chooser  widget.   Pick the one you like and "Issue command" to make it
48       happen.
49
50       Note ‐ some dangerous commands like "Turn  off  load"  may  not  happen
51       right  away.   This  is  a feature, not a bug.  The apcsmart driver and
52       some others require that you send this command  twice  within  a  short
53       window  in  order to make it happen.  This is to keep you from acciden‐
54       tally killing your systems by picking the wrong one.
55
56       To actually turn off the load, you have to send the command once,  then
57       send  it  again  after 3 seconds elapse but before 15 seconds pass.  If
58       you do it too quickly or slowly, you have to wait at  least  3  seconds
59       but not 15 seconds again.
60
61       You  can  also  invoke  instant  commands  from  the  command line with
62       upscmd(8).
63
64

ACCESS CONTROL

66       upsset will only talk to upsd(8) servers that have been defined in your
67       hosts.conf(8).   If  it  complains  about  "Access  to that host is not
68       authorized", check your hosts.conf first.
69
70

SECURITY

72       upsset will not run until you convince it that your CGI  directory  has
73       been  secured.   This is due to the possibility of someone using upsset
74       to try password combinations against your upsd(8) server.
75
76       See the example upsset.conf file for more information  on  how  you  do
77       this.   The short explanation is ‐ if you can't lock it down, don't try
78       to run it.
79
80

FILES

82       hosts.conf(5)
83
84