Forge Home


Manage the Windows Logon Message


10,189 latest version

3.8 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.0 (latest)
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-winlogon', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install souldo-winlogon --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.



souldo/winlogon — version 1.0.0 Oct 23rd 2014


Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.


winlogon is a defined type that manages the logon message that pops up before the username and password prompt on a Windows server.

Module Description

The winlogon defined type edits two values in the registry:

HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon\LegalNoticeCaption
HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon\LegalNoticeText

Any value will cause the logon screen to appear. A null entry will remove the screen.



ensure  => present | absent  # set the ensure status
caption => 'your caption message here' # the caption, defaults to $title
message => 'your message here' # the message, defaults to $title

If you need multiple paragraphs, you can use an array for the message, or use double quotes and the \n escape character in the message string.


Set caption and message to "AUTHORIZED USERS ONLY":

winlogon { 'AUTHORIZED USERS ONLY' : }

Set caption and a separate message:

  message => 'This system is for authorized users only.  All logins will be reported',

Set caption and a really long message :

  message => ['Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus.',
    'Sed sit amet ipsum mauris. Maecenas congue ligula ac quam viverra nec consectetur ante hendrerit.',
    'Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue.'],


Defined Type: winlogon


Tested on Windows 2008 R2 and Windows 2012 R2 with Windows Management Framework 3.0 and greater.