Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

win32_openssh

Setup OpenSSH server (win32-openssh) on Windows
Project URLRSS FeedReport issues

5,628 downloads

5,628 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

  • 1.0.0 (latest)
released Jun 8th 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
  • windows

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetfinland-win32_openssh', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetfinland-win32_openssh
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetfinland-win32_openssh --version 1.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.

Download

Documentation

puppetfinland/win32_openssh — version 1.0.0 Jun 8th 2018

puppet-win32_openssh

Puppet module for managing win32-openssh, Microsoft's official version of sshd for Windows.

The Chocolatey package ("openssh") pokes a hole in the Windows firewall by default, so this module does not need to it separately.

Usage

To use default settings just

include ::win32_openssh

This sets up OpenSSH server with default settings. You can customize several basic settings:

class { '::win32_openssh':
  listenaddress                => ['0.0.0.0','::1'],
  port                         => 10022,
  permitrootlogin              => 'no',
  passwordauthentication       => 'no',
  disable_microsoft_ssh_server => true,
}

The default shell for SSH logins depends on what is available. If Powershell Core is found it is preferred over stock Powershell. This behavior can be overridden with the $default_shell parameter, which should be in the format that the Set-SSHDefaultShell.ps1 cmdlet expects.

Limitations

Currently this module can't update the default shell once it has been set unless registry value HKLM:\SOFTWARE\OpenSSH\DefaultShell is removed manually.

This module also does not remove the original firewall rule generated by the Chocolatey package. This does not affect anything unless SSH port is later changed, in which case the ports will be out of sync.