Resource Type: dsc_xregistry

Defined in:

lib/puppet/type/dsc_xregistry.rb

Overview

The DSC xRegistry resource type. Automatically generated from version 9.2.1

Properties

• dsc_ensure

  Specifies whether or not the registry key or value should exist. To add or modify a registry key or value, set this property to Present. To remove a registry key or value, set the property to Absent.

• dsc_hex

  Specifies whether or not the specified DWord or QWord registry key data is provided in a hexadecimal format. Not valid for types other than DWord and QWord. The default value is $false.

• dsc_valuedata

  The data the specified registry key value should have as a string or an array of strings (MultiString only).

• dsc_valuetype

  The type the specified registry key value should have.

Parameters

• dsc_force

  Specifies whether or not to overwrite the specified registry key value if it already has a value or whether or not to delete a registry key that has subkeys. The default value is $false.

• dsc_key (namevar)

  The path of the registry key to add, modify, or remove. This path must include the registry hive/drive.

• dsc_psdscrunascredential
• dsc_timeout

  The maximum time in seconds to wait for the DSC resource to complete.

• dsc_valuename (namevar)

  The name of the registry value. To add or remove a registry key, specify this property as an empty string without specifying ValueType or ValueData. To modify or remove the default value of a registry key, specify this property as an empty string while also specifying ValueType or ValueData.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).