registry
Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 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
- Puppet >= 7.0.0 < 9.0.0
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-registry', '5.0.1'Learn more about managing modules with a PuppetfileDocumentation
registry
Table of Contents
- Overview - What is the registry module?
- Module Description - What registry does and why it is useful
- Setup - The basics of getting started with registry
- Usage - Configuration options and additional functionality
- Reference
- Limitations
- Development - Guide for contributing to registry
Overview
This module supplies the types and providers you'll need to manage the Registry on your Windows nodes.
Module Description
The Registry is a hierarchical database built into Microsoft Windows. It stores settings and other information for the operating system and a wide range of applications. This module lets Puppet manage individual Registry keys and values, and provides a simplified way to manage Windows services.
Setup
This module must be installed on your Puppet server. For a complete list of supported operating systems, please take a look at our metadata.json.
Beginning with registry
Use the registry_key type to manage a single registry key:
registry_key { 'HKLM\System\CurrentControlSet\Services\Puppet':
ensure => present,
}
Usage
The registry module works mainly through two types: registry_key and registry_value. These types combine to let you specify a Registry container and its intended contents.
Manage a single Registry value
registry_value { 'HKLM\System\CurrentControlSet\Services\Puppet\Description':
ensure => present,
type => string,
data => "The Puppet Agent service periodically manages your configuration",
}
Manage a single Registry value with a backslash in the value name
registry_value { 'HKLM\System\CurrentControlSet\Services\Puppet\\\ValueWithA\Backslash':
ensure => present,
type => string,
data => "The Puppet Agent service periodically manages your configuration",
}
Manage a single Registry value with a different resource title
registry_value { 'PuppetDescription':
path => 'HKLM\System\CurrentControlSet\Services\Puppet\Description',
ensure => present,
type => string,
data => "The Puppet Agent service periodically manages your configuration",
}
Manage a Registry value and its parent key in one declaration
class myapp {
registry::value { 'puppetserver':
key => 'HKLM\Software\Vendor\PuppetLabs',
data => 'puppet.puppet.com',
}
}
Puppet looks up the key 'HKLM\Software\Vendor\PuppetLabs' and makes sure it contains a value named 'puppetserver' containing the string 'puppet.puppet.com'.
Set the default value for a key
registry::value { 'Setting0':
key => 'HKLM\System\CurrentControlSet\Services\Puppet',
value => '(default)',
data => "Hello World!",
}
You can still add values in a string (or array) beyond the default, but you can only set one default value per key.
Purge existing values
By default, if a key includes additional values besides the ones you specify through this module, Puppet leaves those extra values in place. To change that, use the purge_values => true parameter of the registry_key resource. Enabling this feature deletes any values in the key that are not managed by Puppet.
The registry::purge_example class provides a quick and easy way to see a demonstration of how this works. This example class has two modes of operation determined by the Facter fact PURGE_EXAMPLE_MODE: 'setup' and 'purge'.
To run the demonstration, make sure the registry::purge_example class is included in your node catalog, then set an environment variable in PowerShell. This sets up a Registry key that contains six values.
PS C:\> $env:FACTER_PURGE_EXAMPLE_MODE = 'setup'
PS C:\> puppet agent --test
notice: /Stage[main]/Registry::Purge_example/Registry_key[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value3]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value2]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_key[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\SubKey]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value5]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value6]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\SubKey\Value1]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value1]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\SubKey\Value2]/ensure: created
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value4]/ensure: created
notice: Finished catalog run in 0.14 seconds
Switching the mode to 'purge' causes the class to only manage three of the six registry_value resources. The other three are purged because they are not specifically declared in the manifest.
Notice how Value4, Value5 and Value6 are being removed.
PS C:\> $env:FACTER_PURGE_EXAMPLE_MODE = 'purge'
PS C:\> puppet agent --test
notice: /Registry_value[hklm\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value4]/ensure: removed
notice: /Registry_value[hklm\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value6]/ensure: removed
notice: /Registry_value[hklm\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value5]/ensure: removed
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value3]/data: data changed 'key3' to 'should not be purged'
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value2]/data: data changed '2' to '0'
notice: /Stage[main]/Registry::Purge_example/Registry_value[HKLM\Software\Vendor\Puppet Labs\Examples\KeyPurge\Value1]/data: data changed '1' to '0'
notice: Finished catalog run in 0.16 seconds
Manage Windows services
The registry::service define manages entries in the Microsoft service control framework by automatically manipulating values in the key HKLM\System\CurrentControlSet\Services\$name\.
This is an alternative approach to using INSTSRV.EXE 1.
registry::service { puppet:
ensure => present,
display_name => "Puppet Agent",
description => "Periodically fetches and applies configurations from a Puppet Server.",
command => 'C:\PuppetLabs\Puppet\service\daemon.bat',
}
Reference
For information on the classes and types, see the REFERENCE.md
Limitations
- Keys within
HKEY_LOCAL_MACHINE(hklm),HKEY_CLASSES_ROOT(hkcr) orHKEY_USERS(hku) are supported. Other predefined root keys (e.g.,HKEY_CURRENT_USER) are not currently supported. - Puppet doesn't recursively delete Registry keys.
Please report any issues through our Module Issue Tracker.
Development
Puppet Inc modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
If you would like to contribute to this module, please follow the rules in the CONTRIBUTING.md. For more information, see our module contribution guide.
Contributors
To see who's already involved, see the list of contributors.
Reference
Table of Contents
Defined types
registry::service: Defined resource type that manages service entriesregistry::value: High level abstraction on top of registry_key and registry_value resources
Resource types
registry_key: Manages registry keys on Windowsregistry_value: Manages registry values on Windows systems.
Defined types
registry::service
Manages the values in the key HKLM\System\CurrentControlSet\Services\$name\
- Note This defined resource type manages service entries in the Microsoft service control framework by managing the appropriate registry keys and values.
This is an alternative approach to using INSTSRV.EXE [1].
[1] http://support.microsoft.com/kb/137890
Examples
Sample Usage:
registry::service { puppet:
ensure => present,
display_name => 'Puppet Agent',
description => 'Periodically fetches and applies
configurations from a Puppet Server.',
command => 'C:\PuppetLabs\Puppet\service\daemon.bat',
}
Parameters
The following parameters are available in the registry::service defined type:
ensure
Data type: Enum['present', 'absent', 'UNSET']
Ensures the presence or absence of a registry key. Valid values: 'present', 'absent', 'UNSET'.
Default value: 'UNSET'
display_name
Data type: String[1]
The Display Name of the service. Defaults to the title of the resource.
Default value: 'UNSET'
description
Data type: String[1]
A description of the service. String value set to 'UNSET' by default.
Default value: 'UNSET'
command
Data type: String[1]
The command to execute. Set to 'UNSET' by default.
Default value: 'UNSET'
start
Data type: Enum['automatic', 'manual', 'disabled', 'UNSET']
The starting mode of the service. (Note, the native service resource can also be used to manage this setting.) Valid values: 'automatic', 'manual', 'disabled'
Default value: 'UNSET'
registry::value
Actions:
- Manage the parent key if not already managed.
- Manage the value
Requires:
- Registry Module
- Stdlib Module
- Note This defined resource type provides a higher level of abstraction on top of the registry_key and registry_value resources. Using this defined resource type, you do not need to explicitly manage the parent key for a particular value. Puppet will automatically manage the parent key for you.
Examples
This example will automatically manage the key. It will also create a value named 'puppetserver' inside this key.
class myapp {
registry::value { 'puppetserver':
key => 'HKLM\Software\Vendor\PuppetLabs',
data => 'puppet.puppetlabs.com',
}
}
Parameters
The following parameters are available in the registry::value defined type:
key
Data type: Pattern[/^\w+/]
The path of key the value will placed inside.
value
Data type: Optional[String]
The name of the registry value to manage. This will be copied from the resource title if not specified. The special value of '(default)' may be used to manage the default value of the key.
Default value: undef
type
Data type: Pattern[/^\w+/]
The type the registry value. Defaults to 'string'. See the output of
puppet describe registry_value for a list of supported types in the
"type" parameter.
Default value: 'string'
data
Data type:
Optional[Variant[
String,
Numeric,
Array[String]
]]
The data to place inside the registry value.
Default value: undef
Resource types
registry_key
Manages registry keys on Windows
Properties
The following properties are available in the registry_key type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
Parameters
The following parameters are available in the registry_key type.
path
The path to the registry key to manage
provider
The specific backend to use for this registry_key resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.
purge_values
Valid values: true, false
Common boolean for munging and validation.
Default value: false
registry_value
Manages registry values on Windows systems.
Properties
The following properties are available in the registry_value type.
data
The data stored in the registry value.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
type
Valid values: string, array, dword, qword, binary, expand
The Windows data type of the registry value.
Default value: string
Parameters
The following parameters are available in the registry_value type.
path
The path to the registry value to manage.
provider
The specific backend to use for this registry_value resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v5.0.1 - 2023-06-20
Fixed
v5.0.0 - 2023-04-05
Changed
v4.1.2 - 2023-03-23
Fixed
v4.1.1 - 2022-10-03
Fixed
- (MAINT) Dropped support for Windows(7,8, 2008 Server and 2008 R2 Server) #267 (jordanbreen28)
v4.1.0 - 2022-06-06
Added
- pdksync - (FM-8922) - Add Support for Windows 2022 #259 (david22swan)
v4.0.1 - 2021-08-23
Fixed
v4.0.0 - 2021-03-01
Changed
- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #236 (carabasdaniel)
v3.2.0 - 2020-12-08
Added
- pdksync - (feat) Add support for Puppet 7 #231 (daianamezdrea)
v3.1.1 - 2020-08-12
Added
- pdksync - (IAC-973) - Update travis/appveyor to run on new default branch
main#217 (david22swan)
Fixed
- (IAC-967) Puppet 7 compatibility fix: null termination for strings #216 (sanfrancrisko)
v3.1.0 - 2019-12-10
Added
v3.0.0 - 2019-10-17
Added
- (FM-7693) Add Windows Server 2019 #174 (glennsarti)
Fixed
- (MODULES-5625) Fail on empty strings in REG_MULTI_SZ #173 (glennsarti)
2.1.0 - 2018-10-08
2.0.2 - 2018-08-06
Added
- (MODULES-4271) Add Server 2016 and Windows 10 to metadata #160 (glennsarti)
- (MODULES-6744) Add testmode switcher #158 (jpogran)
Fixed
2.0.1 - 2018-01-26
Fixed
2.0.0 - 2018-01-25
Added
- (MODULES-2957) Add support for backslashes in registry value name #146 (glennsarti)
- (MODULES-5144) Prep for puppet 5 #133 (hunner)
Fixed
- (MODULES-2957) Fix registry_value tests #143 (glennsarti)
1.1.4 - 2017-03-06
Added
- (MODULES-4263) add blacksmith rake tasks #121 (eputnam)
- (FM-4917) Rake / Beaker / Rspec compatibility #98 (ferventcoder)
Fixed
- (MODULES-4331) quoted UNSET string #123 (binford2k)
- (maint) Fix the style of the registry::value parameters #102 (natemccurdy)
1.1.3 - 2015-12-07
1.1.2 - 2015-08-17
Fixed
1.1.1 - 2015-08-12
Added
Fixed
- (MODULES-1921) Ruby registry writes corrupt string #93 (Iristyle)
- (maint) fix registry_value provider spec fail #90 (Iristyle)
- (MODULES-2207) Gem restrictions for Older puppet versions #89 (ferventcoder)
- (maint) Multiple node acceptance fixes #79 (Iristyle)
1.1.0 - 2015-03-26
Fixed
- Fix issue with Rakefile where require beaker fails on windows or when not installed #74 (cyberious)
- Modify the way we install stdlib due to github rpc hangups #71 (cyberious)
- Fix tolerate mixed case test regex #69 (cyberious)
1.0.3 - 2014-08-28
Added
Fixed
- (MODULES-1292) Don't try to apply a regex to a binary string #62 (joshcooper)
- Fix registry testing, remove dependency of master to enable both foss an... #59 (cyberious)
1.0.2 - 2014-07-15
1.0.1 - 2014-07-07
Added
1.0.0 - 2014-03-03
Added
Fixed
- Fix acceptance tests when running on 32-bit version of 2003 #22 (joshcooper)
- (Maint) Fix unhandled exception working around #4248 #19 (jeffmccune)
0.1.1 - 2012-05-22
Fixed
- (#14572) Fix management of the default value #17 (jeffmccune)
0.1.0 - 2012-05-16
Added
- (#14529) Add registry::value defined type #16 (jeffmccune)
- Separate the implementation of the type and provider #11 (jeffmccune)
Fixed
- Fix autorequire case sensitivity #14 (jeffmccune)
0.0.1 - 2012-05-04
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select 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.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-registry
- Module version:
- 5.0.1
- Scan initiated:
- June 21st 2023, 15:40:55
- Detections:
- 0 / 59
- Scan stats:
- 59 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 16 unsupported
- Scan report:
- View the detailed scan report