netxml-ups(8)

1NETXML-UPS(8)                     NUT Manual                     NETXML-UPS(8)
2
3
4

NAME

6       netxml-ups - Driver for Eaton / MGE Network Management Card / Proxy
7       (XML/HTTP Protocol) equipment
8

NOTE

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

SUPPORTED HARDWARE

15       netxml-ups support 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

EXTRA ARGUMENTS

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       login=value
50           Set the login value for authenticated mode. This feature also needs
51           the password argument, and allows value settings in the card. This
52           feature is not used yet.
53
54       password=value
55           Set the password value, needed with the login for authenticated
56           mode. This feature is not used yet.
57

IMPLEMENTATION

59       The hostname of the UPS is specified with the "port" value in ups.conf,
60       i.e.:
61
62           [mgexml]
63                   driver = netxml-ups
64                   port = http://netxml-ups.example.com:80
65
66       Specifying the method to connect to the UPS (http, https) is mandatory.
67       If the port is equal to the default for the method specified (80 for
68       http, 443 for https) it may be omitted.
69
70       In order not to overload older NMCs by polling them too frequently, it
71       is recommended to increase the "pollinterval" (see nutupsdrv(8)) and
72       ups.conf(5)) to at least 5 seconds.
73

KNOWN ISSUES

75       Don’t connect to the UPS through a proxy. Although it would be trivial
76       to add support for proxies, this is not recommended and don’t ask for
77       it. Not only because it will prevent the driver to make a persistent
78       connection to the UPS, but also it adds an additional failure mode. If
79       the proxy goes down (for whatever reason), the driver will no longer be
80       able to reach the UPS.
81

AUTHORS

83       Arjen de Korte <adkorte-guest@alioth.debian.org>
84