nut.conf(5)

1NUT.CONF(5)                       NUT Manual                       NUT.CONF(5)
2
3
4

NAME

6       nut.conf - UPS definitions for Network UPS Tools
7

DESCRIPTION

9       This file attempts to standardize the various files being found in
10       different installations, like /etc/default/nut on Debian based systems
11       and /etc/sysconfig/ups on RedHat based systems.
12
13       Distribution’s init script should source this file in order to
14       determine which components have to be started.
15
16       Blank lines are ignored. Lines with a hash (#) character at the 1st
17       position of the line are ignored, too. They can be used to add
18       comments.
19

IMPORTANT NOTE

21       This file is intended to be sourced by shell scripts. You MUST NOT use
22       spaces around the equal sign!
23
24       Refer to the EXAMPLE section for illustrations.
25

DIRECTIVES

27       MODE
28           Required. Recognized values are none, standalone, netserver and
29           netclient. Defaults to none.
30
31           none
32               Indicates that NUT should not get started automatically,
33               possibly because it is not configured or that an Integrated
34               Power Management or some external system, is used to startup
35               the NUT components.
36
37           standalone
38               Addresses a local only configuration, with 1 UPS protecting the
39               local system. This implies to start the 3 NUT layers (driver,
40               upsd and upsmon), with the related configuration files. This
41               mode can also address UPS redundancy.
42
43           netserver
44               Like the standalone configuration, but also possibly need one
45               or more specific LISTEN directive(s) in upsd.conf. Since this
46               MODE is open to the network, a special care should be applied
47               to security concerns.
48
49           netclient
50               When only upsmon is required, possibly because there are other
51               hosts that are more closely attached to the UPS, the MODE
52               should be set to netclient.
53
54       UPSD_OPTIONS
55           Optional. Set upsd specific options. See upsd(8) for more details.
56           It is ignored when MODE above indicates that no upsd should be
57           running.
58
59       UPSMON_OPTIONS
60           Optional. Set upsmon specific options. See upsmon(8) for more
61           details. It is ignored when MODE above indicates that no upsmon
62           should be running.
63
64       POWEROFF_WAIT
65           Optional. At the end of an emergency system halt, the upsmon
66           primary will signal the UPS to switch off. This may fail for a
67           number of reasons. Most notably is the case that mains power
68           returns during the shutdown process. See the section "Power races"
69           in /usr/share/doc/nut/FAQ.txt.gz. The system will wait this long
70           for the UPS to cut power, and then reboot. It should be long enough
71           to exhaust the batteries, in case line power continues to be
72           unavailable. On the other hand, it should not be so long that the
73           system remains offline for an unreasonable amount of time if line
74           power has returned. See sleep(1) for compatible time syntax. If you
75           specify the time in seconds, use the "s" suffix.
76
77           Warning
78           this workaround might be dangerous under some circumstances. Please
79           read http://bugs.debian.org/358696 for more details.
80

EXAMPLE

82              # /etc/nut/nut.conf.  See nut.conf(5)
83
84              MODE=none
85
86              UPSD_OPTIONS=""
87
88              UPSMON_OPTIONS=""
89
90              # POWEROFF_WAIT=15m
91

INTEGRATION

93       An init script, such as /etc/init.d/nut, is expected to source this
94       file in order to determine which components have to be started.
95

NAME

DESCRIPTION

IMPORTANT NOTE

DIRECTIVES

EXAMPLE

INTEGRATION

SEE ALSO