Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

unifi

Module for managing a Ubiquiti UniFi Controller.
Project URLRSS FeedReport issues

18,622 downloads

13,977 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.0.3 (latest)
  • 0.0.2
  • 0.0.1
released Dec 28th 2018
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.7.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'jmkeyes-unifi', '0.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jmkeyes-unifi
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jmkeyes-unifi --version 0.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

jmkeyes/unifi — version 0.0.3 Dec 28th 2018

Puppet Unifi Controller Module

Puppet Forge Build Status

Table of Contents

  1. Overview
  2. Description
  3. Todo

Overview

This is a Puppet module to manage and deploy a Ubiquiti UniFi controller from the vendor APT repositories. It currently targets the latest stable release of Puppet, and should support Debian family distributions (like the vendor).

Description

To use this module, use either an include-like or resource-like declaration:

# An include-like declaration for Hiera integration.
include ::unifi

# A resource-like declaration for manual overrides.
class { '::unifi': }

This module is intended to work with Puppet 4.x.

Configuration

All configuration can be handled either through Hiera or by arguments to the unifi class.

UniFi Controller (using manifests)

# Install a UniFi Controller:
class { '::unifi': }

UniFi Controller (using Hiera)

# In Hiera configuration:
classes:
  - 'unifi'

Todo

  • Log rotation rules for logs located at ${::unifi::data_path}/logs.
  • Custom fact for UUID written to system properties after first boot.
  • Custom configuration for known usable parameters.