Forge Home

iperf

Install and run Iperf as a daemon

11,375 downloads

10,334 latest version

3.8 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.

Version information

  • 0.2.1 (latest)
  • 0.2.0
  • 0.1.0
released Jun 10th 2015

Start using this module

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

Add this module to your Puppetfile:

mod 'jgazeley-iperf', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jgazeley-iperf
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jgazeley-iperf --version 0.2.1

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

jgazeley/iperf — version 0.2.1 Jun 10th 2015

iperf

Table of Contents

  1. Overview
  2. Usage - Configuration options and additional functionality
  3. Limitations - OS compatibility, etc.
  4. Development - Guide for contributing to the module

Overview

This module installs Iperf and configures it to run as a daemon.

It installs Iperf 3 from distro repos but sets it to listen on TCP port 5001, which is the default for Iperf 2. This is because many Iperf clients distributed are version 2. If anyone raises an issue, I'll add support for customising the listen port.

Usage

This module is simple to use. The only parameter is to enable to disable automatic firewall rules.

class { 'iperf':
  firewall => true,
}

firewall

Open the firewall port automatically. Default: false

restart

Periodically restart iperf2 via cron, since it has a bug where it consumes 100% CPU. Default: false

version

Specify an array of versions you wish to install. Multiple versions are OK. Available options: 2, 3.

motd

Whether you want this module to automatically insert a service into motd using jgazeley/motd. Default: false.

Limitations

This is where you list OS compatibility, version compatibility, etc.

Development

Since your module is awesome, other users will want to play with it. Let them know what the ground rules for contributing are.