Forge Home

windows_shortcuts

Manage Microsoft Windows shortcuts.

147 downloads

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

Version information

  • 0.2.1 (latest)
  • 0.2.0
  • 0.1.9
released Jul 10th 2024
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.21.0 < 99.0.0

Start using this module

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

Add this module to your Puppetfile:

mod 'rfbennett-windows_shortcuts', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add rfbennett-windows_shortcuts
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install rfbennett-windows_shortcuts --version 0.2.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.

Download

Documentation

rfbennett/windows_shortcuts — version 0.2.1 Jul 10th 2024

Windows Shortcuts

Manage Microsoft Windows shortcuts.

Table of Contents

  1. Description
  2. Usage - Configuration options and additional functionality
  3. Limitations - OS compatibility, etc.
  4. Development - Guide for contributing to the module

Description

This module allows you to manage .LNK and/or .URL shortcuts all in one place (as opposed to creating your own custom module with the file_lnk and file_url resources).

Usage

Simply supply an array of shortcuts:

windows_shortcuts::shortcuts_lnk: [
  {
    file_name: 'Example01',
    parent_folder: 'C:\\Users\\Public\\Desktop',
    target_path: 'C:\\Windows\\write.exe',
    description: 'An example LNK shortcut',
  },
  {
    file_name: 'Example02',
    parent_folder: 'C:\\Users\\Public\\Desktop',
    target_path: 'C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe',
    description: 'Another example LNK shortcut',
    target_arguments: 'http://its.uiowa.edu',
  },
],
windows_shortcuts::shortcuts_url: [
  {
    file_name: 'Example01.url',
    parent_folder:> 'C:\\Users\\Public\\Desktop',
    url: 'https://www.puppet.com',
  },
  {
    file_name: 'Example02.url',
    parent_folder: 'C:\\Users\\Public\\Desktop',
    url: 'https://www.gitlab.com',
    icon_file: 'C:\\Program Files\\Git\\git-cmd.exe',
    icon_index: 0,
  },
]

Limitations

  1. This modules uses the following to generate the contents of the REFERENCE.md file:
  • puppet strings generate --format markdown --out REFERENCE.md
  1. This module has been evaluated against the following:
  • Microsoft Windows Server 2022 (running PowerShell 5.1.20348.643)
  • Microsoft Windows Server 2019 (running PowerShell 5.1.17763.1971)
  • Microsoft Windows Server 2016 (running PowerShell 5.1.14393.4530)
  • Microsoft Windows 10 (running PowerShell 5.1.19041.1023)

Development

Feedback and ideas are always welcome - please contact an Author (listed in metadata.json) to discuss your input, or feel free to simply open an Issue.

Command to apply this module locally (and try it out): puppet apply --modulepath="<PathToModuleParentFolders>" --execute "include <ModuleName>" --environment "<EnvironmentName>" --no-splay --verbose --debug

For example: puppet apply --modulepath="C:\ProgramData\PuppetLabs\code\environments\production\modules;c:\projects\forge" --execute "include windows_shortcuts" --environment "production" --no-splay