Forge Home


A module to set up bginfo from Sysinternals


8,564 latest version

4.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

  • 0.3.1 (latest)
  • 0.3.0
released Sep 14th 2016
This version is compatible with:
  • Puppet Enterprise >=2015.2.0 < 2016.3.0

Start using this module

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

Add this module to your Puppetfile:

mod 'ncorrare-bginfo', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ncorrare-bginfo
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ncorrare-bginfo --version 0.3.1

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.



ncorrare/bginfo — version 0.3.1 Sep 14th 2016


Table of Contents

  1. Overview
  2. Setup - The basics of getting started with bginfo


BGInfo automatically displays relevant information about a Windows computer on the desktop's background, such as the computer name, IP address, service pack version, and more. This module installs bginfo using chocolatey and deploys a default template configuration.


Setup Requirements

Classify your Windows node with the bginfo class. You'll need chocolatey there at some point to install the software. The module includes the default bgi configuration file which includes a lot of information, feel free to replace it with one that fits your use case. For more information on bginfo, visit

Beginning with bginfo

There are three parameters in the init class:

  • String $conffile: Puppet path to the configuration file. Defaults to puppet:///bginfo/default.bgi.
  • String $confpath: Where to store BGInfo configuration's file in the target system. Defaults to c:/default.bgi.
  • Boolean $setonstart: Configure a BAT script to start bginfo when any user logs in.
  • Boolean $addtrustedsite: If using ESC in Internet Explorer, add to trusted sites for https only.