-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathdocumentation.html
482 lines (479 loc) · 17.4 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Network UPS Tools - Documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" />
<meta name="description" content="Power Devices support" />
<meta name="keywords" content="NUT, Network UPS Tools, Eaton, APC, Free Software, UPS, Uninterruptible Power Supplies, PDU, Power Distributions Units, Solar Controllers, power, power devices, control, monitor, Linux, Unix, Windows, Mac OS X" />
<meta name="format-detection" content="telephone=no" />
<link rel="stylesheet" href="css/xhtml11.css" type="text/css" />
<link rel="stylesheet" href="css/xhtml11-quirks.css" type="text/css" />
<link rel="stylesheet" href="css/web-layout.css" type="text/css" />
<link rel="shortcut icon" href="faviconut.ico" />
<link rel="icon" type="image/png" href="faviconut.png" />
<script type="text/javascript" src="./scripts/asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
<!--[if lte IE 7]>
<link rel="stylesheet" href="css/ie-overrides.css" type="text/css" />
<![endif]-->
<!--[if lte IE 6]>
<script type="text/javascript" src="./scripts/filter_png.js"></script>
<![endif]-->
</head>
<body>
<div id="layout-banner-box">
<div id="layout-banner">
<div id="layout-logo"><img src="images/nut-logo.png" alt="NUT logo" /></div>
<div id="layout-title">Network UPS Tools</div>
<div id="layout-description">Power Devices support</div>
</div>
</div>
<div id="layout-menu-box">
<ul id="layout-menu">
<li><a href="index.html">Home</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="projects.html">Related projects</a></li>
<li><a href="stable-hcl.html">Compatibility</a></li>
<li><a href="features.html">Features</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a href="support.html">Support</a></li>
<li>* <a href="https://alioth-lists.debian.net/pipermail/nut-upsuser/">NUT UPS User archive</a></li>
<li>* <a href="https://alioth-lists.debian.net/pipermail/nut-upsdev/">NUT UPS Dev archive</a></li>
<li>* <a href="https://github.com/networkupstools/nut/">GitHub</a>:<a
href="https://github.com/networkupstools/nut/issues">issues</a>,<a
href="https://github.com/networkupstools/nut/wiki">wiki</a>
and more</li>
<li><a href="/historic/index.html">Sub-sites for historic releases</a></li>
<li><a href="https://opencollective.com/networkupstools/">Sponsor NUT</a></li>
</ul>
<!-- div id="sponsor"><span>Hosted by<br/></span>
<a href="http://sponsor.com"><img src="images/sponsor-logo.png" alt="Sponsor" /></a>
</div -->
</div>
<div id="layout-content-box">
<div id="layout-content">
<div id="header">
<h1>Documentation</h1>
</div>
<div id="content">
<div class="sect1">
<h2 id="_user_documentation">User Documentation</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
FAQ - Frequently Asked Questions (<a href="docs/FAQ.html">online</a>) (<a href="docs/FAQ.pdf">PDF</a>)
</p>
</li>
<li>
<p>
NUT User Manual (<a href="docs/user-manual.chunked/index.html">online</a>) (<a href="docs/user-manual.pdf">PDF</a>)
</p>
</li>
<li>
<p>
Cables information (<a href="cables.html">online</a>) (<a href="docs/cables.pdf">PDF</a>)
</p>
</li>
<li>
<p>
<a href="docs/man/index.html#User_man">User manual pages</a>
</p>
</li>
<li>
<p>
<a href="ddl/index.html#_supported_devices">Devices Dumps Library (DDL)</a>: Provides information on how devices are supported; see also <a href="stable-hcl.html">the HCL</a>
</p>
</li>
<li>
<p>
<a href="docs/solaris-usb.html">Notes on NUT monitoring of USB devices in Solaris and related operating systems</a>
</p>
</li>
<li>
<p>
<a href="https://github.com/networkupstools/ConfigExamples/releases/latest/download/ConfigExamples.pdf">NUT Configuration Examples</a> book maintained by Roger Price
</p>
</li>
<li>
<p>
<a href="https://github.com/networkupstools/nut/wiki">NUT GitHub Wiki</a>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_developer_documentation">Developer Documentation</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
NUT Developer Guide (<a href="docs/developer-guide.chunked/index.html">online</a>) (<a href="docs/developer-guide.pdf">PDF</a>)
</p>
</li>
<li>
<p>
NUT Quality Assurance Guide (<a href="docs/qa-guide.chunked/index.html">online</a>) (<a href="docs/qa-guide.pdf">PDF</a>)
</p>
</li>
<li>
<p>
NUT Packager Guide (<a href="docs/packager-guide.chunked/index.html">online</a>) (<a href="docs/packager-guide.pdf">PDF</a>)
</p>
</li>
<li>
<p>
NUT Release Notes (<a href="docs/release-notes.chunked/index.html">online</a>) (<a href="docs/release-notes.pdf">PDF</a>)
</p>
</li>
<li>
<p>
NUT Change Log (<a href="docs/ChangeLog.chunked/index.html">online</a>) (<a href="docs/ChangeLog.pdf">PDF</a>)
</p>
</li>
<li>
<p>
<a href="ups-protocols.html">UPS protocols library</a>
</p>
</li>
<li>
<p>
<a href="docs/man/index.html#Developer_man">Developer manual pages</a>
</p>
</li>
<li>
<p>
<a href="nut-qa.html">NUT Quality Assurance</a>
</p>
</li>
<li>
<p>
<a href="ddl/index.html">Devices Dumps Library (DDL)</a>: Provides simulation data to the driver
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_data_dumps_for_the_ddl">Data dumps for the DDL</h2>
<div class="sectionbody">
<div class="paragraph"><p>Note: both developers contributing a driver and users using an existing driver
for device not previously documented as supported by it, are welcome to report
new data for the Devices Dumps Library (DDL) mentioned above. Best of all such
"data dump" reports can be prepared by the
<a href="https://raw.githubusercontent.com/networkupstools/nut/master/tools/nut-ddl-dump.sh"><code>tools/nut-ddl-dump.sh</code></a>
script from the main NUT codebase, and reported on the NUT mailing list or
via <a href="https://github.com/networkupstools/nut/issues">NUT issues on GitHub</a>
or as a pull request against the
<a href="https://github.com/networkupstools/nut-ddl">NUT Devices Dumps Library</a>
following the naming and other rules described in the DDL documentation page.</p></div>
<div class="paragraph"><p>Data dumps collected by the tools above, or by <code>upsc</code> client, or by drivers
in exploratory data-dumping mode (with <code>-d 1</code> argument), can be compared by
<a href="https://raw.githubusercontent.com/networkupstools/nut/master/tools/nut-dumpdiff.sh"><code>tools/nut-dumpdiff.sh</code></a>
script from the main NUT codebase, which strips away lines with only numeric
values (aiming to minimize the risk of losing meaningful changes like counters).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_offsite_links">Offsite Links</h2>
<div class="sectionbody">
<div class="paragraph" id="general_powerdev_info"><p>These are general information about UPS, PDU, ATS, PSU and SCD:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="http://tldp.org/HOWTO/UPS-HOWTO/">UPS HOWTO</a> (The Linux Documentation Project)
</p>
</li>
<li>
<p>
<a href="http://en.wikipedia.org/wiki/Uninterruptible_power_supply">UPS on Wikipedia</a>
</p>
</li>
<li>
<p>
<a href="http://en.wikipedia.org/wiki/Power_distribution_unit">PDU on Wikipedia</a>
</p>
</li>
<li>
<p>
<a href="https://en.wikipedia.org/wiki/Transfer_switch">Automatic Transfer Switch</a>
</p>
</li>
<li>
<p>
<a href="https://en.wikipedia.org/wiki/Power_supply_unit_%28computer%29">Power Supply Units</a>
</p>
</li>
<li>
<p>
<a href="http://en.wikipedia.org/wiki/Solar_controller">Solar controller on Wikipedia</a>
</p>
</li>
<li>
<p>
<a href="http://www.pcguide.com/ref/power/ext/ups/over.htm">UPS on The PC Guide</a>
</p>
</li>
</ul></div>
<div class="paragraph"><p>These are writeups by users of the software.</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="http://rogerprice.org/NUT">NUT Configuration Examples and helper scripts</a>
<em>(Roger Price)</em> (sources replicated in NUT GitHub organization as
<a href="https://github.com/networkupstools/ConfigExamples">ConfigExamples</a>,
<a href="https://github.com/networkupstools/TLS-UPSmon">TLS-UPSmon</a>,
and <a href="https://github.com/networkupstools/TLS-Shims">TLS-Shims</a>)
</p>
</li>
<li>
<p>
<a href="https://dan.langille.org/2020/09/10/nut-testing-the-shutdown-mechanism/">nut – testing the shutdown mechanism</a> <em>(Dan Langille)</em>
</p>
</li>
<li>
<p>
<a href="http://www.dimat.unina2.it/LCS/MonitoraggioUpsNutUbuntu10-eng.htm">Deploying NUT on an Ubuntu 10.04 cluster</a> <em>(Stefano Angelone)</em>
</p>
</li>
<li>
<p>
<a href="http://blog.shadypixel.com/monitoring-a-ups-with-nut-on-debian-or-ubuntu-linux">Monitoring a UPS with nut on Debian or Ubuntu Linux</a> <em>(Avery Fay)</em>
</p>
</li>
<li>
<p>
<a href="http://linux.developpez.com/cours/upsusb/">Installation et gestion d’un UPS USB en réseau sous linux</a> <em>(Olivier Van Hoof, french)</em>
</p>
</li>
<li>
<p>
<a href="https://github.com/networkupstools/nut/wiki/NUT-on-Mac-OS-X">Network UPS Tools (NUT) on Mac OS X (10.4.10)</a> <em>(Andy Poush)</em>
</p>
</li>
<li>
<p>
<a href="http://www.llondel.org/ups.shtml">Interfacing a Contact-Closure UPS to Mac OS X and Linux</a> <em>(David Hough)</em>
</p>
</li>
<li>
<p>
<a href="http://fedoranews.org/contributors/kazutoshi_morioka/nut/">How to use UPS with nut on RedHat / Fedora Core</a> <em>(Kazutoshi Morioka)</em>
</p>
</li>
<li>
<p>
<a href="http://people.freebsd.org/~thierry/nut_FreeBSD_HowTo.txt">FreeBSD installation procedure</a> <em>(Thierry Thomas, from FreeBSD)</em>
</p>
</li>
<li>
<p>
<a href="http://www.usebox.net/jjm/ups-obsd/">Gestionando un SAI desde OpenBSD con NUT</a> <em>(Juan J. Martinez, spanish)</em>
</p>
</li>
<li>
<p>
<a href="http://forums.gentoo.org/viewtopic-p-2663684.html">HOWTO: MGE Ellipse 300 on gentoo</a> <em>(nielchiano)</em>
</p>
</li>
<li>
<p>
<a href="http://deschis.blogspot.com/2006/07/cum-se-configureaz-un-ups-apollo-seria.html">Cum se configurează un UPS Apollo seria 1000F pe Linux</a> <em>(deschis, Romanian)</em>
</p>
</li>
<li>
<p>
<a href="http://buffalo.nas-central.org/wiki/Install_a_UPS_%28nut%29">Install a UPS (nut) on a Buffalo NAS</a> <em>(various authors)</em>
</p>
</li>
<li>
<p>
<a href="http://blog.pointbre.com/2903/nutnetwork-ups-tool-korean-guidebook.html">NUT Korean GuideBook</a> <em>(PointBre)</em>
</p>
</li>
<li>
<p>
<a href="https://www.jamesridgway.co.uk/monitoring-eaton-5sc-ups-scripts-and-integration-network-tools-home-assistant/amp/">USB UPS, notifications, and Home Assistant</a> <em>(James Ridgway)</em>
</p>
</li>
<li>
<p>
<a href="https://www.hirschler.solutions/posts/2022/06/powerwalker-ups-on-fedora-server-36">PowerWalker UPS on Fedora Server 36</a> <em>(Michael Hirschler)</em>
</p>
</li>
</ul></div>
<div class="paragraph"><p>Video articles are also available:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="https://www.youtube.com/watch?v=vyBP7wpN72c">Network UPS Tools (NUT Server) Ultimate Guide</a> <em>(Techno Tim)</em>
</p>
</li>
<li>
<p>
<a href="https://www.jeffgeerling.com/blog/2025/nut-on-my-pi-so-my-servers-dont-die">NUT on my Pi, so my servers don’t die</a> <em>(Jeff Geerling)</em> also including Home Assistant (HA) examples
</p>
<div class="ulist"><ul>
<li>
<p>
<a href="https://www.youtube.com/watch?v=fLt5YhOubxk&t=207s">Jeff’s lab tour due to an outage</a>
</p>
</li>
<li>
<p>
<a href="https://youtu.be/yFnItLSRpLI">Save your servers! NUT on a Raspberry Pi!</a>
</p>
</li>
<li>
<p>
<a href="https://github.com/geerlingguy/pi-nut">Ansible PiNUT project</a> and <a href="https://github.com/geerlingguy/ansible-role-nut_client"><code>geerlingguy.nut_client</code> Ansible role</a>
</p>
</li>
</ul></div>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_news_articles_and_press_releases">News articles and Press releases</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<a href="http://www.crn.com/news/channel-programs/199000818/linux-ups-without-tears.htm">Linux UPS Without Tears</a> <em>(A. Lizard)</em>
</p>
</li>
<li>
<p>
<a href="http://www.enterprisenetworkingplanet.com/netsysm/article.php/3295841/Graceful-UPS-Shutdowns-on-Linux.htm">Graceful UPS shutdowns on Linux</a> <em>(Carla Schroder)</em>
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version nut:v2.8.2.2628-2628+gb30d183ec ddl:v2.8.2-20-gd0dc96d384 web:v2.8.2-263-gc2275c7d-master<br />
Last updated 2025-03-30 23:46:30
</div>
<div id="footer-badges">
<a href="https://github.com/networkupstools/nut">
<img style="border:0;height:20"
src="https://img.shields.io/github/checks-status/networkupstools/nut/master"
alt="Latest GitHub checks status: master branch"/>
</a>
<!--
<a href="https://travis-ci.org/github/networkupstools/nut">
<img style="border:0;height:20"
src="https://api.travis-ci.org/networkupstools/nut.svg?branch=master"
alt="Latest Travis CI build status: master branch"/>
</a>
-->
<a href="https://ci.networkupstools.org/job/nut/job/nut/job/master/">
<img style="border:0;height:20"
src="https://ci.networkupstools.org/buildStatus/icon?job=nut%2Fnut%2Fmaster"
alt="Latest NUT CI build status: master branch"/>
</a>
<!-- MacOS, maybe later Windows builds: -->
<a href="https://app.circleci.com/pipelines/github/networkupstools">
<img style="border:0;height:20"
src="https://circleci.com/gh/networkupstools/nut/tree/master.svg?style=svg"
alt="Latest Circle CI build status: master branch"/>
</a>
<!-- Windows, maybe later MacOS builds: -->
<a href="https://ci.appveyor.com/project/nut-travis/nut/build/artifacts">
<img style="border:0;height:20"
src="https://ci.appveyor.com/api/projects/status/vrhkatid9hr7lq7r/branch/master?svg=true&failingText=Windows-FAIL&passingText=Windows-OK&pendingText-Windows-PENDING"
alt="Latest AppVeyor build status (NUT for Windows iterations)"/>
</a>
<!--
<a href="https://ci.networkupstools.org/job/nut/job/nut/job/fightwarn/">
<img style="border:0;height:20"
src="https://ci.networkupstools.org/buildStatus/icon?job=nut%2Fnut%2Ffightwarn&subject=Fightwarn%20Branch"
alt="Latest NUT CI build status: fightwarn branch"/>
</a>
-->
<!--
<a href="https://github.com/networkupstools/nut/releases">
<img style="border:0;height:20"
src="https://img.shields.io/github/v/release/networkupstools/nut"
alt="Latest GitHub drafted NUT source release"/>
</a>
-->
<a href="https://github.com/networkupstools/nut/releases">
<img style="border:0;height:20"
src="https://img.shields.io/github/v/tag/networkupstools/nut?sort=semver"
alt="Latest Git-tagged NUT source release"/>
</a>
<!-- Maintainer note: for the counter below to work, a git tag
is not sufficient -- a release must be drafted and published
at https://github.com/networkupstools/nut/releases
Counter URL may also be .../latest/BRANCHNAME -->
<a href="https://github.com/networkupstools/nut">
<img style="border:0;height:20"
src="https://img.shields.io/github/commits-since/networkupstools/nut/latest.svg"
alt="Commits on master branch since latest release on GitHub"/>
</a>
<!-- See also:
// https://web.archive.org/web/20200731075618/http://www.methods.co.nz/asciidoc/
// https://github.com/asciidoc-py/asciidoc-py
-->
<a href="https://asciidoc.org/">
<img style="border:0;width:88px;height:31px"
src="images/asciidoc.png"
alt="Powered by AsciiDoc"/>
</a>
<a href="https://validator.w3.org/check?uri=referer">
<img style="border:0;width:88px;height:31px"
src="https://www.w3.org/Icons/valid-xhtml11-blue"
alt="Valid XHTML 1.1"/>
</a>
<a href="https://jigsaw.w3.org/css-validator/check?uri=referer">
<img style="border:0;width:88px;height:31px"
src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
alt="Valid CSS!"/>
</a>
<a href="https://www.gandi.net/">
<img style="border:0;height:38px;"
src="images/gandi-ar21.svg"
alt="DNS, redirection and related services Hoster"/>
</a>
<!--
// FH web site defunct since ~Apr 2024
<a href="https://fosshost.org/">
<img style="border:0;width:112px;height:38px;"
src="images/ci/fosshost.org_Host_Light_38px.png"
alt="Dedicated Hosting for NUT CI"/>
</a>
-->
<a href="https://www.digitalocean.com/?refcode=d2fbf2b9e082&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
<img style="border:0;height:38px;"
src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg"
alt="Dedicated Hosting for NUT CI"/>
</a>
</div>
</div>
</div>
</div>
<!-- Google Analytics integration -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-9664272-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>