Otter Documentation

registry - Ensure Registry Key

  • Last Modified: 2020-06-26

This is generated from the built-in components of Otter 2.2, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your Otter instance to see exactly what operations are available.

Ensure Registry Key

Ensures that a registry key exists or does not exist.

Operation type:

Ensuring - this operation will ensure a specified configuration exists on a remote server after comparing its current state to the desired state.

Script usage:

Windows::Ensure-RegistryKey(
	Hive: <integer>,
	Key: <text>,
	[Exists: <true/false>],
	[DefaultValue: <text>]
);

Arguments:

Name Format Script Usage Usage Notes
🔑 Hive
integer
Hive
This argument is the unique key for this operation, which means it must uniquely identify the target of the operation. This argument is required.
🔑 Key
text
Key
This argument is the unique key for this operation, which means it must uniquely identify the target of the operation. This argument is required.
Exists
true/false
Exists
Default value
text
DefaultValue
A key's default value is the legacy unnamed value that every registry key may have. This is rarely used.

Example:

Windows::Ensure-RegistryKey
(
    Hive: LocalMachine,
    Key: SOFTWARE\Inedo\BuildMaster
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 46e90aca on master