upsset.cgi(8)

1UPSSET.CGI(8)                     NUT Manual                     UPSSET.CGI(8)
2
3
4

NAME

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

SYNOPSIS

9       upsset.cgi
10
11           Note
12           As a CGI program, this should be invoked through your web server.
13           If you run it from the command line, it will sit there until you
14           give it input resembling a POST request.
15

DESCRIPTION

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

CHANGING SETTINGS

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

INSTANT COMMANDS

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

ACCESS CONTROL

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

SECURITY

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

FILES

77       hosts.conf(5), upsset.conf(5)
78