#ssh

####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]
   • What [Ssh] affects
   • Setup requirements
   • Beginning 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

##Overview

This module manages OpenSSH's daemon, server configuration, client configuration, and user specific client configuration.

##Module Description

This module manages OpenSSH and the associated configuration with both server and clients. It'll also allow you to configure per user configuration.

##Setup

###What [Ssh] affects

• sshd_config
• ssh_config
• ~/.ssh/ files.
• sshd daemon.

###Beginning with [Ssh]

In order to ensure sshd is running you just need to:

include ssh::server

##Usage

The two main classes for this module are ssh::server and ssh::client. Through these two classes you should be able to manage ssh comprehensively.

##Reference

###Classes

• ssh::client - Main class for managing the ssh client global settings.
• ssh::client::install - Installs the main ssh client.
• ssh::client::config - Configs the main ssh client.
• ssh::server - Main class for managing the ssh server.
• ssh::server::install - Installs the ssh server.
• ssh::server::config - Configures the ssh server.
• ssh::server::service - Configures the ssh service.
• ssh::params - Default parameters.

###Parameters

###ssh::server

####config_ensure

Should the config file be present or absent.

####config_path

The path for the configuration file.

####package_ensure

Should the package be present or absent.

####package_name

What is the name of the ssh server package?

####service_ensure

Should be the service be running or stopped.

####service_name

What is the name of the ssh server service?

####configuration_data

This allows you to pass in arbitary configuration to the sshd_config file. You create it in the format of:

{ 'Parameter' => 'Value' }

To change any individual value in this hash you'll need to copy the entire hash from the params.pp file and modify it to taste.

####os_configuration_data

Similar to the configuration_data parameter this is a hash containing configuration data that differs between operating systems. This seperation allows you to set only OS specific configuration settings without touching the main hash if you so wish.

###ssh::client

####config_ensure

Should the config file be present or absent.

####config_path

The path for the configuration file.

####package_ensure

Should the package be present or absent.

####package_name

What is the name of the ssh client package?

####configuration_data

This parameter allows you to create configuration entries for multiple hosts. You must create an array of hashes, containing subhashes, such as:

[ { '*' => { 'Port' => '2222' }, 'testhost' => { 'Port => '22' } } ]

###Defines

• ssh::user

###Parameters

###ssh::user

####ensure

Should the config file be present or absent.

####owner

Who should own the configuration file.

####group

Which group should own the configuration file.

####configuration_data

This parameter allows you to create configuration entries for multiple hosts. You must create an array of hashes, containing subhashes, such as:

[ { '*' => { 'Port' => '2222' }, 'testhost' => { 'Port => '22' } } ]

##Limitations

This module only supports the following osfamily:

• Debian
• RedHat

##Development