Penguin
Recent Changes
Annotated edit history of ups.conf(5) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 UPS.CONF
2 !!!UPS.CONF
3 NAME
4 DESCRIPTION
5 FIELDS
6 INTEGRATION
7 SEE ALSO
8 ----
9 !!NAME
10
11
12 ups.conf - UPS definitions for Network UPS Tools
13 !!DESCRIPTION
14
15
16 This file is read by the driver controller upsdrvctl, the
17 UPS drivers that use the common core (see
18 nutupsdrv(8)) and upsd(8). Each UPS gets its
19 own section, and that section contains a number of
20 directives that set parameters for that UPS.
21
22
23 The section begins with the name of the ups in brackets, and
24 continues until the next UPS name in brackets or until EOF.
25 The name
26
27
28 You must define the
29
30
31 [[myups]
32 driver = fentonups
33 port = /dev/ttyS0
34
35
36 A slightly more complicated version includes some extras for
37 the hardware-specific part of the driver:
38
39
40 [[bigups]
41 driver = apcsmart
42 port = /dev/cua00
43 cable = 940-0095B
44 sdtype = 2
45
46
47 In this case, the apcsmart(8) driver will receive
48 variables called
49 __
50
51
52 Note that
53 apcsmart__(8) will accept on the
54 command line via -x. All options that can be specified with
55 -x can be set here in this file. In the event that a value
56 is set both here and on the command line, the command line
57 takes precedence. This allows you to set reasonable defaults
58 in this file and then override them manually when
59 needed.
60 !!FIELDS
61
62
63 driver
64
65
66 Required. This specifies which program will be monitoring
67 this UPS. You need to specify the one that is compatible
68 with your hardware. See nutupsdrv(8) for more
69 information on drivers in general and pointers to the man
70 pages of specific drivers.
71
72
73 port
74
75
76 Required. This is the serial port where the UPS is
77 connected. On a Linux system, the first serial port usually
78 is /dev/ttyS0. On FreeBSD and similar systems, it probably
79 will be /dev/cuaa0.
80
81
82 sddelay
83
84
85 Optional. You can set this to a number of seconds that the
86 driver will allow to elapse when you tell it to shut down
87 the UPS with -k. This is the same as doing -d
88
89
90 sdorder
91
92
93 Optional. When you have multiple UPSes on your system, you
94 usually need to turn them off in a certain order. upsdrvctl
95 shuts down all the 0s, then the 1s, 2s, and so on. To
96 exclude a UPS from the shutdown sequence, set this to
97 -1.
98
99
100 The default value for this parameter is 0.
101
102
103 nolock
104
105
106 Optional. When you specify this, the driver skips the port
107 locking routines every time it starts. This may allow other
108 processes to seize the port if you start more than one
109 accidentally.
110
111
112 You should only use this if your system won't work without
113 it.
114
115
116 Note to FreeBSD users: all new style drivers (i.e. drivers
117 that support ups.conf) now automatically disable locking
118 during shutdown (-k). This means you can use the shutdown
119 routines even when your filesystems are mounted
120 read-only.
121
122
123 maxstartdelay
124
125
126 Optional. This can be set as a global variable above your
127 first UPS definition and it can also be set in a UPS
128 section. This value controls how long upsdrvctl will wait
129 for the driver to finish starting. This keeps your system
130 from getting stuck due to a broken driver or
131 UPS.
132
133
134 The default is 45 seconds.
135
136
137 All other fields are passed through to the hardware-specific
138 part of the driver. See those manuals for the list of what
139 is allowed.
140 !!INTEGRATION
141
142
143 upsdrvctl uses this file to start and stop the
144 drivers.
145
146
147 The drivers themselves obtain configuration data from this
148 file when they are started by upsdrvctl, or when you start
149 them with -a. See nutupsdrv(8) for more information
150 on that.
151
152
153 upsd(8) learns about which UPSes are installed on
154 this system by reading this file. If this system is called
155 upsc(8) or similar as
156 __
157
158
159 Additionally, the first UPS in this file is the default ups
160 in upsd. If you tell one of the clients to monitor a UPS by
161 the hostname alone (
162 !!SEE ALSO
163
164
165 upsd(8), nutupsdrv(8),
166 upsdrvctl(8)
167
168
169 __Internet resources:__
170
171
172 The NUT (Network UPS Tools) home page:
173 http://www.exploits.org/nut/
174
175
176 NUT mailing list archives and information:
177 http://lists.exploits.org/
178 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.