Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bodgit/puppet-nut
Puppet Module for Network UPS Tools (NUT)
https://github.com/bodgit/puppet-nut
nut puppet
Last synced: 4 months ago
JSON representation
Puppet Module for Network UPS Tools (NUT)
- Host: GitHub
- URL: https://github.com/bodgit/puppet-nut
- Owner: bodgit
- License: apache-2.0
- Created: 2015-08-30T20:21:40.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-08-03T16:45:55.000Z (over 1 year ago)
- Last Synced: 2024-09-30T05:40:48.985Z (4 months ago)
- Topics: nut, puppet
- Language: Ruby
- Homepage: https://forge.puppetlabs.com/bodgit/nut
- Size: 205 KB
- Stars: 1
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nut
[](https://travis-ci.org/bodgit/puppet-nut)
[](https://codecov.io/gh/bodgit/puppet-nut)
[](https://forge.puppetlabs.com/bodgit/nut)
[](https://forge.puppetlabs.com/bodgit/nut)
[](https://forge.puppetlabs.com/bodgit/nut)
#### Table of Contents
1. [Description](#description)
2. [Setup - The basics of getting started with nut](#setup)
* [What nut affects](#what-nut-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with nut](#beginning-with-nut)
3. [Usage - Configuration options and additional functionality](#usage)
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
## 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](https://forge.puppet.com/stahnma/epel) or by other means.
### Beginning with nut
In the very simplest case, you can just include the following:
```puppet
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:
```puppet
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:
```puppet
include ::nut:client
::nut::client::ups { 'sua1000i@remotehost':
user => 'remote',
password => 'password',
}
```
## Reference
The reference documentation is generated with
[puppet-strings](https://github.com/puppetlabs/puppet-strings) and the latest
version of the documentation is hosted at
[https://bodgit.github.io/puppet-nut/](https://bodgit.github.io/puppet-nut/)
and available also in the [REFERENCE.md](https://github.com/bodgit/puppet-nut/blob/master/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](https://puppet.com/docs/pdk/1.x/pdk.html) and has
both [rspec-puppet](http://rspec-puppet.com) and
[beaker-rspec](https://github.com/puppetlabs/beaker-rspec) tests. Run them
with:
```
$ bundle exec rake spec
$ PUPPET_INSTALL_TYPE=agent PUPPET_INSTALL_VERSION=x.y.z bundle exec rake beaker:
```
Please log issues or pull requests at
[github](https://github.com/bodgit/puppet-nut).