registry_key_present

Ensure that a Registry Key does exist.

⚙️ Compatible targets: Windows

Parameters

NameDocumentation
keyRegistry key (ie, HKLM:\Software\Rudder).

This parameter is required.

Example

method: registry_key_present
params:
  key: VALUE

Documentation

Create a Registry Key if it does not exist. There are two different supported syntaxes to describe a Registry Key:

  • with short drive name and ":" like HKLM:\SOFTWARE\myKey
  • with long drive name and without ":" like HKEY_LOCAL_MACHINE:\SOFTWARE\myKey

Please, note that Rudder can not create new drive and new "first-level" Registry Keys.

Examples

-name: Make sure the Rudder reg key is defined
 method: registry_entry_present
   key: "HKLM:\SOFTWARE\Rudder"