Network UPS Tools User Manual

Russell Kroll, Arnaud Quette and Arjen de Korte

Table of Contents

1. Introduction
2. Network UPS Tools Overview
2.1. Description
2.2. Installing
2.3. Upgrading
2.4. Configuring and using
2.5. Documentation
2.6. Network Information
2.7. Manifest
2.8. Drivers
2.9. Network Server
2.10. Monitoring client
2.11. Clients
2.12. CGI Programs
2.13. Version Numbering
2.14. Backwards and Forwards Compatibility
2.15. Support / Help / etc.
2.16. Hacking / Development Info
2.17. Acknowledgements / Contributions
3. Features
3.1. Multiple manufacturer and device support
3.2. Multiple architecture support
3.3. Layered and modular design with multiple processes
3.4. Redundancy support - Hot swap/high availability power supplies
3.5. Security and access control
3.6. Web-based monitoring
3.7. Free software
3.8. UPS management and control
3.9. Monitoring diagrams
3.10. Image credits
3.11. Compatibility information
4. Download information
4.1. Source code
4.2. Binary packages
4.3. Java packages
4.4. Virtualization packages
5. Installation instructions
5.1. Installing from source
5.2. Installing from packages
6. Configuration notes
6.1. Details about the configuration files
6.2. Basic configuration
6.3. Configuring automatic shutdowns for low battery events
6.4. Typical setups for enterprise networks and data rooms
6.5. Typical setups for big servers with UPS redundancy
7. Advanced usage and scheduling notes
7.1. The simple approach, using your own script
7.2. The advanced approach, using upssched
8. NUT outlets management and PDU notes
8.1. Introduction
8.2. NUT outlet data collection
8.3. Outlets on PDU
8.4. Outlets on UPS
8.5. Other type of devices
9. Notes on securing NUT
9.1. How to verify the NUT source code signature
9.2. System level privileges and ownership
9.3. NUT level user privileges
9.4. Network access control
9.5. Configuring SSL
9.6. chrooting and other forms of paranoia
A. Glossary
B. Acknowledgements / Contributions
B.1. The NUT Team
Active members
Retired members
B.2. Supporting manufacturers
UPS manufacturers
Appliances manufacturers
B.3. Other contributors
B.4. Older entries (before 2005)
C. NUT command and variable naming scheme
C.1. Variables
device: General unit information
ups: General unit information
input: Incoming line/power information
output: Outgoing power/inverter information
Three-phase additions
battery: Any battery details
ambient: Conditions from external probe equipment
outlet: Smart outlet management
driver: Internal driver information
server: Internal server information
C.2. Instant commands
D. Hardware Compatibility List
E. Documentation
E.1. User Documentation
E.2. Developer Documentation
E.3. Offsite Links
E.4. News articles and Press releases
F. Support instructions
F.1. Documentation
F.2. Mailing lists
Request help
Post a patch, ask a development question, …
Discuss packaging and related topics
G. Cables information
G.1. APC
940-0024C clone
940-0024E clone
940-0024C clone for Macs
G.2. Belkin
OmniGuard F6C***-RKM
G.3. Eaton
MGE Office Protection Systems
Powerware LanSafe
G.4. HP - Compaq
Older Compaq UPS Family
G.5. Phoenixtec (Best Power)
G.6. Tripp-Lite
H. Configure options
H.1. Driver selection
H.2. Optional features
H.3. Other configuration options
H.4. Installation directories
H.5. Directories used by NUT at run-time
H.6. Things the compiler might need to find
I. Upgrading notes
I.1. Changes from 2.7.3 to 2.7.4
I.2. Changes from 2.7.2 to 2.7.3
I.3. Changes from 2.7.1 to 2.7.2
I.4. Changes from 2.6.5 to 2.7.1
I.5. Changes from 2.6.4 to 2.6.5
I.6. Changes from 2.6.3 to 2.6.4
I.7. Changes from 2.6.2 to 2.6.3
I.8. Changes from 2.6.1 to 2.6.2
I.9. Changes from 2.6.0 to 2.6.1
I.10. Changes from 2.4.3 to 2.6.0
I.11. Changes from 2.4.2 to 2.4.3
I.12. Changes from 2.4.1 to 2.4.2
I.13. Changes from 2.4.0 to 2.4.1
I.14. Changes from 2.2.2 to 2.4.0
I.15. Changes from 2.2.1 to 2.2.2
I.16. Changes from 2.2.0 to 2.2.1
I.17. Changes from 2.0.5 to 2.2.0
I.18. Changes from 2.0.4 to 2.0.5
I.19. Changes from 2.0.3 to 2.0.4
I.20. Changes from 2.0.2 to 2.0.3
I.21. Changes from 2.0.1 to 2.0.2
I.22. Changes from 2.0.0 to 2.0.1
I.23. Changes from 1.4.0 to 2.0.0
J. Project history
J.1. Prototypes and experiments
May 1996: early status hacks
January 1997: initial protocol tests
September 1997: first client/server code
J.2. Smart UPS Tools
March 1998: first public release
June 1999: Redesigned, rewritten
J.3. Network UPS Tools
September 1999: new name, new URL
June 2001: common driver core
May 2002: casting off old drivers, IANA port, towards 1.0
J.4. Leaving 0.x territory
August 2002: first stable tree: NUT 1.0.0
November 2002: second stable tree: NUT 1.2.0
April 2003: new naming scheme, better driver glue, and an overhauled protocol
July 2003: third stable tree: NUT 1.4.0
July 2003: pushing towards 2.0
November 2003: a new URL
J.6. Second major version
March 2004: NUT 2.0.0
J.7. The change of leadership
February 2005: NUT 2.0.1