Otter Documentation

registry - Ensure Registry Value

  • Last Modified: 2020-03-05

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 Value

Ensures that a registry value exists or does not exist on a specified key.

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-RegistryValue(
	Name: <text>,
	Hive: <integer>,
	Key: <text>,
	[Value: <@(text)>],
	[Kind: <integer>],
	[Exists: <true/false>]
);

Arguments:

Name Format Script Usage Usage Notes
🔑 Value name
text
Name
This argument is the unique key for this operation, which means it must uniquely identify the target of the operation. This argument is required.
🔑 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.
Value
@(text)
Value
Value kind
integer
Kind
Exists
true/false
Exists

Example:

Windows::Ensure-RegistryValue
(
    Name: ServicePath,
    Value: C:\BuildMaster\Service,
    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 7ca022a8 on master