Forge Home

registry

Task allows you to add and remove registry keys.

2,994 downloads

2,982 latest version

4.9 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)
  • 0.1.0 (deleted)
released Mar 31st 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
Tasks:
  • registry

Start using this module

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

Add this module to your Puppetfile:

mod 'ffalor-registry', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add ffalor-registry
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install ffalor-registry --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

ffalor/registry — version 1.0.0 Mar 31st 2020

registry

Puppet Forge downloads GitHub issues Puppet Forge version Puppet Forge – PDK version

Table of Contents

  1. Description
  2. Requirements
  3. Usage - Configuration options and additional functionality
  4. Development - Guide for contributing to the module

Description

This module includes a puppet task to help manage registry keys.

This task can be used to:

  • Get current registry keys/values (get)
  • Create new or overwrite registry keys/values (set)
  • Delete registry keys/values (delete)

Requirements

Any Powershell Version

Usage

Puppet Task and Bolt

To run an registry task, use the task command, specifying the command to be executed.

  • With PE on the command line, run puppet task run registry action=<set|delete|get> key=<key_path>.
  • With Bolt on the command line, run bolt task run registry action=<set|delete|get> key=<key_path>.

For example, to add to create a key HKLM:\SOFTWARE\Example with a property example_property with a value of example_value of type string while overwriting current values, run:

  • With PE, run puppet task run registry action=set key="HKLM:\SOFTWARE\Example" property="example_property" value="example_value" type=string force=true --nodes saturn.
  • With Bolt, run bolt task run registry action=set key="HKLM:\SOFTWARE\Example" property="example_property" value="example_value" type=string force=true --nodes saturn.

Puppet Task API

endpoint: https://<puppet>:8143/orchestrator/v1/command/task

method: post

body:

{
  "environment": "production",
  "task": "registry",
  "params": {
    "action": "present",
    "key": "HKLM:\\SOFTWARE\\Example",
    "property": "example_property",
    "value": "example_value",
    "type": "string",
    "force": true
  },
  "description": "Description for task",
  "scope": {
    "nodes": ["saturn.example.com"]
  }
}

You can also run tasks in the PE console. See PE task documentation for complete information.

Limitations

None

Development

Feel free to open issues or create pull requests on Github.