clone(8) - f37

1CLONE(8)                          NUT Manual                          CLONE(8)
2
3
4

NAME

6       clone - UPS driver clone
7

NOTE

9       This man page only documents the specific features of the clone driver.
10       For information about the core driver, see nutupsdrv(8).
11

DESCRIPTION

13       This driver, which sits on top of another driver socket, allows users
14       to group clients to a particular outlet of a device and deal with this
15       output as if it was a normal UPS.
16

EXTRA ARGUMENTS

18       This driver supports the following settings:
19
20       load.off=command
21           Recommended. Set the command on the "real" UPS driver that will be
22           used to switch off the outlet. You need both load.off and load.on
23           in order to power cycle the outlet. Otherwise, shutting down the
24           clients powered by an outlet is a one way street (see IMPORTANT).
25
26       load.on=command
27           Recommended. Set the command on the "real" UPS driver that will be
28           used to switch on the outlet. You need both load.off and load.on in
29           order to power cycle the outlet. Otherwise, shutting down the
30           clients powered by an outlet is a one way street (see IMPORTANT).
31
32       load.status=value
33           Recommended. Set the variable on the "real" UPS driver that will be
34           used to indicate the outlet status (i.e. on/off). If not specified,
35           the clone driver will attempt to keep track of the outlet status,
36           but this is less reliable.
37
38       offdelay=num
39           Set the timer (in seconds) before the outlet is turned off after
40           the shutdown condition (OB LB) for this outlet is met or a command
41           to shutdown was issued. Defaults to 120 seconds.
42
43       ondelay=num
44           Set the timer (in seconds) for the outlet to switch on in case the
45           power returns after the outlet has been switched off. Defaults to
46           30 seconds.
47
48       mincharge=value
49           Set the remaining battery level when the clone UPS switches to LB
50           (percent).
51
52       minruntime=value
53           Set the remaining battery runtime when the clone UPS switches to LB
54           (seconds).
55

IMPLEMENTATION

57       The port specification in the ups.conf(5) reference the driver socket
58       that the "real" UPS driver is using. For example:
59
60             [realups]
61                driver = usbhid-ups
62                port = auto
63
64             [clone-outlet-1]
65                driver = clone
66                port = usbhid-ups-realups
67                load.on = outlet.1.load.on
68                load.off = outlet.1.load.off
69                load.status = outlet.1.status
70                [...]
71

IMPORTANT

73       Unlike a real UPS, you should not configure a upsmon primary mode for
74       this driver. When a upsmon primary sees the OB LB flags and tells the
75       upsd server it is OK to initiate the shutdown sequence, the server will
76       latch the FSD status and it will not be possible to restart the systems
77       connected without restarting the upsd server.
78
79       This will be a problem if the power returns after the clone UPS
80       initiated the shutdown sequence on it’s outlet, but returns before the
81       real UPS begins shutting down. The solution is in the clone driver,
82       that will insert the FSD flag if needed without the help of a upsmon
83       primary.
84

CAVEATS

86       The clone UPS will follow the status on the real UPS driver. You can
87       only make the clone UPS shutdown earlier than the real UPS driver, not
88       later. If the real UPS driver initiates a shutdown, the clone UPS
89       driver will immediately follow.
90
91       Be aware that the commands to shutdown/restart an outlet on the real
92       UPS drivers are not affected, so if you tell the real UPS driver to
93       shutdown the outlet of the clone UPS driver, your clients will lose
94       power without warning.
95
96       If you use service management frameworks like systemd or SMF to manage
97       the dependencies between driver instances and other units, then you may
98       have to set up special dependencies (e.g. with systemd "drop-in"
99       snippet files) to queue your clone drivers to start after the "real"
100       device drivers.
101

AUTHOR

103       Arjen de Korte <adkorte-guest@alioth.debian.org>
104