Forge Home


Manage Windows Remote Desktop


18,083 latest version

3.4 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

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
released Oct 23rd 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'souldo-remotedesktop', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add souldo-remotedesktop
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install souldo-remotedesktop --version 1.0.2

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.



souldo/remotedesktop — version 1.0.2 Oct 23rd 2014


Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Changelog


The remotedesktop module allows you to manage your remote desktop service on Windows 2008/2012, including the listening port and Windows firewall setting.

Module Description

Short version, use this module to enable/disable remote desktop and the Network Level Authentication (NLA) settings so you can connect to your Windows Server.

Long version, lots of people like to change the listening port for RDP, so if you specify a port parameter you can do this without ever having to look at an ugly registry key. Optionally, you can specify to manage the existing Windows firewall ruleset to update to the new setting.


What remotedesktop affects

  • modifies the Terminal Services WMI object to allow RDP connections.
  • modifies the Terminal Services WMI object to set NLA policy.
  • modifies the registry key for RDP TCP port. (if configured)
  • modifies the windows firewall rule for RDP. (if configured)
  • restarts the Remote Desktop Services service.

Setup Requirements

This module has only been tested with Powershell 3 and up. Please ensure you are using a newer version of Powershell before using this module.


By default, applying this module with no parameters will enable remotedesktop with NLA enabled.

Example 1: Enable remotedesktop with NLA enabled

class { 'remotedesktop' : }

Example 2: Enable remotedesktop with NLA disabled.

class { 'remotedesktop' : 
  ensure => present,
  nla    => absent,

Example 3: Change the Port, Manage Windows Firewall

class { 'remotedesktop' :
  ensure          => present,
  port            => 4926,
  manage_firewall => true,



  • Code cleanup


  • Metadata fixes


  • Initial release