Forge Home


SSH management module


6,671 latest version

4.6 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.5.5 (latest)
  • 0.5.3
  • 0.5.2
  • 0.5.0
  • 0.3.0
  • 0.1.0
released Oct 13th 2016
This version is compatible with:
  • , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'thbe-ssh', '0.5.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add thbe-ssh
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install thbe-ssh --version 0.5.5

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.



thbe/ssh — version 0.5.5 Oct 13th 2016


Build Status Puppet Forge Coverage Status

####Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with ssh
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module


The ssh module provides the installation procedure for SSH including the setup of ssh keys with distributed known hosts as well as authorized keys outside user home owned by root.

##Module Description

The SSH module provide a secure mechanism for using terminals on remote servers accross the internet. All communication is encrypted and secured.


###What ssh affects

  • ssh package
  • ssh configuration file
  • ssh alternative service configuration

###Beginning with ssh

include '::ssh' is enough to get you up and running if the parameters point to proper values. If you wish to pass in parameters like which servers to use then you can use:

include ::ssh


All interaction with the ssh module can do be done through the main ssh class. This means you can simply toggle the options in the ssh class to get at the full functionality.

###I just want SSH, what's the minimum I need?

include '::ssh'



  • ssh: Main class, include all sub-classes
  • ssh::install: Install the required packages
  • ssh::config: Handles the configuration files
  • ssh::service: Handles the services



Hash that specify username and authorized keys for that user.


This module has been built on and tested against Puppet 3.2 and higher.

The module has been tested on:

  • RedHat Enterprise Linux 6/7
  • CentOS 6/7
  • Oracle Enterprise Linux 6/7

Testing on other platforms has been light and cannot be guaranteed.


If you like to add or improve this module, feel free to fork the module and send me a merge request with the modification.