1NETXML-UPS(8) NUT Manual NETXML-UPS(8)
2
3
4
6 netxml-ups - Driver for Eaton / MGE Network Management Card / Proxy
7 (XML/HTTP Protocol) equipment
8
10 This man page only documents the hardware-specific features of the
11 netxml-ups driver. For information about the core driver, see
12 nutupsdrv(8).
13
15 netxml-ups supports all recent Eaton / MGE models which use a Network
16 Management Card or Proxy (MGE XML/HTTP protocol based). This applies to
17 both Eaton (previously MGE Office Protection Systems) and to MGE UPS
18 SYSTEMS. Supported card and proxy models are:
19
20 • NMC Minislot (Ref 66102, firmware EA or newer),
21
22 • SNMP/Web Minislot card (Ref 66244)
23
24 • NMC Transverse (Ref 66074),
25
26 • NMC & Modbus/JBus (Ref 66103),
27
28 • Network Management Proxy,
29
30 • ePDU Monitored (newer version).
31
32 Older models, such as SNMP card (Ref 66062 and Ref 66045), use the SNMP
33 protocol and should use the snmp-ups(8) driver with the "mibs=mge"
34 parameter.
35
37 This driver supports the following optional settings in the
38 ups.conf(5):
39
40 timeout=value
41 The timeout for connecting to and reading from the UPS. Defaults to
42 5 seconds. Don’t change this value unless you know exactly what
43 you’re doing.
44
45 This value must never be higher than half the MAXAGE value specified in
46 upsd.conf(5), otherwise you run the risk that upsd(8) declares the
47 driver stale while it is waiting for a connection to timeout.
48
49 subscribe
50 Connect to the NMC in subscribed mode. This allows to receive
51 notifications and alarms more quickly, beside from the standard
52 polling requests.
53
54 login=value
55 Set the login value for authenticated mode. This feature also needs
56 the password argument, and allows value settings in the card. This
57 feature is not used yet.
58
59 password=value
60 Set the password value, needed with the login for authenticated
61 mode. This feature is not used yet.
62
63 shutdown_duration=value
64 Set the shutdown duration of the operating system, in seconds. This
65 represents the amount of time needed by the system to operate a
66 clean shutdown. Defaults to 120 seconds.
67
68 shutdown_timer=value
69 Set the shutdown timer, in seconds. After value seconds running on
70 battery, the local system will receive a notification to shutdown.
71 Defaults to "none" (disabled).
72
73 do_convert_deci
74 If this flag value is present, the driver assumes you have a very
75 old MGE networked UPS (or rather an old network management card
76 firmware) which serves certain measurements spelled 10x too big in
77 the XML markup. Originally such measurements were decimated by the
78 driver — but this is wrong for newer, more sane, devices — so this
79 behavior was deprecated and is now disabled by default. Enabling
80 this flag in configuration of a particular driver instance restores
81 the old behavior for those measurements.
82
84 The hostname of the UPS is specified with the "port" value in ups.conf,
85 i.e.:
86
87 [mgexml]
88 driver = netxml-ups
89 port = http://netxml-ups.example.com:80
90
91 Specifying the method to connect to the UPS (http, https) is mandatory.
92 If the port is equal to the default for the method specified (80 for
93 http, 443 for https) it may be omitted.
94
95 In order not to overload older NMCs by polling them too frequently, it
96 is recommended to increase the "pollinterval" (see nutupsdrv(8)) and
97 ups.conf(5)) to at least 5 seconds.
98
100 Don’t connect to the UPS through a proxy. Although it would be trivial
101 to add support for proxies, this is not recommended and don’t ask for
102 it. Not only because it will prevent the driver to make a persistent
103 connection to the UPS, but also it adds an additional failure mode. If
104 the proxy goes down (for whatever reason), the driver will no longer be
105 able to reach the UPS.
106
108 Arjen de Korte <adkorte-guest@alioth.debian.org>
109
111 The core driver:
112 nutupsdrv(8)
113
114 Internet resources:
115 The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
116
117
118
119Network UPS Tools 2.8.0 04/26/2022 NETXML-UPS(8)