Resource Type: registry_key

Defined in:
lib/puppet/type/registry_key.rb
Providers:
registry

Overview

Manages registry keys on Windows systems.

Keys within HKEY_LOCAL_MACHINE (hklm) or HKEY_CLASSES_ROOT (hkcr) are supported. Other predefined root keys, e.g. HKEY_USERS, are not currently supported.

If Puppet creates a registry key, Windows will automatically create any necessary parent registry keys that do not exist.

Puppet will not recursively delete registry keys.

Autorequires: Any parent registry key managed by Puppet will be autorequired.

Properties

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent

Parameters

  • path

    The path to the registry key to manage. For example; 'HKLMSoftware', 'HKEY_LOCAL_MACHINESoftwareVendor'. If Puppet is running on a 64-bit system, the 32-bit registry key can be explicitly managed using a prefix. For example: '32:HKLMSoftware'

  • purge_values (defaults to: false)

    Whether to delete any registry value associated with this key that is not being managed by puppet.

    Supported values:
    • true
    • false