Forge Home


Puppet ssh Module


7,617 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.

Version information

  • 3.0.0 (latest)
  • 2.1.0
  • 2.0.0
  • 1.6.0
  • 1.5.1
  • 1.5.0
  • 1.4.1
  • 1.4.0
  • 1.3.2
  • 1.3.1
  • 1.2.2
  • 1.2.1
  • 1.2.0
  • 1.1.2
  • 1.1.1
  • 1.1.0
  • 1.0.1
  • 1.0.0
released May 24th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'attachmentgenie-ssh', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install attachmentgenie-ssh --version 3.0.0

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.



attachmentgenie/ssh — version 3.0.0 May 24th 2018

Build Status


####Table of Contents

  1. Overview
  2. Setup - The basics of getting started with attachmentgenie/ssh
  3. Usage - Configuration options and additional functionality
  4. Development - Guide for contributing to the module


The module makes it possible to install a ssh server and/or client and to add authorized ssh keys to existing users.


###What attachmentgenie/ssh affects

  • ssh server
  • ssh client
  • add authorized ssh keys to existing users.

###Beginning with attachmentgenie/ssh

The ssh::client class installs the ssh client:

class { 'ssh::client': }

The ssh::server class installs and configures the sshd:

class { 'ssh::server':
  password_authentication => 'yes',


You can specify the port the sshd should listen to by including the class with this special syntax:

class { 'ssh::server':
  port => 20009,

You can also restrict access for only certain users:

class { 'ssh::server':
  allowed_users => ['attachmentgenie', 'manager'],

And you can permit root logins (not recommended):

class { 'ssh::server':
  permit_root_login => 'yes',

To permit root logins could be a serious security issue. In most cases you should use something like sudo instead.

You can use ssh::user to add an authorized ssh key to an existing user for effortless authentication with ssh:

ssh::user { 'attachmentgenie':
  key     => 'a8a7dgf7ad8j13g',
  comment => 'laptop',

ssh::user { 'laptop':
  key  => 'a8a7dgf7ad8j13g',
  user => 'attachmentgenie',


Please see CONTRIBUTING for details.