nut
Table of Contents
- Description
- Setup - The basics of getting started with nut
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module ensures that the Network UPS Tools (NUT) are installed and configured.
RHEL/CentOS, Ubuntu, Debian and OpenBSD are supported using Puppet 5 or later.
Setup
What nut affects
This module will potentially configure your host to respond to power failures.
Setup Requirements
On RHEL/CentOS platforms you will need to have access to the EPEL repository by using stahnma/epel or by other means.
Beginning with nut
In the very simplest case, you can just include the following:
include ::nut
Usage
The above example is not terribly useful as it does not include any UPS devices, so it should be extended to something like the following:
include ::nut
::nut::ups { 'sua1000i':
driver => 'usbhid-ups',
port => 'auto',
}
::nut::user { 'local':
password => 'password',
upsmon => 'master',
}
::nut::user { 'remote':
password => 'password',
upsmon => 'slave',
}
::nut::client::ups { 'sua1000i@localhost':
user => 'local',
password => 'password',
}
If the host does not have any UPS device directly attached, but is powered by one which is controlled by another host such as the one above, use the following:
include ::nut:client
::nut::client::ups { 'sua1000i@remotehost':
user => 'remote',
password => 'password',
}
Reference
The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-nut/ and available also in the REFERENCE.md.
Limitations
This module has been built on and tested against Puppet 5 and higher.
The module has been tested on:
- RedHat Enterprise Linux 6/7
- Ubuntu 14.04/16.04
- Debian 8
- OpenBSD 6.0
Development
The module relies on PDK and has both rspec-puppet and beaker-rspec tests. Run them with:
$ bundle exec rake spec
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:<nodeset>
Please log issues or pull requests at github.