1UPSD.CONF(5)                Network UPS Tools (NUT)               UPSD.CONF(5)
2
3
4

NAME

6       upsd.conf - Configuration for Network UPS Tools upsd
7
8

DESCRIPTION

10       upsd  uses this file to control access to the server and set some other
11       miscellaneous configuration values.   This  file  contains  details  on
12       access  controls,  so  keep  it secure.  Ideally, only the upsd process
13       should be able to read it.
14
15

ACCESS CONTROL CONFIGURATION

17       ACL name netblock
18
19              Define an Access Control List (ACL) called  name  that  contains
20              the network netblock.  The netblock can be either the old style,
21              such as this for a traditional "class C":
22
23                   ACL mynet 192.168.50.0/255.255.255.0
24
25              Or, you can use new‐style "CIDR format":
26
27                   ACL mynet 192.168.50.0/24
28
29              To just list one host, it would look like one of these:
30
31                   ACL mybox 192.168.50.1/255.255.255.255
32
33                   ACL mybox 192.168.50.1/32
34
35              ACLs are used whenever you need to refer to a network  or  host,
36              such   as   in   ACCEPT/REJECT   definitions  (below)  and  with
37              "allowfrom" in upsd.users(5).
38
39
40       ACCEPT aclname [aclname...]
41
42              ACCEPT let clients on the hosts or networks defined  by  aclname
43              connect  to  upsd.   You  may  specify multiple ACL names on the
44              ACCEPT line, and you may have multiple ACCEPT lines.
45
46                   ACCEPT localhost mybox
47
48                   ACCEPT otherbox
49
50
51       REJECT aclname [aclname...]
52
53              Like ACCEPT, but it denies access instead.  upsd will close  the
54              connection without reading any data from the network.
55
56              Note:  you  should  still use firewall rules if your system pro‐
57              vides them.  That provides another level of coverage.
58
59                   REJECT badbox
60
61                   REJECT all
62
63

ACCESS CONTROL EXAMPLES

65       Here is an example configuration to show some of what is possible.
66
67       "bigserver" has a UPS attached to a serial port.  It runs  the  driver,
68       upsd,  and  upsmon  in master mode.  This definition is also referenced
69       with an "allowfrom" in upsd.users(8).
70
71       "workstation" draws from the same UPS as "bigserver", but has to  moni‐
72       tor  it  over  the network.  It runs upsmon in slave mode.   It is also
73       referenced with an "allowfrom" in upsd.users(8).
74
75       "webserver" doesn't get power from this UPS at all, but it runs the CGI
76       programs so it can make nice status displays.
77
78       An abuser's host is explicitly denied.
79
80       Everything else is rejected.
81
82
83                   ACL bigserver 10.20.30.1/32
84                   ACL workstation 10.20.30.2/32
85                   ACL webserver 10.20.30.3/32
86                   ACL abuser 192.168.255.128/32
87                   ACL all 0.0.0.0/0
88
89                   ACCEPT bigserver workstation webserver
90                   REJECT abuser
91                   REJECT all
92

ACCESS CONTROL MATCHING

94       ACCEPT  and  REJECT  directives  are checked in the order they occur in
95       this file.  The first ACL which matches a client causes the  action  to
96       be taken.  If you need to ACCEPT one host and REJECT the rest of a net‐
97       work, first list the host, then list the network on a line below it.
98
99            ACCEPT goodhost
100
101            REJECT badnet
102
103       Any IP address which does not match one of your directives will default
104       to  REJECT.  This is intended to keep your system safe if you forget to
105       put "REJECT all" at the bottom.
106
107       If you really want the whole world to have access to upsd, you  can  do
108       "ACCEPT all", but that is not recommended.
109
110

OTHER CONFIGURATION DIRECTIVES

112       MAXAGE seconds
113
114              upsd  usually  allows  a  driver to stop responding for up to 15
115              seconds before declaring the data "stale".  If your driver takes
116              a  very  long  time  to  process updates but is otherwise opera‐
117              tional, you can use MAXAGE to make upsd wait longer.
118
119              Most users should leave this at the default value.
120
121
122       STATEPATH path
123
124              Tell upsd to look for the driver state sockets  in  path  rather
125              than the default that was compiled into the program.
126
127

SEE ALSO

129       upsd(8), nutupsdrv(8), upsd.users(5)
130
131
132   Internet resources:
133       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
134
135
136
137                                Fri Apr 23 2004                   UPSD.CONF(5)
Impressum